mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-09-06 22:01:34 +00:00
Merge branch 'master' into mv-kubernetes-02
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
This commit is contained in:
Michael Vincerra
+63
-18
@@ -5,8 +5,11 @@ Install |CL-ATTR| from the live desktop beta image
|
||||
|
||||
The live desktop beta image allows you to boot |CL-ATTR| into a GNOME
|
||||
desktop without modifying the host system. Using the live image, you can
|
||||
explore the possibilities of developing with |CL|. You can also launch the
|
||||
new installer and install |CL| on your target system.
|
||||
explore the possibilities of developing with |CL|.
|
||||
|
||||
You can also launch the installer to install |CL| on your target system.
|
||||
If you proceed with installation, this document assumes you follow the
|
||||
`Recommended options`_.
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 1
|
||||
@@ -32,9 +35,7 @@ Preliminary steps
|
||||
|
||||
#. Follow your OS instructions to create a bootable USB drive.
|
||||
|
||||
* :ref:`bootable-usb-linux-all`
|
||||
* :ref:`bootable-usb-mac-all`
|
||||
* :ref:`bootable-usb-windows-all`
|
||||
* :ref:`bootable-usb-beta-all`
|
||||
|
||||
Install from live image
|
||||
***********************
|
||||
@@ -86,18 +87,18 @@ Minimum installation requirements
|
||||
*********************************
|
||||
|
||||
To fulfill minimum installation requirements, complete the
|
||||
`Required options`_. `Advanced options`_ are optional.
|
||||
`Required options`_. We also encourage you to install `Recommended options`_ for a full desktop experience. `Advanced options`_ are optional.
|
||||
|
||||
.. note::
|
||||
|
||||
* The :kbd:`Install` button is only highlighted **after** you complete the
|
||||
`Required options`_, and after you enter required values in submenus.
|
||||
* The :kbd:`Install` button is **only highlighted after** you complete
|
||||
`Required options`_.
|
||||
|
||||
* You must choose whether or not to participate in :ref:`telemetrics`
|
||||
before you can finish installation.
|
||||
|
||||
* You may wish to `Test Network Settings`_ before you
|
||||
`Configure Network Interfaces`_. Assure that a ``Success`` message is received before installation.
|
||||
* You may `Test Network Settings`_ before you
|
||||
`Configure Network Interfaces`_. Assure a *Success* message appears before installation.
|
||||
|
||||
Main Menu
|
||||
*********
|
||||
@@ -242,7 +243,7 @@ Configure Media
|
||||
|
||||
#. Select :kbd:`Enter` to :kbd:`Confirm`.
|
||||
|
||||
#. Choose one partitioning method and continue below:
|
||||
#. Select one partitioning method and continue:
|
||||
|
||||
* `Auto Partition`_
|
||||
* `Add Partition`_
|
||||
@@ -455,6 +456,22 @@ For more detailed information, visit our :ref:`telemetry-about` page.
|
||||
|
||||
Figure 14: Enable Telemetry
|
||||
|
||||
Recommended options
|
||||
*******************
|
||||
|
||||
After you complete the `Required options`_, we highly recommend completing
|
||||
a few `Advanced options`_ at minimum:
|
||||
|
||||
* `Bundle Selection`_ Add basic utlities and tools:
|
||||
|
||||
* :file:`desktop-autostart`
|
||||
* :file:`user-basic`
|
||||
|
||||
* `User Manager`_ Assign a new user with administrative rights
|
||||
* `Assign Hostname`_ Simplify your development environment
|
||||
|
||||
This document assumes you follow these additional steps.
|
||||
|
||||
Skip to finish installation
|
||||
===========================
|
||||
|
||||
@@ -462,10 +479,9 @@ After selecting values for all :guilabel:`Required options`, you may skip
|
||||
to `Finish installation`_.
|
||||
|
||||
Otherwise, continue below. In the Main Menu, select
|
||||
:guilabel:`Advanced options` to configure network interfaces or proxy
|
||||
settings, add bundles, add/manage users, add kernel arguments, and more.
|
||||
:guilabel:`Advanced options` for additional configuration.
|
||||
|
||||
Advanced Options
|
||||
Advanced options
|
||||
****************
|
||||
|
||||
Configure Network Interfaces
|
||||
@@ -588,6 +604,8 @@ Bundle Selection
|
||||
|
||||
#. Select :kbd:`Spacebar` to select the checkbox for each desired bundle.
|
||||
|
||||
#. We recommend adding :file:`desktop-autostart` and :file:`user-basic`.
|
||||
|
||||
.. figure:: figures/bare-metal-install-beta-19.png
|
||||
:scale: 100%
|
||||
:alt: Bundle Selection
|
||||
@@ -815,17 +833,44 @@ Finish installation
|
||||
#. When you are satisfied with your installation configuration, navigate to
|
||||
:guilabel:`Install` and select :kbd:`Enter`.
|
||||
|
||||
#. Select :guilabel:`reboot`.
|
||||
|
||||
.. note::
|
||||
|
||||
When installation is finished, a ``reboot`` button appears.
|
||||
|
||||
#. Select ``reboot``.
|
||||
If you do not perform `Recommended options`_, upon rebooting, a
|
||||
:file:`login:` prompt will appear. At the prompt, enter `root` and change your password immediately.
|
||||
|
||||
#. When the system reboots, remove any installation media present.
|
||||
|
||||
.. note::
|
||||
|
||||
Allow time for the graphical login to appear. This shows the administrative user assigned in `Recommended options`_.
|
||||
|
||||
#. Log in as the adminstrative user.
|
||||
|
||||
#. Upon launch of the GUI, open a Terminal.
|
||||
|
||||
#. In the Terminal, log into *root* for the first time.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo -i
|
||||
|
||||
#. Enter password of administrative user to switch to root.
|
||||
|
||||
#. Enter the command to change the root password:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
passwd root
|
||||
|
||||
#. Follow onscreen instructions to create a password for root.
|
||||
|
||||
#. Enter :command:`exit` to return to the administative user.
|
||||
|
||||
**Congratulations!**
|
||||
|
||||
You have successfully installed |CL| on bare metal using the new installer.
|
||||
You have successfully installed |CL| on bare metal using the installer.
|
||||
|
||||
Next steps
|
||||
**********
|
||||
|
||||
BIN
Binary file not shown.
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 96 KiB |
@@ -6,22 +6,15 @@ Create and enable a new user space
|
||||
This section provides steps to complete the following basic setup tasks for
|
||||
a newly installed |CL-ATTR| system:
|
||||
|
||||
* Create a new user.
|
||||
* Update the OS to its most current version using `swupd`.
|
||||
* Install the most common applications for system administrators and
|
||||
developers using bundles.
|
||||
* Set up a new user and add the new user to the `wheel` group.
|
||||
* Install a GUI to test `sudo` privileges.
|
||||
|
||||
.. note::
|
||||
Log in as the root user to complete the tasks in this
|
||||
section.
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
Create a new user
|
||||
******************
|
||||
*****************
|
||||
|
||||
To create a new user and set a password for that user, enter the following
|
||||
commands as a root user:
|
||||
commands as a `root` user:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@@ -33,29 +26,8 @@ including the password for that user. The :command:`passwd` command prompts
|
||||
you to enter a new password. Retype the new password for the new user
|
||||
account just created.
|
||||
|
||||
Install and update the OS software to its current version
|
||||
*********************************************************
|
||||
|
||||
|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 `sysadmin-basic` bundle installs the vast majority of
|
||||
applications useful to a system administrator.
|
||||
Install the `sysadmin-basic` bundle:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
swupd bundle-add sysadmin-basic
|
||||
|
||||
We provide the full list of bundles and packages installed with the
|
||||
`sysadmin-basic`_ bundle. Additionally, we have listed
|
||||
`all bundles`_ for |CL|, active or deprecated. Click any bundle on the
|
||||
list to view the manifest of the bundle.
|
||||
|
||||
Set up a new user and add the new user to the `wheel` group
|
||||
***********************************************************
|
||||
Add the new user to the `wheel` group
|
||||
*************************************
|
||||
|
||||
Before logging off as root and logging into your new user account,
|
||||
enable the :command:`sudo` command for your new `<userid>`.
|
||||
@@ -73,65 +45,50 @@ To be able to execute all applications with root privileges, add the
|
||||
|
||||
To log off as root, enter :command:`exit`.
|
||||
|
||||
The command will bring you back to the `login:` prompt.
|
||||
|
||||
#. Enter the new `<userid>` and the password created earlier.
|
||||
|
||||
You will now be in the home directory of `<userid>`. The bundle
|
||||
`sysadmin-basic`_ contains the majority of applications that a system
|
||||
administrator would want, but it does not include a graphical user
|
||||
interface. The `desktop` bundle includes the GNOME\* Display Manager and
|
||||
additional supporting applications.
|
||||
You will now be in the home directory of `<userid>`.
|
||||
|
||||
Install a GUI to test `sudo` privileges
|
||||
========================================
|
||||
.. note::
|
||||
Install and update the OS software to its current version
|
||||
*********************************************************
|
||||
|
||||
If you are following this sequence after just setting up the
|
||||
pre-configured VMware\* virtual machine from the repo, you must
|
||||
:ref:`increase virtual disk size<increase-virtual-disk-size>` or the
|
||||
following step will fail.
|
||||
The |CL| software utility :ref:`swupd <swupd-guide>` allows you to perform system updates while reaping the benefits of upstream development.
|
||||
|
||||
To test the :command:`sudo` command and ensure it is set up correctly,
|
||||
install the GNOME Display Manager (gdm) and start it.
|
||||
To update your newly installed OS, run:
|
||||
|
||||
#. To install the the GNOME Display Manager using :command:`swupd`, enter
|
||||
the following command:
|
||||
.. code-block:: bash
|
||||
|
||||
.. code-block:: bash
|
||||
sudo swupd update
|
||||
|
||||
sudo swupd bundle-add desktop
|
||||
Add a bundle
|
||||
************
|
||||
|
||||
#. To start the GNOME Display Manager, enter the following command:
|
||||
Software applications are installed as bundles using the command
|
||||
:command:`swupd bundle-add`. Experienced Linux* users might compare `swupd`
|
||||
to running :command:`apt-get` or :command:`yum install` for package
|
||||
management. Yet |CL| manages packages at the level of bundles, which
|
||||
are integrated stacks of packages.
|
||||
|
||||
.. code-block:: bash
|
||||
For example, the `sysadmin-basic` bundle installs the majority of applications useful to a system administrator. To install it, enter:
|
||||
|
||||
systemctl start gdm
|
||||
.. code-block:: bash
|
||||
|
||||
#. The system prompts you to authenticate the user. Enter the password for
|
||||
`<userid>`, and the GNOME Display Manager starts as shown in Figure
|
||||
1:
|
||||
swupd bundle-add sysadmin-basic
|
||||
|
||||
.. figure:: figures/gnomedt.png
|
||||
:scale: 50 %
|
||||
:alt: Gnome Desktop
|
||||
View a full list of bundles and packages installed with the `sysadmin-basic`_ bundle. You can also view `all bundles`_ for |CL|, active or deprecated.
|
||||
|
||||
Figure 1: :guilabel:`Gnome Desktop`
|
||||
Expand your knowledge of :command:`swupd` and check out our developer resources:
|
||||
|
||||
#. To start the GNOME Display Manager each time you start your system, enter
|
||||
the following command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
systemctl enable gdm
|
||||
* :ref:`swupd-guide`
|
||||
* :ref:`developer-workstation`
|
||||
|
||||
Next steps
|
||||
***********
|
||||
**********
|
||||
|
||||
With your system now running |CL|, many opportunities exist.
|
||||
Check out our guides and tutorials.
|
||||
|
||||
Visit the :ref:`tutorials <tutorials>` page for examples on using your |CL|
|
||||
system.
|
||||
* :ref:`guides`
|
||||
* :ref:`tutorials`
|
||||
|
||||
.. _`sysadmin-basic`:
|
||||
https://github.com/clearlinux/clr-bundles/blob/master/bundles/sysadmin-basic
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
.. _kubernetes-bp:
|
||||
|
||||
Kubernetes Best Practices on |CL|
|
||||
#################################
|
||||
|
||||
Use swupd to update clusters
|
||||
****************************
|
||||
|
||||
This tutorial shows you how to manage your Kubernetes cluster while using
|
||||
:command:`swupd` to update |CL-ATTR|.
|
||||
|
||||
In our tutorial :ref:`kubernetes`, we explain how to set up a Kubernetes
|
||||
cluster on |CL| using `kubeadm`. `Kubeadm documentation`_ often builds on the
|
||||
assumption that the distribution uses a traditional package manager (e.g.,
|
||||
RPM/DEB).
|
||||
|
||||
In contrast, |CL| uses `swupd` to update the OS, which in this case updates
|
||||
all of the kubernetes node and client binaries simultaneously, as part of
|
||||
the `cloud-native-basic` bundle (e.g., kubectl, kubeadm, kubelet). Running
|
||||
:command:`sudo swupd update` requires special care to ensure the OS
|
||||
incorporates the latest Kubernetes upgrades.
|
||||
|
||||
This document describes best practices to manage cluster upgrades with
|
||||
`kubeadm` on a |CL|-based cluster.
|
||||
|
||||
Prerequisites
|
||||
*************
|
||||
|
||||
Assure that you:
|
||||
|
||||
* Completed :ref:`kubernetes`
|
||||
* Installed the bundle `cloud-native-basic`
|
||||
|
||||
.. note::
|
||||
|
||||
Other Linux\* distros shown in Kubernetes upgrade documentation reflect
|
||||
`apt-get update`, `apt-mark hold kubeadm`, and similar commands; however, such commands **are not valid** on |CL|.
|
||||
|
||||
Update the control plane
|
||||
************************
|
||||
|
||||
#. Read kubernetes documentation `before you begin`_.
|
||||
|
||||
#. On your master node, run the command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd update
|
||||
|
||||
.. note::
|
||||
|
||||
If the minor version of Kubernetes changes, |CL| shows a message-of-the-day, or `motd`. When the `motd` appears, you **must postpone** a kubelet restart on master and nodes until the control plane is properly updated. :command:`swupd update` does not restart services automatically unless explicitly configured to do so.
|
||||
|
||||
#. Now follow these instructions in kubernetes documentation.
|
||||
|
||||
* `Upgrade control plane`_
|
||||
* `Drain control plane node`_
|
||||
* `Restart Kubelet and undrain node`_
|
||||
|
||||
Update worker nodes
|
||||
*******************
|
||||
|
||||
#. On each worker node, run the command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd update
|
||||
|
||||
#. Now follow these instructions in kubernetes documentation:
|
||||
|
||||
* `Drain node`_
|
||||
* `Update kubelet configuration`_
|
||||
* `Restart Kubelet and undrain node`_
|
||||
|
||||
.. _Kubeadm documentation: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-upgrade/
|
||||
|
||||
.. _Restart Kubelet and undrain node: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#restart-the-kubelet-for-all-nodes
|
||||
|
||||
.. _Update kubelet configuration: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#upgrade-the-kubelet-config-on-worker-nodes
|
||||
|
||||
.. _Drain node: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#drain-control-plane-and-worker-nodes
|
||||
|
||||
.. _Restart kubelet and undrain node: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#restart-the-kubelet-for-all-nodes
|
||||
|
||||
.. _Upgrade control plane: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#upgrade-the-control-plane-node
|
||||
|
||||
.. _Drain control plane node: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#drain-control-plane-and-worker-nodes
|
||||
|
||||
.. _Kubeadmn documentation: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/
|
||||
|
||||
.. _before you begin: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#before-you-begin
|
||||
|
||||
+13
-2
@@ -1,7 +1,12 @@
|
||||
.. _kubernetes:
|
||||
|
||||
<<<<<<< HEAD:source/clear-linux/tutorials/kubernetes.rst
|
||||
Run Kubernetes\*
|
||||
################
|
||||
=======
|
||||
Run Kubernetes
|
||||
##############
|
||||
>>>>>>> master:source/clear-linux/tutorials/kubernetes/kubernetes.rst
|
||||
|
||||
This tutorial describes how to install, configure, and run the
|
||||
`Kubernetes container orchestration system`_ on |CL-ATTR| using CRI+O and
|
||||
@@ -240,8 +245,8 @@ Read the Kubernetes documentation to learn more about:
|
||||
|
||||
* `Joining your nodes`_
|
||||
|
||||
Package configuration customization in |CL| (optional)
|
||||
******************************************************
|
||||
Package configuration customization (optional)
|
||||
**********************************************
|
||||
|
||||
|CL| is a stateless system that looks for user-defined package configuration
|
||||
files in the :file:`/etc/<package-name>` directory to be used as default. If
|
||||
@@ -289,6 +294,12 @@ commands as a shell script to configure all of these services in one step:
|
||||
EOF
|
||||
done
|
||||
|
||||
Next steps
|
||||
**********
|
||||
|
||||
:ref:`kubernetes-bp`
|
||||
|
||||
|
||||
Troubleshooting
|
||||
***************
|
||||
|
||||
@@ -14,6 +14,7 @@ Explore our tutorials to discover what you can do with |CL|!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
wordpress/wordpress
|
||||
flatpak/flatpak
|
||||
@@ -30,6 +31,6 @@ Explore our tutorials to discover what you can do with |CL|!
|
||||
spark
|
||||
kata
|
||||
kata_migration
|
||||
kubernetes
|
||||
kubernetes/kubernetes*
|
||||
greengrass
|
||||
dlrs
|
||||
|
||||
Reference in New Issue
Block a user