clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-09-04 12:51:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Numbers steps, makes one full guide, moves re-usable section to guide.

Browse Source 
Makes an end-to-end auto bare-metal doc with a branch to manual install.
Post installation tasks separated and moved to maintenance guide.

Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
This commit is contained in:
ihutchin
2017-09-28 21:20:40 -07:00
parent f7b5b5087e
commit 487391bdac
6 changed files with 547 additions and 534 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/clear-linux/get-started/bare-metal-install/bare-metal-auto-install.rst
-253
View File
@@ -1,253 +0,0 @@
.. _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)
source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst
+234 -116
View File
@@ -41,51 +41,58 @@ Follow these steps to install |CL| on the target system:
#. Power on the system.
#. Open the system BIOS setup menu, normally by pressing the F2 key. Your
BIOS setup menu entry point may vary.
#. Open the system BIOS setup menu, normally by pressing the :kbd:`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.
#. Reboot the target system.
.. figure:: figures/cmi1.png
:scale: 50 %
:alt: |CL| boot menu
#. The |CL| Installer menu will start as shown in Figure 1.
Select :guilabel:`Clear Linux OS for Intel Architecture` and press the
:kbd:`Enter` key or wait five seconds to automatically select it.
Figure 1: :guilabel:`|CL| boot menu`
.. figure:: figures/cmi1.png
:scale: 50 %
:alt: Clear Linux 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 1: :guilabel:`Clear Linux boot menu`
.. figure:: figures/cmi2.png
:scale: 50 %
:alt: Clear Linux OS for Intel Architecture Installer
#. 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 2: :guilabel:`Clear Linux OS for Intel Architecture Installer`
.. figure:: figures/cmi2.png
:scale: 50 %
:alt: 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 2: :guilabel:`Clear Linux OS for Intel Architecture Installer`
.. figure:: figures/cmi3.png
:scale: 50 %
:alt: Keyboard Selection
Press the :kbd:`Enter` key.
Figure 3: :guilabel:`Keyboard Selection`
#. The ``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.
This will bring you to the ``Network Requirements`` menu, the 1st step of the
.. figure:: figures/cmi3.png
:scale: 50 %
:alt: Keyboard Selection
Figure 3: :guilabel:`Keyboard Selection`
For this guide we will select :guilabel:`< * us >`
for the keyboard mapping, which should already be highlighted. Press the
:kbd:`Enter` key to continue to the next menu.
Network requirements
====================
This will bring you to the ``Network Requirements`` menu, the first 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
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
@@ -94,139 +101,250 @@ a screen similar to the one shown in figure 4:
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
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 the
:guilabel:`< Set proxy configuration >` field and press :kbd:`Enter`. You will
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``
Optionally, set up a ``static IP configuration`` to your update server.
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.
The information displayed in the lower right quadrant of the screen
shows the current IP configuration for the update server where the installer
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.
If you are having difficulty establishing a connection to the update server
and you see the message ``none detected, install will fail``, you can
:kbd:`Tab` to the :guilabel:`< Refresh >` field and press :kbd:`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.
Once the connection to the |CL| udpate server is established, use the
:kbd:`Tab` key to advance to the :guilabel:`< Next >` field and press
:kbd:`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:
Choose action
=============
.. figure:: figures/cmi5.png
:scale: 50 %
:alt: Choose Action
The ``Choose Action`` menu is where you can choose to install, repair, open
a shell, or exit the installer.
#. Select the :guilabel:`Install` menu item in the ``Choose action`` menu.
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.
By choosing :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.
The :guilabel:`Repair` menu option reinstalls all software
packages that have been installed on the existing |CL| system using the
:command:`swupd` command. The :guilabel:`Repair` menu option also updates
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.
The :guilabel:`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
``Choose Action`` menu.
By selecting :guilabel:`Exit`, you will terminate the installation process
and the system will shut down.
The :guilabel:`Exit` menu option terminates the installation process
and the system will shut down.
Install Clear Linux OS
----------------------
#. You will be prompted to join the ``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 >` field to advance to the next menu item.
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:: figures/cmi3of6.png
:scale: 50 %
:alt: Stability Enhancement Program
Figure 6: :guilabel:`Stability Enhancement Program`
Figure 6: :guilabel:`Stability Enhancement Program`
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.`_
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
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
:alt: Choose installation type
Figure 7: :guilabel:`Choose installation Type`
Automatic vs. Manual installation
---------------------------------
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
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
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
* 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
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
follow the steps outlined in the :ref:`bare-metal-manual-install`. This guide
is a continuation from this point.
.. toctree::
:maxdepth: 1
bare-metal-manual-install
Automatic installation
**********************
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.
#. Move your cursor to this field and press the :kbd:`Enter` key.
#. 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.
.. figure:: figures/cai5of6.png
:scale: 50 %
:alt: Choose target device for installation
Figure 8: :guilabel:`Choose target device for installation`
In this example we select the single primary partition from our hard drive.
#. 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.
.. 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
through the automated installation process.
Complete installation process
=============================
#. 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 10: :guilabel:`Installation complete`
#. 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 11: :guilabel:`Successful Installation`
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:
.. figure:: figures/cairoot.png
:scale: 50 %
:alt: Login screen
Figure 12: :guilabel:`Login screen`
#. At the initial login prompt, enter: ``root``
#. Once you are 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.
#. 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.
**Congratulations!**
You have successfully installed |CL| on a bare metal system using the
automatic installation method.
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:
* Update the OS to its most current version using `swupd`.
* Install the most common applications for system administrators and
developers using bundles.
* Setup a new user.
* Setup `sudo` privileges for that new user.
* Install a GUI using those `sudo` privileges.
.. _`information about stateless`:
https://clearlinux.org/features/stateless
.. _`learn more about telemetry.`:
https://clearlinux.org/features/telemetry
.. _`NUC6i5SYH product page`:
http://www.intel.com/content/www/us/en/nuc/nuc-kit-nuc6i5syh.html
source/clear-linux/get-started/bare-metal-install/bare-metal-manual-install.rst
+153 -165
View File
@@ -1,67 +1,64 @@
.. _bare-metal-manual-install:
Bare Metal Manual Installation Guide
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...
This section is a continuation of steps from the :ref:`bare-metal-install`
page.
With the :guilabel:`< Manual(Advanced) >` option you can do the following
additional tasks during |CL| Installer setup:
By following this guide and selecting the :guilabel:`< Manual(Advanced) >`
menu option as seen in figure 1, you can do the following
additional tasks during the |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
* 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.
Begin the manual installation process
*************************************
.. figure:: figures/cmi7.png
:scale: 50 %
:alt: Choose installation Type
#. Move your cursor to the :guilabel:`< Manual(Advanced) >` menu item
and press the :kbd:`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:
#. This will bring you to the ``Choose partitioning method`` screen as shown
in figure 8. 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 :kbd:`Enter` to move to the next step of the installer
setup process. This is the option that we will take for this guide.
.. figure:: figures/cmi5of13.png
:scale: 50 %
:alt: Choose partitioning method
.. figure:: figures/cmi5of13.png
:scale: 50 %
:alt: Choose partitioning method
Figure 8: :guilabel:`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:
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.
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.
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 :kbd:`Enter`.
If you want to return to the previous menu, press the :kbd:`Tab` key to
highlight the :guilabel:`< Previous >` field and press :kbd:`Enter` to
return to the ``< Choose partitioning method >`` menu.
.. figure:: figures/cmi6of13.png
:scale: 50 %
@@ -69,109 +66,113 @@ the :guilabel:`< Previous >` field and press ``Enter`` to return to the
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:
#. 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. Use the :kbd:`Tab` key to highlight
the :guilabel:`< Yes >` field and press :kbd:`Enter` to proceed to the next
step if this is the device that you want to install |CL| onto.
.. figure:: figures/cmi7of13.png
:scale: 50 %
:alt: Device installation warning
.. 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.
Figure 10: :guilabel:`Device installation warning`
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.
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``.
#. 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 official
documentation of the `latest kernel's command-line parameters`_.
.. figure:: figures/cmi8of13.png
:scale: 50 %
:alt: Append to kernel cmdline
Add any additional command-line parameters in the
:guilabel:`Append to cmdline:` and then press the :kbd:`Tab` key to
highlight the :guilabel:`< Next >` and press :kbd:`Enter`.
Figure 11: :guilabel:`Append to kernel cmdline`
.. figure:: figures/cmi8of13.png
:scale: 50 %
:alt: 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 11: :guilabel:`Append to kernel cmdline`
.. figure:: figures/cmi9of13.png
:scale: 50 %
:alt: Configure Hostname
#. 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
:kbd:`Tab` key to move to the :guilabel:`< Next >` field and press
:kbd:`Enter`.
.. 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.
To learn more about hostname naming conventions and restrictions, you can
check this `wiki page about hostnames`_.
.. figure:: figures/cmi10of13.png
:scale: 50 %
:alt: User configuration
#. The ``User configuration`` menu shown in figure 13 gives you the option to
create a user with administrative privileges. Select the field
:guilabel:`< Create an administrative user >` and press :kbd:`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 13: :guilabel:`User configuration`
.. figure:: figures/cmi10of13.png
:scale: 50 %
:alt: 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 13: :guilabel:`User configuration`
.. figure:: figures/cmi10of13a.png
:scale: 50 %
:alt: User configuration - create user
#. 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 :kbd:`Tab` key
to highlight the :guilabel:`< Next >` field and press :kbd:`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.
#. 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
:kbd:`Tab` key to go to each field and pressing the :kbd:`Spacebar` or the
:kbd:`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:: figures/cmi11of13.png
:scale: 50 %
:alt: Bundle selector
Figure 15: :guilabel:`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
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 >`
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
@@ -180,26 +181,16 @@ to have an IP address automatically assigned when the system boots up.
Figure 16: :guilabel:`Network configuration`
You can optionally set up a static IP address for your system by selecting the
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|.
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 :kbd:`Enter` to begin installing |CL|.
.. figure:: figures/cmi13of13.png
:scale: 50 %
@@ -207,7 +198,7 @@ you are satisfied with the information you have entered, select the
Figure 17: :guilabel:`Begin installation`
|CL| Installation begins...each step will show it's status as it progresses
|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
@@ -216,51 +207,48 @@ through each step as illustrated in figure 18
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.
#. Once all steps have completed, you will see the :guilabel:`< Ok >` prompt as
shown in figure 19. Press the :kbd:`Enter` key to continue.
.. figure:: figures/cmi18.png
:scale: 50 %
:alt: Installation complete
.. figure:: figures/cmi18.png
:scale: 50 %
:alt: Installation complete
Figure 19: :guilabel:`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.
#. 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
:kbd:`Enter` key and remove the USB media while the system restarts.
.. figure:: figures/cmi19.png
:scale: 50 %
:alt: Successful Installation
.. figure:: figures/cmi19.png
:scale: 50 %
:alt: Successful Installation
Figure 20: :guilabel:`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:
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:: figures/cmi20.png
:scale: 50 %
:alt: Gnome sign-in screen
Figure 21: :guilabel:`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:
#. 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:: figures/cmi22.png
:scale: 50 %
:alt: Gnome Desktop Manager
Figure 22: :guilabel:`Gnome Desktop Manager`
Next steps
==========
Figure 22: :guilabel:`Gnome Desktop Manager`
**Congratulations!**
You have successfully installed |CL| on a bare metal system using the
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|
source/clear-linux/guides/maintenance/enable-user-space.rst
+159
View File
@@ -0,0 +1,159 @@
.. _enable-user-space:
Enable your new user space
##########################
This section provides steps to complete the following basic setup tasks for
a newly installed |CL| system:
* Update the OS to its most current version using `swupd`.
* Install the most common applications for system administrators and
developers using bundles.
* Setup a new user.
* Setup `sudo` privileges for that new user.
* Install a GUI using those `sudo` privileges.
Install and update software
===========================
|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`.
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.
Install the `os-clr-on-clr` bundle using the software update
utility:
.. 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.
#. Add `<userid>` to the wheel group:
.. code-block:: console
usermod -G wheel -a <userid>
#. Open the :file:`/etc/sudoers` file:
.. 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` key 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 will bring you back to the `login:` prompt.
#. Enter your new `<userid>` and the password you created earlier.
You will 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 sudo
--------------------------
To test the :command:`sudo` command and ensure it is set up correctly,
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 13:
.. figure:: figures/gnomedt.png
:scale: 50 %
:alt: Gnome Desktop
Figure 13: :guilabel:`Gnome Desktop`
#. To start the Gnome Desktop each time you start your system, enter
the following command:
.. code-block:: console
systemctl enable gdm
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.
.. _`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)
source/clear-linux/get-started/bare-metal-install/figures/gnomedt.png → source/clear-linux/guides/maintenance/figures/gnomedt.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.4 MiB

After

Width:  |  Height:  |  Size: 1.4 MiB

source/clear-linux/guides/maintenance/maintenance.rst
+1
View File
@@ -9,6 +9,7 @@ maintaining |CLOSIA| after :ref:`installation <get-started>` is completed.
.. toctree::
:maxdepth: 2
enable-user-space
update
bulk-provision
mixer