From e2316340eb28e38926dfb2709f0f0dfb2b50fc99 Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Mon, 24 Sep 2018 11:34:32 -0700 Subject: [PATCH 1/6] Initial commit for new hostname guide. Updated landing page to add link to new guide. Signed-off-by: Kristal Dale --- .../guides/maintenance/hostname.rst | 78 +++++++++++++++++++ .../guides/maintenance/maintenance.rst | 5 +- 2 files changed, 81 insertions(+), 2 deletions(-) create mode 100644 source/clear-linux/guides/maintenance/hostname.rst diff --git a/source/clear-linux/guides/maintenance/hostname.rst b/source/clear-linux/guides/maintenance/hostname.rst new file mode 100644 index 00000000..43dfa814 --- /dev/null +++ b/source/clear-linux/guides/maintenance/hostname.rst @@ -0,0 +1,78 @@ +.. _hostname: + +Modify hostname on |CL-ATTR| +############################ + +This guide describes how to modify and view the hostname of your +|CL-ATTR| system. + + +By default, |CL| installations have a machine generated name. This +long string of letters and numbers is fine for computers, but is not +human-friendly. Administrators and users will often want to rename +their machines with a name that is easier to remember, type, and search +for. Renaming a machine also makes it easier to identify, by including +meaningful data in the name. A meaningful, human-friendly machine +name might: + + * indicate the computer purpose e.g. “regression-test” + * indicate the owner e.g. “sally-test-box1” + * indicate the geographical location e.g. “az-bld2-lab” + + +.. note:: + + There are three types of hostname: “static”, “transient”, and “pretty”. + The most common is the static hostname. If the static hostname exists, + it is used to generate the transient hostname, which is maintained by the + kernel. Note that the transient hostname can be changed by DHCP or mDNS + at runtime. The pretty hostname is a human readable name that is used + for presentation to the user. + + Static hostnames must be between 2 and 63 characters long, must start + and end with a letter or number, and may contain letters (case-insensitive), + numbers, dashes or dots. Pretty hostnames can use free-form UTF8 characters, + to make the hostname more aesthetically pleasing for the user. + + +Setting your hostname +********************* + +|CL| uses the :command:`hostnamectl` command to display and modify the +machine name. :command:`hostnamectl` is part of the **os-core** bundle. + +This example sets the hostname to “telemetry-test-2-h15”, to identify a +|CL| telemetry test machine on the second floor at grid location H15. +Make sure to reboot after setting a new hostname. + + .. code-block:: bash + + sudo hostnamectl set-hostname telemetry-test-2-h15 + sudo reboot + + +View your hostname +****************** + +View your current hostname using the following command: + + .. code-block:: bash + + hostnamectl + +You should see output similar to: + + .. code-block:: console + + Static hostname: telemetry-test-2-h15 + Pretty hostname: telemetry-test-2-h15 + Icon name: computer-desktop + Chassis: desktop + Machine ID: 4d0d60207a904ebbab96680a51ac1339 + Boot ID: 98d3514e5a984e8cbbdf46a2f0d6b397 + Operating System: Clear Linux OS + Kernel: Linux 4.18.8-632.native + Architecture: x86-64 + + +**Congratulations!** You successfully modified the hostname of your |CL| system. diff --git a/source/clear-linux/guides/maintenance/maintenance.rst b/source/clear-linux/guides/maintenance/maintenance.rst index 09737c90..f8f1349c 100644 --- a/source/clear-linux/guides/maintenance/maintenance.rst +++ b/source/clear-linux/guides/maintenance/maintenance.rst @@ -3,8 +3,8 @@ Maintenance guide ################# -This guide provides step-by-step instructions for common tasks associated with -maintaining |CLOSIA| after :ref:`installation ` is completed. +These guides provide step-by-step instructions for common tasks associated with +maintaining |CL-ATTR| after :ref:`installation ` is completed. .. toctree:: :maxdepth: 2 @@ -19,6 +19,7 @@ maintaining |CLOSIA| after :ref:`installation ` is completed. validate-signatures telemetry-enable time + hostname increase-virtual-disk-size download-verify-uncompress-linux download-verify-uncompress-mac From 7720c914237738ca95648f858981f7a8f985c9d2 Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Mon, 24 Sep 2018 13:45:59 -0700 Subject: [PATCH 2/6] Edits for grammar. Signed-off-by: Kristal Dale --- .../guides/maintenance/hostname.rst | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/source/clear-linux/guides/maintenance/hostname.rst b/source/clear-linux/guides/maintenance/hostname.rst index 43dfa814..2d058091 100644 --- a/source/clear-linux/guides/maintenance/hostname.rst +++ b/source/clear-linux/guides/maintenance/hostname.rst @@ -15,23 +15,23 @@ for. Renaming a machine also makes it easier to identify, by including meaningful data in the name. A meaningful, human-friendly machine name might: - * indicate the computer purpose e.g. “regression-test” - * indicate the owner e.g. “sally-test-box1” - * indicate the geographical location e.g. “az-bld2-lab” + * indicate the computer purpose e.g. “regression-test.” + * indicate the owner e.g. “sally-test-box1.” + * indicate the geographical location e.g. “az-bld2-lab.” .. note:: - There are three types of hostname: “static”, “transient”, and “pretty”. + There are three types of hostname: “static”, “transient”, and “pretty.” The most common is the static hostname. If the static hostname exists, - it is used to generate the transient hostname, which is maintained by the - kernel. Note that the transient hostname can be changed by DHCP or mDNS - at runtime. The pretty hostname is a human readable name that is used - for presentation to the user. + it is used to generate the transient hostname, which is maintained by + the kernel. The transient hostname can be changed by DHCP or mDNS at + runtime. The pretty hostname is a human readable name that is used for + presentation to the user. - Static hostnames must be between 2 and 63 characters long, must start + Static hostnames must be between two and 63 characters long, must start and end with a letter or number, and may contain letters (case-insensitive), - numbers, dashes or dots. Pretty hostnames can use free-form UTF8 characters, + numbers, dashes, or dots. Pretty hostnames can use free-form UTF8 characters to make the hostname more aesthetically pleasing for the user. @@ -41,7 +41,7 @@ Setting your hostname |CL| uses the :command:`hostnamectl` command to display and modify the machine name. :command:`hostnamectl` is part of the **os-core** bundle. -This example sets the hostname to “telemetry-test-2-h15”, to identify a +This example sets the hostname to “telemetry-test-2-h15,” to identify a |CL| telemetry test machine on the second floor at grid location H15. Make sure to reboot after setting a new hostname. @@ -64,15 +64,15 @@ You should see output similar to: .. code-block:: console - Static hostname: telemetry-test-2-h15 - Pretty hostname: telemetry-test-2-h15 - Icon name: computer-desktop - Chassis: desktop - Machine ID: 4d0d60207a904ebbab96680a51ac1339 - Boot ID: 98d3514e5a984e8cbbdf46a2f0d6b397 + Static hostname: telemetry-test-2-h15 + Pretty hostname: telemetry-test-2-h15 + Icon name: computer-desktop + Chassis: desktop + Machine ID: 4d0d60207a904ebbab96680a51ac1339 + Boot ID: 98d3514e5a984e8cbbdf46a2f0d6b397 Operating System: Clear Linux OS - Kernel: Linux 4.18.8-632.native - Architecture: x86-64 + Kernel: Linux 4.18.8-632.native + Architecture: x86-64 **Congratulations!** You successfully modified the hostname of your |CL| system. From 408d5817b8858251fce1341f2659d1bc72d6c3dc Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Tue, 25 Sep 2018 12:46:51 -0700 Subject: [PATCH 3/6] Revisions to simplify sentences and examples, bring in-line with collaboration guidelines. Signed-off-by: Kristal Dale --- .../guides/maintenance/hostname.rst | 51 +++++++++---------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/source/clear-linux/guides/maintenance/hostname.rst b/source/clear-linux/guides/maintenance/hostname.rst index 2d058091..1571f813 100644 --- a/source/clear-linux/guides/maintenance/hostname.rst +++ b/source/clear-linux/guides/maintenance/hostname.rst @@ -7,41 +7,25 @@ This guide describes how to modify and view the hostname of your |CL-ATTR| system. -By default, |CL| installations have a machine generated name. This -long string of letters and numbers is fine for computers, but is not -human-friendly. Administrators and users will often want to rename +By default, |CL| installations have a machine generated name, which is a +long string of letters and numbers. The generated name is fine for computers +but is not human-friendly. Administrators and users will often want to rename their machines with a name that is easier to remember, type, and search for. Renaming a machine also makes it easier to identify, by including -meaningful data in the name. A meaningful, human-friendly machine -name might: +meaningful data in the name. The following examples show human-friendly machine names: - * indicate the computer purpose e.g. “regression-test.” - * indicate the owner e.g. “sally-test-box1.” - * indicate the geographical location e.g. “az-bld2-lab.” + * *regression-test* + * *sally-test-box1* + * *az-bldg2-lab* -.. note:: - - There are three types of hostname: “static”, “transient”, and “pretty.” - The most common is the static hostname. If the static hostname exists, - it is used to generate the transient hostname, which is maintained by - the kernel. The transient hostname can be changed by DHCP or mDNS at - runtime. The pretty hostname is a human readable name that is used for - presentation to the user. - - Static hostnames must be between two and 63 characters long, must start - and end with a letter or number, and may contain letters (case-insensitive), - numbers, dashes, or dots. Pretty hostnames can use free-form UTF8 characters - to make the hostname more aesthetically pleasing for the user. - - -Setting your hostname -********************* +Set your hostname +***************** |CL| uses the :command:`hostnamectl` command to display and modify the machine name. :command:`hostnamectl` is part of the **os-core** bundle. -This example sets the hostname to “telemetry-test-2-h15,” to identify a +This example sets the hostname to *telemetry-test-2-h15*, to identify a |CL| telemetry test machine on the second floor at grid location H15. Make sure to reboot after setting a new hostname. @@ -51,6 +35,21 @@ Make sure to reboot after setting a new hostname. sudo reboot +.. note:: + + There are three types of hostname: *static*, *transient*, and *pretty*. + The most common is the static hostname. Static hostnames must be between + two and 63 characters long, must start and end with a letter or number, + and may contain letters (case-insensitive), numbers, dashes, or dots. + + If the static hostname exists, it is used to generate the transient hostname, + which is maintained by the kernel. The transient hostname can be changed + by DHCP or mDNS at runtime. + + The pretty hostname is a free-form UTF8 name used for presentation to the user. + + + View your hostname ****************** From 16c13d4079c4661ca36e5cccfe59e970da861e5c Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Thu, 27 Sep 2018 09:25:51 -0700 Subject: [PATCH 4/6] reST formatting clean up Signed-off-by: Kristal Dale --- .../guides/maintenance/hostname.rst | 45 +++++++++---------- 1 file changed, 21 insertions(+), 24 deletions(-) diff --git a/source/clear-linux/guides/maintenance/hostname.rst b/source/clear-linux/guides/maintenance/hostname.rst index 1571f813..718173e2 100644 --- a/source/clear-linux/guides/maintenance/hostname.rst +++ b/source/clear-linux/guides/maintenance/hostname.rst @@ -14,26 +14,25 @@ their machines with a name that is easier to remember, type, and search for. Renaming a machine also makes it easier to identify, by including meaningful data in the name. The following examples show human-friendly machine names: - * *regression-test* - * *sally-test-box1* - * *az-bldg2-lab* - +* *regression-test* +* *sally-test-box1* +* *az-bldg2-lab* Set your hostname ***************** -|CL| uses the :command:`hostnamectl` command to display and modify the -machine name. :command:`hostnamectl` is part of the **os-core** bundle. +|CL| uses the :command:`hostnamectl` command to display and modify the machine +name. :command:`hostnamectl` is part of the **os-core** bundle, which provides +a basic Linux\* user space and utilities. This example sets the hostname to *telemetry-test-2-h15*, to identify a |CL| telemetry test machine on the second floor at grid location H15. Make sure to reboot after setting a new hostname. - .. code-block:: bash - - sudo hostnamectl set-hostname telemetry-test-2-h15 - sudo reboot +.. code-block:: bash + sudo hostnamectl set-hostname telemetry-test-2-h15 + sudo reboot .. note:: @@ -48,30 +47,28 @@ Make sure to reboot after setting a new hostname. The pretty hostname is a free-form UTF8 name used for presentation to the user. - - View your hostname ****************** View your current hostname using the following command: - .. code-block:: bash +.. code-block:: bash - hostnamectl + hostnamectl You should see output similar to: - .. code-block:: console +.. code-block:: console - Static hostname: telemetry-test-2-h15 - Pretty hostname: telemetry-test-2-h15 - Icon name: computer-desktop - Chassis: desktop - Machine ID: 4d0d60207a904ebbab96680a51ac1339 - Boot ID: 98d3514e5a984e8cbbdf46a2f0d6b397 - Operating System: Clear Linux OS - Kernel: Linux 4.18.8-632.native - Architecture: x86-64 + Static hostname: telemetry-test-2-h15 + Pretty hostname: telemetry-test-2-h15 + Icon name: computer-desktop + Chassis: desktop + Machine ID: 4d0d60207a904ebbab96680a51ac1339 + Boot ID: 98d3514e5a984e8cbbdf46a2f0d6b397 + Operating System: Clear Linux OS + Kernel: Linux 4.18.8-632.native + Architecture: x86-64 **Congratulations!** You successfully modified the hostname of your |CL| system. From 307dc6dcd71b693035e41b539685b9b29da1a68e Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Fri, 28 Sep 2018 13:43:08 -0700 Subject: [PATCH 5/6] - Added clarification about the os-core bundle - Clean up reST formatting Signed-off-by: Kristal Dale --- source/clear-linux/guides/maintenance/hostname.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/clear-linux/guides/maintenance/hostname.rst b/source/clear-linux/guides/maintenance/hostname.rst index 718173e2..04173288 100644 --- a/source/clear-linux/guides/maintenance/hostname.rst +++ b/source/clear-linux/guides/maintenance/hostname.rst @@ -6,13 +6,13 @@ Modify hostname on |CL-ATTR| This guide describes how to modify and view the hostname of your |CL-ATTR| system. - By default, |CL| installations have a machine generated name, which is a long string of letters and numbers. The generated name is fine for computers but is not human-friendly. Administrators and users will often want to rename their machines with a name that is easier to remember, type, and search for. Renaming a machine also makes it easier to identify, by including -meaningful data in the name. The following examples show human-friendly machine names: +meaningful data in the name. The following examples show human-friendly machine +names: * *regression-test* * *sally-test-box1* From 1fe62a0c41d79a34699a928d53265fcad1179d2f Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Fri, 28 Sep 2018 16:23:26 -0700 Subject: [PATCH 6/6] - corrected reST formatting (indentation) Signed-off-by: Kristal Dale --- .../guides/maintenance/hostname.rst | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/source/clear-linux/guides/maintenance/hostname.rst b/source/clear-linux/guides/maintenance/hostname.rst index 04173288..04c7108e 100644 --- a/source/clear-linux/guides/maintenance/hostname.rst +++ b/source/clear-linux/guides/maintenance/hostname.rst @@ -31,8 +31,8 @@ Make sure to reboot after setting a new hostname. .. code-block:: bash - sudo hostnamectl set-hostname telemetry-test-2-h15 - sudo reboot + sudo hostnamectl set-hostname telemetry-test-2-h15 + sudo reboot .. note:: @@ -54,21 +54,21 @@ View your current hostname using the following command: .. code-block:: bash - hostnamectl + hostnamectl You should see output similar to: .. code-block:: console - Static hostname: telemetry-test-2-h15 - Pretty hostname: telemetry-test-2-h15 - Icon name: computer-desktop - Chassis: desktop - Machine ID: 4d0d60207a904ebbab96680a51ac1339 - Boot ID: 98d3514e5a984e8cbbdf46a2f0d6b397 - Operating System: Clear Linux OS - Kernel: Linux 4.18.8-632.native - Architecture: x86-64 + Static hostname : telemetry-test-2-h15 + Pretty hostname : telemetry-test-2-h15 + Icon name : computer-desktop + Chassis : desktop + Machine ID : 4d0d60207a904ebbab96680a51ac1339 + Boot ID : 98d3514e5a984e8cbbdf46a2f0d6b397 + Operating System : Clear Linux OS + Kernel : Linux 4.18.8-632.native + Architecture : x86-64 **Congratulations!** You successfully modified the hostname of your |CL| system.