Merge of latest changes into RTD theme to enable multi-language support (#604)
* virtualbox-cl-installer: Revise figures to match VirtualBox 6.0.8 and new live-server installer. (#502) * Revises instruciton to match VirtualBox 6.0.8 and new live-desktop installer; -live.img deprecated. - Incorporates LGA and Troubleshooting from virtualbox.rst - Replaces virtualbox.rst. - Refer also to GH-493. - Closes #495 - Closes #502 - Closes #498 Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Resizes figures; reassigns Troubleshooting section from virtualbox this doc. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Adds Troubleshooting section. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Removes ununsed figures, previously from virtualbox.rst. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Re-adds prev removed CAUTION in substitutions.txt Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Revises guide per reviewer feedback. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Adds note on file size if using live-desktop install--below Fig. 6. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Incorporates reviewer feedback. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Revert to use case of live-server per reviewer feedback. - Revise all Figures - Revise all steps Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Respond to reviewers' feedback. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Revise figures; add step for VBoxSVGA; move add desktop-autostart to post-install. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Respond to reviewer feedback re clarifying post-installation steps. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Simplify steps; define context for steps; correct values in code-block. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Replaces step with note re kernel update in LGA section. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * google-cloud: New tutorial on creating Clear Linux VM on GCP (#505) * google-cloud: New tutorial on creating Clear Linux VM on GCP This tutorial documents how to create Clear Linux compute engine on Google Cloud Platform. Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com> Reviewed-by: Sethi, Puneet <puneet.sethi@intel.com> Reviewed-by: Vincerra, Michael <michael.vincerra@intel.com> * virtualbox-cl-installer: Revise figures to match VirtualBox 6.0.8 and new live-server installer. (#502) * Revises instruciton to match VirtualBox 6.0.8 and new live-desktop installer; -live.img deprecated. - Incorporates LGA and Troubleshooting from virtualbox.rst - Replaces virtualbox.rst. - Refer also to GH-493. - Closes #495 - Closes #502 - Closes #498 Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Resizes figures; reassigns Troubleshooting section from virtualbox this doc. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Adds Troubleshooting section. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Removes ununsed figures, previously from virtualbox.rst. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Re-adds prev removed CAUTION in substitutions.txt Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Revises guide per reviewer feedback. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Adds note on file size if using live-desktop install--below Fig. 6. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Incorporates reviewer feedback. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Revert to use case of live-server per reviewer feedback. - Revise all Figures - Revise all steps Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Respond to reviewers' feedback. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Revise figures; add step for VBoxSVGA; move add desktop-autostart to post-install. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Respond to reviewer feedback re clarifying post-installation steps. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Simplify steps; define context for steps; correct values in code-block. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Replaces step with note re kernel update in LGA section. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * google-cloud: New tutorial on creating Clear Linux VM on GCP This tutorial documents how to create Clear Linux compute engine on Google Cloud Platform. Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com> Reviewed-by: Sethi, Puneet <puneet.sethi@intel.com> Reviewed-by: Vincerra, Michael <michael.vincerra@intel.com> * Corrects gce filename, rst syntax for proper build and rendering. - Adds new steps to cover gaps where necessary. - Closes #504 Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Removes multi-boot tutorial; deferred until further technical review. (#526) Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Add link to quantization tools for model conversion (#529) * A bunch of improvements and proof of concept for moving tooling to top level. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Added tooling to main intro. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Moved a bunch of things around. Now at risk of not being able to merge with master. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Removed superfluous layer from documentation hiearchy and renamed master doc from clear-linux.rst to index.rst to generate a cleaner url. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Adds redis tutorial with systemctl service check, 2 example use cases (#525) * Adds redis tutorial with systemctl service check; add 2 example use cases. - Closes #519 Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Refine intro and add development examples. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Revise wording intro; add hyperlinks in Example 2. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Correct description of client libraries. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Correct spacing; add note to define syntax behavior. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Respond to reviewer's feedback. Revise wording. Add docker command. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Apply wording revisions for clarity. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Edit for squash. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Resolve build error to avoid duplicate ref's. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Replaces `swupd verify` and related flag commands per @castulo. - Closes #522 - Deprecates use of: `swupd verify` `swupd verify --fix` `swupd verify --install` `-m / --manifest` Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Revise instance where `swupd repair` is better option than `diagnose`. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Additional proposed fixes to organization for RTD site. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Incorporates feedback from @castulo on revised swupd commands. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Kubernetes doc updates (#531) * kubernetes: update CNI instructions CRI-O now supports multiple CNI binary paths and Clear Linux by default uses /usr/libexec/cni AND /opt/bin/cni so there's no need to give these instructions anymore. Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com> * kubernetes: add RuntimeClass instructions for Kata Containers Clarify how to enable Kata Containers via RuntimeClass (which is now enabled by default in Clear Linux kubernetes). Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com> * Created an RST note for mixin deprecation notice. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * * Moved kernel guides to their own section. * Restored redis tutorial that was orphaned in now nonexistent clear-linux/guides section. * Fixed includes broken by moving kernel guides Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Fixed broken :command: role. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Add statement to clarify enable/disable default status of client (#537) * Add statement to clarify enable/disable default status of client * Fix duplicate -is- and embolden opt-in * Update the telemetry concept page to reflect opt-in nature of telemetry * Add important callout regarding enable/disable telemetry * Reword important note to be stronger. * TCS review of swupd-guide (#509) * TCS review of swupd-guide Signed-off-by: MCamp859 <maryx.camp@intel.com> * Incoporated feedback. Signed-off-by: MCamp859 <maryx.camp@intel.com> * Added minor edits. Signed-off-by: MCamp859 <maryx.camp@intel.com> * Fixed bullets Signed-off-by: MCamp859 <maryx.camp@intel.com> * TCS edits in Creating CL VM on Google Cloud Platform doc (#534) * Signed-off-by: MCamp859 <maryx.camp@intel.com> TCS review of GCE guide * Incorporated feedback. Signed-off-by: MCamp859 <maryx.camp@intel.com> * KP add proxy tutorial (#514) * First commit of proxy tutorial Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * First commit of new proxy tutorial content. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Added additional content and some todo items. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Removed todo list. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Added requested proxy variables. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Updates based on peer review. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Fixed typo. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Update image types to match current offerings. (#548) * * updated image types to match current offerings * fixed broken link in ister.rst - now pointing at image-types.rst Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Updates based on peer review. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Removed deprecated cloud image. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Update KVM download script (#551) update the grep string to isolate and download the -kvm.img file * Remove non-production image types (#555) container-host-kvm.img is considered developmental and should not be shown in documentation. Want to keep list of image types in documentation oriented toward production. Signed-off-by: George T Kramer <george.t.kramer@intel.com> * Update telemetry about (#549) * Update telemetry about Remove link to the features/telemetry, it no longer exists * Update next steps Update next steps section * add backticks cut and paste zapped the backticks, restore them * Add document on CPU power and performance (#542) * Add document on CPU power and performance * Minor revisions for: - grammar - wording/spelling - formatting Signed-off-by: Kristal Dale <kristal.dale@intel.com> * Add section for kubectl to dlrs tutorial (#550) * Add section for kubectl to dlrs tutorial * Editorial clean up to Kubectl section. * Minor grammatical edits: missing punctuation and line length clean up. Signed-off-by: Kristal Dale <kristal.dale@intel.com> * Dm autospec guide editorial (#565) * Edited for syntax, spelling, trademarking, and branding. Signed-off-by: douglasm <doug.martin@intel.com> * Made editorial revisions, e.g., grammar and spelling. Signed-off-by: douglasm <doug.martin@intel.com> * changed one phrase to use active voice present tense. Reset autoproxy.rst. Signed-off-by: douglasm <doug.martin@intel.com> * Add document on debug system (#561) * Add stateless concept document (#564) * Changed ister.rst for trademarks, branding, and editorial issues. (#573) * Minor editorial revision to test multiple commits on one file. Signed-off-by: douglasm <doug.martin@intel.com> * Minor editorial revisions completes my revisions to this file. Signed-off-by: douglasm <doug.martin@intel.com> * Add a FAQ page (#547) * Add a new FAQ document * Clerical changes to faq doc Signed-off-by: MCamp859 <maryx.camp@intel.com> * Add note about AUTOINSTALL=yes in dkms.conf (#575) * Add link for launcher.py and note MKL HW reqs for DLRS tutorial. (#570) * Add link for launcher.py and note MKL HW reqs for DLRS tutorial. * Reword note about MKL, change from note to warning. Closes #560, Closes #559 * Add note specifying Kubeflow v0.4 when using launcher.py * Closes #559 , Closes #560 * Update assign static IP doc to have NM instructions (#574) * Moved new content to new structure. Added FAQ back into top level index. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * Simplified tooling label from clear-linux-tooling. Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * minor editorial changes; edits complete. (#580) Signed-off-by: DougTW <doug.martin@intel.com> * Update NVIDIA documentation to isolate install even further (#586) * Add updating section to NVIDIA doc * Isolate NVIDIA files under /opt and /etc even more Adds more parameters to avoid nvidia-installer placing files under /usr and have applications use alternative paths. * Explicitly add warning about libGL.so conflict Add a warning about the well-know libGL conflict between mesa and NVIDIA packages. * Update nvidia.rst * Add a step restart NetworkManager in static IP doc (#584) * Update assign static IP doc to have NM instructions * Add step to restart NetworkManager * Adds note to clarify BIOS behavior if installing on multiple partitions. (#582) Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Rewording revisions. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Incorporates reviewer feedback. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Editorial change. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Fix minor syntax on nvidia.rst (#594) * Minor editorial changes to swupd-guide.rst. (#591) Signed-off-by: DougTW <doug.martin@intel.com> * q * Retested QEMU-KVM doc. against latest Clear and 3rd-party distros. Updated doc. to reflect any changes. Signed-off-by: Bun K Tan <bun.k.tan@intel.com> * Added reviewer comments. Signed-off-by: MCamp859 <maryx.camp@intel.com> * Add link to terms of use in the dlrs tutorial (#596) * Added FAQ to sitemap and shortened FAQ title text to "FAQ." (#600) Closes #599 Signed-off-by: Kevin Putnam <kevin.putnam@intel.com> * mixer.rst: editorial changes (#585) * Editorial, spelling, and formatting changes only. Signed-off-by: DougTW <doug.martin@intel.com> * Fixed indentation error on mixer.rst Signed-off-by: DougTW <doug.martin@intel.com> * Add a note about running stack on other Linux distros (#598) * Add a note about running stack on other Linux distros * Add unistall instructions * Replaces telemetry figure with clr-installer 2.0.8 version, live-desktop. (#597) * Update telemetry figure per Engineering to reflect clr-installer 2.0.8. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Revise instruction to match new GUI. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Revise wording of step to match new GUI. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * Replaces telemetry figure per Engineering for clr-installer 2.0.8. (#595) Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Revises Figure 16, telemetry, to remove installer version. - Closes #590 to address non-UEFI USB entry in BIOS during install Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> Closes #590. Signed-off-by: Michael Vincerra <michael.vincerra@intel.com> * NVIDIA; Trademark, branding, and editorial changes (#601) * Minor editorial and trademark/branding changes. Signed-off-by: DougTW <doug.martin@intel.com> * Fixed file directive. Made grammatical change suggested by puneetse. Signed-off-by: DougTW <doug.martin@intel.com> * Fixed heading markup requested by mvincerx. Signed-off-by: DougTW <doug.martin@intel.com> * Corrects Step 4 command to verify integrity. (#602) Signed-off-by: MCamp859 <maryx.camp@intel.com>
@@ -0,0 +1,189 @@
|
||||
.. _faq:
|
||||
|
||||
FAQ
|
||||
###
|
||||
|
||||
Below is a list of commonly asked questions with answers sourced from the
|
||||
|CL-ATTR| team and `Clear Linux community forums`_.
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 2
|
||||
|
||||
|
||||
General
|
||||
*******
|
||||
|
||||
Why did you make another distro?
|
||||
================================
|
||||
|
||||
The |CL| team felt that performance was left on the table with Linux software.
|
||||
|CL| takes a holistic approach to improving performance across the stack. We
|
||||
also wanted to take more modern approaches with OS updates and tooling.
|
||||
|
||||
|
|
||||
|
||||
Can other distros copy |CL| improvements?
|
||||
=========================================
|
||||
|
||||
Yes, we absolutely love open source reuse and upstreaming improvements.
|
||||
|
||||
|
|
||||
|
||||
How often do you update?
|
||||
========================
|
||||
|
||||
The |CL| team puts out multiple releases a week, often releasing 2 or more
|
||||
times a day. This rolling release approach allows |CL| to remain agile to
|
||||
upstream changes and security patches.
|
||||
|
||||
|
|
||||
|
||||
Is telemetry required?
|
||||
======================
|
||||
|
||||
The telemetry solution provided by |CL| is entirely optional and customizable.
|
||||
It is disabled by default. If you do choose to enable telemetry, the data
|
||||
helps the |CL| team proactively identify and resolve bugs. See the
|
||||
:ref:`telemetry <telemetry-about>` page for more information.
|
||||
|
||||
|
|
||||
|
||||
What is the default firewall?
|
||||
=============================
|
||||
|
||||
|CL| packages :command:`iptables` as a bundle, however, there are no default
|
||||
firewall rules. All network traffic is allowed by default.
|
||||
|
||||
|
|
||||
|
||||
Where are the files that I usually see under /etc like fstab?
|
||||
=============================================================
|
||||
|
||||
|CL| has a stateless design that maintains a separation between system files
|
||||
and user files. Default values are stored under :file:`/usr/share/defaults/`.
|
||||
Files under :file:`/etc/` are not created unless you create one.
|
||||
|
||||
A blog post explaining how this is accomplished with :file:`/etc/fstab/`
|
||||
specifically is available here:
|
||||
https://clearlinux.org/news-blogs/where-etcfstab-clear-linux
|
||||
|
||||
|
|
||||
|
||||
Software packages
|
||||
*****************
|
||||
|
||||
How is software installed and updated?
|
||||
======================================
|
||||
|
||||
|CL| provides software in the form of :ref:`bundles <bundles-about>` and
|
||||
updates software with :ref:`swupd <swupd-about>`.
|
||||
|
||||
:ref:`FlatPak\* <flatpak>` is an application virtualization solution that allows
|
||||
more software to be available to |CL| users by augmenting the software |CL|
|
||||
packages natively with software available through FlatPak.
|
||||
|
||||
Our goal is to have software packaged natively and made available through
|
||||
bundles whenever possible.
|
||||
|
||||
|
|
||||
|
||||
Does |CL| use RPMs like other distros?
|
||||
======================================
|
||||
|
||||
|CL| provides software in the form of :ref:`bundles <bundles-about>`. The RPM
|
||||
format is used as an intermediary step for packaging and determining software
|
||||
dependencies at OS build time.
|
||||
|
||||
Individual RPMs can sometimes be manually installed on a |CL| system with the
|
||||
right tools, but that is not the intended use case.
|
||||
|
||||
|
|
||||
|
||||
Can I install a software package from another OS on |CL|?
|
||||
=========================================================
|
||||
|
||||
Software that is packaged in other formats for other Linux distributions is
|
||||
not guaranteed to work on |CL| and may be impacted by |CL| updates.
|
||||
|
||||
If the software you're seeking is open source, please submit a request to add
|
||||
it to |CL|. Submit requests on GitHub\* here:
|
||||
https://github.com/clearlinux/distribution/issues
|
||||
|
||||
|
|
||||
|
||||
Software availability
|
||||
*********************
|
||||
|
||||
What software is available on |CL|?
|
||||
===================================
|
||||
|
||||
Available software can be found in the `Software Store`_, through the GNOME\*
|
||||
Software application on the desktop, or by using :ref:`swupd search <bundle-commands>`.
|
||||
|
||||
|
|
||||
|
||||
Is Google\* Chrome\* available?
|
||||
===============================
|
||||
|
||||
The Google Chrome web browser is not distributed as a bundle in |CL| due to
|
||||
copyright and licensing complexities.
|
||||
|
||||
A discussion on manually installing and maintaining Google Chrome can be found
|
||||
on GitHub: https://github.com/clearlinux/distribution/issues/422
|
||||
|
||||
|
|
||||
|
||||
Is FFmpeg available?
|
||||
====================
|
||||
|
||||
`FFmpeg`_ is a multimedia software suite, which is commonly used for
|
||||
various media encoding/decoding, streaming, and playback.
|
||||
|
||||
|CL| does not distribute FFmpeg due to well-known licensing and legal
|
||||
complexities (See https://www.ffmpeg.org/legal.html and
|
||||
http://blog.pkh.me/p/13-the-ffmpeg-libav-situation.html).
|
||||
|
||||
Read more in the |CL| repository, including discussion of an alternative
|
||||
hardware-based solution:
|
||||
https://github.com/clearlinux/distribution/issues/429.
|
||||
|
||||
While |CL| cannot distribute FFmpeg, a manual solution to build and install
|
||||
FFmpeg under :file:`/usr/local` has been shared on the community forums:
|
||||
https://community.clearlinux.org/t/how-to-h264-etc-support-for-firefox-including-ffmpeg-install.
|
||||
|
||||
|
|
||||
|
||||
Is ZFS\* available?
|
||||
===================
|
||||
|
||||
ZFS is not available with |CL| because of copyright and licensing
|
||||
complexities. BTRFS is an alternative filesystem that is available in |CL|
|
||||
natively.
|
||||
|
||||
A user on GitHub notes that the ZFS kernel module can be compiled, built, and
|
||||
installed manually: https://github.com/clearlinux/distribution/issues/631
|
||||
|
||||
|
|
||||
|
||||
Can you add a driver that I need?
|
||||
=================================
|
||||
|
||||
If a kernel module is available as part of the Linux kernel source tree but
|
||||
not enabled in the |CL| kernels, in many cases the |CL| team will enable it
|
||||
upon request. Submit requests on GitHub here:
|
||||
https://github.com/clearlinux/distribution/issues
|
||||
|
||||
The |CL| team does not typically add out-of-tree kernel modules as a matter of
|
||||
practice because of the maintenance overhead. If the driver was unable to be
|
||||
merged upstream, there is a good chance we may be unable to merge it for
|
||||
similar reasons.
|
||||
|
||||
Kernel modules can be individually built and installed on |CL|. See the
|
||||
:ref:`kernel modules <kernel-modules>` page for more information.
|
||||
|
||||
|
|
||||
|
||||
|
||||
.. _`Clear Linux community forums`: https://community.clearlinux.org
|
||||
.. _`Software Store`: https://clearlinux.org/software
|
||||
.. _`FFmpeg`: https://ffmpeg.org/
|
||||
@@ -249,4 +249,9 @@ th,td {
|
||||
font-family: "IntelClear-Bold", Helvetica, Arial, sans-serif;
|
||||
margin-left: 0.67em;
|
||||
line-height: 100px;
|
||||
}
|
||||
|
||||
/*Adds a bit of spacing after the last paragraph in a bulleted list*/
|
||||
.wy-plain-list-disc li p:last-child, .rst-content .section ul li p:last-child, .rst-content .toctree-wrapper ul li p:last-child, article ul li p:last-child {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
@@ -1,48 +0,0 @@
|
||||
.. _clear-linux:
|
||||
|
||||
|CL-PRJ|
|
||||
#############################################
|
||||
|
||||
Welcome to the |CL-ATTR| documentation pages, the source for |CL| documentation.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/JFg-_5xihkE" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
|
||||
Our documentation is divided into the following sections:
|
||||
|
||||
* :ref:`get-started`
|
||||
|
||||
If you are new to |CL|, get started fast with tutorials for installing |CL| on
|
||||
bare metal, in a virtual environment, or as a live image on a USB stick.
|
||||
|
||||
* :ref:`concepts`
|
||||
|
||||
Wondering what makes |CL| different? Learn about |CL| features and what
|
||||
differentiates |CL| from other Linux distros.
|
||||
|
||||
* :ref:`guides`
|
||||
|
||||
Guides show how to complete common tasks that help you leverage |CL| native
|
||||
features effectively. From basic system configuration to advanced management
|
||||
of a cloud installation, there is a guide for you.
|
||||
|
||||
* :ref:`tutorials`
|
||||
|
||||
|CL| tutorials provide step-by-step instructions on how |CL| features can
|
||||
be used and extended, frequently with third-party tools.
|
||||
|
||||
* :ref:`reference`
|
||||
|
||||
Find the detailed information you need to enable your configuration or task
|
||||
in our |CL| reference section.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
get-started/get-started
|
||||
concepts/concepts
|
||||
guides/guides
|
||||
tutorials/tutorials
|
||||
reference/reference
|
||||
@@ -1,18 +0,0 @@
|
||||
.. _concepts:
|
||||
|
||||
Concepts
|
||||
########
|
||||
|
||||
|CL-ATTR| does things differently than other Linux distributions. Use the concepts section to learn in detail about the features that make |CL|
|
||||
different.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
swupd-about
|
||||
mixer-about
|
||||
bundles-about
|
||||
autospec-about
|
||||
restart
|
||||
security
|
||||
telemetry-about
|
||||
|
Before Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 7.7 KiB |
|
Before Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 9.8 KiB |
|
Before Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 36 KiB |
@@ -1,40 +0,0 @@
|
||||
.. _virtual-machine-install:
|
||||
|
||||
Install |CL-ATTR| in a virtual machine
|
||||
######################################
|
||||
|
||||
There are some considerations to make when installing |CL-ATTR| in a VM.
|
||||
First, you need to decide which kernel to use. This document
|
||||
will walk you through the available kernel options to help this decision. At
|
||||
the end of this document, you will be able to select the set of installation
|
||||
steps most suitable to you and install |CL| under a VM.
|
||||
|
||||
Compatible kernels
|
||||
******************
|
||||
|
||||
The |CL| provides the following Linux kernels with a respective
|
||||
:ref:`bundle <bundles-about>` for VMs. Specific use cases these bundles serve
|
||||
are provided along with links to their source code.
|
||||
|
||||
.. include:: ../../reference/compatible-kernels.rst
|
||||
:Start-after: vm-kernels:
|
||||
|
||||
Next steps
|
||||
**********
|
||||
|
||||
Now that you have read about the |CL| compatible kernels, choose the
|
||||
appropriate set of step-by-step instructions to proceed.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
kvm
|
||||
virtualbox
|
||||
vmware-esxi-install-cl
|
||||
vmware-esxi-preconfigured-cl-image
|
||||
vmw-player
|
||||
vmw-player-preconf
|
||||
hyper-v
|
||||
virtualbox-cl-installer
|
||||
../../guides/maintenance/increase-virtual-disk-size.rst
|
||||
|
||||
@@ -1,275 +0,0 @@
|
||||
.. _virtualbox-cl-installer:
|
||||
|
||||
Install |CL-ATTR| as a VirtualBox\* Virtual Machine
|
||||
###################################################
|
||||
|
||||
VirtualBox\* is a type 2 hypervisor from Oracle. This document explains how
|
||||
to create a virtual machine on the `VirtualBox hypervisor`_ with |CL-ATTR|
|
||||
as the guest operating system.
|
||||
|
||||
These instructions make use of the |CL| installer to create a brand new |CL|
|
||||
installation. A preinstalled disk image is also available to get started
|
||||
with |CL| faster. See: :ref:`virtualbox`
|
||||
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 2
|
||||
|
||||
|
||||
.. include:: virtualbox.rst
|
||||
:start-after: vbox-prereqs-begin:
|
||||
:end-before: vbox-prereqs-end:
|
||||
|
||||
|
||||
|
||||
Download and extract the |CL| installer ISO image
|
||||
*************************************************
|
||||
|
||||
The appropriate |CL| installer image needs to be downloaded and extracted.
|
||||
|
||||
.. note::
|
||||
The :file:`installer.iso` is for limited use on special cases where ISO
|
||||
image format is required, such as |VB|. The preferred installer for |CL|
|
||||
for UEFI systems is the :file:`-installer.img`.
|
||||
|
||||
#. Download the **installer ISO** image (:file:`clear-<VERSION>-installer.iso.xz`) of
|
||||
|CL|. On the `downloads page`_, this is listed as
|
||||
**Clear Linux OS for Virtual Provisioning**.
|
||||
|
||||
|
||||
You can also use this command to download from a terminal:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep installer.iso)
|
||||
|
||||
#. Validate the integrity of the downloaded image by checking the file hash
|
||||
and signatures. Refer to the document on :ref:`validate-signatures` for
|
||||
detailed steps.
|
||||
|
||||
#. Decompress the downloaded image. Uncompressed image size is ~ **5GB**.
|
||||
|
||||
- On Windows you can use `7zip`_ to extract the file by right-clicking the
|
||||
file to *Extract Here* (in the same directory)
|
||||
|
||||
.. image:: ./figures/vbox/vbox-extract-cl-ISO.png
|
||||
:alt: 7zip extract here command
|
||||
|
||||
- On Linux :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
xz -d clear-<VERSION>-installer.iso.xz
|
||||
|
||||
|
||||
|
||||
|
||||
#. The originally downloaded compressed archive file
|
||||
(:file:`clear-<VERSION>-installer.iso.xz`) can now be deleted.
|
||||
|
||||
|
||||
Create a new |VB| virtual machine
|
||||
*********************************
|
||||
|
||||
A new :abbr:`VM (Virtual Machine)` needs to be created in |VBM| for |CL| to be installed onto.
|
||||
|
||||
General instructions for creating a virtual machine and details about using
|
||||
different settings are available on the
|
||||
`VirtualBox manual section on Creating a VM`_.
|
||||
|
||||
|
||||
#. Launch the |VBM| from your host system.
|
||||
|
||||
|
||||
#. Click the *New* button to create a new VM.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-new-vm.png
|
||||
:alt: Create a new VM in VirtualBox
|
||||
|
||||
|
||||
#. A *Create Virtual Machine* window will appear.
|
||||
Select the following settings:
|
||||
|
||||
- Type: **Linux**
|
||||
- Version: **Linux 2.6 / 3.x / 4.x (64-bit)**
|
||||
- Memory size: **1024 MB** (this can be adjusted appropriately)
|
||||
- Hard disk: **Create a virtual hard disk now**
|
||||
|
||||
.. image:: ./figures/vbox/vbox-create-vm-new-disk.png
|
||||
:alt: Create a new VM in VirtualBox with a new disk
|
||||
|
||||
|
||||
#. Click the *Create* button.
|
||||
|
||||
#. A *Create Virtual Hard Disk* window will appear.
|
||||
Select the following settings:
|
||||
|
||||
- File size: **8.00 GB** (this can be adjusted appropriately)
|
||||
|
||||
- Hard disk file type: **VDI (Virtual Box Disk Image)**
|
||||
|
||||
- Storage on physical hard disk: **Dynamically allocated**
|
||||
|
||||
.. image:: ./figures/vbox/vbox-create-disk.png
|
||||
:alt: Create a new virtual hard disk in VirtualBox
|
||||
|
||||
#. Click the *Create* button.
|
||||
|
||||
#. A new virtual machine will be created and appear in the |VBM|. Click
|
||||
*Settings* to configure the |CL| VM.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-vm-created.png
|
||||
:alt: A VM selected in VirtualBox Manager
|
||||
|
||||
#. A *VM - Settings* window will appear. Navigate to the *System* pane from
|
||||
the left-hand and select the following setting:
|
||||
|
||||
- **Enable I/O APIC**
|
||||
- **Enable EFI (special OSes only)**
|
||||
|
||||
|
||||
.. image:: ./figures/vbox/vbox-vm-settings-EFI.png
|
||||
:alt: Enable EFI on a VirtualBox VM settings
|
||||
|
||||
.. note::
|
||||
By default, only 1 virtual CPU is allocated to the new VM. Consider
|
||||
increasing the number of virtual processors allocated to the virtual
|
||||
machine under Settings --> System --> Processor for increased
|
||||
performance.
|
||||
|
||||
|
||||
Install |CL| on the |VB| VM
|
||||
***************************
|
||||
|
||||
|CL| is ready to be installed.
|
||||
|
||||
|
||||
Mount the installation ISO
|
||||
==========================
|
||||
At this point, the newly created VM has a blank virtual hard disk with no
|
||||
operating system.The |CL| installer ISO needs to be mounted as a virtual
|
||||
CD-ROM on the VM before powering the VM on.
|
||||
|
||||
#. From the *VM - Settings* window, navigate to the *Storage* pane from the
|
||||
left-hand side.
|
||||
|
||||
#. From the middle *Storage Devices* column, click the blue CD disk labeled
|
||||
*Empty* under the *Controller: IDE* from.
|
||||
|
||||
#. From the right-hand *Attributes* column, click the blue CD disk next to
|
||||
the *Optical Drive* drop down menu and click *Choose Virtual Optical
|
||||
Disk File...*
|
||||
|
||||
.. image:: ./figures/vbox/vbox-vm-settings-mount-ISO.png
|
||||
:alt: Mounting an ISO in VirtualBox VM Settings
|
||||
|
||||
#. A *choose a virtual optical disk file* browser window will appear.
|
||||
Navigate to the extracted ISO file, select it, and click *Open*.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-vm-settings-browse-ISO.png
|
||||
:alt: Mounting an ISO in VirtualBox VM Settings
|
||||
|
||||
#. Click *OK* to exit the *VM Settings* menu and return to the main
|
||||
|VBM|.
|
||||
|
||||
|
||||
|
||||
Install |CL| using the installer
|
||||
================================
|
||||
|
||||
#. Start the VM from the |VBM| by selecting the |CL| VM and
|
||||
clicking *Start*
|
||||
|
||||
.. image:: ./figures/vbox/vbox-start-vm.png
|
||||
:alt: Starting a VirtualBox VM
|
||||
|
||||
#. A new window of the VM console will appear and boot into the |CL|
|
||||
installer. Follow the steps in :ref:`bare-metal-install-desktop` to
|
||||
install |CL| onto the VM virtual disk.
|
||||
|
||||
.. note::
|
||||
Do not choose a different kernel from the installer. **kernel-lts**, the
|
||||
Long Term Support (LTS) kernel is required for |VB| driver compatibility.
|
||||
|
||||
|
||||
#. After |CL| installation is complete, the VM will reboot and return to the
|
||||
|CL| installer.
|
||||
|
||||
.. note::
|
||||
To release the mouse cursor from the VM console window, press the right Ctrl key on the keyboard.
|
||||
|
||||
|
||||
Unmount the installation ISO
|
||||
============================
|
||||
|
||||
The |CL| installer ISO needs to be unmounted to allow the VM to boot from the
|
||||
virtual hard disk, which |CL| has been installed to.
|
||||
|
||||
|
||||
#. Power off the |CL| VM.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-shutdown-vm.png
|
||||
:alt: Powering off a VirtualBox VM
|
||||
|
||||
#. Click *Settings* to configure the |CL| VM.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-vm-created.png
|
||||
:alt: A VM selected in VirtualBox Manager
|
||||
|
||||
#. From the *VM - Settings* window, navigate to the *Storage* pane from the
|
||||
left-hand side.
|
||||
|
||||
#. From the middle *Storage Devices* column, click the blue CD disk labeled
|
||||
*clear-<VERSION>-installer.iso* under the *Controller: IDE* from.
|
||||
|
||||
#. From the right-hand *Attributes* column, click the blue CD disk next to
|
||||
the *Optical Drive* drop down menu and click *Remove Disk from Virtual
|
||||
Drive*
|
||||
|
||||
.. image:: ./figures/vbox/vbox-vm-settings-unmount-ISO.png
|
||||
:alt: Unmounting an ISO in VirtualBox VM Settings
|
||||
|
||||
#. Click *OK* to exit the *VM Settings* menu and return to the main
|
||||
|VBM|.
|
||||
|
||||
|
||||
|
||||
|
||||
.. include:: virtualbox.rst
|
||||
:start-after: vbox-start-vm-and-lga-begin:
|
||||
:end-before: vbox-start-vm-and-lga-end:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
.. include:: virtualbox.rst
|
||||
:start-after: vbox-troubleshooting-begin:
|
||||
:end-before: vbox-troubleshooting-end
|
||||
|
||||
|
||||
|
||||
|
||||
.. |VB| replace:: VirtualBox
|
||||
.. |VBM| replace:: VirtualBox Manager
|
||||
|
||||
|
||||
.. _appropriate instructions: https://www.virtualbox.org/manual/ch02.html
|
||||
|
||||
.. _official VirtualBox website: https://www.virtualbox.org/wiki/Downloads
|
||||
|
||||
.. _VirtualBox hypervisor: https://www.virtualbox.org/
|
||||
|
||||
.. _downloads page: https://clearlinux.org/downloads
|
||||
|
||||
.. _`VirtualBox manual section on Creating a VM`: https://www.virtualbox.org/manual/UserManual.html#gui-createvm
|
||||
|
||||
.. _`VirtualBox manual section on Running a VM`: https://www.virtualbox.org/manual/ch01.html#intro-starting-vm-first-time
|
||||
|
||||
.. _`Virtual Media Manager`: https://www.virtualbox.org/manual/ch05.html#vdis
|
||||
|
||||
.. _7zip: http://www.7-zip.org/
|
||||
|
||||
.. _Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
|
||||
|
||||
.. _`VirtualBox manual section on VBoxManage`: https://www.virtualbox.org/manual/ch08.html#vboxmanage-convertfromraw
|
||||
@@ -1,368 +0,0 @@
|
||||
.. _virtualbox:
|
||||
|
||||
Run pre-configured |CL-ATTR| as a VirtualBox\* Virtual Machine
|
||||
##############################################################
|
||||
|
||||
VirtualBox\* is a type 2 hypervisor from Oracle. This document explains how
|
||||
to create a virtual machine on the `VirtualBox hypervisor`_ with |CL-ATTR|
|
||||
as the guest operating system.
|
||||
|
||||
These instructions make use of a preinstalled |CL| disk image to setup a |CL|
|
||||
virtual machine without manual installation. |CL| can also be installed from
|
||||
scratch on a |VB| using the |CL| installed.
|
||||
See: :ref:`virtualbox-cl-installer`
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 2
|
||||
|
||||
|
||||
|
||||
.. _vbox-prereqs-begin:
|
||||
|
||||
Prerequisites
|
||||
*************
|
||||
|
||||
Before continuing make sure that you have:
|
||||
|
||||
#. Enabled virtualization, such as Intel®
|
||||
`Virtualization Technology`_ (Intel® VT), on the host system from
|
||||
EFI/BIOS.
|
||||
|
||||
#. Downloaded and installed |VB| **version 6.0 or greater** from
|
||||
the `official VirtualBox website`_ per the `appropriate instructions`_
|
||||
for your platform.
|
||||
|
||||
.. _vbox-prereqs-end:
|
||||
|
||||
|
||||
|
||||
Download and extract |CL|
|
||||
*************************
|
||||
|
||||
The |CL| live image needs to be downloaded and extracted. The live image will
|
||||
be used to created a |VB| virtual disk image that can be used with a
|
||||
:abbr:`VM (Virtual Machine)`.
|
||||
|
||||
#. Download the **live image** (:file:`clear-<VERSION-live.img.xz`) of
|
||||
|CL|. On the `downloads page`_, this is listed as
|
||||
**Clear Linux OS live boot image**.
|
||||
|
||||
|
||||
You can also use this command to download from a terminal:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep live.img)
|
||||
|
||||
#. Validate the integrity of the downloaded image by checking the file hash
|
||||
and signatures. Refer to the document on :ref:`validate-signatures` for
|
||||
detailed steps.
|
||||
|
||||
#. Decompress the downloaded image. Uncompressed image size is ~ **5GB**.
|
||||
|
||||
- On Windows you can use `7zip`_ to extract the file by right-clicking the
|
||||
file and selecting *Extract Here* (in the same directory)
|
||||
|
||||
.. image:: ./figures/vbox/vbox-extract-cl-IMG.png
|
||||
:alt: 7zip extract here command
|
||||
|
||||
- On Linux :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
xz -d clear-<VERSION>-live.img.xz
|
||||
|
||||
#. There originally downloaded compressed archive file
|
||||
(:file:`clear-<VERSION>-live.img.xz`) can now be deleted.
|
||||
|
||||
|
||||
|
||||
Convert |CL| live image to a |VB| Disk Image
|
||||
********************************************
|
||||
|
||||
The |CL| live image is in a RAW disk image. The live image needs to be
|
||||
converted to a :abbr:`VDI (VirtualBox Disk Image)` format which |VB|
|
||||
can utilize.
|
||||
|
||||
#. Launch a terminal and navigate to the directory containing the
|
||||
extracted live image.
|
||||
|
||||
|
||||
#. Convert RAW live image to a :abbr:`VDI (VirtualBox Disk Image)`
|
||||
format using the command-line VirtualBox Disk Utility.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
VBoxManage convertfromraw clear-<VERSION>-live.img clear-VM.vdi --format VDI
|
||||
|
||||
.. note::
|
||||
The :command:`PATH` environment variable may need to be updated to make the
|
||||
:command:`VBoxManage` command easily accessible from the terminal.
|
||||
For example, using Windows PowerShell:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$env:PATH += ";C:\Program Files\Oracle\VirtualBox"
|
||||
|
||||
|
||||
.. image:: ./figures/vbox/vbox-convert-raw-to-VDI.png
|
||||
:alt: Convert image in Windows command prompt
|
||||
|
||||
For more information on the :command:`VBoxManage` command,
|
||||
see the `VirtualBox manual section on VBoxManage`_.
|
||||
|
||||
|
||||
#. The originally extracted live image file
|
||||
(:file:`clear-<VERSION>-live.img`) can now be deleted.
|
||||
|
||||
|
||||
#. Move the converted :file:`clear-VM.vdi` disk image file to a permanent
|
||||
location. The VDI will be attached to the |VB| VM and should not be
|
||||
deleted.
|
||||
|
||||
|
||||
|
||||
Create a new |VB| virtual machine
|
||||
*********************************
|
||||
|
||||
A new VM needs to be created in |VBM| to attach the VDI with |CL| installed.
|
||||
|
||||
General instructions for creating a virtual machine and details about using
|
||||
different settings are available on the
|
||||
`VirtualBox manual section on Creating a VM`_.
|
||||
|
||||
|
||||
#. Launch the |VBM| from your host system.
|
||||
|
||||
|
||||
#. Click the *New* button to create a new VM.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-new-vm.png
|
||||
:alt: Create a new VM in VirtualBox
|
||||
|
||||
|
||||
#. A *Create Virtual Machine* window will appear.
|
||||
Select the following settings:
|
||||
|
||||
- Type: **Linux**
|
||||
- Version: **Linux 2.6 / 3.x / 4.x (64-bit)**
|
||||
- Memory size: **1024 MB** (this can be adjusted appropriately)
|
||||
- Hard disk: **Use an existing virtual hard disk file**
|
||||
|
||||
Click the folder icon next to the drop down menu:
|
||||
|
||||
.. image:: ./figures/vbox/vbox-create-vm-existing-disk.png
|
||||
:alt: Create a new VM in VirtualBox with an existing disk
|
||||
|
||||
|
||||
#. A new window will appear for choosing an existing disk. Click the *Add*
|
||||
button, browse to the saved VDI file, and click *Choose*.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-create-vm-choose-disk.png
|
||||
:alt: Create a new VM in VirtualBox with an existing disk
|
||||
|
||||
#. Click the *Create* button.
|
||||
|
||||
|
||||
#. A new virtual machine will be created and appear in the |VBM|. Click
|
||||
*Settings* to configure the |CL| VM.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-vm-created.png
|
||||
:alt: A VM selected in VirtualBox Manager
|
||||
|
||||
#. A *VM - Settings* window will appear. Navigate to the *System* pane from
|
||||
the left-hand and select the following setting:
|
||||
|
||||
- **Enable I/O APIC**
|
||||
- **Enable EFI (special OSes only)**
|
||||
|
||||
|
||||
.. image:: ./figures/vbox/vbox-vm-settings-EFI.png
|
||||
:alt: Enable EFI on a VirtualBox VM settings
|
||||
|
||||
|
||||
|
||||
.. note::
|
||||
By default, only 1 virtual CPU is allocated to the new VM. Consider
|
||||
increasing the number of virtual processors allocated to the virtual
|
||||
machine under Settings --> System --> Processor for increased
|
||||
performance.
|
||||
|
||||
.. _vbox-start-vm-and-lga-begin:
|
||||
|
||||
Start the |CL| VM
|
||||
*****************
|
||||
|
||||
The |CL| VM can now be powered on and setup.
|
||||
|
||||
General instructions for using a |VB| virtual machine are available on the
|
||||
`VirtualBox manual section on Running a VM`_.
|
||||
|
||||
#. Start the VM from the |VBM| by selecting the |CL| VM and clicking *Start*
|
||||
|
||||
.. image:: ./figures/vbox/vbox-start-vm.png
|
||||
:alt: Starting a VirtualBox VM
|
||||
|
||||
#. |CL| will boot and prompt for login.
|
||||
|
||||
- Enter **root** for the username.
|
||||
|
||||
#. You will be immediately prompted to set a new password for the **root**
|
||||
user. Reference :ref:`security` for more information about |CL| security
|
||||
concepts.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-cl-first-login.png
|
||||
:alt: Initial login to Clear Linux OS on a VirtualBox VM
|
||||
|
||||
|
||||
|
||||
Install |VB| Linux Guest Additions
|
||||
==================================
|
||||
|
||||
The |VB| Linux Guest Additions provide drivers for full compatibility and
|
||||
functionality.
|
||||
|
||||
|CL| provides |VB| guest drivers and an install script in the **kernel-lts**
|
||||
(Long Term Support) bundle by |CL|.
|
||||
|
||||
|
||||
#. Validate the installed kernel is **kernel-lts** by checking the output
|
||||
of the :command:`uname -r` command. It should end in **.lts**.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
uname -r
|
||||
4.<VERSION>.lts
|
||||
|
||||
If the running kernel is not **lts**: install the LTS kernel manually,
|
||||
update the bootloader, and check again:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
swupd bundle-add kernel-lts
|
||||
clr-boot-manager set-kernel $(basename $(realpath /usr/lib/kernel/default-lts))
|
||||
clr-boot-manager update
|
||||
reboot
|
||||
|
||||
#. Remove any kernel bundles that are not *kernel-lts* or *kernel-install*
|
||||
to simplify and avoid conflicts:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
swupd bundle-list | grep kernel
|
||||
swupd bundle-remove <NON-LTS-KERNEL>
|
||||
|
||||
.. image:: ./figures/vbox/vbox-cl-remove-non-lts-kernels.png
|
||||
:alt: Initial login to Clear Linux OS on a VirtualBox VM
|
||||
|
||||
#. From the VM Console window, click *Devices* on the top menu bar, and
|
||||
select *Insert Guest Additions CD image...* to mount the |VB| driver
|
||||
installation to the |CL| VM.
|
||||
|
||||
.. image:: ./figures/vbox/vbox-vm-insert-ga-cd.png
|
||||
:alt: VirtualBox CD
|
||||
|
||||
.. note::
|
||||
To release the mouse cursor from the VM console window, press the right Ctrl key on the keyboard.
|
||||
|
||||
|
||||
#. |CL| provides a script called :command:`install-vbox-lga` to help patch
|
||||
and install |VB| drivers for |CL|. Inside |CL| VM run this command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
install-vbox-lga
|
||||
|
||||
#. After the script completes successfully, reboot the |CL| VM.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
reboot
|
||||
|
||||
#. After the VM reboot, login and verify the |VB| drivers are loaded:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
lsmod | grep ^vbox
|
||||
|
||||
You should see drivers loaded with names beginning with **vbox**: (vboxguest, vboxsf, vboxvideo).
|
||||
|
||||
|
||||
The |CL| VM running on |VB| is ready to be used.
|
||||
|
||||
.. _vbox-start-vm-and-lga-end:
|
||||
|
||||
.. _vbox-troubleshooting-begin:
|
||||
|
||||
Troubleshooting
|
||||
***************
|
||||
|
||||
#. **Problem:** Out of disk space inside of |CL| and not be able to install
|
||||
additional bundles.
|
||||
|
||||
**Solution:** The |CL| images are small to minimize download time and
|
||||
initial disk space .
|
||||
|
||||
Power off the VM and resize the virtual disk for the |CL| VM using the |VB|
|
||||
`Virtual Media Manager`_ found under the File menu. Afterwards, power the
|
||||
|CL| VM on and follow the instructions here to have |CL| detect the resized
|
||||
disk. :ref:`increase-virtual-disk-size`
|
||||
|
||||
#. **Problem:** On a Microsoft Windows OS, |VB| encounters an error when
|
||||
trying to start a VM indicating *VT-X/AMD-v hardware acceleration is not
|
||||
available on your system.*
|
||||
|
||||
|
||||
.. image:: ./figures/vbox/vbox-no-vtx.png
|
||||
:alt: VirtualBox hardware acceleration error
|
||||
|
||||
|
||||
**Solution:** First, double check the `Prerequisites`_ section to make sure
|
||||
*Hardware accelerated virtualization* extensions have been enabled in the
|
||||
host system's EFI/BIOS.
|
||||
|
||||
*Hardware accelerated virtualization*, may get disabled for |VB| when another
|
||||
hypervisor, such as *Hyper-V* is enabled.
|
||||
|
||||
To disable *Hyper-V* execute this command in an
|
||||
**Administrator: Command Prompt or Powershell**, and reboot the system:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bcdedit /set {current} hypervisorlaunchtype off
|
||||
|
||||
|
||||
To enable Hyper-V again, execute this command in an
|
||||
**Administrator: Command Prompt or Powershell**, and reboot the system:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bcdedit /set {current} hypervisorlaunchtype Auto
|
||||
|
||||
.. _vbox-troubleshooting-end:
|
||||
|
||||
|
||||
|
||||
|
||||
.. |VB| replace:: VirtualBox
|
||||
.. |VBM| replace:: VirtualBox Manager
|
||||
|
||||
.. _appropriate instructions: https://www.virtualbox.org/manual/ch02.html
|
||||
|
||||
.. _official VirtualBox website: https://www.virtualbox.org/wiki/Downloads
|
||||
|
||||
.. _VirtualBox hypervisor: https://www.virtualbox.org/
|
||||
|
||||
.. _downloads page: https://clearlinux.org/downloads
|
||||
|
||||
.. _`VirtualBox manual section on Creating a VM`: https://www.virtualbox.org/manual/UserManual.html#gui-createvm
|
||||
|
||||
.. _`VirtualBox manual section on Running a VM`: https://www.virtualbox.org/manual/ch01.html#intro-starting-vm-first-time
|
||||
|
||||
.. _`Virtual Media Manager`: https://www.virtualbox.org/manual/ch05.html#vdis
|
||||
|
||||
.. _7zip: http://www.7-zip.org/
|
||||
|
||||
.. _Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
|
||||
|
||||
.. _`VirtualBox manual section on VBoxManage`: https://www.virtualbox.org/manual/ch08.html#vboxmanage-convertfromraw
|
||||
@@ -1,71 +0,0 @@
|
||||
.. _assign-static-ip:
|
||||
|
||||
Assign a static IP address to a network interface
|
||||
#################################################
|
||||
|
||||
Introduction
|
||||
************
|
||||
|
||||
By default, your |CL-ATTR| system automatically gets an IP address from your
|
||||
network via DHCP. If you do not have a DHCP server on your network or simply
|
||||
want to use a static IP address, follow the steps in this guide.
|
||||
|
||||
Process
|
||||
*******
|
||||
|
||||
#. Create this directory structure:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo mkdir -p /etc/systemd/network
|
||||
|
||||
#. Identify the interface to be assigned the static IP address:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
ip addr
|
||||
|
||||
The system returns the following:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
|
||||
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
|
||||
inet 127.0.0.1/8 scope host lo
|
||||
valid_lft forever preferred_lft forever
|
||||
inet6 ::1/128 scope host
|
||||
valid_lft forever preferred_lft forever
|
||||
|
||||
2: wlp1s0: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc mq state DOWN group default qlen 1000
|
||||
link/ether 4a:98:8d:e5:43:15 brd ff:ff:ff:ff:ff:ff
|
||||
|
||||
3: eno1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc fq state UP group default qlen 1000
|
||||
link/ether f4:4d:30:68:96:20 brd ff:ff:ff:ff:ff:ff
|
||||
inet 10.0.1.2/24 brd 10.54.74.255 scope global dynamic eno1
|
||||
valid_lft 6766sec preferred_lft 6766sec
|
||||
inet6 fe80::f64d:30ff:fe68:9620/64 scope link
|
||||
valid_lft forever preferred_lft forever
|
||||
|
||||
In this example, we will use the `eno1` interface.
|
||||
|
||||
#. Create the :file:`70-static.network` file and add the following:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo $EDITOR /etc/systemd/network/70-static.network
|
||||
|
||||
[Match]
|
||||
Name=[interface name]
|
||||
[Network]
|
||||
Address=[IP address]/24
|
||||
DHCP=yes # to get DNS info, etc.
|
||||
|
||||
Replace [interface name] and [IP address] with your specific settings.
|
||||
|
||||
#. Restart the networkd service:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo systemctl restart systemd-networkd
|
||||
|
||||
**Congratulations!** You have successfully assigned a static IP address.
|
||||
@@ -1,355 +0,0 @@
|
||||
.. _swupd-guide:
|
||||
|
||||
swupd
|
||||
#####
|
||||
|
||||
:command:`swupd` links a |CL-ATTR| installation with upstream updates and
|
||||
software.
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 2
|
||||
|
||||
Description
|
||||
***********
|
||||
|
||||
:command:`swupd` has two main functions:
|
||||
|
||||
#. It manages software replacing APT or YUM, installing bundles
|
||||
rather than packages.
|
||||
#. It checks for system updates and installs them.
|
||||
|
||||
:ref:`Bundles <bundles>` are the smallest granularity component that is
|
||||
managed by |CL| and contain everything needed to deliver a software
|
||||
capability. Rather than downloading a cascade of package dependencies when
|
||||
installing a piece of software, a bundle comes with all of its dependencies.
|
||||
:command:`swupd` manages overlapping dependencies behind the scenes ensuring
|
||||
that all software is compatible across the system.
|
||||
|
||||
Versioning
|
||||
==========
|
||||
|
||||
In a traditional distribution, the process of describing current software
|
||||
versioning usually involves:
|
||||
|
||||
- Listing and keeping track of the current OS release (generally
|
||||
uninformative about any singular packages or functionality).
|
||||
|
||||
- Keeping track of packages and repositories being used, and updating them
|
||||
individually.
|
||||
|
||||
- Listing and tracking every package available and installed on the
|
||||
system, none of which are directly tied to the current OS release.
|
||||
|
||||
This can be done effectively, but given the nearly endless combinations of
|
||||
packages and versions of packages a server may have, it quickly becomes
|
||||
non-trivial to define what "version" the system is and what software it
|
||||
is running without explicitly going through each system and inspecting
|
||||
every package.
|
||||
|
||||
With |CL|, we need track:
|
||||
|
||||
- One number
|
||||
|
||||
A number representing the **current** release of the OS is sufficient to
|
||||
describe the versions of all the software on the OS. Each build is
|
||||
composed of a specific set of bundles made from a particular version of
|
||||
packages. This matters on a daily basis to system administrators, who
|
||||
need to determine which of their systems do not have the latest security
|
||||
fixes, or which combinations of software have been tested. Every release
|
||||
of the same number is guaranteed to contain the same versions of software,
|
||||
so there's no ambiguity between two systems running the same version of |CL|.
|
||||
|
||||
Updating
|
||||
========
|
||||
|
||||
|CL| enforces regular updating of the OS by default and will automatically
|
||||
check for updates against a version server. The content server provides the
|
||||
file and metadata content for all versions and can be the same as the
|
||||
version server. The content url server provides metadata in the form of
|
||||
manifests. These Manifest files list and describe file contents, symlinks,
|
||||
and directories. Additionally, the actual content is
|
||||
provided to clients in the form of archive files.
|
||||
|
||||
Software updates with |CL| are also efficient. Unlike package-based
|
||||
distributions, :command:`swupd` only updates files that have changed rather
|
||||
than entire packages. For example, it is quite common for an OS security
|
||||
patch to be as small as 15 KB. Using binary deltas, the |CL| is able to
|
||||
apply only what is needed.
|
||||
|
||||
To get a more detailed understanding of how to generate update content for
|
||||
|CL| see the :ref:`mixer <mixer>` tool.
|
||||
|
||||
How it works
|
||||
************
|
||||
|
||||
Prerequisites
|
||||
=============
|
||||
|
||||
* The device is on a well-connected network.
|
||||
* The device is able to connect to an update server. The default server is:
|
||||
http://update.clearlinux.org
|
||||
|
||||
Updates
|
||||
=======
|
||||
|
||||
|CL| updates are automatic by default but can be set to occur only on
|
||||
demand. :command:`swupd` makes sure that regular updates are simple and
|
||||
secure. It can also check the validity of currently installed files and
|
||||
software and correct any problems.
|
||||
|
||||
Manifests
|
||||
---------
|
||||
|
||||
The Clear Linux OS software update content consists of data and
|
||||
metadata. The data is the files that end up in the OS. The metadata
|
||||
contains relevant information to properly provision the data to the OS
|
||||
file system, as well as update the system and add or remove additional
|
||||
content to the OS.
|
||||
|
||||
The Manifests are mostly long lists of hashes that describe content.
|
||||
Each bundle gets its own manifest file. There is a master manifest
|
||||
file that describes all manifests to tie it all together.
|
||||
|
||||
Fullfiles, packs, and delta packs
|
||||
---------------------------------
|
||||
|
||||
The data that an update provisions to a system can be obtained in
|
||||
three different ways. There are three different methods, and they
|
||||
exist to optimize the delivery of content and speed up updates.
|
||||
|
||||
Fullfiles are always generated for every file in every release. This
|
||||
allows any Clear Linux OS to obtain the exact copy of the content
|
||||
for each version directly. This would be used if the OS verification
|
||||
needed to replace a single file, for instance.
|
||||
|
||||
Packs are available for some releases and combine many files to speed
|
||||
up the creation of installation media and large updates. Delta packs
|
||||
are an optimized version of packs that only contain updates (binary
|
||||
diffs) and cannot be used without having the original file content.
|
||||
|
||||
Bundle Search
|
||||
=============
|
||||
|
||||
:command:`swupd` search downloads manifest data and searches for
|
||||
bundles that match the term. Enter only one term, or hyphenated term, per
|
||||
search. Use the command :command:`man swupd` to learn more.
|
||||
|
||||
Only the base bundle is returned. Bundles can contain other bundles via
|
||||
includes. For more details, see `Bundle Definition Files`_ and its
|
||||
subdirectory bundles.
|
||||
|
||||
Bundles that are already installed, will be marked [installed] in search
|
||||
results.
|
||||
|
||||
Optionally, you can review our `bundles`_ on GitHub.
|
||||
|
||||
Examples
|
||||
********
|
||||
|
||||
Example 1: Disable and Enable automatic updates
|
||||
===============================================
|
||||
|
||||
|CL| updates are automatic by default but can be set to occur only
|
||||
on demand.
|
||||
|
||||
#. First verify your current auto-update setting.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd autoupdate
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Enabled
|
||||
|
||||
#. Disable automatic updates.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd autoupdate --disable
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Warning: disabling automatic updates may take you out of compliance with your IT policy
|
||||
|
||||
Running systemctl to disable updates
|
||||
Created symlink /etc/systemd/system/swupd-update.service → /dev/null.
|
||||
Created symlink /etc/systemd/system/swupd-update.timer → /dev/null.
|
||||
|
||||
#. Check manually for updates.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd check-update
|
||||
|
||||
#. Install an update after identifying one that you need.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd update -m <version number>
|
||||
|
||||
#. Re-enable automatic installs.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd autoupdate --enable
|
||||
|
||||
.. _swupd-guide-example-install-bundle:
|
||||
|
||||
Example 2: Find and install Kata\* Containers
|
||||
=============================================
|
||||
|
||||
Kata Containers is a popular container implementation. Unlike other
|
||||
container implementations, each Kata Container has its own
|
||||
kernel instance and runs on its own :abbr:`Virtual Machine (VM)` for
|
||||
improved security.
|
||||
|
||||
|CL| makes it very easy to install, since you only need to add
|
||||
`one bundle`_ to use `Kata Containers`_: `containers-virt`, despite a
|
||||
number of dependencies. Also, check out our tutorial: :ref:`kata`.
|
||||
|
||||
#. Find the right bundle.
|
||||
|
||||
* To return all possible matches for the search string enter
|
||||
:command:`swupd search`, followed by 'kata':
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd search kata
|
||||
|
||||
The output should be similar to:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Bundle with the best search result:
|
||||
|
||||
containers-virt - Run container applications from Dockerhub in lightweight virtual machines
|
||||
|
||||
This bundle can be installed with:
|
||||
|
||||
swupd bundle-add containers-virt
|
||||
|
||||
Alternative bundle options are
|
||||
|
||||
cloud-native-basic - Contains ClearLinux native software for Cloud
|
||||
|
||||
.. note::
|
||||
|
||||
If your search does not produce results with a specific
|
||||
term, shorten the search term. For example, use *kube* instead of
|
||||
*kubernetes*.
|
||||
|
||||
#. Add the bundle.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd bundle-add containers-virt
|
||||
|
||||
.. note::
|
||||
|
||||
To add multiple bundles simply add a space followed by the bundle name.
|
||||
|
||||
The output of a successful installation should be similar to:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Downloading packs...
|
||||
|
||||
Extracting containers-virt pack for version 24430
|
||||
...50%
|
||||
Extracting kernel-container pack for version 24430
|
||||
...100%
|
||||
Starting download of remaining update content. This may take a while...
|
||||
...100%
|
||||
Finishing download of update content...
|
||||
Installing bundle(s) files...
|
||||
...100%
|
||||
Calling post-update helper scripts.
|
||||
Successfully installed 1 bundle
|
||||
|
||||
Example 3: Verify and correct system file mismatch
|
||||
==================================================
|
||||
|
||||
:command:`swupd` can determine whether system directories and files have
|
||||
been added to, overwritten, removed, or modified (e.g., permissions).
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd verify
|
||||
|
||||
All directories that are watched by :command:`swupd` are verified according
|
||||
to the manifest data and hash mismatches are flagged as follows:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Verifying version 23300
|
||||
Verifying files
|
||||
...0%
|
||||
Hash mismatch for file: /usr/bin/chardetect
|
||||
...
|
||||
...
|
||||
Hash mismatch for file: /usr/lib/python3.6/site-packages/urllib3/util/wait.py
|
||||
...100%
|
||||
Inspected 237180 files
|
||||
423 files did not match
|
||||
Verify successful
|
||||
|
||||
In this case, python packages that were installed on top of the default
|
||||
install were flagged as mismatched. :command:`swupd` can be directed to
|
||||
ignore or fix issues based on command line options.
|
||||
|
||||
:command:`swupd` can correct any issues it detects. Additional directives
|
||||
can be added including a white list of directories that will be ignored.
|
||||
|
||||
The following command will repair issues, remove unknown items, and
|
||||
ignore files or directories matching `/usr/lib/python`:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo swupd verify --fix --picky --picky-whitelist=/usr/lib/python
|
||||
|
||||
Quick Reference
|
||||
***************
|
||||
|
||||
swupd info
|
||||
To see the currently installed version and update servers.
|
||||
|
||||
swupd update <version number>
|
||||
To update to a specific version or with no arguments to update to latest.
|
||||
|
||||
swupd bundle-list [--all]
|
||||
To list installed bundles.
|
||||
|
||||
swupd bundle-add [-b] <search term>
|
||||
To find a bundle that contains your search term.
|
||||
|
||||
swupd bundle-add <bundle name>
|
||||
To add a bundle.
|
||||
|
||||
swupd bundle-remove <bundle name>
|
||||
To remove a bundle.
|
||||
|
||||
swupd --help
|
||||
For additional :command:`swupd` commands.
|
||||
|
||||
man swupd
|
||||
To reference the :command:`swupd` man page, or see the
|
||||
`source documentation`_ available on github.
|
||||
|
||||
Related topics
|
||||
**************
|
||||
|
||||
* :ref:`autospec`
|
||||
* :ref:`mixer`
|
||||
* :ref:`bundles`
|
||||
|
||||
.. _source documentation: https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst
|
||||
|
||||
.. _Kata Containers: https://clearlinux.org/downloads/containers
|
||||
|
||||
.. _one bundle: https://github.com/clearlinux/clr-bundles/blob/master/bundles/containers-virt
|
||||
|
||||
.. _Bundle Definition Files: https://github.com/clearlinux/clr-bundles
|
||||
|
||||
.. _bundles: https://github.com/clearlinux/clr-bundles/tree/master/bundles
|
||||
@@ -1,91 +0,0 @@
|
||||
.. _compatible-kernels:
|
||||
|
||||
Compatible kernels
|
||||
##################
|
||||
|
||||
The |CL-ATTR| provides the following Linux kernels with a respective bundle.
|
||||
This document describes the specific use cases these `bundles`_ serve
|
||||
and provides links to their source code.
|
||||
|
||||
Kernel native
|
||||
=============
|
||||
|
||||
The *kernel-native* bundle focuses on the bare metal platforms. It is
|
||||
optimized for fast booting and performs best on the Intel® architectures
|
||||
described on the :ref:`supported hardware list<system-requirements>`. The
|
||||
optimization patches are found in our `Linux`_ GitHub\* repo.
|
||||
|
||||
Kernel Container
|
||||
================
|
||||
|
||||
The *kernel-container* bundle contains the kernel used by the
|
||||
Intel® Clear Containers project. This kernel is optimized for
|
||||
fast booting and performs best on |CC| running on the Intel® architectures
|
||||
described on the :ref:`supported hardware list<system-requirements>`.
|
||||
The optimization patches are found in our `Linux-Container`_ GitHub repo.
|
||||
|
||||
.. _vm-kernels:
|
||||
|
||||
Kernel LTS
|
||||
==========
|
||||
|
||||
The *kernel-lts* bundle focuses on the bare metal platforms but uses the
|
||||
latest :abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for fast
|
||||
booting and performs best on the Intel® architectures described on the
|
||||
:ref:`supported hardware list<system-requirements>`. Additionally, this
|
||||
kernel includes the VirtualBox\* kernel modules, see our
|
||||
:ref:`instructions on using Virtualbox<virtualbox>` for more information.
|
||||
The optimization patches are found in our `Linux-LTS`_ GitHub repo.
|
||||
|
||||
Kernel KVM
|
||||
==========
|
||||
|
||||
The *kernel-kvm* bundle focuses on the Linux
|
||||
:abbr:`KVM (Kernel-based Virtual Machine)`. It is optimized for fast booting
|
||||
and performs best on Virtual Machines running on the Intel® architectures
|
||||
described on the :ref:`supported hardware list<system-requirements>`.
|
||||
Use this kernel when running |CL| as the guest OS on top of *qemu/kvm*. Use
|
||||
this kernel with **cloud orchestrators** using *qemu/kvm* internally as
|
||||
their **hypervisor**. This kernel can be used as a standalone |CL| VM, see
|
||||
our :ref:`instructions on using KVM<kvm>` for more information. The
|
||||
optimization patches are found in our `Linux-KVM`_ GitHub repo.
|
||||
|
||||
Kernel Hyper-V\*
|
||||
================
|
||||
|
||||
The *kernel-hyperv* bundle focuses on running Linux on Microsoft\*
|
||||
Hyper-V. It is optimized for fast booting and performs best on Virtual
|
||||
Machines running on the Intel® architectures described on the
|
||||
:ref:`supported hardware list<system-requirements>`.
|
||||
Use this kernel when running |CL| as the guest OS of **Cloud Instances** in
|
||||
projects such as Microsoft `Azure`_\*. This kernel can be used in a
|
||||
standalone |CL| VM, see our :ref:`instructions on using Hyper-V<hyper-v>` for
|
||||
more information. The optimization patches are found in our `Linux-HyperV`_
|
||||
GitHub repo.
|
||||
|
||||
Kernel Hyper-V LTS
|
||||
==================
|
||||
|
||||
The *kernel-hyperv-lts* bundle focuses on running Linux on Microsoft
|
||||
Hyper-V but uses the latest :abbr:`LTS (Long Term Support)` Linux kernel. It
|
||||
is optimized for fast booting and performs best on Virtual
|
||||
Machines running on the Intel® architectures described on the
|
||||
:ref:`supported hardware list<system-requirements>`.
|
||||
Use this kernel when running |CL| as the guest OS of **Cloud Instances** in
|
||||
projects such as Microsoft `Azure`_. This kernel can be used in a standalone
|
||||
|CL| VM, see our :ref:`instructions on using Hyper-V<hyper-v>` for
|
||||
more information. The optimization patches are found in our
|
||||
`Linux-HyperV-LTS`_ GitHub repo.
|
||||
|
||||
|
||||
.. _Linux: https://github.com/clearlinux-pkgs/linux
|
||||
.. _Linux-LTS: https://github.com/clearlinux-pkgs/linux-lts
|
||||
.. _Linux-KVM: https://github.com/clearlinux-pkgs/linux-kvm
|
||||
.. _Linux-HyperV: https://github.com/clearlinux-pkgs/linux-hyperv
|
||||
.. _Linux-HyperV-LTS: https://github.com/clearlinux-pkgs/linux-hyperv-lts
|
||||
.. _Linux-Container: https://github.com/clearlinux-pkgs/linux-container
|
||||
.. _bundles: https://github.com/clearlinux/clr-bundles
|
||||
.. _CIAO: https://github.com/01org/ciao
|
||||
.. _Azure:
|
||||
https://azuremarketplace.microsoft.com/en-us/marketplace/apps/clear-linux-project.clear-linux-os
|
||||
|
||||
|
Before Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 83 KiB |
|
Before Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 77 KiB |
|
Before Width: | Height: | Size: 96 KiB |
|
Before Width: | Height: | Size: 126 KiB |
|
Before Width: | Height: | Size: 123 KiB |
|
Before Width: | Height: | Size: 110 KiB |
|
Before Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 204 KiB |
|
Before Width: | Height: | Size: 250 KiB |
|
Before Width: | Height: | Size: 152 KiB |
|
Before Width: | Height: | Size: 122 KiB |
|
Before Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 111 KiB |
|
Before Width: | Height: | Size: 108 KiB |
|
Before Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 197 KiB |
|
Before Width: | Height: | Size: 173 KiB |
|
Before Width: | Height: | Size: 173 KiB |
|
Before Width: | Height: | Size: 82 KiB |
|
Before Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 142 KiB |
|
Before Width: | Height: | Size: 128 KiB |
|
Before Width: | Height: | Size: 131 KiB |
|
Before Width: | Height: | Size: 79 KiB |
|
Before Width: | Height: | Size: 159 KiB |
|
Before Width: | Height: | Size: 122 KiB |
|
Before Width: | Height: | Size: 128 KiB |
@@ -1,140 +0,0 @@
|
||||
.. _multi-boot-mint:
|
||||
|
||||
Install Linux Mint\* 18.1 *Serena* MATE
|
||||
#######################################
|
||||
|
||||
This guide describes Linux Mint-specific details of the :ref:`multi-boot`
|
||||
tutorial.
|
||||
|
||||
#. Start the Mint installer and follow the prompts.
|
||||
|
||||
#. At the :guilabel:`Installation type` screen, choose
|
||||
:guilabel:`Something else`. See Figure 1.
|
||||
|
||||
.. figure:: figures/multi-boot-mint-1.png
|
||||
|
||||
Figure 1: Mint: Installation type.
|
||||
|
||||
#. Create a new root partition.
|
||||
|
||||
#. Under the :guilabel:`Device` column, select :guilabel:`free space`. See
|
||||
Figure 2.
|
||||
|
||||
.. figure:: figures/multi-boot-mint-2.png
|
||||
|
||||
Figure 2: Mint: Add partition.
|
||||
|
||||
#. Click the :guilabel:`+` button.
|
||||
|
||||
#. In the :guilabel:`Size` field, enter a value for the new partition
|
||||
size. For this example, we used *40000 MB*, as shown in Figure 3.
|
||||
|
||||
.. figure:: figures/multi-boot-mint-3.png
|
||||
|
||||
Figure 3: Mint: Configure new partition settings.
|
||||
|
||||
#. Set :guilabel:`Use as` to :guilabel:`Ext4 journaling file system`.
|
||||
|
||||
#. Set the :guilabel:`Mount point` to :guilabel:`/`.
|
||||
|
||||
#. Click :guilabel:`OK`.
|
||||
|
||||
#. Share the swap partition created by |CL|.
|
||||
|
||||
#. Under the :guilabel:`Device` column, select :file:`/dev/sda2`.
|
||||
|
||||
#. Click :guilabel:`Change`.
|
||||
|
||||
#. Confirm :guilabel:`Use as` is set to :guilabel:`Swap area`. See Figure 4.
|
||||
|
||||
.. figure:: figures/multi-boot-mint-4.png
|
||||
|
||||
Figure 4: Mint: Set swap partition.
|
||||
|
||||
#. Follow the remaining prompts to complete the Mint installation.
|
||||
|
||||
#. At this point, you cannot boot |CL| because `Grub`
|
||||
is the default boot loader. Follow these steps to make the |CL|
|
||||
Systemd-Boot the default boot loader and add Mint as a boot option.
|
||||
|
||||
#. Boot into Mint.
|
||||
|
||||
#. Log in.
|
||||
|
||||
#. Locate the Mint :file:`grub.cfg` file in the :file:`/boot/grub/`
|
||||
directory and look for the :guilabel:`menuentry` section. In Figure 5, the
|
||||
highlighted lines identify the kernel, the :file:`initrd` files, the root
|
||||
partition UUID, and the additional parameters used. Use this information
|
||||
to create a new Systemd-Boot entry for Mint.
|
||||
|
||||
.. figure:: figures/multi-boot-mint-5.png
|
||||
|
||||
Figure 5: Mint: grub.cfg file.
|
||||
|
||||
#. Copy the kernel and :file:`initrd` file to the EFI partition.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo cp /boot/vmlinuz-4.4.0-53-generic /boot/efi
|
||||
|
||||
sudo cp /boot/initrd.img-4.4.0-53-generic /boot/efi
|
||||
|
||||
#. Create a boot entry for Mint. At a minimum, the file must contain
|
||||
these settings:
|
||||
|
||||
+---------+------------------------------------+
|
||||
| Setting | Description |
|
||||
+=========+====================================+
|
||||
| title | Text to show in the boot menu |
|
||||
+---------+------------------------------------+
|
||||
| linux | Linux kernel image |
|
||||
+---------+------------------------------------+
|
||||
| initrd | initramfs image |
|
||||
+---------+------------------------------------+
|
||||
| options | Options to pass to the EFI program |
|
||||
| | or kernel boot parameters |
|
||||
+---------+------------------------------------+
|
||||
|
||||
See the `systemd boot loader documentation`_ for additional
|
||||
details.
|
||||
|
||||
The *options* parameters must specify the root partition UUID and
|
||||
any additional parameters that Mint requires.
|
||||
|
||||
.. note:: The root partition UUID used below is unique to this example.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudoedit /boot/efi/loader/entries/mint.conf
|
||||
|
||||
Add the following lines to the :file:`mint.conf` file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
title Mint 18.1 Serena MATE
|
||||
|
||||
linux /vmlinuz-4.4.0-53-generic
|
||||
|
||||
initrd /initrd.img-4.4.0-53-generic
|
||||
|
||||
options root=UUID=af4901e1-6238-470a-8c14-bc0f0f7715ec ro
|
||||
|
||||
#. Re-install Systemd-Boot to make it the default boot loader.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo bootctl install --path /boot/efi
|
||||
|
||||
.. note::
|
||||
If an older version of Mint does not have the `bootctl` command,
|
||||
skip this step and see :ref:`multi-boot-restore-bl` to restore
|
||||
Systemd-Boot.
|
||||
|
||||
#. Reboot.
|
||||
|
||||
If you want to install other :abbr:`OSes (operating systems)`, refer to
|
||||
:ref:`multi-boot` for details.
|
||||
|
||||
|
||||
.. _systemd boot loader documentation:
|
||||
https://wiki.archlinux.org/index.php/Systemd-boot
|
||||
@@ -1,58 +0,0 @@
|
||||
.. _multi-boot-restore-bl:
|
||||
|
||||
Restore the |CL-ATTR| boot loader
|
||||
###################################
|
||||
|
||||
This guide is part of the :ref:`multi-boot` tutorial. If you install a new
|
||||
:abbr:`OS (operating system)` or upgrade an existing OS, the default boot
|
||||
loader may change from |CL| Systemd-Boot. This guide describes how to restore
|
||||
Systemd-Boot.
|
||||
|
||||
#. Boot the |CL| installer from a USB thumb drive. See :ref:`bootable-usb`.
|
||||
|
||||
#. At the introduction screen, press :kbd:`Control+Alt+F2` to bring up the
|
||||
|CL| console. See Figure 1.
|
||||
|
||||
.. figure:: figures/multi-boot-restore-bl-1.png
|
||||
|
||||
Figure 1: |CL|: Console.
|
||||
|
||||
#. Log in as *root*.
|
||||
|
||||
.. note::
|
||||
When you log in for the first time as *root* through the console, you must
|
||||
set a new password.
|
||||
|
||||
#. Find the location of the |CL| EFI partition. In this example, it is
|
||||
:file:`/dev/sda3`. See Figure 2.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
fdisk -l
|
||||
|
||||
.. figure:: figures/multi-boot-restore-bl-2.png
|
||||
|
||||
Figure 2: |CL|: fdisk -l command.
|
||||
|
||||
#. Mount the EFI partition.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
mount /dev/sda3 /mnt
|
||||
|
||||
#. Re-install Systemd-Boot to make it the default boot loader.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
bootctl install --path /mnt
|
||||
|
||||
#. Unmount the EFI partition.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
umount /mnt
|
||||
|
||||
#. Reboot.
|
||||
|
||||
If you want to install other :abbr:`OSes (operating systems)`, refer to
|
||||
:ref:`multi-boot` for details.
|
||||
@@ -1,165 +0,0 @@
|
||||
.. _multi-boot-rhel:
|
||||
|
||||
Install Red Hat\* Enterprise Linux 7.4 Beta
|
||||
###########################################
|
||||
|
||||
This guide describes Red Hat-specific details of the :ref:`multi-boot`
|
||||
tutorial.
|
||||
|
||||
#. Start the Red Hat installer and follow the prompts.
|
||||
|
||||
#. At the :guilabel:`INSTALLATION SUMMARY` screen, choose
|
||||
:guilabel:`INSTALLATION DESTINATION`. See Figure 1.
|
||||
|
||||
.. figure:: figures/multi-boot-rhel-1.png
|
||||
|
||||
Figure 1: Red Hat: Installation summary.
|
||||
|
||||
#. In the :guilabel:`Device Selection` section, select a drive on which to
|
||||
install the OS. See Figure 2.
|
||||
|
||||
.. figure:: figures/multi-boot-rhel-2.png
|
||||
|
||||
Figure 2: Red Hat: Installation destination.
|
||||
|
||||
#. Under the :guilabel:`Other Storage Options` section, choose
|
||||
:guilabel:`I will configure partitioning`. See Figure 2.
|
||||
|
||||
#. Click :guilabel:`Done`.
|
||||
|
||||
#. Under the :menuselection:`New Red Hat Enterprise Linux 7.4 Installation
|
||||
--> New mount points will use the following partitioning scheme` section,
|
||||
select :menuselection:`Standard Partition` from the drop down list. See
|
||||
Figure 3.
|
||||
|
||||
.. figure:: figures/multi-boot-rhel-3.png
|
||||
|
||||
Figure 3: Red Hat: New partition scheme.
|
||||
|
||||
#. Create a new root partition.
|
||||
|
||||
#. Click the :menuselection:`+` button on the lower left corner.
|
||||
|
||||
#. Enter `/` and the new partition size. For this example, we specified 45
|
||||
GB. See Figure 4.
|
||||
|
||||
.. figure:: figures/multi-boot-rhel-4.png
|
||||
|
||||
Figure 4: Red Hat: Create new root partition.
|
||||
|
||||
#. Click :guilabel:`Add mount point`.
|
||||
|
||||
#. Share the swap partition that was created by |CL|. See Figure 5.
|
||||
|
||||
#. Expand :guilabel:`Unknown`.
|
||||
|
||||
#. Select :guilabel:`swap / sda2`.
|
||||
|
||||
#. Select :guilabel:`Reformat`.
|
||||
|
||||
#. Click :guilabel:`Update Settings`.
|
||||
|
||||
.. figure:: figures/multi-boot-rhel-5.png
|
||||
|
||||
Figure 5: Red Hat: Configure swap partition.
|
||||
|
||||
#. Share the EFI partition that was created by |CL|. See Figure 6.
|
||||
|
||||
#. Expand :guilabel:`Unknown.`
|
||||
|
||||
#. Select :guilabel:`EFI System Partition / sda3`.
|
||||
|
||||
#. Under :guilabel:`Mount Point`, enter `/boot/efi`.
|
||||
|
||||
#. Click :guilabel:`Update Settings`.
|
||||
|
||||
.. figure:: figures/multi-boot-rhel-6.png
|
||||
|
||||
Figure 6: Red Hat: Configure EFI partition.
|
||||
|
||||
#. Click :guilabel:`Done`.
|
||||
|
||||
#. Follow the remaining prompts to complete the Red Hat installation.
|
||||
|
||||
#. At this point, you cannot boot |CL| because `Grub` is the default boot
|
||||
loader. Follow these steps to make the |CL| Systemd-Boot the default boot
|
||||
loader and add Red Hat as a boot option:
|
||||
|
||||
#. Boot into Red Hat.
|
||||
|
||||
#. Log in.
|
||||
|
||||
#. Locate the Red Hat :file:`grub.cfg` file in the
|
||||
:file:`/boot/efi/EFI/redhat/` directory and look for the primary Red
|
||||
Hat :guilabel:`menuentry` section. In Figure 7, the highlighted lines
|
||||
identify the kernel and `initrd` filenames, root partition UUID, and
|
||||
additional parameters used. Use this information to create a
|
||||
new Systemd-Boot entry for Red Hat.
|
||||
|
||||
.. figure:: figures/multi-boot-rhel-7.png
|
||||
|
||||
Figure 7: Red Hat: grub.cfg file.
|
||||
|
||||
#. Copy the kernel and :file:`initrd` file to the EFI partition.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo cp /boot/vmlinuz-3.10.0-663.el7.x86_64 /boot/efi
|
||||
|
||||
sudo cp /boot/initramfs-3.10.0-663.el7.x86_64.img /boot/efi
|
||||
|
||||
#. Create a boot entry for Red Hat. At a minimum, the file must contain
|
||||
these settings:
|
||||
|
||||
+---------+---------------------------------------------------+
|
||||
| Setting | Description |
|
||||
+=========+===================================================+
|
||||
| title | Text to show in the boot menu |
|
||||
+---------+---------------------------------------------------+
|
||||
| linux | Linux kernel image |
|
||||
+---------+---------------------------------------------------+
|
||||
| initrd | initramfs image |
|
||||
+---------+---------------------------------------------------+
|
||||
| options | Options to pass to the EFI program or kernel boot |
|
||||
| | parameters |
|
||||
+---------+---------------------------------------------------+
|
||||
|
||||
See the `systemd boot loader documentation`_ for additional
|
||||
details.
|
||||
|
||||
The *options* parameters must specify the root partition UUID and any
|
||||
additional parameters that Red Hat requires.
|
||||
|
||||
.. note:: The root partition UUID used below is unique to this example.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudoedit /boot/efi/loader/entries/redhat.conf
|
||||
|
||||
Add the following lines to the :file:`redhat.conf` file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
title Red Hat Enterprise Linux 7.4 Beta
|
||||
|
||||
linux /vmlinuz-3.10.0-663.el7.x86_64
|
||||
|
||||
initrd /initramfs-3.10.0-663.el7.x86_64.img
|
||||
|
||||
options root=UUID=30655c74-6cc1-4c55-8fcc-ac8bddcea4db ro
|
||||
crashkernel=auto rhgb LANG=en_US.UTF-8
|
||||
|
||||
#. Re-install Systemd-Boot to make it the default boot loader.
|
||||
|
||||
.. note::
|
||||
This version of Red Hat does not support `bootctl install`. Perform
|
||||
the steps in :ref:`multi-boot-restore-bl` instead.
|
||||
|
||||
#. Reboot.
|
||||
|
||||
If you want to install other :abbr:`OSes (operating systems)`, refer to
|
||||
:ref:`multi-boot` for details.
|
||||
|
||||
|
||||
.. _systemd boot loader documentation:
|
||||
https://wiki.archlinux.org/index.php/Systemd-boot
|
||||
@@ -1,124 +0,0 @@
|
||||
.. _multi-boot-sles:
|
||||
|
||||
Install SUSE\* Linux Enterprise Server 12 SP2
|
||||
#############################################
|
||||
|
||||
This guide describes SUSE-specific details of the :ref:`multi-boot`
|
||||
tutorial.
|
||||
|
||||
#. Start the SUSE installer and follow the prompts.
|
||||
|
||||
#. At the :guilabel:`Suggested Partitioning` screen, choose
|
||||
:guilabel:`Expert Partitioner`. See Figure 1.
|
||||
|
||||
.. figure:: figures/multi-boot-sles-1.png
|
||||
|
||||
Figure 1: SUSE: Suggested partitioning.
|
||||
|
||||
**Optional:** Under :guilabel:`Available Storage on Linux` section,
|
||||
right-click the SUSE :file:`/home` partition and delete it. In this example, it is :file:`/dev/sda8`. See Figure 2.
|
||||
|
||||
.. figure:: figures/multi-boot-sles-2.png
|
||||
|
||||
Figure 2: SUSE: Delete /home partition.
|
||||
|
||||
#. Under :guilabel:`Available Storage on Linux` section, right-click the SUSE
|
||||
root partition and resize it. In this example, :file:`/dev/sda7` is
|
||||
resized to 45 GB. See Figure 3.
|
||||
|
||||
.. figure:: figures/multi-boot-sles-3.png
|
||||
|
||||
Figure 3: SUSE: Resize root partition.
|
||||
|
||||
#. Click :guilabel:`Accept`.
|
||||
|
||||
#. Follow the remaining prompts to complete the SUSE installation.
|
||||
|
||||
#. At this point, you cannot boot |CL| because `Grub`
|
||||
is the default boot loader. Follow these steps to make the |CL|
|
||||
Systemd-Boot the default boot loader and add SUSE as a boot option:
|
||||
|
||||
#. Boot into SUSE.
|
||||
|
||||
#. Log in.
|
||||
|
||||
#. Locate the SUSE :file:`grub.cfg` file in the :file:`/boot/grub2/` directory
|
||||
and look for the primary SUSE :guilabel:`menuentry` section. In Figure 4, the
|
||||
highlighted lines identify the kernel, the :file:`initrd` filenames, the
|
||||
root partition UUID, and the additional parameters used. Use this information
|
||||
to create a new Systemd-Boot entry for SUSE.
|
||||
|
||||
.. figure:: figures/multi-boot-sles-4.png
|
||||
|
||||
Figure 4: SUSE: grub.cfg file.
|
||||
|
||||
#. Copy the kernel and the :file:`initrd` file to the EFI partition.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo cp /boot/vmlinuz-4.4.21-69-default /boot/efi
|
||||
|
||||
sudo cp /boot/initrd-4.4.21-69-default /boot/efi
|
||||
|
||||
#. Create a boot entry for SUSE. At a minimum, the file must contain
|
||||
these settings:
|
||||
|
||||
+---------+---------------------------------------+
|
||||
| Setting | Description |
|
||||
+=========+=======================================+
|
||||
| title | Text to show in the boot menu |
|
||||
+---------+---------------------------------------+
|
||||
| linux | Linux kernel image |
|
||||
+---------+---------------------------------------+
|
||||
| initrd | initramfs image |
|
||||
+---------+---------------------------------------+
|
||||
| options | Options to pass to the EFI program or |
|
||||
| | kernel boot parameters |
|
||||
+---------+---------------------------------------+
|
||||
|
||||
See the `systemd boot loader documentation`_ for additional
|
||||
details.
|
||||
|
||||
The *options* parameter must specify the root partition UUID and
|
||||
any additional parameters SUSE requires.
|
||||
|
||||
.. note:: The root partition UUID used below is unique to this example.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudoedit /boot/efi/loader/entries/suse.conf
|
||||
|
||||
Add the following lines to the :file:`suse.conf` file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
title SUSE Linux Enterprise 12 SP2
|
||||
|
||||
linux /vmlinuz-4.4.21-69-default
|
||||
|
||||
initrd /initrd-4.4.21-69-default
|
||||
|
||||
options root=UUID=b9e25e98-a644-4ac3-b955-ae32800ee350 ro
|
||||
resume=/dev/disk/by-uuid/6a50c032-1c1e-4b4a-b799-ca365bb10dc7
|
||||
splash=silent showopts crashkernel=109M,high
|
||||
crashkernel=72M,low
|
||||
|
||||
#. Re-install Systemd-Boot to make it the default boot loader.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo bootctl install --path /boot/efi
|
||||
|
||||
.. note::
|
||||
If an older version of SUSE does not have the `bootctl` command,
|
||||
skip this step and see :ref:`multi-boot-restore-bl` to restore
|
||||
Systemd-Boot.
|
||||
|
||||
#. Reboot.
|
||||
|
||||
If you want to install other :abbr:`OSes (operating systems)`, refer to
|
||||
:ref:`multi-boot` for details.
|
||||
|
||||
|
||||
.. _systemd boot loader documentation:
|
||||
https://wiki.archlinux.org/index.php/Systemd-boot
|
||||
@@ -1,142 +0,0 @@
|
||||
.. _multi-boot-ubuntu:
|
||||
|
||||
Install Ubuntu\* 16.04 LTS Desktop
|
||||
##################################
|
||||
|
||||
This guide describes Ubuntu-specific details of the :ref:`multi-boot`
|
||||
tutorial.
|
||||
|
||||
#. Start the Ubuntu installer and follow the prompts.
|
||||
|
||||
#. At the :guilabel:`Installation type` screen, choose
|
||||
:guilabel:`Something else`. See Figure 1.
|
||||
|
||||
.. figure:: figures/multi-boot-ubuntu-1.png
|
||||
|
||||
Figure 1: Ubuntu: Installation type.
|
||||
|
||||
#. Create a new root partition.
|
||||
|
||||
#. Under the :guilabel:`Device` column, select :guilabel:`free space`. See
|
||||
Figure 2.
|
||||
|
||||
.. figure:: figures/multi-boot-ubuntu-2.png
|
||||
|
||||
Figure 2: Ubuntu: Add partition.
|
||||
|
||||
#. Click the :guilabel:`+` button on the lower left corner.
|
||||
|
||||
#. Enter the new partition size. For this example, we used *40000 MB*, as
|
||||
shown in Figure 3.
|
||||
|
||||
.. figure:: figures/multi-boot-ubuntu-3.png
|
||||
|
||||
Figure 3: Ubuntu: Configure new root partition.
|
||||
|
||||
#. Set :guilabel:`Use as` to :guilabel:`Ext4 journaling file system`.
|
||||
|
||||
#. Set the :guilabel:`Mount point` to `/`.
|
||||
|
||||
#. Click :guilabel:`OK`.
|
||||
|
||||
#. Under the :guilabel:`Format?` column, select the new partition to be
|
||||
formatted, in this example :file:`/dev/sda8`.
|
||||
|
||||
#. Share the swap partition that was created by |CL|.
|
||||
|
||||
#. Under the :guilabel:`Device` column, select :file:`/dev/sda2`.
|
||||
|
||||
#. Click :guilabel:`Change`.
|
||||
|
||||
#. Confirm :guilabel:`Use as` is set to :guilabel:`swap area`. See Figure 4.
|
||||
|
||||
.. figure:: figures/multi-boot-ubuntu-4.png
|
||||
|
||||
Figure 4: Ubuntu: Set swap partition.
|
||||
|
||||
#. Follow the remaining prompts to complete the Ubuntu installation.
|
||||
|
||||
#. At this point, you cannot boot |CL| because `Grub`
|
||||
is the default boot loader. Follow these steps to make the |CL|
|
||||
Systemd-Boot the default boot loader and add Ubuntu as a boot option:
|
||||
|
||||
#. Boot into Ubuntu.
|
||||
|
||||
#. Log in.
|
||||
|
||||
#. Locate the Ubuntu :file:`grub.cfg` file in the :file:`/boot/grub/`
|
||||
directory and look for the :guilabel:`menuentry` section. In Figure 5, the
|
||||
highlighted lines identify the kernel, the :file:`initrd` files, the
|
||||
root partition UUID, and the additional parameters used. Use this
|
||||
information to create a new Systemd-Boot entry for Ubuntu.
|
||||
|
||||
.. figure:: figures/multi-boot-ubuntu-5.png
|
||||
|
||||
Figure 5: Ubuntu: grub.cfg file.
|
||||
|
||||
#. Copy the kernel and the :file:`initrd` file to the EFI partition.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo cp /boot/vmlinuz-4.8.0-36-generic.efi.signed /boot/efi
|
||||
|
||||
sudo cp /boot/initrd.img-4.8.0-36-generic /boot/efi
|
||||
|
||||
#. Create a boot entry for Ubuntu. At a minimum, the file must contain
|
||||
these settings:
|
||||
|
||||
+---------+------------------------------------+
|
||||
| Setting | Description |
|
||||
+=========+====================================+
|
||||
| title | Text to show in the boot menu |
|
||||
+---------+------------------------------------+
|
||||
| linux | Linux kernel image |
|
||||
+---------+------------------------------------+
|
||||
| initrd | initramfs image |
|
||||
+---------+------------------------------------+
|
||||
| options | Options to pass to the EFI program |
|
||||
| | or kernel boot parameters |
|
||||
+---------+------------------------------------+
|
||||
|
||||
See the `systemd boot loader documentation`_ for additional
|
||||
details.
|
||||
|
||||
The *options* parameters must specify the root partition UUID and
|
||||
any additional parameters that Ubuntu requires.
|
||||
|
||||
.. note:: The root partition UUID used below is unique to this example.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudoedit /boot/efi/loader/entries/ubuntu.conf
|
||||
|
||||
Add the following lines to the :file:`ubuntu.conf` file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
title Ubuntu 16.04 LTS Desktop
|
||||
|
||||
linux /vmlinuz-4.8.0-36-generic.efi.signed
|
||||
|
||||
initrd /initrd.img-4.8.0-36-generic
|
||||
|
||||
options root=UUID=17f0aa66-3467-4f99-b92c-8b2cea1045aa ro
|
||||
|
||||
#. Re-install Systemd-Boot to make it the default boot loader.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo bootctl install --path /boot/efi
|
||||
|
||||
.. note::
|
||||
If an older version of Ubuntu does not have the `bootctl` command,
|
||||
skip this step and see :ref:`multi-boot-restore-bl` to restore
|
||||
Systemd-Boot.
|
||||
|
||||
#. Reboot.
|
||||
|
||||
If you want to install other :abbr:`OSes (operating systems)`, refer to
|
||||
:ref:`multi-boot` for details.
|
||||
|
||||
.. _systemd boot loader documentation:
|
||||
https://wiki.archlinux.org/index.php/Systemd-boot
|
||||
@@ -1,46 +0,0 @@
|
||||
.. _multi-boot-win:
|
||||
|
||||
Install Windows\* Server 2016
|
||||
#############################
|
||||
|
||||
This guide describes Windows-specific details of the :ref:`multi-boot`
|
||||
tutorial.
|
||||
|
||||
#. Start the Windows installer and follow the prompts.
|
||||
|
||||
#. At the :guilabel:`Type of installation` screen, choose
|
||||
:guilabel:`Custom: Install Windows only (advanced)`. See Figure 1.
|
||||
|
||||
.. figure:: figures/multi-boot-win-1.png
|
||||
|
||||
Figure 1: Windows: Choose installation type.
|
||||
|
||||
#. Select :guilabel:`Unallocated Space` and create a new partition of the
|
||||
desired size. In this example, we specified 50000 MB. See Figure 2.
|
||||
|
||||
.. figure:: figures/multi-boot-win-2.png
|
||||
|
||||
Figure 2: Windows: Create new partition.
|
||||
|
||||
.. note::
|
||||
Windows creates its own 100 MB EFI partition if none exists.
|
||||
In this example, Windows sees the EFI partition created during the
|
||||
|CL| installation and does not create one.
|
||||
|
||||
#. Select the newly created partition and follow the remaining prompts
|
||||
to complete the Windows installation. See Figure 3.
|
||||
|
||||
.. figure:: figures/multi-boot-win-3.png
|
||||
|
||||
Figure 3: Windows: Install on newly created partition.
|
||||
|
||||
#. Finish the Windows out-of-box-experience process.
|
||||
|
||||
#. At this point, you cannot boot |CL| because Windows is the
|
||||
default boot loader. See :ref:`multi-boot-restore-bl` to restore
|
||||
Systemd-Boot and add Windows to its boot menu.
|
||||
|
||||
|
||||
If you want to install other :abbr:`OSes (operating systems)`, refer to
|
||||
:ref:`multi-boot` for details.
|
||||
|
||||
@@ -1,266 +0,0 @@
|
||||
.. _multi-boot:
|
||||
|
||||
Multi-boot |CL-ATTR| with other operating systems
|
||||
#################################################
|
||||
|
||||
|CL-ATTR| uses the Systemd-Boot boot loader, which does not support multi-
|
||||
booting without manual manipulation. This tutorial shows how to configure the
|
||||
|CL| boot loader to work with other :abbr:`OSes (operating systems)`.
|
||||
|
||||
Process overview
|
||||
****************
|
||||
|
||||
The process to install other operating systems for a multi-booting computer is
|
||||
described below. Install |CL| first, then install other operating systems in
|
||||
any order.
|
||||
|
||||
#. Install |CL| first with a EFI partition large enough to store the kernels
|
||||
of other operating systems and their initrds, in the case of Linux
|
||||
distributions.
|
||||
|
||||
#. Install the next operating system without creating its own EFI
|
||||
partition.
|
||||
|
||||
#. Boot into the newly installed operating system.
|
||||
|
||||
#. For Linux distributions, copy its kernel and `initrd` to the |CL| EFI
|
||||
partition. This step is not needed for Windows\*.
|
||||
|
||||
#. Add an entry for the newly installed operating system in the
|
||||
Systemd-Boot menu.
|
||||
|
||||
#. Make Systemd-Boot the default boot loader.
|
||||
|
||||
#. Repeat the previous steps to install each additional operating system.
|
||||
|
||||
If you update any installed operating systems, be aware that:
|
||||
|
||||
* The default boot loader may change from |CL| Systemd-Boot. Perform the
|
||||
steps in :ref:`multi-boot-restore-bl`.
|
||||
|
||||
* Linux kernels or `initrd` images may change. Keep their corresponding Systemd-Boot
|
||||
:file:`/boot/efi/loader/entries/*.conf` files up-to-date.
|
||||
|
||||
This process is not guaranteed to work with all Linux distributions and all
|
||||
their versions. The next section lists the OSes that we tested.
|
||||
|
||||
|
||||
Tested operating systems
|
||||
************************
|
||||
|
||||
The following operating systems were tested on an Intel® NUC6i7KYK with 32GB
|
||||
RAM and a 360GB SSD. Table 1 lists the information specific to the
|
||||
installation of the tested operating systems.
|
||||
|
||||
.. csv-table:: Table 1: OS specific installation information
|
||||
:header: # , OS, Version, Partition Size [#]_, Swap Size [#]_, EFI Partition Size [#]_, Download Link
|
||||
|
||||
1,Clear Linux,16140,50 GB,8 GB,1 GB,https://cdn.download.clearlinux.org/releases/16140/clear/
|
||||
2,Windows,Server 2016,50 GB,N/A,Shared with #1,https://www.microsoft.com/en-us/cloud-platform/windows-server
|
||||
3,Red Hat\*,Server 7.4 Beta,45 GB,Shared with #1,Shared with #1,https://access.redhat.com/downloads/
|
||||
4,SUSE\*,Server 12 SP2,45 GB,Shared with #1,Shared with #1,https://www.suse.com/download-linux/
|
||||
5,Ubuntu\*,16.04.02 LTS Desktop,40 GB,Shared with #1,Shared with #1,https://www.ubuntu.com/download/desktop
|
||||
6,Linux Mint\*,18.1 *Serena* MATE,40 GB,Shared with #1,Shared with #1,https://linuxmint.com/edition.php?id=228
|
||||
|
||||
Table notes:
|
||||
|
||||
.. [#] Configure the partition size as desired.
|
||||
|
||||
|
||||
.. [#] To save disk space, share a single swap partition between
|
||||
multiple Linux installations. Swap size was determined using these
|
||||
`recommended swap partition sizes`_.
|
||||
|
||||
|
||||
.. [#] The EFI partition holds the kernel and boot information for |CL| and
|
||||
other operating systems. The partition size is dependent on the number
|
||||
of operating systems to be installed. In general, allocate about 100 MB
|
||||
per operating system. For this tutorial, we used 1 GB.
|
||||
|
||||
|
||||
|
||||
.. _multi-boot-detail-proc:
|
||||
|
||||
Detailed procedures
|
||||
*******************
|
||||
|
||||
* :ref:`multi-boot-cl` (below)
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
multi-boot-win
|
||||
multi-boot-rhel
|
||||
multi-boot-sles
|
||||
multi-boot-ubuntu
|
||||
multi-boot-mint
|
||||
multi-boot-restore-bl
|
||||
|
||||
|
||||
.. _multi-boot-cl:
|
||||
|
||||
Install |CL|
|
||||
************
|
||||
|
||||
Navigation tips for text-based installation interfaces:
|
||||
|
||||
* Use the :kbd:`Up Arrow` and :kbd:`Down Arrow` keys to move between
|
||||
the options on the screen.
|
||||
|
||||
* Use the :kbd:`Space` to select or highlight an option.
|
||||
|
||||
* Press :kbd:`Enter` to activate the selected option and to move ahead.
|
||||
|
||||
Installation details
|
||||
====================
|
||||
|
||||
#. Create a bootable USB drive of the |CL| installer using one of the methods
|
||||
below.
|
||||
|
||||
* :ref:`bootable-usb-linux`
|
||||
* :ref:`bootable-usb-mac`
|
||||
* :ref:`bootable-usb-windows`
|
||||
|
||||
#. Start the |CL| installer and follow the prompts.
|
||||
|
||||
#. On the :guilabel:`Choose Installation Type` screen, choose
|
||||
:guilabel:`Manual (Advanced)`, as shown in Figure 1.
|
||||
|
||||
.. figure:: figures/multi-boot-01.png
|
||||
|
||||
Figure 1: |CL| installer: Choose installation type screen.
|
||||
|
||||
#. On the :guilabel:`Choose partitioning method` screen, choose
|
||||
:guilabel:`Manually configure mounts and partitions`, as shown in
|
||||
Figure 2.
|
||||
|
||||
.. figure:: figures/multi-boot-02.png
|
||||
|
||||
Figure 2: |CL|: Choose partitioning method.
|
||||
|
||||
#. Select the drive, in this case :file:`/dev/sda`, and press :kbd:`Enter` to
|
||||
go into the `cgdisk` partitioning tool. See Figure 3.
|
||||
|
||||
.. figure:: figures/multi-boot-03.png
|
||||
|
||||
Figure 3: |CL|: Choose drive to partition.
|
||||
|
||||
#. Create a new root partition.
|
||||
|
||||
#. Select :guilabel:`New`, as shown in Figure 4.
|
||||
|
||||
.. _multi-boot-04:
|
||||
|
||||
.. figure:: figures/multi-boot-04.png
|
||||
|
||||
Figure 4: |CL|: Create new partition.
|
||||
|
||||
#. Accept the default first sector.
|
||||
|
||||
#. Specify the desired size of the partition. For this example, we
|
||||
specified *50 GB*. See Figure 5.
|
||||
|
||||
.. figure:: figures/multi-boot-05.png
|
||||
|
||||
Figure 5: |CL|: New partition size.
|
||||
|
||||
#. Set the partition type to :guilabel:`8300 (Linux filesystem)`, as shown
|
||||
in Figure 6.
|
||||
|
||||
.. figure:: figures/multi-boot-06.png
|
||||
|
||||
Figure 6: |CL|: Set partition type.
|
||||
|
||||
#. Name the partition :file:`CL-root`. This name makes it easier to
|
||||
identify later. See Figure 7.
|
||||
|
||||
.. figure:: figures/multi-boot-07.png
|
||||
|
||||
Figure 7: |CL|: Name partition.
|
||||
|
||||
#. Create a new swap partition as shown in Figure 8.
|
||||
|
||||
.. figure:: figures/multi-boot-08.png
|
||||
|
||||
Figure 8: |CL|: Create swap partition.
|
||||
|
||||
#. Select the *free space* partition located at the bottom of the column.
|
||||
|
||||
#. Select :guilabel:`New`. See :ref:`Figure 4<multi-boot-04>`.
|
||||
|
||||
#. Accept the default first sector.
|
||||
|
||||
#. Specify the desired size of the swap partition. For this example, we
|
||||
used 8 GB. See the `recommended swap partition sizes`_ for guidance.
|
||||
|
||||
#. Set the partition type to :guilabel:`8200 (Linux swap)`.
|
||||
|
||||
#. Name the partition :file:`CL-swap`.
|
||||
|
||||
#. Create a new EFI partition as shown in Figure 9.
|
||||
|
||||
.. figure:: figures/multi-boot-09.png
|
||||
|
||||
Figure 9: |CL|: Create EFI partition.
|
||||
|
||||
#. In the :guilabel:`Partition Type` column, select :guilabel:`free space`
|
||||
located at the bottom of the column.
|
||||
|
||||
#. Select :guilabel:`New`. See :ref:`Figure 4<multi-boot-04>`.
|
||||
|
||||
#. Accept the default first sector.
|
||||
|
||||
#. Specify the desired size of the partition. For this example, we used
|
||||
1024 MB. This partition will hold |CL|, the kernels of the other
|
||||
operating systems, and their boot information. Its size depends on the
|
||||
number of installed operating systems. In general, allocate about 100 MB
|
||||
per operating system. For this example, we used 1024 MB.
|
||||
|
||||
#. Set the partition type to :guilabel:`ef00 (EFI partition)`.
|
||||
|
||||
#. Name the partition :file:`CL-EFI`.
|
||||
|
||||
#. Select :guilabel:`Write` to apply the new partition table.
|
||||
|
||||
#. Select :guilabel:`Quit` to exit the `cgdisk` tool.
|
||||
|
||||
#. On the :guilabel:`Set mount points` screen, specify the mount points and
|
||||
format settings as shown in Figure 10.
|
||||
|
||||
.. figure:: figures/multi-boot-10.png
|
||||
|
||||
Figure 10: |CL|: Set mount points.
|
||||
|
||||
#. On the :guilabel:`User configuration` screen, select
|
||||
:guilabel:`Create an administrative user`, as shown in Figure 11.
|
||||
|
||||
.. figure:: figures/multi-boot-11.png
|
||||
|
||||
Figure 11: |CL|: User configuration.
|
||||
|
||||
#. Select :guilabel:`Add user to sudoers?`, as shown in Figure 12.
|
||||
|
||||
.. figure:: figures/multi-boot-12.png
|
||||
|
||||
Figure 12: |CL|: Add user as sudoer.
|
||||
|
||||
#. Follow the remaining prompts to complete the installation and finish
|
||||
the out-of-box-experience for |CL|.
|
||||
|
||||
#. Log in.
|
||||
|
||||
#. Add a Systemd-Boot timeout period or Systemd-Boot will not present the
|
||||
boot menu of available OSes to choose from and will always boot |CL|.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo clr-boot-manager set-timeout 20
|
||||
|
||||
sudo clr-boot-manager update
|
||||
|
||||
#. Reboot.
|
||||
|
||||
If you want to install other OSes, refer to :ref:`multi-boot-detail-proc`.
|
||||
|
||||
.. _recommended swap partition sizes:
|
||||
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/5/html/Deployment_Guide/ch-swapspace.html
|
||||
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 94 KiB |
|
After Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 131 KiB After Width: | Height: | Size: 131 KiB |
@@ -0,0 +1,145 @@
|
||||
.. _stateless:
|
||||
|
||||
Stateless
|
||||
#########
|
||||
|
||||
In most operating systems, files can become intermingled with user and system
|
||||
data and configurations.
|
||||
|
||||
.. figure:: figures/stateless-1.png
|
||||
:scale: 45%
|
||||
:align: center
|
||||
:alt: Stateless: User and system files mixed
|
||||
|
||||
Figure 1: Without stateless, user and system files become mixed on the filesystem over time.
|
||||
|
||||
|CL-ATTR| has a stateless design philosophy of which the goal is to provide an
|
||||
:abbr:`OS (operating system)` that functions without excessive user
|
||||
configuration or customization. Stateless in this context does *not* mean
|
||||
ephemeral or non-persistent.
|
||||
|
||||
.. contents:: :local:
|
||||
:depth: 2
|
||||
|
||||
|
||||
File-level separation
|
||||
*********************
|
||||
|
||||
To accomplish a stateless design the Linux Filesystem Hierarchy is separated
|
||||
between user-owned areas and |CL|-owned areas.
|
||||
|
||||
.. figure:: figures/stateless-2.png
|
||||
:scale: 45%
|
||||
:align: center
|
||||
:alt: Stateless: User and system files separation
|
||||
|
||||
Figure 2: With stateless, user and system files are separated on the filesystem.
|
||||
|
||||
System areas
|
||||
============
|
||||
File under the :file:`/usr` directory are managed by |CL| as system files.
|
||||
Files written under the :file:`/usr` directory by users can get removed
|
||||
through system updates with :ref:`swupd <swupd-about>`.This operating
|
||||
assumption allows |CL| to verify and maintain integrity of system files.
|
||||
|
||||
User areas
|
||||
==========
|
||||
Files under the :file:`/etc/`, :file:`/home`, and :file:`/var` directories are
|
||||
owned and managed by the user. A freshly installed |CL| system will only have
|
||||
a minimal set of files in the :file:`/etc/` directory and software installed
|
||||
by |CL| does not write to :file:`/etc`. This operating assumption allows |CL|
|
||||
users to clearly identify the configuration that makes their system unique.
|
||||
|
||||
|
||||
Software Configuration
|
||||
**********************
|
||||
|
||||
With stateless separation, default software configurations are read in order
|
||||
from predefined source code, |CL| provided defaults, and user-provided
|
||||
configuration.
|
||||
|
||||
Default configurations
|
||||
======================
|
||||
|
||||
Software in |CL| provides default configuration values so that it is
|
||||
immediately functional, whenever it is appropriate to do so.
|
||||
|
||||
|CL| distributed software packages may be directly modified to include default
|
||||
configuration values or default configuration files may be provided by |CL|
|
||||
under :file:`/usr/share/defaults`. These files can be referenced as templates
|
||||
for customization.
|
||||
|
||||
For example, the default configuration that Apache uses when installed can be
|
||||
found at :file:`/usr/share/defaults/httpd/httpd.conf` directory.
|
||||
|
||||
|
||||
Overriding configurations
|
||||
=========================
|
||||
|
||||
If a configuration needs to be changed, the appropriate file should be
|
||||
modified by the user under :file:`/etc/`. If the configuration file does not
|
||||
already exist, it can be created in the appropriate location.
|
||||
|
||||
User defined configuration files should contain the minimal set of desired
|
||||
changes and rely on default configuration for the rest.
|
||||
|
||||
For example, a customized Apache configuration can be used instead by:
|
||||
|
||||
#. Create the destination directory for the configuration:
|
||||
|
||||
.. code :: bash
|
||||
|
||||
sudo mkdir /etc/httpd
|
||||
|
||||
#. Copy the default configuration as a reference template:
|
||||
|
||||
.. code :: bash
|
||||
|
||||
sudo cp /usr/share/defaults/httpd/httpd.conf /etc/httpd/
|
||||
|
||||
#. Make any desired modifications to the configurations:
|
||||
|
||||
.. code :: bash
|
||||
|
||||
sudoedit /etc/httpd/httpd.conf
|
||||
|
||||
#. Reload the service or reboot the system to pickup any changes:
|
||||
|
||||
.. code :: bash
|
||||
|
||||
systemctl daemon-reload httpd && systemctl restart httpd
|
||||
|
||||
|
||||
This pattern can be used to modify the configurations of other programs too.
|
||||
The `stateless man page`_ has application-specific examples.
|
||||
|
||||
|
||||
System reset
|
||||
************
|
||||
|
||||
Once advantage of the stateless design is that the system defaults can be
|
||||
easily restored by simply deleting everything under :file:`/etc/` and
|
||||
:file:`/var`.
|
||||
|
||||
Running the commands below effectively performs a system reset as if it was
|
||||
just installed:
|
||||
|
||||
.. code::
|
||||
|
||||
sudo rm -rf /etc
|
||||
sudo rm -rf /var
|
||||
|
||||
In other Linux distributions, this can be a catastrophic action that renders a
|
||||
system unable to boot.
|
||||
|
||||
Additional information
|
||||
**********************
|
||||
|
||||
* `stateless man page`_
|
||||
|
||||
* `Where is /etc/fstab in Clear Linux? <https://clearlinux.org/news-blogs/where-etcfstab-clear-linux>`_
|
||||
|
||||
|
||||
.. _`stateless man page`: https://github.com/clearlinux/clr-man-pages/blob/master/stateless.7.rst
|
||||
|
||||
|
||||
@@ -60,12 +60,8 @@ to update.
|
||||
Update integrity
|
||||
----------------
|
||||
|
||||
:command:`swupd` operates against a published manifest of files for a
|
||||
particular |CL| version that contains the unique hash of each file. This is
|
||||
the basis of the :command:`swupd verify` subcommand, which allows a |CL|
|
||||
system to check for and remediate any discrepancies to system files. As
|
||||
necessary, :command:`swupd verify` provides a useful way for software
|
||||
developers to return to a known filesystem state.
|
||||
This is the basis of the :command:`swupd diagnose` subcommand, which allows a |CL| system to check for any discrepancies to system files. As necessary,
|
||||
:command:`swupd repair` provides a useful way for software developers to remediate these discrepancies and return to a known filesystem state.
|
||||
|
||||
Bundles
|
||||
=======
|
||||
@@ -24,6 +24,10 @@ for debugging purposes. You can use **libtelemetry** in your code to create cust
|
||||
telemetry records. You can also use **telem-record-gen** in script files or call
|
||||
it from another program.
|
||||
|
||||
.. note::
|
||||
|
||||
The |CL| telemetry client is disabled by default until you decide to enable it. Telemetry is an **opt-in** solution and can be easily enabled or disabled.
|
||||
|
||||
Architecture
|
||||
************
|
||||
|
||||
@@ -74,10 +78,5 @@ own records, then you must set up your own telemetry backend server.
|
||||
Next steps
|
||||
**********
|
||||
|
||||
To put this concept into practice, see the following resources:
|
||||
To put this concept into practice, refer to :ref:`telem-guide`.
|
||||
|
||||
* :ref:`telem-guide`
|
||||
* `Telemetry feature description`_
|
||||
|
||||
.. _`Telemetry feature description`:
|
||||
https://clearlinux.org/features/telemetry
|
||||
@@ -49,7 +49,7 @@ source_suffix = '.rst'
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'clear-linux/clear-linux'
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
#project = u'Clear Linux* project'
|
||||
@@ -133,7 +133,8 @@ html_context = {
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
html_theme_options = {
|
||||
'style_nav_header_background': '#8e6db6'
|
||||
'style_nav_header_background': '#8e6db6',
|
||||
'navigation_depth': 4
|
||||
}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
|
||||
@@ -70,8 +70,8 @@ Confirm network connection
|
||||
==========================
|
||||
|
||||
Confirm there is a network connection before launching the installer.
|
||||
Choose a method: `Wired Connection`, or `WiFi Connected`.
|
||||
This guide shows an example of a **Wired Connection**.
|
||||
Choose a method: `Wired Connection`, or `WiFi Connected`. This guide shows
|
||||
an example of a **Wired Connection**.
|
||||
|
||||
#. In the upper right of the top menu bar, select the square icon to view
|
||||
Network settings, shown in Figure 2.
|
||||
@@ -243,6 +243,16 @@ Use this method to safely install |CL| on media with available space, or
|
||||
alongside existing partitions, and accept the `Default partition schema`_.
|
||||
If enough free space exists, safe installation is allowed.
|
||||
|
||||
.. note::
|
||||
|
||||
|CL| allows installation alongside another OS. Typically, when you boot
|
||||
your system, you can press an `F key` to view and select a bootable
|
||||
device or partition during the BIOS POST stage. Some BIOSes present the
|
||||
|CL| partition, and you can select and boot it. However, other
|
||||
BIOSes may only show the primary partition, in which case you will not be
|
||||
able boot |CL|. Be aware of this possible limitation.
|
||||
|
||||
|
||||
Destructive Installation
|
||||
------------------------
|
||||
|
||||
@@ -344,11 +354,7 @@ team for improvements. For more information, see :ref:`telemetry-about`.
|
||||
|
||||
#. From :guilabel:`Required Options`, select :guilabel:`Telemetry`.
|
||||
|
||||
#. Select :kbd:`Confirm`.
|
||||
|
||||
#. If you don't wish to participate, deselect :kbd:`Enable Telemetry`.
|
||||
|
||||
#. Select :kbd:`Confirm`.
|
||||
#. Select :kbd:`Yes`.
|
||||
|
||||
.. figure:: figures/bare-metal-install-desktop-12.png
|
||||
:scale: 100%
|
||||
@@ -356,6 +362,8 @@ team for improvements. For more information, see :ref:`telemetry-about`.
|
||||
|
||||
Figure 12: Enable Telemetry
|
||||
|
||||
#. If you don't wish to participate, select :kbd:`No`.
|
||||
|
||||
Advanced options
|
||||
****************
|
||||
|
||||
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 196 KiB After Width: | Height: | Size: 196 KiB |
|
Before Width: | Height: | Size: 214 KiB After Width: | Height: | Size: 214 KiB |
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 75 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |