Provides options for automatic or manual installs on bare metal.
Cleans up the bare metal install steps prior to the manual vs auto decision with new screen captures. Then, forks to provide two ways to install on bare-metal. Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
@@ -0,0 +1,253 @@
|
||||
.. _bare-metal-auto-install:
|
||||
|
||||
Bare Metal Automatic Installation Guide
|
||||
#######################################
|
||||
|
||||
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 1. Move your cursor to
|
||||
this field and press the ``Enter`` key.
|
||||
|
||||
.. figure:: figures/cai4of6.png
|
||||
:scale: 50 %
|
||||
:alt: Choose installation Type
|
||||
|
||||
Figure 1: :guilabel:`Choose installation Type`
|
||||
|
||||
This will bring you to the ``Choose target device for installation`` screen as
|
||||
shown in figure 2:
|
||||
|
||||
.. figure:: figures/cai5of6.png
|
||||
:scale: 50 %
|
||||
:alt: Choose target device for installation
|
||||
|
||||
Figure 2: :guilabel:`Choose target device for installation`
|
||||
|
||||
Begin Automatic 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 3. If you are satisfied with the information
|
||||
you have entered, select the :guilabel:`< Yes >` field and press ``Enter`` to
|
||||
begin installing |CL|.
|
||||
|
||||
.. figure:: figures/cai6of6.png
|
||||
:scale: 50 %
|
||||
:alt: Begin installation
|
||||
|
||||
Figure 3: :guilabel:`Begin installation`
|
||||
|
||||
|CL| Installation begins...each step will show it's status as it progresses
|
||||
through the automated installation process. Once all steps have completed,
|
||||
you will see the :guilabel:`< Ok >` prompt as shown in figure 4. Press the
|
||||
``Enter`` key to continue.
|
||||
|
||||
.. figure:: figures/caisuccess.png
|
||||
:scale: 50 %
|
||||
:alt: Installation complete
|
||||
|
||||
Figure 4: :guilabel:`Installation complete`
|
||||
|
||||
The final screen is shown in figure 5 and you will be prompted that the
|
||||
installation was successful and the system will be rebooted. Press the
|
||||
``Enter`` key and remove the USB media while the system restarts.
|
||||
|
||||
.. figure:: figures/cairestart.png
|
||||
:scale: 50 %
|
||||
:alt: Successful Installation
|
||||
|
||||
Figure 5: :guilabel:`Successful Installation`
|
||||
|
||||
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 6:
|
||||
|
||||
.. figure:: figures/cairoot.png
|
||||
:scale: 50 %
|
||||
:alt: Login screen
|
||||
|
||||
Figure 6: :guilabel:`Login screen`
|
||||
|
||||
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.
|
||||
|
||||
Set up your root and user accounts
|
||||
----------------------------------
|
||||
|
||||
#. At the initial login prompt, enter: root
|
||||
#. Once you are prompted, enter a new password
|
||||
#. Re-enter the password to verify it.
|
||||
|
||||
You have set your root password and are logged in with root privileges.
|
||||
|
||||
The next step is to create a new user and set a password for
|
||||
that user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
useradd <userid>
|
||||
passwd <userid>
|
||||
|
||||
Replace <userid> with the name of the user account you want to create.
|
||||
|
||||
Remain logged in as the root user because there are some other things to do
|
||||
before we can fully enable your new user space.
|
||||
|
||||
Software installation and updates
|
||||
---------------------------------
|
||||
|
||||
|CL| has a unique application and architecture to add and update applications
|
||||
and to perform system updates called software update utility or
|
||||
:command:`swupd`. Software applications are installed as bundles using the
|
||||
sub-command :command:`bundle-add`.
|
||||
|
||||
Next, we should install some useful applications using the software update
|
||||
utility. The `os-clr-on-clr` bundle installs the vast majority of
|
||||
applications useful to a system administrator or a developer. The bundle
|
||||
contains other bundles such as `sysadmin-basic`, `editors`, `c-basic`, `dev-
|
||||
utils-dev`, and other useful packages.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
swupd bundle-add os-clr-on-clr
|
||||
|
||||
.. note::
|
||||
|
||||
The image we installed may not be the latest version of |CL| available on
|
||||
the server. However, whenever the command
|
||||
:command:`swupd bundle-add <bundle>` runs, the OS is updated to the latest
|
||||
available version. Our website provides more `information about swupd`_.
|
||||
|
||||
We provide the full list of bundles and packages installed with the
|
||||
`os-clr-on-clr`_ bundle. Additionally, we have listed
|
||||
`all Clear Linux bundles`_, active or deprecated. Click any bundle on the
|
||||
list to view the manifest of the bundle.
|
||||
|
||||
Finish setting up your new user
|
||||
-------------------------------
|
||||
|
||||
Before logging off as root and logging into your new user account, we must
|
||||
enable the :command:`sudo` command for your new `<userid>`.
|
||||
|
||||
To be able to execute all applications with root privileges, we must add the
|
||||
`<userid>` to the `wheel group`_ and enable the wheel group in the
|
||||
:file:`/etc/sudoers` file.
|
||||
|
||||
1. To add `<userid>` to the wheel group, enter the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usermod -G wheel -a <userid>
|
||||
|
||||
#. To open the :file:`/etc/sudoers` file, enter the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
vi /etc/sudoers
|
||||
|
||||
.. note::
|
||||
|
||||
Normally, we would use the visudo script to edit the :file:`/etc/sudoers`
|
||||
file to safely modify the contents of the file. In this instance, the file
|
||||
does not exist yet. Therefore, we create the initial instance of the file.
|
||||
|
||||
#. In the vi\* editor window, press the :kbd:`o` to open a new line.
|
||||
|
||||
#. Add the following line to the file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
%wheel ALL=(ALL) ALL
|
||||
|
||||
#. To save the changes to the file and exit vi, press the :kbd:`ESC` key
|
||||
followed by the :kbd:`:` and :kbd:`x` keys.
|
||||
|
||||
.. important::
|
||||
|
||||
Creating the file logged as the root user keeps the permissions of the
|
||||
file with the root user.
|
||||
|
||||
Now, we can log out of root and into our new `<userid>`.
|
||||
|
||||
To log off as root, enter :command:`exit`.
|
||||
|
||||
The command should bring you back to the `login:` prompt.
|
||||
|
||||
Enter your new `<userid>` and the password you created earlier.
|
||||
|
||||
You should now be in the home directory of `<userid>`. The bundle
|
||||
`os-clr-on-clr`_ contains the majority of applications that a developer or
|
||||
system administrator would want but it does not include a graphical user
|
||||
interface. The `desktop` bundle includes the Gnome Desktop Manager and
|
||||
additional supporting applications.
|
||||
|
||||
To test the :command:`sudo` command and ensure we set it up correctly, we can
|
||||
install the Gnome Desktop Manager (gdm) and start it.
|
||||
|
||||
To install Gnome using :command:`swupd`, enter the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
sudo swupd bundle-add desktop
|
||||
|
||||
To start the Gnome Desktop Manager, enter the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
systemctl start gdm
|
||||
|
||||
You will be prompted to authenticate your user. Enter the password for
|
||||
`<userid>` and the Gnome Desktop should start as shown in figure 1:
|
||||
|
||||
.. figure:: figures/gnomedt.png
|
||||
:scale: 50 %
|
||||
:alt: Gnome Desktop
|
||||
|
||||
Figure 1: :guilabel:`Gnome Desktop`
|
||||
|
||||
To start the Gnome Desktop each time you start your system, enter
|
||||
the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
systemctl enable gdm
|
||||
|
||||
**Congratulations!**
|
||||
|
||||
You have successfully installed |CL| on a bare metal system using the
|
||||
automatic installation method.
|
||||
|
||||
Additionally, you performed the following basic setup for your system:
|
||||
|
||||
* Setup of a root user.
|
||||
* Updated the OS to its most current version using `swupd`.
|
||||
* Installed the most common applications for system administrators and
|
||||
developers using bundles.
|
||||
* Setup of a new user.
|
||||
* Setup of `sudo` privileges for that new user.
|
||||
* Installed a GUI using those `sudo` privileges.
|
||||
|
||||
Next steps
|
||||
==========
|
||||
|
||||
With your system now running |CL| many paths are open for you.
|
||||
|
||||
Visit our :ref:`tutorials <tutorials>` page for examples on using your |CL|
|
||||
system.
|
||||
|
||||
.. _`NUC6i5SYH product page`:
|
||||
http://www.intel.com/content/www/us/en/nuc/nuc-kit-nuc6i5syh.html
|
||||
|
||||
.. _`information about swupd`:
|
||||
https://clearlinux.org/features/software-update
|
||||
|
||||
.. _`os-clr-on-clr`:
|
||||
https://github.com/clearlinux/clr-bundles/blob/master/bundles/os-clr-on-clr
|
||||
|
||||
.. _`all Clear Linux bundles`:
|
||||
https://github.com/clearlinux/clr-bundles/tree/master/bundles
|
||||
|
||||
.. _`wheel group`:
|
||||
https://en.wikipedia.org/wiki/Wheel_(Unix_term)
|
||||
@@ -1,286 +1,232 @@
|
||||
.. _bare-metal-install:
|
||||
|
||||
Install Clear Linux host OS on bare metal
|
||||
#########################################
|
||||
|
||||
This instruction set will guide you through the automatic installation of |CL|
|
||||
on bare metal using a bootable USB drive.
|
||||
|
||||
.. include:: ../compatibility-check.rst
|
||||
:Start-after: compatibility-check:
|
||||
|
||||
.. include:: ../bootable-usb/bootable-usb-linux.rst
|
||||
:Start-after: bootable-usb-linux:
|
||||
:end-before: download-cl-image
|
||||
|
||||
.. include:: ../bootable-usb/bootable-usb-linux.rst
|
||||
:Start-after: download-cl-image:
|
||||
:end-before: verify-checksum
|
||||
|
||||
.. include:: ../bootable-usb/bootable-usb-linux.rst
|
||||
:Start-after: verify-checksum:
|
||||
:end-before: copy-usb-linux
|
||||
|
||||
.. include:: ../bootable-usb/bootable-usb-linux.rst
|
||||
:Start-after: copy-usb-linux:
|
||||
:end-before: usb-next
|
||||
|
||||
.. _install-on-target:
|
||||
|
||||
Install Clear Linux on your target system
|
||||
*****************************************
|
||||
|
||||
The USB drive that was created in the previous step has been formatted 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:
|
||||
|
||||
#. Insert the USB drive into an available USB slot.
|
||||
|
||||
#. Power on the system.
|
||||
|
||||
#. Open the system BIOS setup menu, normally by pressing the F2 key. Your
|
||||
BIOS setup menu entry point may vary.
|
||||
|
||||
#. In the setup menu, enable the UEFI boot and set the USB drive as the first
|
||||
option in the device boot order.
|
||||
|
||||
#. Save these settings and exit.
|
||||
|
||||
#. Reboot the target system and the |CL| Installer menu will start.
|
||||
|
||||
.. note::
|
||||
|
||||
Use the arrow keys, space bar, and enter key to navigate the menu of the
|
||||
|CL| Installer.
|
||||
|
||||
#. In this tutorial, we will enable telemetrics and select the `Automatic`
|
||||
installation type.
|
||||
|
||||
The primary drive to install |CL| onto is :file:`/dev/sdb` since the
|
||||
target system identifies the USB drive as :file:`/dev/sda`.
|
||||
|
||||
#. Follow the instructions to begin the installation.
|
||||
|
||||
The installation is completed in the following stages:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Reading configuration
|
||||
Validating configuration
|
||||
Creating partitions
|
||||
Creating file systems
|
||||
Setting up mount points
|
||||
Starting swupd. May take several minutes
|
||||
Cleaning up
|
||||
Successful installation
|
||||
|
||||
Once complete, an `<OK>` prompt appears in the dialog box, letting you know
|
||||
that you have successfully installed |CL| onto your system.
|
||||
|
||||
#. Press enter once the <OK> prompt appears. The following dialog box takes
|
||||
its place:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Successful installation, the system will be rebooted
|
||||
|
||||
<OK>
|
||||
|
||||
#. Press enter, remove the USB drive from the system, and the system will
|
||||
reboot running |CL|.
|
||||
|
||||
.. _initial-setup:
|
||||
|
||||
Clear Linux initial setup after installation
|
||||
********************************************
|
||||
|
||||
Your newly installed |CL| boots on your target system and presents a full
|
||||
screen console requesting `Login:`. |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.
|
||||
|
||||
Set up your root and user accounts
|
||||
==================================
|
||||
|
||||
#. At the initial login prompt, enter: root
|
||||
|
||||
#. Once you are prompted, enter a new password
|
||||
|
||||
#. Re-enter the password to verify it.
|
||||
|
||||
You have set your root password and are logged in with root privileges.
|
||||
|
||||
The next step is to create a new user and set a password for
|
||||
that user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
useradd <userid>
|
||||
passwd <userid>
|
||||
|
||||
Replace <userid> with the name of the user account you want to create.
|
||||
|
||||
Remain logged in as the root user because there are some other things to do
|
||||
before we can fully enable your new user space.
|
||||
|
||||
Software installation and updates
|
||||
=================================
|
||||
|
||||
|CL| has a unique application and architecture to add and update applications
|
||||
and to perform system updates called software update utility or `swupd`.
|
||||
Software applications are installed as bundles using the command
|
||||
:command:`bundle-add`.
|
||||
|
||||
Next, we should install some useful applications using the software update
|
||||
utility. The `os-clr-on-clr` bundle installs the vast majority of
|
||||
applications useful to a system administrator or a developer. The bundle
|
||||
contains other bundles such as `sysadmin-basic`, `editors`, `c-basic`, `dev-
|
||||
utils-dev`, and other useful packages.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
swupd bundle-add os-clr-on-clr
|
||||
|
||||
.. note::
|
||||
|
||||
The image we installed may not be the latest version of |CL| available on
|
||||
the server. However, whenever the command
|
||||
:command:`swupd bundle-add <bundle>` runs, the OS is updated to the latest
|
||||
available version. Our website provides more `information about swupd`_.
|
||||
|
||||
We provide the full list of bundles and packages installed with the
|
||||
`os-clr-on-clr`_ bundle. Additionally, we have listed
|
||||
`all Clear Linux bundles`_, active or deprecated. Click any bundle on the
|
||||
list to view the manifest of the bundle.
|
||||
|
||||
Finish setting up your new user
|
||||
===============================
|
||||
|
||||
Before logging off as root and logging into your new user account, we must
|
||||
enable the :command:`sudo` command for your new `<userid>`.
|
||||
|
||||
To be able to execute all applications with root privileges, we must add the
|
||||
`<userid>` to the `wheel group`_ and enable the wheel group in the
|
||||
:file:`/etc/sudoers` file.
|
||||
|
||||
#. To add `<userid>` to the wheel group, enter the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
usermod -G wheel -a <userid>
|
||||
|
||||
#. To open the :file:`/etc/sudoers` file, enter the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
vi /etc/sudoers
|
||||
|
||||
.. note::
|
||||
|
||||
Normally, we would use the visudo script to edit the :file:`/etc/sudoers`
|
||||
file to safely modify the contents of the file. In this instance, the file
|
||||
does not exist yet. Therefore, we create the initial instance of the file.
|
||||
|
||||
#. In the vi\* editor window, press the :kbd:`o` to open a new line.
|
||||
|
||||
#. Add the following line to the file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
%wheel ALL=(ALL) ALL
|
||||
|
||||
#. To save the changes to the file and exit vi, press the :kbd:`ESC` key
|
||||
followed by the :kbd:`:` and :kbd:`x` keys.
|
||||
|
||||
.. important::
|
||||
|
||||
Creating the file logged as the root user keeps the permissions of the
|
||||
file with the root user.
|
||||
|
||||
Now, we can log out of root and into our new <userid>.
|
||||
|
||||
#. To log off as root, enter :command:`exit`.
|
||||
|
||||
The command should bring you back to the `Login:` prompt.
|
||||
|
||||
#. Enter your new `<userid>` and the password you created earlier.
|
||||
|
||||
You should now be in the home directory of `<userid>`. The bundle
|
||||
`os-clr-on-clr`_ contains the majority of applications that a developer or
|
||||
system administrator would want but it does not include a graphical user
|
||||
interface. The `desktop` bundle includes the Gnome Desktop Manager and
|
||||
additional supporting applications.
|
||||
|
||||
Install a GUI
|
||||
=============
|
||||
|
||||
#. To test the :command:`sudo` command and ensure we set it up correctly, we
|
||||
can install the Gnome Desktop Manager (gdm) and start it.
|
||||
|
||||
#. To install Gnome using swupd, enter the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
sudo swupd bundle-add desktop
|
||||
|
||||
#. To start the Gnome Desktop Manager, enter the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
systemctl start gdm
|
||||
|
||||
You will be prompted to authenticate your user. Enter the password for
|
||||
`<userid>` and the Gnome Desktop should start as shown in figure 1:
|
||||
|
||||
.. figure:: figures/gnomedt.png
|
||||
:alt: Gnome Desktop
|
||||
|
||||
Figure 1: :guilabel:`Gnome Desktop`
|
||||
|
||||
#. To start the Gnome Desktop each time you start your system, enter
|
||||
the following command:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
systemctl enable gdm
|
||||
|
||||
**Congratulations!**
|
||||
|
||||
You have successfully installed |CL| on a bare metal system.
|
||||
|
||||
Additionally, you performed the following basic setup for your system:
|
||||
|
||||
* Setup of a root user.
|
||||
* Updated the OS to its most current version using `swupd`.
|
||||
* Installed the most common applications for system administrators and
|
||||
developers using bundles.
|
||||
* Setup of a new user.
|
||||
* Setup of `sudo` privileges for that new user.
|
||||
* Installed a GUI using those `sudo` privileges.
|
||||
|
||||
Next steps
|
||||
**********
|
||||
|
||||
With your system now running |CL| many paths are open for you.
|
||||
|
||||
Visit our :ref:`tutorials` page for examples on using your |CL|
|
||||
system.
|
||||
|
||||
.. _`information about swupd`:
|
||||
https://clearlinux.org/features/software-update
|
||||
|
||||
.. _`os-clr-on-clr`:
|
||||
https://github.com/clearlinux/clr-bundles/blob/master/bundles/os-clr-on-clr
|
||||
|
||||
.. _`all Clear Linux bundles`:
|
||||
https://github.com/clearlinux/clr-bundles/tree/master/bundles
|
||||
|
||||
.. _`wheel group`:
|
||||
https://en.wikipedia.org/wiki/Wheel_(Unix_term)
|
||||
|
||||
.. _image: https://download.clearlinux.org/image
|
||||
|
||||
.. _releases: https://download.clearlinux.org/releases
|
||||
.. _bare-metal-install:
|
||||
|
||||
Install Clear Linux OS on bare metal
|
||||
####################################
|
||||
|
||||
This instruction set will guide you through the installation of |CLOSIA|
|
||||
on bare metal using a bootable USB drive.
|
||||
|
||||
.. include:: ../compatibility-check.rst
|
||||
:Start-after: compatibility-check:
|
||||
|
||||
.. include:: ../bootable-usb/bootable-usb-linux.rst
|
||||
:Start-after: bootable-usb-linux:
|
||||
:end-before: download-cl-image
|
||||
|
||||
.. include:: ../bootable-usb/bootable-usb-linux.rst
|
||||
:Start-after: download-cl-image:
|
||||
:end-before: verify-checksum
|
||||
|
||||
.. include:: ../bootable-usb/bootable-usb-linux.rst
|
||||
:Start-after: verify-checksum:
|
||||
:end-before: copy-usb-linux
|
||||
|
||||
.. include:: ../bootable-usb/bootable-usb-linux.rst
|
||||
:Start-after: copy-usb-linux:
|
||||
:end-before: usb-next
|
||||
|
||||
.. _install-on-target:
|
||||
|
||||
Install Clear Linux on your target system
|
||||
*****************************************
|
||||
|
||||
The USB drive that was created in the previous step has been formatted 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:
|
||||
|
||||
#. Insert the USB drive into an available USB slot.
|
||||
|
||||
#. Power on the system.
|
||||
|
||||
#. Open the system BIOS setup menu, normally by pressing the F2 key. Your
|
||||
BIOS setup menu entry point may vary.
|
||||
|
||||
#. In the setup menu, enable the UEFI boot and set the USB drive as the first
|
||||
option in the device boot order.
|
||||
|
||||
#. Save these settings and exit.
|
||||
|
||||
#. Reboot the target system and the |CL| Installer menu will start as shown in
|
||||
Figure 1.
|
||||
|
||||
.. figure:: figures/cmi1.png
|
||||
:scale: 50 %
|
||||
:alt: |CL| boot menu
|
||||
|
||||
Figure 1: :guilabel:`|CL| boot menu`
|
||||
|
||||
Select :guilabel:`Clear Linux OS for Intel Architecture` and press the
|
||||
``Enter`` key or wait 5 seconds to automatically select it. This will take
|
||||
you into the ``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 %
|
||||
:alt: Clear Linux OS for Intel Architecture Installer
|
||||
|
||||
Figure 2: :guilabel:`Clear Linux OS for Intel Architecture Installer`
|
||||
|
||||
Press the ``Enter`` key to continue to the ``Keyboard selection`` menu,
|
||||
shown in figure 3. This menu allows you to set up the keyboard layout that
|
||||
you will be using to navigate within the |CL| installer setup menus. For
|
||||
this guide we will select :guilabel:`< * us >` for the keyboard mapping, which
|
||||
should already be highlighted. Press the ``Enter`` key to continue to the
|
||||
next menu.
|
||||
|
||||
.. figure:: figures/cmi3.png
|
||||
:scale: 50 %
|
||||
:alt: Keyboard Selection
|
||||
|
||||
Figure 3: :guilabel:`Keyboard Selection`
|
||||
|
||||
This will bring you to the ``Network Requirements`` menu, the 1st step of the
|
||||
installer setup process, and will attempt to connect to the |CL| update
|
||||
server. Once the connection to the update server is established you will see
|
||||
a screen similar to the one shown in figure 4:
|
||||
|
||||
.. figure:: figures/cmi4.png
|
||||
:scale: 50 %
|
||||
:alt: Network Requirements
|
||||
|
||||
Figure 4: :guilabel:`Network Requirements`
|
||||
|
||||
If you need to configure ``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 :guilabel:`< Set proxy configuration >`
|
||||
field and press ``Enter``. If you entered the address correctly you should
|
||||
then see the connection to the update server established.
|
||||
|
||||
You can optionally set up a ``static IP configuration`` to your update server
|
||||
by entering the required information in the :guilabel:`Interface`,
|
||||
:guilabel:`IP address`, :guilabel:`Subnet mask`, :guilabel:`Gateway` and
|
||||
:guilabel:`DNS` fields and then selecting the
|
||||
:guilabel:`< Set static IP configuration >` field and pressing the ``Enter``
|
||||
key.
|
||||
|
||||
The information displayed in the lower right quadrant of the screen
|
||||
shows the current IP configuration for the 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 ``none detected, install will fail``, you can
|
||||
``Tab`` to the :guilabel:`< Refresh >` field and press ``Enter`` to attempt
|
||||
to reconnect to the 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 ``Tab``
|
||||
key to advance to the :guilabel:`< Next >` field and press ``Enter`` to
|
||||
advance to the next installer setup menu.
|
||||
|
||||
The ``Choose Action`` menu is where you can choose to Install, Repair, open
|
||||
a Shell or Exit the installer. This menu is shown in figure 5:
|
||||
|
||||
.. figure:: figures/cmi5.png
|
||||
:scale: 50 %
|
||||
:alt: Choose Action
|
||||
|
||||
Figure 5: :guilabel:`Choose Action`
|
||||
|
||||
If you choose :guilabel:`Install`, the installer setup process will continue
|
||||
to the next menu screen.
|
||||
|
||||
Choosing the :guilabel:`Repair` menu option will reinstall all software
|
||||
packages that have been installed on the existing |CL| system using the
|
||||
:command:`swupd` command and update all installed software bundles including
|
||||
the core OS to the latest bundle release. Since |CL| is a stateless system,
|
||||
the default configuration files in the :file:`/usr` and :file:`/etc`
|
||||
directories will be restored and the system will be returned to a factory
|
||||
default state. See our website for more `information about stateless`_.
|
||||
Once the repair process has completed you will be returned to the
|
||||
``Choose Action`` menu.
|
||||
|
||||
Selecting the :guilabel:`Shell` menu item will open 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
|
||||
``Choose Action`` menu.
|
||||
|
||||
By selecting :guilabel:`Exit`, you will terminate the installation process
|
||||
and the system will shut down.
|
||||
|
||||
Install Clear Linux OS
|
||||
----------------------
|
||||
|
||||
If you select the ``Install`` menu item in the ``Choose action`` menu, you
|
||||
will be prompted to join the ``Stability Enhancement Program`` as shown in
|
||||
figure 6. Press the ``Spacebar`` or ``Enter`` key while the cursor
|
||||
is in the :guilabel:`[ ] Yes.` field to enable this functionality and then
|
||||
select the :guilabel:`< Next >` field to advance to the next menu item. 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.`_
|
||||
|
||||
.. figure:: figures/cmi3of6.png
|
||||
:scale: 50 %
|
||||
:alt: Stability Enhancement Program
|
||||
|
||||
Figure 6: :guilabel:`Stability Enhancement Program`
|
||||
|
||||
Choose installation type
|
||||
------------------------
|
||||
|
||||
The next menu of the |CL| installer setup is ``Choose installation Type`` and
|
||||
is shown in figure 7. This menu will allow you to install |CL|
|
||||
**automatically** or **manually**. You can also terminate the |CL| Installer
|
||||
to stop the |CL| installer setup process by selecting :guilabel:`< Exit >` and
|
||||
shutting down the system.
|
||||
|
||||
.. figure:: figures/cai4of6.png
|
||||
:scale: 50 %
|
||||
:alt: Choose installation Type
|
||||
|
||||
Figure 7: :guilabel:`Choose installation Type`
|
||||
|
||||
Automatic vs. 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
|
||||
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
|
||||
|CL| installation
|
||||
* optionally set up a static IP address for your system
|
||||
|
||||
If you want to complete the |CL| installation with minimum amount of
|
||||
functionality, select the :guilabel:`< Automatic >` option and follow the
|
||||
steps outlined in the
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
bare-metal-auto-install
|
||||
|
||||
If you want 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
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
bare-metal-manual-install
|
||||
|
||||
.. _`information about stateless`:
|
||||
https://clearlinux.org/features/stateless
|
||||
|
||||
.. _`learn more about telemetry.`:
|
||||
https://clearlinux.org/features/telemetry
|
||||
|
||||
@@ -0,0 +1,282 @@
|
||||
.. _bare-metal-manual-install:
|
||||
|
||||
Bare Metal Manual Installation Guide
|
||||
####################################
|
||||
|
||||
TODO: it is assumed that you came here from the |CLOSIA| bare-metal-install-intro
|
||||
guide...if not, start there first...
|
||||
|
||||
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
|
||||
|CL| installation
|
||||
* optionally set up a static IP address for your system
|
||||
|
||||
If you are planning to perform any of these tasks the recommended action is to
|
||||
select the :guilabel:`< Manual(Advanced) >` menu item. Move your cursor to
|
||||
this field and press the ``Enter`` key.
|
||||
|
||||
.. figure:: figures/cmi7.png
|
||||
:scale: 50 %
|
||||
:alt: Choose installation Type
|
||||
|
||||
Figure 7: :guilabel:`Choose installation Type`
|
||||
|
||||
This will bring you to the ``Choose partitioning method`` screen as shown in
|
||||
figure 8:
|
||||
|
||||
.. figure:: figures/cmi5of13.png
|
||||
:scale: 50 %
|
||||
:alt: Choose partitioning method
|
||||
|
||||
Figure 8: :guilabel:`Choose partitioning method`
|
||||
|
||||
If you have already set up your hard drive for a linux system then you can
|
||||
select the :guilabel:`< Use default partition and mount scheme on target device >`
|
||||
menu item and press ``Enter`` to move to the next step of the installer
|
||||
setup process. This is the option that we will take for this guide.
|
||||
|
||||
If you want to set up your hard drive partitions before moving to the next
|
||||
step, select the :guilabel:`< Manually configure mounts and partitions >` menu
|
||||
item and follow the instructions to set up your |CL| hard drive.
|
||||
|
||||
TODO: this needs to have a link to the steps to set up the disk using
|
||||
cgdisk along with a simple linux partitioning primer that I will write
|
||||
after I finish the first draft.
|
||||
|
||||
.. _choose-target-device:
|
||||
|
||||
Choose target device for installation
|
||||
-------------------------------------
|
||||
|
||||
The ``Choose target device for installation`` menu, shown in figure 9, will
|
||||
appear with the current device and partition information displayed. In this
|
||||
example, ``/dev/sda`` is the only drive on the system with 3 partitions
|
||||
defined and assigned. The menu cursor is highlighting the device to install
|
||||
|CL| onto. Select :guilabel:`< Partition /dev/sda >` and press ``Enter``.
|
||||
If you want to return to the previous menu, press the ``Tab`` key to highlight
|
||||
the :guilabel:`< Previous >` field and press ``Enter`` to return to the
|
||||
``< Choose partitioning method >`` menu.
|
||||
|
||||
.. figure:: figures/cmi6of13.png
|
||||
:scale: 50 %
|
||||
:alt: Choose target device for installation
|
||||
|
||||
Figure 9: :guilabel:`Choose target device for installation`
|
||||
|
||||
After selecting the :guilabel:`< Partition /dev/sda >` field you will be
|
||||
presented with a warning screen as shown in figure 10 with the
|
||||
:guilabel:`< No >` field highlighted:
|
||||
|
||||
.. figure:: figures/cmi7of13.png
|
||||
:scale: 50 %
|
||||
:alt: Device installation warning
|
||||
|
||||
Figure 10: :guilabel:`Device installation warning`
|
||||
|
||||
Use the ``Tab`` key to highlight the :guilabel:`< Yes >` field and press
|
||||
``Enter`` to proceed to the next step if this is the device that you want to
|
||||
install |CL| onto.
|
||||
|
||||
Additional manual installer settings
|
||||
------------------------------------
|
||||
|
||||
The next steps of the manual installer setup process will allow you to set up
|
||||
any additional command-line parameters to the kernel, create a hostname for
|
||||
your system, set up an administrative user, install any additional software
|
||||
bundles to enhance your system and optionally create a static IP address for
|
||||
your system.
|
||||
|
||||
On the menu ``Append to kernel cmdline``, you can add additional options to
|
||||
the kernel command-line to further customize your installation as shown in
|
||||
figure 11. Normally this would not be required but if there is something
|
||||
specific that needs to be set you can do it here. For a complete list of
|
||||
command-line parameters for the Linux kernel you can visit the
|
||||
`latest kernel's command-line parameters`_ at kernel.org and explore through
|
||||
the documents listed there. Add any additional command-line parameters in the
|
||||
:guilabel:`Append to cmdline:` and then press the ``Tab`` key to highlight the
|
||||
:guilabel:`< Next >` and press ``Enter``.
|
||||
|
||||
.. figure:: figures/cmi8of13.png
|
||||
:scale: 50 %
|
||||
:alt: Append to kernel cmdline
|
||||
|
||||
Figure 11: :guilabel:`Append to kernel cmdline`
|
||||
|
||||
The next menu, ``Configuring Hostname``, will start off suggesting a hostname
|
||||
string prefaced with "clr" as shown in figure 12. You can make your hostname
|
||||
anything meaningful and unique. Once complete, press the ``Tab`` key to move
|
||||
to the :guilabel:`< Next >` field and press ``Enter``. To learn more about
|
||||
hostname naming conventions and restrictions, you can check this
|
||||
`wiki page about hostnames`_ for more information.
|
||||
|
||||
.. figure:: figures/cmi9of13.png
|
||||
:scale: 50 %
|
||||
:alt: Configure Hostname
|
||||
|
||||
Figure 12: :guilabel:`Configure Hostname`
|
||||
|
||||
The ``User configuration`` menu shown in figure 13 gives you the option to
|
||||
create a user with administrative priveleges. Select the field
|
||||
:guilabel:`< Create an administrative user >` and press ``Enter`` to go to the
|
||||
second page of this menu item. If you want to create a user at a later time,
|
||||
select :guilabel:`< No user creation (login as root) >` to skip this step and
|
||||
proceed to the ``Bundle selector`` menu.
|
||||
|
||||
.. figure:: figures/cmi10of13.png
|
||||
:scale: 50 %
|
||||
:alt: User configuration
|
||||
|
||||
Figure 13: :guilabel:`User configuration`
|
||||
|
||||
If you choose to create a user you will be presented with the second ``User
|
||||
configuration`` menu shown in figure 14. You are only required to fill in
|
||||
the :guilabel:`Username`, :guilabel:`Password` and guilabel:`Confirm password`
|
||||
fields but it is recommended that you also enter a meaningful name and to also
|
||||
select the :guilabel:`Add user to the sudoers?` if you want this user to be
|
||||
able to execute the :command:`sudo` command. Once you have entered all the
|
||||
data for this menu, press the ``Tab`` key to highlight the
|
||||
:guilabel:`< Next >` field and press ``Enter``.
|
||||
|
||||
.. figure:: figures/cmi10of13a.png
|
||||
:scale: 50 %
|
||||
:alt: User configuration - create user
|
||||
|
||||
Figure 14: :guilabel:`User configuration - create user`
|
||||
|
||||
The ``Bundle selector`` menu shown in figure 15 will allow you to add
|
||||
additional software bundles to your initial |CL| installation. In this
|
||||
example we will select all additional bundles offered by pressing the ``Tab``
|
||||
key to go to each field and pressing the ``Spacebar`` or the ``Enter`` key to
|
||||
select each additional bundle. This menu also lists the additional software
|
||||
bundles that will be installed during the |CL| installation.
|
||||
|
||||
.. figure:: figures/cmi11of13.png
|
||||
:scale: 50 %
|
||||
:alt: Bundle selector
|
||||
|
||||
Figure 15: :guilabel:`Bundle selector`
|
||||
|
||||
For a complete description of the content of these additional bundles, go to
|
||||
the `software bundle list`_ and select the name for a specific bundle to show
|
||||
the contents within the specified bundle.
|
||||
|
||||
Network configuration
|
||||
---------------------
|
||||
|
||||
The final step of the installer setup process before the actual installation
|
||||
of |CL| begins is to set up the ``Network configuration``. This menu is
|
||||
shown in figure 16 and for this guide we will select :guilabel:`< Use DHCP >`
|
||||
to have an IP address automatically assigned when the system boots up.
|
||||
|
||||
.. figure:: figures/cmi12of13.png
|
||||
:scale: 50 %
|
||||
:alt: Network configuration
|
||||
|
||||
Figure 16: :guilabel:`Network configuration`
|
||||
|
||||
You can optionally set up a static IP address for your system by selecting the
|
||||
:guilabel:`< Use static IP configuration >` menu item.
|
||||
|
||||
TODO: Add the Network configuration/Static IP Configuration menu as a
|
||||
separate link to another guide for setting this up and describe the
|
||||
fields. Here is one of the screen shots...
|
||||
|
||||
.. figure:: figures/cmi12of13static.png
|
||||
:scale: 50 %
|
||||
:alt: Network configuration
|
||||
|
||||
Figure 16a: :guilabel:`Network configuration`
|
||||
|
||||
Begin installation
|
||||
------------------
|
||||
|
||||
With all the |CL| installer setup information gathered, the |CL| Installer
|
||||
will prompt you to begin the actual installation as shown in figure 17. If
|
||||
you are satisfied with the information you have entered, select the
|
||||
:guilabel:`< Yes >` field and press ``Enter`` to begin installing |CL|.
|
||||
|
||||
.. figure:: figures/cmi13of13.png
|
||||
:scale: 50 %
|
||||
:alt: Begin installation
|
||||
|
||||
Figure 17: :guilabel:`Begin installation`
|
||||
|
||||
|CL| Installation begins...each step will show it's status as it progresses
|
||||
through each step as illustrated in figure 18
|
||||
|
||||
.. figure:: figures/cmi17.png
|
||||
:scale: 50 %
|
||||
:alt: Installation status
|
||||
|
||||
Figure 18: :guilabel:`Installation status`
|
||||
|
||||
Once all steps have completed, you will see the :guilabel:`< Ok >` prompt as
|
||||
shown in figure 19. Press the ``Enter`` key to continue.
|
||||
|
||||
.. figure:: figures/cmi18.png
|
||||
:scale: 50 %
|
||||
:alt: Installation complete
|
||||
|
||||
Figure 19: :guilabel:`Installation complete`
|
||||
|
||||
The final screen is shown in figure 20 and you will be prompted that the
|
||||
installation was successful and the system will be rebooted. Press the
|
||||
``Enter`` key and remove the USB media while the system restarts.
|
||||
|
||||
.. figure:: figures/cmi19.png
|
||||
:scale: 50 %
|
||||
:alt: Successful Installation
|
||||
|
||||
Figure 20: :guilabel:`Successful Installation`
|
||||
|
||||
With the USB device removed and the system restarted, you will be presented
|
||||
with the Gnome Desktop sign-in screen to begin using your system as shown in
|
||||
figure 21:
|
||||
|
||||
.. figure:: figures/cmi20.png
|
||||
:scale: 50 %
|
||||
:alt: Gnome sign-in screen
|
||||
|
||||
Figure 21: :guilabel:`Gnome sign-in screen`
|
||||
|
||||
Click on the :guilabel:`username` that you created earlier, enter the password
|
||||
that was also created and you will logged into the system. The Gnome 3
|
||||
desktop will appear as shown in figure 22:
|
||||
|
||||
.. figure:: figures/cmi22.png
|
||||
:scale: 50 %
|
||||
:alt: Gnome Desktop Manager
|
||||
|
||||
Figure 22: :guilabel:`Gnome Desktop Manager`
|
||||
|
||||
Next steps
|
||||
==========
|
||||
|
||||
**Congratulations!**
|
||||
|
||||
You have successfully installed |CL| on a bare metal system using the
|
||||
manual installation method.
|
||||
|
||||
Visit our :ref:`tutorials <tutorials>` page for examples on using your |CL|
|
||||
system.
|
||||
|
||||
.. _`information about stateless`:
|
||||
https://clearlinux.org/features/stateless
|
||||
|
||||
.. _`wiki page about Hostnames`:
|
||||
https://en.wikipedia.org/wiki/Hostname
|
||||
|
||||
.. _`software bundle list`:
|
||||
https://clearlinux.org/documentation/clear-linux/reference/bundles/available-bundles.html#available-bundles
|
||||
|
||||
.. _`learn more about telemetry.`:
|
||||
https://clearlinux.org/features/telemetry
|
||||
|
||||
.. _`latest kernel's command-line parameters`:
|
||||
https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html
|
||||
|
After Width: | Height: | Size: 91 KiB |
|
After Width: | Height: | Size: 123 KiB |
|
After Width: | Height: | Size: 181 KiB |
|
After Width: | Height: | Size: 94 KiB |
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 187 KiB |
|
After Width: | Height: | Size: 51 KiB |
|
After Width: | Height: | Size: 106 KiB |
|
After Width: | Height: | Size: 117 KiB |
|
After Width: | Height: | Size: 337 KiB |
|
After Width: | Height: | Size: 91 KiB |
|
After Width: | Height: | Size: 218 KiB |
|
After Width: | Height: | Size: 110 KiB |
|
After Width: | Height: | Size: 131 KiB |
|
After Width: | Height: | Size: 159 KiB |
|
After Width: | Height: | Size: 90 KiB |
|
After Width: | Height: | Size: 269 KiB |
|
After Width: | Height: | Size: 861 KiB |
|
After Width: | Height: | Size: 874 KiB |
|
After Width: | Height: | Size: 633 KiB |
|
After Width: | Height: | Size: 323 KiB |
|
After Width: | Height: | Size: 236 KiB |
|
After Width: | Height: | Size: 270 KiB |
|
After Width: | Height: | Size: 148 KiB |
|
After Width: | Height: | Size: 138 KiB |
|
After Width: | Height: | Size: 124 KiB |
|
After Width: | Height: | Size: 87 KiB |
|
After Width: | Height: | Size: 138 KiB |
|
After Width: | Height: | Size: 215 KiB |
|
After Width: | Height: | Size: 63 KiB |
|
Before Width: | Height: | Size: 1.4 MiB After Width: | Height: | Size: 1.4 MiB |