From 4e8e380a18242a4cc28feab8ee890ffc82bd1188 Mon Sep 17 00:00:00 2001 From: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com> Date: Tue, 10 Oct 2017 14:11:10 -0700 Subject: [PATCH] Updates to bare-metal-install Signed-off-by: Tom Leavitt <30448839+tpleavitt@users.noreply.github.com> --- .../bare-metal-install/bare-metal-install.rst | 236 +++++++++--------- 1 file changed, 112 insertions(+), 124 deletions(-) diff --git a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst index 5f1c949a..7c15419b 100644 --- a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst +++ b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst @@ -30,9 +30,9 @@ on bare metal using a bootable USB drive. Install Clear Linux on your target system ***************************************** -We formatted the previously created USB drive as a UEFI boot device. Our target -system has a hard drive installed containing a single primary partition. The -target system needs a wired Internet connection with DHCP. +We formatted the previously created USB drive as a UEFI boot device. Our +target system has a hard drive installed containing a single primary +partition. The target system needs a wired Internet connection with DHCP. Follow these steps to install |CL| on the target system: @@ -60,9 +60,9 @@ Follow these steps to install |CL| on the target system: Figure 1: :guilabel:`Clear Linux boot menu` -#. This will take you into the :guilabel:`Clear Linux OS for Intel Architecture Installer` - menu as shown in figure 2 and explains how to navigate through the |CL| - installer setup menus. +#. This will take you into the :guilabel:`Clear Linux OS for Intel + Architecture Installer` menu as shown in figure 2 and explains how to + navigate through the |CL| installer setup menus. .. figure:: figures/cmi2.png :scale: 50 % @@ -72,8 +72,8 @@ Follow these steps to install |CL| on the target system: Press the :kbd:`Enter` key. -#. The :guilabel:`Keyboard selection` menu shown in figure 3 allows you to set up the - keyboard layout that you will be using to navigate within the |CL| +#. The :guilabel:`Keyboard selection` menu shown in figure 3 allows you to set + up the keyboard layout that you will be using to navigate within the |CL| installer setup menus. .. figure:: figures/cmi3.png @@ -82,17 +82,18 @@ Follow these steps to install |CL| on the target system: Figure 3: :guilabel:`Keyboard Selection` - For this guide we will select :menuselection:`Keyboard Selection --> < * us >` - for the keyboard mapping, which should already be highlighted. Press the - :kbd:`Enter` key to continue to the next menu. + For this guide we will select :menuselection:`Keyboard Selection --> + < * us >` for the keyboard mapping, which should already be highlighted. + Press the :kbd:`Enter` key to continue to the next menu. Network requirements ==================== The :guilabel:`Network Requirements` menu, the first step of the |CL| -installer setup process, will attempt to connect to the |CL| update -server where the installer image is located. Once the connection to the |CL| update -server is established, you will see a screen similar to the one shown in figure 4: +installer setup process, will attempt to connect to the |CL| update server +where the installer image is located. Once the connection to the |CL| update +server is established, you will see a screen similar to the one shown in +figure 4: .. figure:: figures/cmi4.png :scale: 50 % @@ -100,31 +101,30 @@ server is established, you will see a screen similar to the one shown in figure Figure 4: :guilabel:`Network Requirements` -If you need to configure any :guilabel:`Proxy Settings` to gain access to the update -server, enter the appropriate address and port of your proxy server in the -:guilabel:`HTTPS proxy:` field. Select the -:guilabel:`< Set proxy configuration >` field and press :kbd:`Enter`. You will -then see the connection to the update server established. +If you need to configure any :guilabel:`Proxy Settings` to gain access to the +update server, enter the appropriate address and port of your proxy server in +the :guilabel:`HTTPS proxy:` field. Select the :guilabel:`< Set proxy +configuration >` button and press :kbd:`Enter`. You will then see the +connection to the update server established. -Optionally, set up a :guilabel:`static IP configuration` to your |CL| installer image. -Enter the required information in the :guilabel:`Interface`, +Optionally, set up a :guilabel:`static IP configuration` to your |CL| +installer image. Enter the required information in the :guilabel:`Interface`, :guilabel:`IP address`, :guilabel:`Subnet mask`, :guilabel:`Gateway` and -:guilabel:`DNS` fields and then select the -:guilabel:`< Set static IP configuration >` field and press the :kbd:`Enter` -key. +:guilabel:`DNS` fields and then select the :guilabel:`< Set static IP +configuration >` button and press the :kbd:`Enter` key. -The information displayed in the lower right quadrant of the screen -shows the current IP configuration for the |CL| update server where the installer -image is located. +The information displayed in the lower right quadrant of the screen shows the +current IP configuration for the |CL| update server where the installer image +is located. .. note:: If you are having difficulty establishing a connection to the update server - and you see the message :guilabel:`none detected, install will fail`, you can - press the :kbd:`Tab` key to highlight the :guilabel:`< Refresh >` button - and press :kbd:`Enter` to attempt to reconnect to the |CL| update server. If this - fails to establish a connection after multiple attempts, reboot your system and - return to this step. + and you see the message :guilabel:`none detected, install will fail`, you + can press the :kbd:`Tab` key to highlight the :guilabel:`< Refresh >` + button and press :kbd:`Enter` to attempt to reconnect to the |CL| update + server. If this fails to establish a connection after multiple attempts, + reboot your system and return to this step. Once the connection to the |CL| udpate server is established, use the :kbd:`Tab` key to advance to the :guilabel:`< Next >` button and press @@ -133,12 +133,12 @@ Once the connection to the |CL| udpate server is established, use the Choose Clear Linux installer action =================================== -The :guilabel:`Choose Action` menu is where you can choose to install, repair, open -a shell, or exit the |CL| installer. This menu is shown in figure 5: +The :guilabel:`Choose Action` menu is where you can choose to install, repair, +open a shell, or exit the |CL| installer. This menu is shown in figure 5: - .. figure:: figures/cmi5.png - :scale: 50 % - :alt: Choose Action +.. figure:: figures/cmi5.png + :scale: 50 % + :alt: Choose Action Figure 5: :guilabel:`Choose Action` @@ -146,24 +146,25 @@ a shell, or exit the |CL| installer. This menu is shown in figure 5: the installation process. The :menuselection:`Choose action --> Repair` menu option will run the - :command:`swupd --fix` command to correct any issues found with the system software - that has already been installed on your system and correct any issues found by - overwriting the incorrect file content, adding missing files, fixing permissions - and any additional changes required to return the file to it's original content - and permissions. + :command:`swupd --fix` command to correct any issues found with the system + software that has already been installed on your system and correct any + issues found by overwriting the incorrect file content, adding missing + files, fixing permissions and any additional changes required to return the + file to it's original content and permissions. - The :menuselection:`Choose action --> Shell` menu item opens a terminal session on - your system as the root user and you will be able to manage your system from this - console. When you are finished, type :command:`exit` to return to the - :guilabel:`Choose Action` menu. + The :menuselection:`Choose action --> Shell` menu item opens a terminal + session on your system as the root user and you will be able to manage your + system from this console. When you are finished, type :command:`exit` to + return to the :guilabel:`Choose Action` menu. The :menuselection:`Choose action --> Exit` menu option terminates the |CL| installation process and the system will shut down. -#. You will be prompted to join the :guilabel:`Stability Enhancement Program` as shown - in figure 6. Press the :kbd:`Spacebar` or :kbd:`Enter` key while the cursor - is in the :guilabel:`[ ] Yes.` field to enable this functionality and then - select the :guilabel:`< Next >` button to advance to the next menu item. +#. You will be prompted to join the :guilabel:`Stability Enhancement Program` + as shown in figure 6. Press the :kbd:`Spacebar` or :kbd:`Enter` key while + the cursor is in the :guilabel:`[ ] Yes.` button to enable this + functionality and then select the :guilabel:`< Next >` button to advance to + the next menu item. .. figure:: figures/cmi3of6.png :scale: 50 % @@ -173,17 +174,18 @@ a shell, or exit the |CL| installer. This menu is shown in figure 5: If you choose not to enable this functionality during this step, you can install the ``telemetrics`` software bundle at a later time. As stated in - the menu, this feature only collects anonymous information about your system - to help improve system stability and no personally identifiable information is - collected. Please visit our website to `learn more about telemetry.`_ + the menu, this feature only collects anonymous information about your + system to help improve system stability and no personally identifiable + information is collected. Please visit our website to + `learn more about telemetry.`_ Choose Clear Linux installation type ************************************ Figure 7 shows the next step of the |CL| installer: :guilabel:`Choose installation Type`. Chose whether to install |CL| -**automatically** or **manually**. To end the installer process and shut down the -system, select the :guilabel:`< Exit >` button. +**automatically** or **manually**. To end the installer process and shut down +the system, select the :guilabel:`< Exit >` button. .. figure:: figures/cai4of6.png :scale: 50 % @@ -191,9 +193,6 @@ system, select the :guilabel:`< Exit >` button. Figure 7: :guilabel:`Choose installation Type` -Manual installation -=================== - If you select :guilabel:`< Automatic >` as the installation type, the |CL| Installer will add the minimum amount of functionality required for a fully functional |CL| system. You will not be able to modify the disk layout, add @@ -202,90 +201,79 @@ a user or any other tasks that the manual installation process will allow. With the :guilabel:`< Manual(Advanced) >` option you can do the following additional tasks during |CL| Installer setup: -* modify the disk layout using the cgdisk utility. -* add additional command-line parameters to the kernel. -* create a hostname for your system. -* create an administrative user. -* add additional software bundles to enhance the functionality of your initial +* Modify the disk layout using the cgdisk utility. +* Add additional command-line parameters to the kernel. +* Create a hostname for your system. +* Create an administrative user. +* Add additional software bundles to enhance the functionality of your initial |CL| installation. -* optionally, set up a static IP address for your system. +* Optionally, set up a static IP address for your system. -To implement any of the additional items listed above for the -manual option, select the :guilabel:`< Manual(Advanced) >` menu item and -follow the steps outlined in the :ref:`bare-metal-manual-install`. This guide -is a continuation from this point. +If you want to perform any of these additional tasks, select the +:guilabel:`< Manual(Advanced) >` menu item and follow the steps in our +:ref:`bare-metal-manual-install` to complete the |CL| installation process. +Otherwise you can follow the automatic installation steps outlined below. -.. toctree:: - :maxdepth: 1 +Clear Linux automatic installation +********************************** - bare-metal-manual-install +To install the minimum components for your |CL| implementation, select the +:guilabel:`< Automatic >` menu item shown in figure 7 and press the +:kbd:`Enter` key. -Automatic installation -********************** +The :guilabel:`Choose target device for installation` screen shown in figure 8 +appears. Move the cursor to the desired target and press the :kbd:`Enter` +key. -If you only want to install the minimum components for your |CL| -implementation the recommended action is to select the -:guilabel:`< Automatic >` menu item shown in figure 7. +.. figure:: figures/cai5of6.png + :scale: 50 % + :alt: Choose target device for installation -#. Move your cursor to this field and press the :kbd:`Enter` key. + Figure 8: :guilabel:`Choose target device for installation` -#. This will bring you to the ``Choose target device for installation`` - screen as shown in figure 8. Move your cursor to the desired target and - press the :kbd:`Enter` key. +In this example we selected the single primary partition from our hard drive. - .. figure:: figures/cai5of6.png - :scale: 50 % - :alt: Choose target device for installation +With all the |CL| installer setup information gathered for the automatic +installation option, the |CL| Installer prompts you to begin the actual +installation as shown in figure 9. - Figure 8: :guilabel:`Choose target device for installation` +.. figure:: figures/cai6of6.png + :scale: 50 % + :alt: Begin installation - In this example we select the single primary partition from our hard drive. + Figure 9: :guilabel:`Begin installation` -#. With all the |CL| installer setup information gathered for the automatic - installation option, the |CL| Installer will prompt you to begin the actual - installation as shown in figure 9. +When you are satisfied with the information you have entered, select the +:guilabel:`< Yes >` button and press :kbd:`Enter` to begin installing |CL|. - .. figure:: figures/cai6of6.png - :scale: 50 % - :alt: Begin installation - - Figure 9: :guilabel:`Begin installation` - - If you are satisfied with the information you have entered, select the - :guilabel:`< Yes >` field and press :kbd:`Enter` to begin installing |CL|. - -|CL| Installation begins...each step will show it's status as it progresses +|CL| Installation begins and each step shows its status as it progresses through the automated installation process. -Complete installation process -============================= +Once all steps have completed, you will see the ``Successful installation`` +status message and the :guilabel:`< Ok >` button is highlighted as shown in +figure 10. Press the :kbd:`Enter` key to continue. -#. Once all steps have completed, you will see the :guilabel:`< Ok >` prompt - as shown in figure 10. Press the - :kbd:`Enter` key to continue. +.. figure:: figures/caisuccess.png + :scale: 50 % + :alt: Installation complete - .. figure:: figures/caisuccess.png - :scale: 50 % - :alt: Installation complete + Figure 10: :guilabel:`Installation complete` - Figure 10: :guilabel:`Installation complete` +Figure 11 shows the installer's final screen prompting you that the +installation completed successfully and the system will reboot. Press the +:kbd:`Enter` key and remove the USB media while the system restarts. -#. The final screen is shown in figure 11 and you will be prompted that the - installation was successful and the system will be rebooted. Press the - :kbd:`Enter` key and remove the USB media while the system restarts. +.. figure:: figures/cairestart.png + :scale: 50 % + :alt: Successful installation - .. figure:: figures/cairestart.png - :scale: 50 % - :alt: Successful installation + Figure 11: :guilabel:`Successful Installation` - Figure 11: :guilabel:`Successful Installation` +Set up your root account +======================== -Set up your root and user accounts -================================== - -With the USB device removed and the system restarted, your newly installed -|CL| system boots and presents a full screen console requesting ``login:`` as -shown in figure 12: +Once the |CL| installation is complete and the system boots, a full screen +console requests your login: as shown in figure 12: .. figure:: figures/cairoot.png :scale: 50 % @@ -295,11 +283,11 @@ shown in figure 12: #. At the initial login prompt, enter: ``root`` -#. Once you are prompted, enter a new password +#. Once prompted, enter a new password. #. Re-enter the password to verify it. - You have now set your root password and are logged in with root privileges. +You have now set your root password and are logged in with root privileges. **Congratulations!** @@ -308,8 +296,8 @@ automatic installation method and set the password for the ``root`` user. The automatic installation of |CL| is designed to install with minimal software overhead. Therefore, some housekeeping and package installations -must occur before you have a full-featured |CL| operating system. These -instructions are captured in the :ref:`enable-user-space` section: +could be needed before you can take full advantage of the |CL| operating +system. These instructions are captured in the :ref:`enable-user-space`. * Update the OS to its most current version using `swupd`. * Install the most common applications for system administrators and