Fixed two broken links found in weekly check.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>

.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: cc99ba4fd98ddc62c1fab24f336360f5
-tags: 645f666f9bcd5a90fca523b33c5a78b7

.github/ISSUE_TEMPLATE/modify-document.md

@@ -0,0 +1,22 @@
+---
+name: Modify document
+about: Modify a document for the Clear Linux* Project
+title: ''
+labels: P2
+assignees: ''
+
+---
+
+**Describe the error/improvement to an existing document or image**
+Provide a clear and concise description of the error or proposed improvement.
+
+**Screenshots**
+If applicable, add screenshots to help explain the error or unexpected behavior.
+
+**Environment (please complete the following):**
+ - Clear Linux OS version: [`cat /usr/lib/os-release`]
+ - Third-party tool/software: [version]
+ - Command [ [e.g. `sudo -i`]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/new-document.md

@@ -0,0 +1,20 @@
+---
+name: New document
+about: Request a new document for the Clear Linux* project
+title: ''
+labels: P2
+assignees: ''
+
+---
+
+**Do you think Clear Linux documentation needs a new document? Please describe.**
+Please provide a clear and concise description of the title and content. Identify the target audience: Developer; System Administrator; or Basic User.
+
+**Should the new document be a guide, a reference, or a tutorial?**
+Recommend a type of document, based on the structure here: https://clearlinux.org/documentation/clear-linux
+
+**Describe or provide examples of similar documents, if possible, from other web sites**
+Please provide an example of similar documents if possible.
+
+**Additional context**
+Add any other context or screenshots for the document request here.

.github/workflows/greetings.yml

@@ -0,0 +1,13 @@
+name: Greetings
+
+on: [pull_request, issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        issue-message: 'Welcome to Clear Linux* OS Docs. Thanks for submitting your first issue.'
+        pr-message: 'Welcome to Clear Linux* OS Docs. Thanks for submitting your first PR.'

.gitignore

@@ -0,0 +1,19 @@
+#Exluding from the tree the html build files
+source/_build
+# ignore vi temporary files
+*.swp
+*~
+.*~
+
+# ignore VS code settings
+.vscode/
+
+# ignore .mo translation files
+*.mo
+
+# ignore artifacts generated by running make py
+cloned_repo
+bundles.html.txt
+
+# ignore the venv, used for running make py
+venv

.gitlab-ci.yml

@@ -0,0 +1,19 @@
+image: alpine
+
+pages:
+  script:
+  - apk --no-cache add python3
+  - python3 -m ensurepip
+  - pip3 install sphinx==1.8.0 docutils==0.14 sphinx_rtd_theme breathe==4.9.1 sphinxcontrib-plantuml sphinx-intl==2.0.0 sphinx-sitemap==1.0.2
+  - apk --no-cache add make
+  - apk --no-cache add doxygen
+  - apk --no-cache add graphviz
+  - apk --no-cache add ttf-dejavu 
+  - apk --no-cache add openjdk8-jre
+  - make htmlall
+  - mv source/_build/html/ public/
+  artifacts:
+    paths:
+    - public
+  only:
+  - rtd-theme

.travis.yml

@@ -0,0 +1,54 @@
+language: python
+
+python:
+  - "3.6"
+
+# command to install dependencies
+install:
+  - pip3 install -q -r requirements.txt
+
+# command to run tests
+script:
+  - make py
+  - make htmlall
+
+before_deploy:
+  - make linkcheck
+  # only deploy the latest tagged release of Simplified Chinese docs
+  - wget https://github.com/clearlinux/clear-linux-documentation-zh-CN/releases/latest/download/clearlinux-docs-zh-CN.tar.gz
+  - mkdir source/_build/html/zh_CN
+  - tar xvzf clearlinux-docs-zh-CN.tar.gz -C source/_build/html/zh_CN
+
+deploy:
+  - provider: pages
+    skip_cleanup: true
+    github_token: $GITHUB_TOKEN
+    target-branch: latestHTML
+    on:
+      branch: publish
+    local_dir: source/_build/html/
+  - provider: pages
+    skip_cleanup: true
+    github_token: $GITHUB_TOKEN
+    target-branch: developmentHTML
+    on:
+      branch: master
+    local_dir: source/_build/html/
+  - provider: pages
+    skip_cleanup: true
+    github_token: $GITHUB_TOKEN
+    target-branch: developmentHTML
+    on:
+      branch: development
+    local_dir: source/_build/html/
+  - provider: releases
+    skip_cleanup: true
+    api_key: $GITHUB_TOKEN
+    file: clearlinux-docs-zh-CN.tar.gz
+    on:
+      tags: true
+
+
+after_deploy:
+  - wget $PUBLISH_URL
+  - cat clearlinux-latest

Makefile

@@ -0,0 +1,39 @@
+# Makefile for Sphinx documentation
+
+SHELL := /bin/bash
+
+PY_VERSION ?= 3.6
+
+all:
+	make -C source html
+
+htmlall:
+	make -C source htmlall
+
+htmlzh:
+	make -C source htmlzh
+
+htmlde:
+	make -C source htmlde
+
+html:
+	make -C source html
+
+linkcheck:
+	make -C source linkcheck
+
+py:
+	make -C source py
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+
+clean:
+	make -C source clean
+	rm -rf venv
+
+venv:
+	virtualenv venv;\
+	source venv/bin/activate; \
+	pip3 install -r requirements.txt;

README.rst

@@ -0,0 +1,184 @@
+Documentation build instructions
+################################
+
+.. todo add comment re not using standards here.
+
+`Clear Linux\* OS documentation`_ is written using `reStructuredText`_ and
+built using `Sphinx`_. Follow the instructions in this README to build the
+documentation locally for development and testing.
+
+Please make yourself familiar with our `contribution guidelines`_ before
+submitting a contribution.
+
+Clone the documentation repository
+**********************************
+
+Clone the documentation repository to your local machine.
+
+.. code-block:: bash
+
+   git clone https://github.com/clearlinux/clear-linux-documentation
+
+Requirements
+************
+
+Make sure you have Python 3 installed to start.
+
+The Sphinx documentation provides `instructions for installing Sphinx`_
+on various platforms.
+
+Use pip3 to install additional Python dependencies listed in the
+requirements.txt file found in the repository:
+
+.. code-block:: bash
+
+   pip3 install -r requirements.txt
+
+Run the build
+*************
+
+We build our documentation using Sphinx. In the source directory of your
+local clear-linux-documentation repository, preview changes to the
+documentation by building the docs in the default language (English) by
+running ``make html``:
+
+.. code-block:: bash
+
+   make html
+
+.. code-block:: console
+
+   sphinx-build -b html -d _build/doctrees   . _build/html
+   Running Sphinx v1.8.0
+   making output directory...
+   .
+   .
+   .
+   build succeeded, 0 warnings.
+
+   The HTML pages are in _build/html.
+
+   Build finished. The HTML pages are in _build/html.
+
+Open one of the HTML pages found in ``source/_build/html`` in a web browser
+to view the rendered documentation.
+
+If you want to build the documentation exactly as seen on the website, use
+``make py`` followed by ``make htmlall``. This builds some
+external dependencies and all supported languages.
+
+Use virtualenv 
+**************
+
+To develop documentation in a ``virtualenv``, use the ``venv`` target.
+The Clear Linux OS documentation make target ``venv`` provides a 
+simple development environment that ensures that you have the 
+latest packages and that you manage Python versions separately. Use of the 
+``virtualenv`` requires **Python 3.6** or higher. For Windows examples below, use Powershell as an Administrator.
+
+The **virtual environment** uses the same version of Python that was used to **create the virtual environment**. 
+
+Verify ``pip`` is installed. A file path to pip should appear. 
+
+On Clear Linux OS and macOS\*:
+
+.. code-block:: bash
+
+   which pip
+   
+On Windows\* 10 OS: 
+
+.. code-block:: bash
+
+   pip --version
+
+If ``pip`` is not installed, install it. 
+
+On Clear Linux OS and macOS:
+
+.. code-block:: bash
+
+   python3 -m pip install --user --upgrade pip
+
+On Windows 10 OS: 
+
+.. code-block:: bash
+
+   py -m pip install --upgrade pip
+
+.. note::
+
+   This assumes Python was already added to your Windows path. 
+
+Install virtualenv 
+==================
+
+Install ``virtualenv``. 
+
+On Clear Linux OS and macOS\*:
+
+.. code-block:: bash
+
+   python3 -m pip install --user virtualenv
+
+On Windows 10 OS: 
+
+.. code-block:: bash
+
+   py -m pip install --user virtualenv
+
+Create the ``virtualenv`` and install the required packages: 
+
+.. code-block:: bash
+
+   make venv
+
+Activate the ``venv``. 
+
+.. code-block:: bash
+
+   source venv/bin/activate
+
+Follow `Run the build`_ section to start developing documentation.
+
+Remove the ``venv`` when finished developing.  
+
+.. code-block:: bash
+
+   deactivate
+
+Additional help
+***************
+
+Cleaning up
+===========
+
+When testing changes in the documentation, make sure to remove the previous
+build before building again by running ``make clean``:
+
+.. code-block:: bash
+
+   make clean
+
+This will completely remove the previous build output, including artifacts 
+from the `make venv` target when done outside an active venv.
+
+Convenience script
+==================
+
+This bash script (Linux only) includes both ``make clean`` and
+``make html``. It also starts a simple Python web server that
+displays a preview of the site at http://localhost:8000 on your local machine.
+
+.. code-block:: bash
+
+   ./checkwork.sh
+
+To stop the web server simply use ``ctrl-c``.
+
+.. _Clear Linux\* OS documentation:  https://docs.01.org/clearlinux/
+.. _Sphinx: http://sphinx-doc.org/
+.. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
+.. _contribution guidelines: https://docs.01.org/clearlinux/latest/collaboration/collaboration.html
+.. _instructions for installing Sphinx: https://www.sphinx-doc.org/en/master/usage/installation.html
+

_sources/about.rst.txt

@@ -1,24 +0,0 @@
-.. _about:
-
-About
-#####
-
-Clear Linux is a little different from other distros. Here are some important
-tools and concepts for managing your install.
-
-Training
-********
-
-Additional training materials are available in the `how-to-clear`_ GitHub\*
-project to help you get started with |CL| tools.
-
-The training helps you create a customized OS that is based on |CL| and provides
-complete details on the methods and tools used to create updates and how to
-deploy updates to targets.
-
-To complete the training, you will need a clean |CL| installation and a network connection. The project includes all files needed to complete the exercises.
-
-* `how-to-clear`_ training on GitHub
-
-
-.. _how-to-clear: https://github.com/clearlinux/how-to-clear

_sources/concepts/autospec-about.rst.txt

@@ -1,106 +0,0 @@
-.. _autospec-about:
-
-Autospec
-########
-
-``autospec`` is a tool to assist in the automated creation and maintenance of
-RPM packaging in |CL-ATTR|. Where a standard RPM build process using ``rpmbuild``
-requires a tarball and .spec file to start, ``autospec`` requires only a tarball
-and package name to start.
-
-How autospec works
-******************
-
-``autospec`` attempts to infer the requirements of the .spec file by analyzing
-the source code and :file:`Makefile` information. It will continuously run
-updated builds based on new information discovered from build failures until it
-has a complete and valid .spec file. Although not required, you can influence
-the behavior of ``autospec`` by providing :ref:`control files <control-files>`.
-
-The basic process is described in the following steps:
-
-#. The :command:`make autospec` command generates a .spec based on
-   analysis of code and control files, if present.
-
-#. ``autospec`` creates a ``build root`` with ``mock`` config.
-
-#. ``autospec`` attempts to build an RPM from the generated .spec.
-
-#. ``autospec`` detects any missed declarations in the .spec.
-
-#. If build errors occur, ``autospec`` will scan the build log to try and detect
-   the root cause.
-
-#. If ``autospec`` detects the root cause and knows how to continue, it will restart the build
-   automatically at step 1 with updated build instructions.
-
-#. Otherwise, ``autospec`` will stop the build for user inspection and editing of control files
-   to resolve the errors. The user resumes the process at step 1 after errors are resolved.
-
-Following these steps, ``autospec`` continues to rebuild the package, based on
-new information discovered from build failures, until it has a valid .spec. If
-no build errors occur, RPM packages are successfully built.
-
-.. _control-files:
-
-Control files
-*************
-
-It is possible to influence the behavior of ``autospec`` by providing control
-files. These files may be used to alter the default behavior of the configure
-routine, to blacklist build dependencies, etc. Control files must be located
-in the same directory as the resulting .spec.
-
-Table 1 shows control files used to control dependencies, for example.
-
-.. list-table:: **Table 1. Control files to control dependencies**
-   :widths: 20 80
-   :header-rows: 1
-
-   * - Filename
-     - Description
-   * - buildreq_add
-     - Each line in the file provides the name of a package to add as a
-       build dependency to the .spec.
-   * - buildreq_ban
-     - Each line in the file is a build dependency that under no
-       circumstance should be automatically added to the build dependencies.
-       This is useful to block automatic configuration routines adding
-       undesired functionality, or to omit any automatically discovered
-       dependencies during tarball scanning.
-   * - pkgconfig_add
-     - Each line in the file is assumed to be a pkgconfig() build
-       dependency. Add the pkg-config names here, as ``autospec`` will
-       automatically transform the names into their ``pkgconfig($name)``
-       style when generating the .spec.
-   * - pkgconfig_ban
-     - Each line in this file is a pkgconfig() build dependency that should
-       not be added automatically to the build, much the same as
-       `` buildreq_ban``. As with ``pkgconfig_add``, these names are
-       automatically transformed by ``autospec`` into their correct
-       ``pkgconfig($name))`` style.
-   * - requires_add
-     - Each line in the file provides the name of a package to add as a
-       runtime dependency to the .spec.
-   * - requires_ban
-     - Each line in the file is a runtime dependency that under no
-       circumstance should be automatically added to the runtime
-       dependencies. This is useful to block automatic configuration
-       routines adding undesired functionality, or to omit any automatically
-       discovered dependencies during tarball scanning.
-
-Further control of the build can be achieved through the use of the
-``options.conf`` file. If this file does not exist, it is created by
-``autospec`` with default values. If certain deprecated configuration
-files exists ``autospec`` will use the value indicated by those files and
-remove them.
-
-For a comprehensive list of control files, view the `autospec readme`_.
-
-Related topics
-**************
-
-* :ref:`autospec`
-* :ref:`mixer`
-
-.. _autospec readme: https://github.com/clearlinux/autospec

_sources/concepts/bundles-about.rst.txt

@@ -1,30 +0,0 @@
-.. _bundles-about:
-
-Bundles
-#######
-
-Linux-based operating systems contain the code of several hundred, if
-not thousands, of open source projects. To make this manageable,
-distributions use a concept called "packages" to configure and compile
-the source code of these projects into binaries.
-
-Many distributions then split the content of these compiled packages
-into so-called sub-packages, which are the granularity at which these
-distributions deploy their software. With those kinds of distributions,
-system administrators can then install and update sub-packages
-individually or as a set, using tools such as "yum" and "apt-get."
-
-The |CL-ATTR| takes a slightly different approach. While we also use the
-concept of packages to manage compiling source code into binaries, we do not
-use the package concept to deploy software. Instead, we provide software
-"bundles" that are installed and managed using :ref:`swupd<swupd-about>`.
-Each bundle contains as many or as few open source projects needed to provide a complete functionality.
-
-Next steps
-==========
-
-To put this concept into practice, see the following resources:
-
-* :ref:`bundles`
-* :ref:`bundle-commands`
-* :ref:`compatible-kernels`

_sources/concepts/mixer-about.rst.txt

@@ -1,54 +0,0 @@
-.. _mixer-about:
-
-Mixer
-#####
-
-|CL-ATTR| is a powerful, modular, and customizable OS. Upstream |CL| offers
-many images to support different environments and use-cases.  There are
-hundreds of bundles that will meet most, if not all, of your OS and software
-needs.
-
-However, if you need additional customization or content, |CL| provides the
-mixer tool. Depending on your needs, the mixer tool allows you to:
-
-* :ref:`create-mix` to create a distinct derivative of the |CL| that
-   contains your custom software.
-
-.. _create-mix:
-
-Create a mix
-============
-
-When creating a mix, you can
-
-* Use any existing upstream bundles with no modification.
-* Redefine what goes into existing bundles.
-* Create completely new, custom bundles with your own custom packages.
-
-With mixer you are not required to incorporate every upstream release into
-your mix. You decide which upstream versions to update your derivative to, as
-illustrated in Figure 1.
-
-.. figure:: figures/mixer-about-1.png
-   :scale: 75%
-   :alt: Creating a custom mix.
-
-   Figure 1: With a custom mix, you add your custom bundle and decide which
-   upstream versions to update your mix to, on your own release cycle.
-
-Creating your own mix forks away from the |CL| upstream and requires that you
-act as your own OSV. There is a greater level of responsibility, requiring
-more infrastructure and processes to adopt. However, with this approach, you
-have a higher degree of control and customization of your custom |CL|.
-
-Related topics
-==============
-
-|CL| provides flexibility in how you customize your OS. Learn more about
-mixer and related topics to decide which customization approach is best for
-you.
-
-* :ref:`mixer`
-* :ref:`bundles-about`
-* :ref:`swupd-about`
-* :ref:`deploy-at-scale`

_sources/concepts/swupd-about.rst.txt

@@ -1,97 +0,0 @@
-.. _swupd-about:
-
-swupd: software updater
-#######################
-
-:command:`swupd` is an operating system software manager and update program
-that operates at a file-level to enable verifiable integrity and update
-efficiency.
-
-Visit the `swupd man page`_ for more details.
-
-Versioning
-==========
-
-Using package managers to keep track of software version compatibility or compare multiple systems on many Linux distributions can be cumbersome.
-
-With |CL| :command:`swupd`, versioning happens at the individual
-file-level. This means |CL| generates an entirely new OS version with any set
-of software changes to the system (including software downgrades or removals). This rolling release versioning model is similar to
-:command:`git` internal version tracking, where any of the individual file
-commits are tracked and move the pointer forward when changed.
-
-While administrators can pick and choose which `bundles`_ a system has
-installed, a single |CL| version number strictly represents one combination
-of all software versions that can be installed onto a system of that |CL|
-version. This method of whole OS versioning offers unique advantages.
-Namely, system administrators can quickly compare multiple |CL| systems that share the same version for important software and security fixes.
-
-
-Updating
-========
-
-|CL| promotes regular and automated updating of software to ensure
-integration of new enhancements and security fixes. Refer to :ref:`security`
-documentation for more information.
-
-Learn how to update your system using :ref:`swupd <swupd-guide>`.
-
-Update efficiency
------------------
-
-Because :command:`swupd` operates at the individual file-level instead of a
-package-level, |CL| updates are small and fast.
-
-On many Linux\* distributions, updates to a particular software package
-require the whole software package to be downloaded and replaced
---even for one line of code.
-
-In |CL|, updates are generated using the :ref:`mixer <mixer-about>` tool. Mixer calculates the difference between two |CL| versions and makes available
-*binary deltas*, which contain only the changed portion of files. This
-*binary delta technology* [1]_ means :command:`swupd` on |CL| systems only
-needs to download and apply a small fraction of a package in order to
-receive an update.
-
-The :ref:`mixer <mixer-about>` tool additionally computes updates files in
-multiple compression formats, allowing :command:`swupd` to utilize the most
-efficiently compressed format for a |CL| system to minimize the cost
-to update.
-
-Update integrity
-----------------
-
-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
-=======
-
-|CL-ATTR| approaches software management differently than many other
-Linux-based operating systems.
-
-Instead of deploying granular software packages, |CL| uses the concept of
-bundles with pre-associated software. Each bundle encapsulates a particular
-use-case, which is enabled by composing all the required upstream open-source
-projects and packages into one logical unit.
-
-This bundle-based approach offers some unique advantages:
-
-* Bundles provide a particular functionality, or stack, which
-  include all associated runtime dependencies.
-
-* Software package dependencies are resolved on the server, so file-level
-  conflicts do not occur on the target system after an update.
-
-* All combinations of bundles are able to co-exist on a |CL| system.
-
-For more information on bundles, visit:
-
-* :ref:`bundles`
-* :ref:`bundles-about`
-* :ref:`bundle-commands`
-* :ref:`compatible-kernels`
-
-.. [1] The software update technology for |CL-ATTR| was first presented at the Linux Plumbers conference in 2012.
-
-.. _swupd man page: https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst
-

_sources/concepts/telemetry-about.rst.txt

@@ -1,82 +0,0 @@
-.. _telemetry-about:
-
-Telemetrics
-###########
-
-One of the key features of |CL-ATTR| is telemetry, which is used to
-monitor system health. Telemetry enables developers to observe and proactively
-address issues before end users are impacted.
-
-*Telemetrics* is a combination word made from:
-
-*	*Telemetry* which is sensing and reporting data.
-*	*Analytics* which is using visualization and statistical inferencing to make
-	sense of the reported data.
-
-|CL| telemetry reports system-level debug/crash information using specialized probes. The
-probes monitor system tasks such as :abbr:`swupd (software updater)`, kernel
-oops, machine error checks, and BIOS error report table for unhandled hardware
-failures. Telemetry enables real-time issue reporting to allow system
-developers to quickly focus on an issue and monitor corrective actions.
-
-|CL| telemetry is fully customizable and can be used during software development
-for debugging purposes. You can use **libtelemetry** in your code to create custom
-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
-************
-
-|CL| telemetry has two fundamental components, which are shown in figure 1:
-
-*	Client:  generates and delivers records to the backend server via the network.
-*	Backend: captures records sent from the client and displays the cumulative
-	content through a specialized interface.
-
-	.. note::
-
-		If you want to capture your own records for analysis, you must set up
-		your own backend server.
-
-.. figure:: ../guides/telemetrics/figures/telemetry-e2e.png
-   :scale: 75%
-   :alt: Clear Linux Telemetry Architecture.
-
-   Figure 1: Clear Linux Telemetry Architecture.
-
-The telemetry client provides the front end of a complete telemetrics solution
-and includes the following components:
-
-*	**telemprobd**, a daemon that prepares the telemetry records and spools them on disk prior to delivery
-*       **telempostd**, a daemon that sends the records to the telemetry backend server or leaves them on disk until deleting after the record expires.
-
-*	**probes**, that collect specific types of data from the operating system.
-*	**libtelemetry**, that telemetrics probes use to create telemetrics records and
-	send them to the telemprobd daemon for further processing.
-
-
-The telemetry backend provides the server-side component of a complete telemetrics solution and
-consists of:
-
-*	Nginx web server.
-*	Two Flask apps:
-
-	*	Collector, an ingestion web app for records received from telemetrics-client probes.
-	*	TelemetryUI, a web app that exposes several views to visualize the telemetry data
-		and also provides a REST API to perform queries.
-
-*	PostgreSQL as the underlying database server.
-
-The default telemetry backend server reports back to the |CL| development team
-and is not viewable outside the Intel firewall. If you want to collect your
-own records, then you must set up your own telemetry backend server.
-
-Next steps
-**********
-
-To put this concept into practice, refer to :ref:`telem-guide`.
-

_sources/get-started/bare-metal-install-desktop/bare-metal-install-desktop.rst.txt

@@ -1,542 +0,0 @@
-.. _bare-metal-install-desktop:
-
-Install |CL-ATTR| from the live desktop
-#######################################
-
-This page explains how to boot the |CL-ATTR| live desktop image, from which
-you can install |CL| or explore without modifying the host system.
-
-.. contents::
-   :local:
-   :depth: 1
-
-System requirements
-*******************
-
-Before installing |CL|, verify that the host system supports the
-installation:
-
-* :ref:`system-requirements`
-* :ref:`compatibility-check`
-
-Preliminary steps
-*****************
-
-#. Visit our `Downloads`_ page.
-
-#. Download the file :file:`clear-<release number>-live-desktop.iso`,
-   also called the |CL| Desktop.
-
-   .. note::
-
-      <release-number> is the latest |CL| auto-numbered release.
-
-#. Verify and decompress the file per your OS.
-
-   * :ref:`download-verify-decompress`
-
-#. Follow your OS instructions to create a bootable USB drive.
-
-   * :ref:`bootable-usb`
-
-.. _install-on-target-start:
-
-Install from live image
-***********************
-
-After you download and burn the live desktop image on a USB drive, follow
-these steps.
-
-#. Insert the USB drive into an available USB slot.
-
-#. Power on the system.
-
-#. Open the system BIOS setup menu by pressing the :kbd:`F2` key.
-   Your BIOS setup menu entry point may vary.
-
-#. In the setup menu, enable the UEFI boot and set the USB drive as the
-   first option in the device boot order.
-
-#. Save these settings, e.g. :kbd:`F10`, and exit.
-
-#. Reboot the target system.
-
-#. Select :guilabel:`Clear Linux OS` in the boot menu, shown in Figure 1.
-
-   .. figure:: figures/bare-metal-install-desktop-01.png
-      :scale: 100%
-      :alt: Clear Linux OS in boot menu
-
-      Figure 1: Clear Linux OS in boot menu
-
-.. _install-on-target-end:
-
-Software (optional)
-===================
-
-Explore |CL| bundles and other software. Double-click the
-:guilabel:`Software` icon from the Activities menu, shown in Figure 2.
-Ensure a network connection exists before launching the Software application.
-
-.. note::
-
-   While running the |CL| live desktop image, the Software application is
-   intended only for exploration. Do not attempt to install applications during
-   exploration.
-
-Launch the |CL| installer
-=========================
-
-#. After the live desktop image boots, scroll over the vertical
-   :guilabel:`Activities` menu at left.
-
-#. Click the |CL| penguin icon to launch the installer, shown in Figure 2.
-
-   .. figure:: figures/bare-metal-install-desktop-02.png
-      :scale: 100%
-      :alt: Install Clear Linux OS icon
-
-      Figure 2: |CL| installer icon
-
-#. After the installer is launched, it will appear as shown in Figure 3.
-
-   .. figure:: figures/bare-metal-install-desktop-03.png
-      :scale: 100%
-      :alt: |CL| Desktop Installer
-
-      Figure 3: |CL| OS Desktop Installer
-
-#. In :guilabel:`Select Language`, select a language from the options, or
-   type your preferred language in the search bar.
-
-#. Select :guilabel:`Next`.
-
-Checking prerequisites
-======================
-
-The installer automatically launches :guilabel:`Checking Prerequisites`,
-which checks your target system for compatibility and network connectivity.
-
-After the installer shows `Prerequisites passed`, select :guilabel:`Next` to
-proceed with installation.
-
-.. figure:: figures/bare-metal-install-desktop-04.png
-   :scale: 100%
-   :alt: Checking Prerequisites
-
-   Figure 4: Checking Prerequisites
-
-Network Proxy (optional)
-------------------------
-
-#. Configure :guilabel:`Network Proxy` settings.
-
-#. In the top right menu bar, select the :guilabel:`Power button`.
-
-#. Select :guilabel:`Wired Connected` and then :guilabel:`Wired Settings`.
-
-   #. In :guilabel:`Network Proxy`, select the :guilabel:`Gear` icon to view
-      options.
-
-   #. Select an option from `Automatic`, `Manual` or `Disabled`.
-
-   #. Close :guilabel:`Network Proxy`.
-
-#. Close :guilabel:`Settings`.
-
-.. _incl-bare-metal-beta-start:
-
-Minimum installation requirements
-*********************************
-
-To fulfill minimum installation requirements, complete the
-`Required options`_. We also recommend completing `Advanced options`_.
-
-.. note::
-
-   * The :kbd:`Install` button is only highlighted **after** you complete
-     `Required options`_.
-
-   * Check marks indicate a selection has been made.
-
-   * An Internet connection is required. You may want to launch a browser
-     prior to installation to verify your Internet connection.
-
-|CL| Desktop Installer
-**********************
-
-The |CL| Desktop Installer Main Menu appears as shown in Figure 5. To meet
-the minimum requirements, enter values in all submenus for the
-:guilabel:`Required options`. After you complete them, your selections appear
-below submenus and a check mark appears at right.
-
-.. figure:: figures/bare-metal-install-desktop-05.png
-   :scale: 100%
-   :alt: Clear Linux OS Desktop Installer - Main Menu
-
-   Figure 5: Clear Linux OS Desktop Installer - Main Menu
-
-Navigation
-**********
-
-* Use the :kbd:`mouse` to navigate or select options.
-
-* Use :kbd:`Tab` key to navigate between :guilabel:`Required options`
-  and :guilabel:`Advanced options`
-
-* Use :kbd:`Up` or :kbd:`Down` arrow keys to navigate the submenus.
-
-* Select :kbd:`Confirm`, or :kbd:`Cancel` in submenus.
-
-Required options
-****************
-
-Select Time Zone
-================
-
-#. From the Main Menu, select :guilabel:`Select Time Zone`. `UTC` is selected
-   by default.
-
-#. In :guilabel:`Select Time Zone`, navigate to the desired time zone.
-   Or start typing the region and then the city.
-   (.e.g., :file:`America/Los_Angeles`).
-
-#. Select :guilabel:`Confirm`.
-
-   .. figure:: figures/bare-metal-install-desktop-06.png
-      :scale: 100%
-      :alt: Select System Timezone
-
-      Figure 6: Select System Time Zone
-
-Select Keyboard
-===============
-
-#. From the Main Menu, select :guilabel:`Select Keyboard`.
-
-#. Navigate to your desired keyboard layout. We select "us" for the
-   United States.
-
-#. Select :guilabel:`Confirm`.
-
-   .. figure:: figures/bare-metal-install-desktop-07.png
-      :scale: 100%
-      :alt: Select Keyboard menu
-
-      Figure 7: Select Keyboard menu
-
-Select Installation Media
-=========================
-
-#. From the Main Menu, select :guilabel:`Select Installation Media`.
-
-#. Choose an installation method: `Safe Installation`_ or
-   `Destructive Installation`_.
-
-   .. figure:: figures/bare-metal-install-desktop-08.png
-      :scale: 100%
-      :alt: Select Installation Media
-
-      Figure 8: Select Installation Media
-
-Safe Installation
------------------
-
-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
-------------------------
-
-Use this method to destroy the contents of the target device, install |CL|
-on it, and accept the `Default partition schema`_.
-
-Disk encryption
-===============
-
-For greater security, disk encryption is supported using LUKS. Encryption is
-optional.
-
-#. To encrypt the root partition, select :guilabel:`Enable Encryption`,
-   as shown in Figure 9.
-
-   .. figure:: figures/bare-metal-install-desktop-09.png
-      :scale: 100%
-      :alt: Enable Encryption
-
-      Figure 9: Enable Encryption
-
-#. When :guilabel:`Encryption Passphrase` appears, enter a passphrase.
-
-   .. figure:: figures/bare-metal-install-desktop-10.png
-      :scale: 100%
-      :alt: Encryption Passphrase
-
-      Figure 10: Encryption Passphrase
-
-   .. note::
-
-      Minimum length is 8 characters. Maximum length is 94 characters.
-
-#. Enter the same passphrase in the second field.
-
-#. Select :guilabel:`Confirm` in the dialogue box.
-
-   .. note::
-
-      :guilabel:`Confirm` is only highlighted if passphrases match.
-
-#. Select :guilabel:`Confirm` in submenu.
-
-Manage User
-===========
-
-#. In Required Options, select :guilabel:`Manage User`.
-
-#. In :guilabel:`User Name`, enter a user name.
-
-   .. figure:: figures/bare-metal-install-desktop-11.png
-      :scale: 100%
-      :alt: Manage User
-
-      Figure 11: Manage User
-
-#. In :guilabel:`Login`, create a login name. It must start with a letter
-   and can use numbers, hyphens, and underscores. Maximum length is 31
-   characters.
-
-#. In :guilabel:`Password`, enter a password. Minimum length is
-   8 characters. Maximum length is 255 characters.
-
-#. In :guilabel:`Confirm`, enter the same password.
-
-   .. note::
-
-      :guilabel:`Administrator` rights are selected by default.
-      For security purposes, the default user must be assigned as an
-      Administrator.
-
-#. Select :kbd:`Confirm`.
-
-   .. note::
-
-      Select :guilabel:`Cancel` to return to the Main Menu.
-
-Modify User
------------
-
-#. In Manager User, select :guilabel:`Manage User`.
-
-#. Modify user details as desired.
-
-#. Select :guilabel:`Confirm` to save the changes you made.
-
-   .. note::
-
-      Optional: Select :guilabel:`Cancel` to return to the Main Menu to
-      revert changes.
-
-Optional: Skip to `Finish installation`_.
-
-Telemetry
-=========
-
-Choose whether to participate in `telemetry`. :ref:`telem-guide` is a |CL|
-feature that reports failures and crashes to the |CL| development
-team for improvements. For more information, see :ref:`telemetry-about`.
-
-#. From :guilabel:`Required Options`, select :guilabel:`Telemetry`.
-
-#. Select :kbd:`Yes`.
-
-   .. figure:: figures/bare-metal-install-desktop-12.png
-      :scale: 100%
-      :alt: Enable Telemetry
-
-      Figure 12: Enable Telemetry
-
-#. If you don't wish to participate, select :kbd:`No`.
-
-Advanced options
-****************
-
-After you complete the `Required options`_, we recommend completing
-:guilabel:`Advanced options`--though they're not required. Doing so
-customizes your development environment, so you're ready to go immediately
-after reboot.
-
-.. note::
-
-   You can always add more bundles later with :ref:`swupd-guide`.
-
-Bundle Selection
-================
-
-#. On the Advanced menu, select :guilabel:`Bundle Selection`
-
-#. Select your desired bundles.
-
-   .. figure:: figures/bare-metal-install-desktop-13.png
-      :scale: 100%
-      :alt: Bundle Selection
-
-      Figure 13: Bundle Selection
-
-#. Select :kbd:`Confirm`.
-
-#. View the bundles that you selected.
-
-   .. figure:: figures/bare-metal-install-desktop-14.png
-      :scale: 100%
-      :alt: Bundle Selections - Advanced Options
-
-      Figure 14: Bundle Selections - Advanced Options
-
-Optional: Skip to `Finish installation`_.
-
-Assign Hostname
-===============
-
-#. In Advanced Options, select :guilabel:`Assign Hostname`.
-
-#. In :guilabel:`Hostname`, enter the hostname only (excluding the domain).
-
-   .. figure:: figures/bare-metal-install-desktop-15.png
-      :scale: 100%
-      :alt: Assign Hostname
-
-      Figure 15: Assign Hostname
-
-   .. note::
-
-      Hostname does not allow empty spaces. Hostname must start with an
-      alphanumeric character but may also contain hyphens. Maximum length of
-      63 characters.
-
-#. Select :kbd:`Confirm`.
-
-Optional: Skip to `Finish installation`_.
-
-Kernel Configuration
-====================
-
-#. In :guilabel:`Kernel Configuration`, navigate to select your desired
-   kernel. :guilabel:`Native` is selected by default.
-
-   .. figure:: figures/bare-metal-install-desktop-16.png
-      :scale: 100%
-      :alt: Kernel Configuration
-
-      Figure 16: Kernel Configuration
-
-#. To add arguments, enter the argument in :guilabel:`Add Extra Arguments`.
-
-#. To remove an argument, enter the argument in :guilabel:`Remove Arguments`.
-
-#. Select :kbd:`Confirm`.
-
-Software Updater Configuration
-==============================
-
-#. In Advanced Options, select :guilabel:`Software Updater Configuration`.
-
-#. In :guilabel:`Mirror URL`, follow the instructions if you wish to
-   specify a different installation source.
-
-#. :guilabel:`Enable Auto Updates` is selected by default. If you **do not**
-   wish to enable automatic software updates, uncheck the box.
-
-   .. figure:: figures/bare-metal-install-desktop-17.png
-      :scale: 100%
-      :alt: Software Updater Configuration
-
-      Figure 17: Software Updater Configuration
-
-#. Select :kbd:`Confirm`.
-
-Finish installation
-*******************
-
-#. When you are satisfied with your installation configuration, select
-   :guilabel:`Install`.
-
-   .. figure:: figures/bare-metal-install-desktop-18.png
-      :scale: 100%
-      :alt: Assign Hostname
-
-      Figure 18: Finish installation
-
-   .. note:
-
-      All check marks must appear in :guilabel:`Required Options` for the
-      :guilabel:`Install` button to be enabled.
-
-#. If you do not enter a selection for all :guilabel:`Required Options`,
-   the :guilabel:`Install` button remains disabled, as shown
-   in Figure 19. Return to `Required Options`_ and make selections.
-
-   .. figure:: figures/bare-metal-install-desktop-19.png
-      :scale: 100%
-      :alt: Required Options - Incomplete
-
-      Figure 19: Required Options - Incomplete
-
-#. After installation is complete, select :guilabel:`Exit`.
-
-#. Shut down the target system.
-
-#. Remove the USB or any installation media.
-
-#. Power on your system.
-
-   .. note::
-
-      Allow time for the graphical login to appear. A login prompt shows the administrative user that you created.
-
-#. Log in as the administrative user.
-
-Congratulations. You successfully installed |CL|.
-
-Default partition schema
-========================
-
-Create partitions per requirements in Table 1.
-
-.. list-table:: **Table 1. Default partition schema**
-   :widths: 25, 25, 25, 25
-   :header-rows: 1
-
-   * - FileSystem
-     - Label
-     - Mount Point
-     - Default size
-
-   * - **VFAT(FAT32)**
-     - boot
-     - /boot
-     - 150MB
-
-   * - **linux-swap**
-     - swap
-     -
-     - 256MB
-
-   * - **ext[234] or XFS**
-     - root
-     - /
-     - *Size depends upon use case/desired bundles.*
-
-.. _Downloads: https://clearlinux.org/downloads
-
-

_sources/get-started/bare-metal-install-server/bare-metal-install-server.rst.txt

@@ -1,869 +0,0 @@
-.. _bare-metal-install-server:
-
-Install |CL-ATTR| on bare metal with live server
-################################################
-
-This page explains how to install |CL-ATTR| on bare metal from a bootable USB
-drive using a live server image.
-
-.. contents::
-   :local:
-   :depth: 1
-
-System requirements
-*******************
-
-Before installing |CL|, verify that the host system supports the
-installation:
-
-* :ref:`system-requirements`
-* :ref:`compatibility-check`
-
-Download the latest |CL| live server image
-******************************************
-
-Get the latest |CL| installer image from the `Downloads`_ page. Look for the
-:file:`clear-[version number]-live-server.iso` file.
-
-#. Verify and decompress the file per your OS.
-
-   * :ref:`download-verify-decompress`
-
-#. Follow your OS instructions to create a bootable USB drive.
-
-   * :ref:`bootable-usb`
-
-Install |CL| on your target system
-**********************************
-
-Ensure that your system is configured to boot UEFI. The installation method
-described below requires a wired Internet connection with DHCP.
-
-.. note::
-
-   Alternatively, you can install |CL| over a wireless connection by first
-   using `nmtui`. Follow the `nmtui` instructions shown in Figure 2.
-
-Follow these steps to install |CL| on the target system:
-
-#. Insert the USB drive into an available USB slot.
-
-#. Power on the system.
-
-#. Open the system BIOS setup menu by pressing the :kbd:`F2` key.
-   Your BIOS setup menu entry point may vary.
-
-   .. note::
-      |CL| supports UEFI boot. Some hardware may list UEFI and non-UEFI USB
-      boot entries. In this case, you should select the `UEFI` boot
-      option.
-
-#. In the setup menu, enable the UEFI boot and set the USB drive as the first
-   option in the device boot order.
-
-#. Save these settings and exit.
-
-#. Reboot the target system.
-
-#. This action launches the |CL| installer boot menu, shown in figure 1.
-
-   .. figure:: figures/bare-metal-install-server-01.png
-      :scale: 100%
-      :alt: Clear Linux OS Installer boot menu
-
-      Figure 1: Clear Linux OS Installer boot menu
-
-#. With :guilabel:`Clear Linux OS` highlighted, select :kbd:`Enter`.
-
-Launch the |CL| Installer
-*************************
-
-#. At the :guilabel:`login` prompt, enter :command:`root`.
-
-#. Follow the onscreen instructions, shown in Figure 2, and
-   enter a temporary password.
-
-   .. figure:: figures/bare-metal-install-server-02.png
-      :scale: 100%
-      :alt: root login
-
-      Figure 2: root login
-
-#. At the :guilabel:`root` prompt, enter :command:`clr-installer` and
-   press :kbd:`Enter`.
-
-   .. figure:: figures/bare-metal-install-server-03.png
-      :scale: 100%
-      :alt: clr-installer command
-
-      Figure 3: clr-installer command
-
-Minimum installation requirements
-*********************************
-
-To fulfill minimum installation requirements, complete the
-`Required options`_. While not required, we encourage you to apply the
-`Recommended options`_. `Advanced options`_ are optional.
-
-.. note::
-
-   * The :kbd:`Install` button is **only highlighted after** you complete
-     `Required options`_.
-
-Main Menu
-*********
-The |CL| Installer Main Menu appears as shown in Figure 4.
-
-.. figure:: figures/bare-metal-install-server-04.png
-   :scale: 100%
-   :alt: Clear Linux OS Installer
-
-   Figure 4: Clear Linux OS Installer
-
-The |CL| Installer Main Menu has two tabs: :guilabel:`[R] Required options`
-and :guilabel:`[A] Advanced options`. Navigate between tabs using the arrow
-these shortcut keys:
-
-* :kbd:`Shift+A` for :guilabel:`[A] Advanced options`
-* :kbd:`Shift+R` for :guilabel:`[R] Required options`
-
-To meet the minimum requirements, enter your choices in the
-:guilabel:`Required options`. After confirmation, your selections appear
-beside the :guilabel:`>>` chevron, below the menu options.
-
-Navigation
-**********
-
-* Select :kbd:`Tab` or :kbd:`Up/Down` arrows to highlight your choice.
-
-* Select :kbd:`Enter` or :kbd:`Spacebar` to confirm your choice.
-
-* Select :kbd:`Cancel` or :kbd:`Esc` to cancel your choice.
-
-Required options
-****************
-
-Choose Timezone
-===============
-
-#. From the Main Menu, navigate to :guilabel:`Choose Timezone`.
-   `UTC` is the default.
-
-#. Select :kbd:`Enter`.
-
-#. In :guilabel:`Select System Timezone`, use :kbd:`Up/Down` arrows
-   navigate to the desired timezone.
-
-.. todo: User need only select Enter; can only select Confirm with mouse.
-
-#. Press :kbd:`Enter` to confirm.
-
-   .. figure:: figures/bare-metal-install-server-05.png
-      :scale: 100%
-      :alt: Select System Timezone
-
-      Figure 5: Select System Timezone
-
-Choose Language
-===============
-
-#. From the Main Menu, navigate to :guilabel:`Choose Language`.
-
-#. Select :kbd:`Enter`.
-
-#. In :guilabel:`Select System Language`, navigate to your desired language.
-
-#. Press :kbd:`Enter` to confirm.
-
-   .. figure:: figures/bare-metal-install-server-06.png
-      :scale: 100%
-      :alt: Select System Language
-
-      Figure 6: Select System Language
-
-Configure the Keyboard
-======================
-
-#. From the Main Menu, select :guilabel:`Configure the Keyboard`.
-
-#. Select :kbd:`Enter`.
-
-#. In :guilabel:`Select Keyboard`, navigate to the desired option.
-
-#. Select :kbd:`Enter` to :kbd:`Confirm`.
-
-#. Optional: In :guilabel:`Test keyboard`, type text to assure
-   that the keys map to your keyboard.
-
-   .. figure:: figures/bare-metal-install-server-07.png
-      :scale: 100%
-      :alt: Select Keyboard menu
-
-      Figure 7: Select Keyboard menu
-
-Configure Installation Media
-============================
-
-#. From the Main Menu, select :guilabel:`Configure Installation Media`.
-
-#. Choose an installation method:
-   * `Safe Installation`_
-   * `Destructive Installation`_
-   * `Advanced Configuration`_
-
-
-   .. figure:: figures/bare-metal-install-server-08.png
-      :scale: 100%
-      :alt: Select Installation Media
-
-      Figure 8: Select Installation Media
-
-#. Select :guilabel:`Rescan Media` to show available installation targets.
-
-.. todo: Revise below section to match the dev-gui-00
-
-Safe Installation
------------------
-
-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. See also
-`Troubleshooting`_ below.
-
-Destructive Installation
-------------------------
-
-Use this method to destroy the contents of the target device, install |CL|
-on it, and accept the `Default partition schema`_.
-
-.. note::
-
-   From the :guilabel:`Select Installation Media` menu, select
-   :guilabel:`Enable Encryption` to encrypt the root filesystem for either
-   option above. See also `Disk encryption`_ for more information.
-
-Advanced Configuration
-----------------------
-
-Use this method to manually configure partitions. These must meet
-`Default partition schema`_. You may also choose `Disk encryption`_ during
-configuration of each partition.
-
-.. note::
-
-   `Advanced Configuration` is available in the installer versions 1.2.0 and
-   above.
-
-#. From :guilabel:`Select Installation Media`, shown in Figure 8 above,
-   select :guilabel:`Advanced Configuration`.
-
-#. In :guilabel:`Advanced Configuration`, navigate to :file:`/dev/sda`
-   and then press :kbd:`Enter`.
-
-   .. figure:: figures/bare-metal-install-server-09.png
-      :scale: 100%
-      :alt: Advanced configuration menu
-
-      Figure 9: Advanced configuration menu
-
-#. Choose a partition method:
-
-   * :guilabel:`Auto Partition` Select this option to accept the
-     `Default partition schema`_.
-
-     #. Navigate to and press :guilabel:`Confirm`.
-
-     #. Continue with installation configuration. Jump to `Telemetry`_.
-
-   * `Manual Partition`_ Continue below.
-
-Manual Partition
-----------------
-
-We provide a simple example below.
-
-#. Navigate to the unallocated media (e.g.,`/dev/sda`) until highlighted, as
-   shown in Figure 9.
-
-#. Press :guilabel:`Enter` to edit the partition.
-
-#. The :guilabel:`Partition Setup` menu appears, shown in Figure 10.
-
-   .. note::
-
-      After adding the first partition, select :guilabel:`Free Space` to add another partition.
-
-root partition
---------------
-
-#. We configure the `root` partition as shown in Figure 10.
-   Configuration of the `root` partition varies.
-
-   .. figure:: figures/bare-metal-install-server-10.png
-      :scale: 100%
-      :alt: root partition
-
-      Figure 10: root partition
-
-#. Navigate to :guilabel:`Add` and press :guilabel:`Enter`.
-
-boot partition
---------------
-
-#. We configure the `boot` partition as shown in Figure 11.
-
-   .. figure:: figures/bare-metal-install-server-11.png
-      :scale: 100%
-      :alt: boot partition
-
-      Figure 11: boot partition
-
-#. Navigate to :guilabel:`Add` and press :guilabel:`Enter`.
-
-swap partition
---------------
-
-#. In the :guilabel:`File System` pulldown menu, select `swap`, and
-   enter a label. We enter the minimum required size (e.g., 256M).
-
-   .. figure:: figures/bare-metal-install-server-12.png
-      :scale: 100%
-      :alt: swap partition
-
-      Figure 12: swap partition
-
-#. Navigate to :guilabel:`Add` and press :guilabel:`Enter`.
-
-#. Next, navigate to :guilabel:`Confirm` and press :guilabel:`Enter`,
-   shown in Figure 13.
-
-   Manual partitioning is complete.
-
-   .. figure:: figures/bare-metal-install-server-13.png
-      :scale: 100%
-      :alt: Final configuration of disk partitions
-
-      Figure 13: Final configuration of disk partitions
-
-#. You may skip to the `Telemetry`_ section below.
-
-Disk encryption
-===============
-
-For greater security, disk encryption is supported using LUKS for the
-any partition except `/boot` on |CL|. To encrypt the root partition, see the
-example below. Encryption is optional.
-
-Encryption Passphrase
----------------------
-
-|CL| uses a single passphrase for encrypted partitions. Additional keys may
-be configured post-installation using the ``cryptsetup`` tool.
-
-#. Optional: Select :guilabel:`[X] Encrypt` to encrypt the root partition,
-   as shown in Figure 14.
-
-   .. figure:: figures/bare-metal-install-server-14.png
-      :scale: 100%
-      :alt: Encrypt partition
-
-      Figure 14: Encrypt partition
-
-#. The :guilabel:`Encryption Passphrase` dialogue appears.
-
-   .. note::
-
-      Minimum length is 8 characters. Maximum length is 94 characters.
-
-   .. figure:: figures/bare-metal-install-server-15.png
-      :scale: 100%
-      :alt: Encryption Passphrase
-
-      Figure 15: Encryption Passphrase
-
-#. Enter the same passphrase in the first and second field.
-
-#. Navigate to :guilabel:`Confirm` and press :kbd:`Enter`.
-
-   .. note::
-
-      :guilabel:`Confirm` is only highlighted if passphrases match.
-
-Telemetry
-=========
-
-:ref:`telem-guide` is a |CL| feature that reports failures and crashes to
-the |CL| development team for improvements. For more detailed information,
-visit our :ref:`telemetry-about` page.
-
-Select your desired option on whether to participate in `telemetry`.
-
-#. In the Main Menu, navigate to :guilabel:`Telemetry` and select
-   :kbd:`Enter`.
-
-#. Select :kbd:`Tab` to highlight your choice.
-
-#. Select :kbd:`Enter` to confirm.
-
-   .. figure:: figures/bare-metal-install-server-16.png
-      :scale: 100%
-      :alt: Enable Telemetry
-
-      Figure 16: Enable Telemetry
-
-Recommended options
-*******************
-
-After you complete the `Required options`_, we highly recommend completing
-these selected `Advanced options`_ at minimum:
-
-* `Manage User`_ Assign a new user with administrative rights
-* `Assign Hostname`_ Simplify your development environment
-
-Skip to finish installation
-===========================
-
-After selecting values for all :guilabel:`Required options`, you may skip
-to `Finish installation`_.
-
-Otherwise, continue below. In the Main Menu, select
-:guilabel:`Advanced options` for additional configuration.
-
-Advanced options
-****************
-
-Configure Network Interfaces
-============================
-
-By default, |CL| is configured to automatically detect the host network
-interface using DHCP. However, if you want to use a static IP address or if
-you do not have a DHCP server on your network, follow these instructions to
-manually configure the network interface. Otherwise, default network
-interface settings are automatically applied.
-
-.. note::
-
-   If DHCP is available, no user selection may be required.
-
-#. Navigate to :guilabel:`Configure Network Interfaces` and
-   select :kbd:`Enter`.
-
-#. Navigate to the network :guilabel:`interface` you wish to change.
-
-#. When the desired :guilabel:`interface` is highlighted, select
-   :guilabel:`Enter` to edit.
-
-   .. note:: Multiple network interfaces may appear.
-
-   .. figure:: figures/bare-metal-install-server-17.png
-      :scale: 100%
-      :alt: Configure Network Interfaces
-
-      Figure 17: Configure Network Interfaces
-
-#. Notice :guilabel:`Automatic / dhcp` is selected by default (at bottom).
-
-   Optional: Navigate to the checkbox :guilabel:`Automatic / dhcp` and select
-   :kbd:`Spacebar` to deselect.
-
-   .. figure:: figures/bare-metal-install-server-18.png
-      :scale: 100%
-      :alt: Network interface configuration
-
-      Figure 18: Network interface configuration
-
-#. Navigate to the appropriate fields and assign the desired
-   network configuration.
-
-#. To save settings, navigate to :guilabel:`Confirm` and select
-   :kbd:`Enter`.
-
-   .. note::
-
-      To revert to previous settings, navigate to the :guilabel:`Cancel`
-      and select :kbd:`Enter`.
-
-#. Upon confirming network configuration, the :guilabel:`Testing Networking`
-   dialogue appears. Assure the result shows success. If a failure occurs,
-   your changes will not be saved.
-
-#. Upon confirmation, you are returned to :guilabel:`Network interface`
-   settings.
-
-#. Navigate to and select :guilabel:`Main Menu`.
-
-Optional: Skip to `Finish installation`_.
-
-Proxy
-=====
-
-|CL| automatically attempts to detect proxy settings, as described in
-:ref:`autoproxy`. If you need to manually assign proxy settings, follow this
-instruction.
-
-#. From the Advanced options menu, navigate to :guilabel:`Proxy`, and
-   select :kbd:`Enter`.
-
-#. Navigate to the field :guilabel:`HTTPS Proxy`.
-
-   .. figure:: figures/bare-metal-install-server-19.png
-      :scale: 100%
-      :alt: Configure the network proxy
-
-      Figure 19: Configure the network proxy
-
-#. Enter the desired proxy address and port using conventional syntax,
-   such as: \http://address:port.
-
-#. Navigate to :guilabel:`Confirm` and select :kbd:`Enter`.
-
-#. To revert to previous settings, navigate to :guilabel:`Cancel`
-   and select :guilabel:`Cancel`.
-
-Optional: Skip to `Finish installation`_.
-
-Test Network Settings
-=====================
-
-To manually assure network connectivity before installing |CL|,
-select :guilabel:`Test Network Settings` and select :guilabel:`Enter`.
-
-A progress bar appears as shown in Figure 20.
-
-.. figure:: figures/bare-metal-install-server-20.png
-   :scale: 100%
-   :alt: Testing Networking dialogue
-
-   Figure 20: Testing Networking dialogue
-
-.. note::
-
-   Any changes made to network settings are automatically tested
-   during configuration.
-
-Optional: Skip to `Finish installation`_.
-
-Bundle Selection
-================
-
-#. On the Advanced menu, select :guilabel:`Bundle Selection`
-
-#. Navigate to the desired bundle using :kbd:`Tab` or :kbd:`Up/Down` arrows.
-
-#. Select :kbd:`Spacebar` to select the checkbox for each desired bundle.
-
-   .. figure:: figures/bare-metal-install-server-21.png
-      :scale: 100%
-      :alt: Bundle Selection
-
-      Figure 21: Bundle Selection
-
-#. Optional: To start developing with |CL|, we recommend
-   adding :file:`os-clr-on-clr`.
-
-#. Navigate to and select :kbd:`Confirm`.
-
-   You are returned to the :guilabel:`Advanced options` menu.
-
-Optional: Skip to `Finish installation`_.
-
-Manage User
-===========
-
-Add New User
-------------
-
-#. In Advanced Options, select :guilabel:`Manage User`.
-
-#. Select :guilabel:`Add New User` as shown in Figure 22.
-
-   .. figure:: figures/bare-metal-install-server-22.png
-      :scale: 100%
-      :alt: Add New User, User Name
-
-      Figure 22: Add New User
-
-#. Optional: Enter a :guilabel:`User Name`.
-
-   .. note:
-
-      The User Name must be alphanumeric and can include spaces, commas, or hyphens. Maximum length is 64 characters.
-
-   .. figure:: figures/bare-metal-install-server-23.png
-      :scale: 100%
-      :alt: User Name
-
-      Figure 23: User Name
-
-#. Enter a :guilabel:`Login`.
-
-   .. note::
-
-      The User Login must be alphanumeric and can include hyphens and underscores. Maximum length is 31 characters.
-
-#. Enter a :guilabel:`Password`.
-
-   .. note:
-
-      Minimum length is 8 characters. Maximum length is 255 characters.
-
-#. In :guilabel:`Confirm`, enter the same password.
-
-#. Optional: Navigate to the :guilabel:`Administrative` checkbox and select
-   :kbd:`Spacebar` to assign administrative rights to the user.
-
-   .. note::
-
-      Selecting this option enables sudo privileges for the user.
-
-#. Select :kbd:`Confirm`.
-
-   .. note::
-
-      If desired, select :guilabel:`Reset` to reset the form.
-
-#. In :guilabel:`Manage User`, navigate to :guilabel:`Confirm`.
-
-#. With :guilabel:`Confirm` highlighted, select :kbd:`Enter`.
-
-Modify / Delete User
---------------------
-
-#. In :guilabel:`Manage User`, navigate to the user you wish
-   to modify until highlighted, as shown in Figure 24.
-
-#. Select :kbd:`Enter` to modify the user.
-
-   .. figure:: figures/bare-metal-install-server-24.png
-      :scale: 100%
-      :alt: Modify User
-
-      Figure 24: Modify User
-
-#. Modify user details as desired.
-
-#. Navigate to :kbd:`Confirm` until highlighted.
-
-   .. note::
-
-      Optional: Select :guilabel:`Reset` to rest the form.
-
-#. Select :guilabel:`Confirm` to save the changes you made.
-
-#. Optional: In :guilabel:`Modify User`, to delete the user, navigate to
-   the :guilabel:`Delete` button and select :kbd:`Enter`.
-
-   .. figure:: figures/bare-metal-install-server-25.png
-      :scale: 100%
-      :alt: Delete User
-
-      Figure 25: Delete User
-
-You are returned to :guilabel:`Manage User`.
-
-#. Navigate to :kbd:`Confirm` until highlighted.
-
-#. Select :guilabel:`Enter` to complete :guilabel:`Manage User` options.
-
-Optional: Skip to `Finish installation`_.
-
-Kernel Command Line
-===================
-
-For advanced users, |CL| provides the ability to add or remove kernel
-arguments. If you want to append a new argument, enter the argument here.
-This argument will be used every time you install or update a
-new kernel.
-
-#. In Advanced Options, select :guilabel:`Tab` to highlight
-   :guilabel:`Kernel Command Line`.
-
-#. Select :kbd:`Enter`.
-
-   .. figure:: figures/bare-metal-install-server-26.png
-      :scale: 100%
-      :alt: kernel command line
-
-      Figure 26: kernel command line
-
-#. Choose from the following options.
-
-   * To add arguments, enter the argument in :guilabel:`Add Extra Arguments`.
-
-   * To remove an argument, enter the argument in
-     :guilabel:`Remove Arguments`.
-
-#. Select :kbd:`Confirm`.
-
-Optional: Skip to `Finish installation`_.
-
-Kernel Selection
-================
-
-#. Select a kernel option. By default, the latest kernel release is
-   selected. Native kernel is shown in Figure 27.
-
-#. To select a different kernel, navigate to it using :guilabel:`Tab`.
-
-   .. figure:: figures/bare-metal-install-server-27.png
-      :scale: 100%
-      :alt: Kernel selection
-
-      Figure 27: Kernel selection
-
-#. Select :kbd:`Spacebar` to select the desired option.
-
-#. Navigate to :kbd:`Confirm` and select :kbd:`Enter`.
-
-Optional: Skip to `Finish installation`_.
-
-Swupd Mirror
-============
-
-If you have your own custom mirror of |CL|, you can add its URL.
-
-#. In Advanced Options, select :guilabel:`Swupd Mirror`.
-
-#. To add a local swupd mirror, enter a valid URL in :guilabel:`Mirror URL:`
-
-#. Select :kbd:`Confirm`.
-
-   .. figure:: figures/bare-metal-install-server-28.png
-      :scale: 100%
-      :alt: Swupd Mirror
-
-      Figure 28: Swupd Mirror
-
-Optional: Skip to `Finish installation`_.
-
-Assign Hostname
-===============
-
-#. In Advanced Options, select :guilabel:`Assign Hostname`.
-
-#. In :guilabel:`Hostname`, enter the hostname only (excluding the domain).
-
-   .. note::
-
-      Hostname does not allow empty spaces. Hostname must start with an
-      alphanumeric character but may also contain hyphens. Maximum length of
-      63 characters.
-
-   .. figure:: figures/bare-metal-install-server-29.png
-      :scale: 100%
-      :alt: Assign Hostname
-
-      Figure 29: Assign Hostname
-
-#. Navigate to :kbd:`Confirm` until highlighted.
-
-#. Select :kbd:`Confirm`.
-
-Optional: Skip to `Finish installation`_.
-
-Automatic OS Updates
-====================
-
-Automatical OS updates are enabled by default. In the rare case that you
-need to disable automatic software updates, follow the onscreen instructions,
-shown in Figure 30.
-
-#. In Advanced Options, select :guilabel:`Automatic OS Updates`.
-
-#. Select the desired option.
-
-   .. figure:: figures/bare-metal-install-server-30.png
-      :scale: 100%
-      :alt: Automatic OS Updates
-
-      Figure 30: Automatic OS Updates
-
-You are returned to the :guilabel:`Main Menu`.
-
-Save Configuration Settings
-===========================
-
-#. In Advanced Options, select :guilabel:`Save Configuration Settings`.
-
-#. A dialogue box shows the installation configuration was saved to
-   :file:`clr-installer.yaml`
-
-   .. figure:: figures/bare-metal-install-server-31.png
-      :scale: 100%
-      :alt: Automatic OS Updates
-
-      Figure 31: Automatic OS Updates
-
-#. Use the :file:`clr-installer.yaml` file to install |CL|, with the same
-   configuration, on multiple targets.
-
-Finish installation
-*******************
-
-#. When you are satisfied with your installation configuration, navigate to
-   :guilabel:`Install` and select :kbd:`Enter`.
-
-   .. figure:: figures/bare-metal-install-server-32.png
-      :scale: 100%
-      :alt: Select Install
-
-      Figure 32: Select Install
-
-#. Select :guilabel:`reboot`.
-
-   .. note::
-
-      If you do not assign an administrative user, upon rebooting,
-      enter `root` and set the root password immediately.
-
-#. When the system reboots, remove any installation media present.
-
-Default partition schema
-========================
-
-Create partitions per requirements in Table 1.
-
-.. list-table:: **Table 1. Default partition schema**
-   :widths: 25, 25, 25, 25
-   :header-rows: 1
-
-   * - FileSystem
-     - Label
-     - Mount Point
-     - Default size
-
-   * - ``VFAT(FAT32)``
-     - boot
-     - /boot
-     - 150MB
-
-   * - ``linux-swap``
-     - swap
-     -
-     - 256MB
-
-   * - ``ext[234] or XFS``
-     - root
-     - /
-     - *Size depends upon use case/desired bundles.*
-
-Troubleshooting
-***************
-
-For Configure Installation Media
-================================
-
-If a warning message appears that no media or space is available after
-entering :guilabel:`Configure Installation Media`:
-
-- Verify that target media has enough free space.
-
-- Confirm the USB is properly connected to and mounted on target media.
-
-- Review the size of existing partitions on the target media:
-
-  - Linux\* OS: :command:`lsblk -a`
-  - Windows\* OS:  :command:`diskpart`, then :command:`list disk`
-  - macOS\* platform: :command:`diskutil list`
-
-.. _Downloads: https://clearlinux.org/downloads

_sources/get-started/get-started.rst.txt

@@ -1,49 +0,0 @@
-.. _get-started:
-
-Get started
-###########
-
-The Get Started section guides you through the requirements and installation of
-|CL-ATTR|. Follow these step-by-step intructions to get started with |CL|, fast.
-
-Pre-install
-***********
-
-There are a couple of things to take care of before you install.
-
-* :ref:`system-requirements`
-* :ref:`compatibility-check`
-* :ref:`bootable-usb`
-
-When installing |CL-ATTR| in a VM, consider which kernel to use. 
-
-* :ref:`Compatible VM kernels <vm-kernels>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   compatibility-check
-   bootable-usb/bootable-usb
-
-Install
-*******
-
-.. toctree::
-   :maxdepth: 1
-
-   bare-metal-install-desktop/bare-metal-install-desktop
-   bare-metal-install-server/bare-metal-install-server
-   install-configfile
-
-.. _virtual-machine-install:
-
-Install in a virtual machine
-****************************
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   virtual-machine-install/*
-   ../../guides/maintenance/increase-virtual-disk-size.rst

_sources/get-started/virtual-machine-install/gce.rst.txt

@@ -1,266 +0,0 @@
-.. _gce:
-
-Launch |CL-ATTR| Compute Engine on Google Cloud Platform\*
-##########################################################
-
-This page explains the steps to create a virtual machine instance of
-|CL-ATTR| on `Google Cloud Platform`_ (:abbr:`GCP (Google Cloud Platform)`).
-
-.. contents::
-   :local:
-   :depth: 1
-
-Prerequisites
-*************
-
-* Set up a Google account and a GCP billing account.
-
-* Generate and install a user SSH key in the Linux PCs that will connect to
-  the VMs in GCP.
-
-Setup |CL| VM on GCP
-********************
-
-#. Sign in to your Google\* account on the
-   `Google Cloud Console <https://console.cloud.google.com/>`_:
-
-   .. figure:: figures/gce/00-sign-in.png
-      :scale: 50 %
-      :alt: Sign in to Google services
-
-      Figure 1: Google sign in screen
-
-#. Google Cloud Platform uses **Projects** to manage resources.
-   Select or create a new project for hosting the |CL| VM.
-
-   .. note::
-
-      Refer to the
-      `Quickstart Using a Linux VM <https://cloud.google.com/compute/docs/quickstart-linux>`_
-      guide to learn about the process of creating VM instances on GCP.
-
-#. Navigate to the latest |CL|
-   `release folder <https://download.clearlinux.org/releases/current/clear/>`_
-   to view the currently released :abbr:`GCE (Google Compute Engine\*)`
-   image, and download the :file:`clear-<release number>-gce.tar.gz`
-   image archive.
-
-   You don't need to uncompress the image archive, the intact file will
-   be uploaded to the Google Cloud Storage later.
-
-#. Create a *Storage Bucket* for hosting the |CL| image source archive
-   downloaded in the previous step:
-
-   * Click the :guilabel:`Navigation menu` icon on the upper left screen menu.
-
-   * Select the :menuselection:`Storage` item from the side bar on the left. You
-     will be sent to the Storage Browser tool or the Cloud Storage overview page.
-
-   .. figure:: figures/gce/01-cloud-storage.png
-      :scale: 50 %
-      :alt: Browse Google Cloud Storage
-
-      Figure 2: Browse Google Cloud Storage
-
-   .. note::
-      You may need to create a billing account and link to this project
-      before you create a bucket.
-
-   .. figure:: figures/gce/02-storage-browser.png
-      :scale: 50 %
-      :alt: Cloud Storage Browser tool
-
-      Figure 3: Cloud Storage Browser tool
-
-   * Click the :guilabel:`CREATE BUCKET` button to enter the bucket creation tool.
-     The bucket name must be unique because buckets in the Cloud Storage share
-     a single global namespace.
-
-     Leave the remaining options set to the defaults, and click the
-     :guilabel:`Create` button at the bottom to create a *Bucket*.
-
-     .. figure:: figures/gce/03-create-bucket.png
-        :scale: 50 %
-        :alt: Set a unique bucket name
-
-        Figure 4: Set bucket name
-
-#. Once the bucket is created, click the :guilabel:`Upload files` button
-   on the Bucket details page to upload the |CL| GCE image archive
-   to the named bucket:
-
-   .. figure:: figures/gce/04-bucket-created.png
-      :scale: 50 %
-      :alt: Cloud Storage bucket is available for storing objects
-
-      Figure 5: Cloud Storage bucket
-
-   .. figure:: figures/gce/10-image-upload.png
-      :scale: 50 %
-      :alt: Uploading the image source archive file
-
-      Figure 6: Uploading the image source archive file
-
-   .. figure:: figures/gce/11-bucket-uploaded.png
-      :scale: 50 %
-      :alt: Image archive imported complete
-
-      Figure 7: Importing complete
-
-#. Browse the Compute Engine Image library page:
-
-   * Click the :guilabel:`Navigation menu` icon on the upper left screen menu.
-
-   * Select the :menuselection:`Compute Engine --> Images` from the side bar on
-     the left.
-
-     .. figure:: figures/gce/20-gce-image.png
-        :scale: 50 %
-        :alt: Go to Google Compute Engine Image library
-
-        Figure 8: Image library
-
-#. On the Compute Engine Image library page, click the :guilabel:`[+] CREATE IMAGE`
-   menu item to create a custom image:
-
-   .. figure:: figures/gce/20-image-library.png
-      :scale: 50 %
-      :alt: Create a Google Compute Engine image
-
-      Figure 9: Create image
-
-#. In the VM image creation page, change the image source type to
-   *Cloud Storage file*.
-
-#. Under :guilabel:`Source`, select :guilabel:`Browse`.
-
-#. Locate the :file:`clear-<release number>-gce.tar.gz` file,
-   and click :guilabel:`Select`.
-
-   .. figure:: figures/gce/21-create-image.png
-      :scale: 50 %
-      :alt: Create the image using the imported image archive object
-
-      Figure 10: Create image using imported object
-
-   Accept all default options, and click the :guilabel:`Create` button
-   at the bottom to import the Clear Linux GCE image to the image library.
-
-   .. figure:: figures/gce/22-image-list.png
-      :scale: 50 %
-      :alt: Clear Linux Compute Engine image is created
-
-      Figure 11: Image is created
-
-#. After the |CL| image is imported, you can launch a VM instance running
-   |CL|:
-
-   * Click the :guilabel:`Navigation menu` icon on the upper left screen menu.
-
-   * Select :menuselection:`Compute Engine --> VM Instances` from the side bar on
-     the left.
-
-   .. figure:: figures/gce/30-vm-instances.png
-      :scale: 50 %
-      :alt: Go to VM instances catalog
-
-      Figure 12: VM instances catalog
-
-#. If no VM instance was created in this project, you will be prompted to
-   create one.
-
-#. Alternatively, click the :guilabel:`CREATE INSTANCE` button on the VM
-   instances page to create a VM instance.
-
-   .. figure:: figures/gce/30-vm-none.png
-      :scale: 50 %
-      :alt: Prompt for VM creation
-
-      Figure 13: VM creation
-
-   .. figure:: figures/gce/30-vm-catalog.png
-      :scale: 50 %
-      :alt: List of VM instances
-
-      Figure 14: VM instances list
-
-   * Under :guilabel:`Region`, choose a region based on the
-     `Best practices for Compute Engine regions selection`_.
-
-   * Under :guilabel:`Boot disk`, click the :guilabel:`Change` button.
-
-     .. figure:: figures/gce/30-create-vm.png
-        :scale: 50 %
-        :alt: Use custom image while creating Clear Linux VM instance
-
-        Figure 15: Use custom image
-
-   * Select the :menuselection:`Custom images` tab for using Clear Linux OS GCE image.
-
-     .. figure:: figures/gce/31-select-boot-disk.png
-        :scale: 50 %
-        :alt: Select Clear Linux boot disk to create a VM instance
-
-        Figure 16: Select Clear Linux boot disk to create a VM instance
-
-   * Scroll down to the bottom of the VM instance creation page,
-     expand the :guilabel:`Management, security, disks, networking, sole tenancy`
-     group.
-
-     .. figure:: figures/gce/40-clear-vm-security.png
-        :scale: 50 %
-        :alt: Clear Linux requires setting up SSH keys
-
-        Figure 17: Set up SSH keys
-
-     .. note::
-        |CL| does not allow SSH login with a root account by default.
-        As a result, you must configure the VM instance with your
-        SSH public key, so that you are able to access it remotely.
-
-        Refer to :ref:`security` for more details.
-
-   * Click the :menuselection:`Security` tab, copy and paste your SSH public key:
-
-     .. figure:: figures/gce/40-ssh-key.png
-        :scale: 50 %
-        :alt: Set SSH key for remote login
-
-        Figure 18: Set SSH key for remote login
-
-     .. warning::
-
-        The username is assigned from characters preceding ``@`` in the email
-        address, included in the SSH key. The dot symbol "." is not allowed,
-        because it is an invalid character while creating user accounts in
-        |CL|.
-
-   * Click the :guilabel:`Create` button to create the |CL| VM.
-
-#. The Clear Linux VM instance is created and assigned a public IP address:
-
-   .. figure:: figures/gce/41-vm-created.png
-      :scale: 50 %
-      :alt: Clear Linux VM instance is created and started
-
-      Figure 19: Clear Linux VM instance is created and started
-
-#. You can now SSH login to the VM using the IP address obtained in the
-   previous step, and the username associated with the SSH public key:
-
-   .. figure:: figures/gce/42-ssh-vm.png
-      :scale: 50 %
-      :alt: SSH login to the Clear Linux VM
-
-      Figure 20: SSH login to Clear Linux VM
-
-Related topics
-**************
-
-* :ref:`azure`
-* :ref:`aws-web`
-
-
-.. _Google Cloud Platform: https://cloud.google.com/
-
-.. _Best practices for Compute Engine regions selection: https://cloud.google.com/solutions/best-practices-compute-engine-region-selection

_sources/get-started/virtual-machine-install/hyper-v.rst.txt

@@ -1,68 +0,0 @@
-.. _hyper-v:
-
-Use Hyper-V\*
-#############
-
-This page explains how to run |CL-ATTR| inside a
-`Windows Server Virtualization`_\* or **Hyper-V** environment.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Prerequisites
-*************
-
-* Enable `Intel® Virtualization Technology`_ (Intel® VT)
-
-* Enable `Intel® Virtualization Technology for Directed I/O`_ (Intel® VT-d) in
-  your BIOS/UEFI firmware configuration.
-
-Enable Hyper-V
-**************
-
-Please refer to `Install Hyper-V on Windows 10`_ to enable and configure
-*Hyper-V* on your machine.
-
-Create a virtual network
-************************
-
-Once *Hyper-V* has been enabled on your Windows system you will need to
-create a virtual network in the **Hyper-V Manager**.  Refer to the
-`Create a virtual network`_ documentation to create and configure
-a virtual network.
-
-Create a virtual machine
-************************
-
-#. Download and decompress the latest hyperv disk image
-   :file:`clear-XXXXX-hyperv.img.gz`, where XXXXX is the latest
-   available version of |CL| from our `Downloads`_ page.
-
-#. Create a virtual machine using the **Hyper-V Manager**:
-
-   a. Choose **Generation 2** when prompted to *specify VM generation*.
-   b. Choose **Use an existing virtual hard disk** and browse to find the
-      :file:`clear-XXXX-hyperv.vhdx` file.
-   c. When finished, open VM settings, select Firmware Section and in Secure
-      Boot config, **uncheck** Enable Secure Boot.
-
-   .. note:: Currently, |CL| does not boot with `secure boot`
-      enabled.
-
-#. Connect to your new VM and start it. You should see a prompt:
-
-   .. code-block:: console
-
-      > User: root
-
-#. Set a root user password.
-
-Your virtual machine running |CL| is ready!
-
-.. _Windows Server Virtualization: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/about/
-.. _Install Hyper-V on Windows 10: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v
-.. _Create a virtual network: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network
-.. _Downloads: https://cdn.download.clearlinux.org/image/
-.. _Intel® Virtualization Technology: http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
-.. _Intel® Virtualization Technology for Directed I/O: https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices

_sources/get-started/virtual-machine-install/kvm.rst.txt

@@ -1,253 +0,0 @@
-.. _kvm:
-
-Run |CL-ATTR| as a KVM guest OS
-###############################
-
-This page explains how to run |CL-ATTR| in a virtualized environment using
-:abbr:`KVM (Kernel-based Virtual Machine)`.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Install QEMU-KVM
-****************
-
-#. Enable the `Intel® Virtualization Technology`_ (Intel® VT) and the
-   `Intel® Virtualization Technology for Directed I/O`_ (Intel® VT-d) in the
-   host machine’s BIOS.
-
-#. Log in and open a terminal emulator.
-
-#. Install `QEMU*-KVM` on the host machine. Below are some example distros.
-
-   * On |CL|:
-
-     .. code-block:: bash
-
-        sudo swupd bundle-add kvm-host
-
-   * On Ubuntu\* 18.04 LTS Desktop:
-
-     .. code-block:: bash
-
-        sudo apt-get install qemu-kvm
-
-   * On Mint\* 19.1 “Cinnamon” Desktop:
-
-     .. code-block:: bash
-
-        sudo apt-get install qemu-kvm
-
-   * On Fedora\* 30 Workstation:
-
-     .. code-block:: bash
-
-        sudo dnf install qemu-kvm
-
-Download and launch the virtual machine
-***************************************
-
-#. Download the latest pre-built |CL| KVM image file from
-   the `image <https://cdn.download.clearlinux.org/image/>`_ directory. Look for
-   ``clear-<version>-kvm.img.xz``.  You can also use this command:
-
-   .. code-block:: bash
-
-      curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep '[0-9]'-kvm'\.')
-
-#. Uncompress the downloaded image:
-
-   .. code-block:: bash
-
-      unxz -v clear-<version>-kvm.img.xz
-
-#. Download the 3 OVMF files (`OVMF.fd`, `OVMF_CODE.fd`, `OVMF_VARS.fd`) that
-   provides UEFI  support for virtual machines.
-
-   .. code-block:: bash
-
-      curl -O https://cdn.download.clearlinux.org/image/OVMF.fd
-      curl -O https://cdn.download.clearlinux.org/image/OVMF_CODE.fd
-      curl -O https://cdn.download.clearlinux.org/image/OVMF_VARS.fd
-
-   .. note::
-
-      The default OVMF files from |CL| may not work for some distro version(s).
-      You may get an `ASSERT` in the `debug.log` file when starting the VM.
-      If that is the case, use the distro-specific-OVMF files instead.
-      For example, the |CL| OVMF files work for Ubuntu 18.04 LTS, but not for Ubuntu 19.04 LTS.
-      Installing and using the OVMF files for Ubuntu 19.04 LTS resolved the `ASSERT` issue.
-
-#. Download the `start_qemu.sh`_ script from the
-   `image <https://cdn.download.clearlinux.org/image/>`_ directory.  This script
-   will launch the |CL| VM and provide console interaction within the same
-   terminal emulator window.
-
-   .. code-block:: bash
-
-      curl -O https://cdn.download.clearlinux.org/image/start_qemu.sh
-
-#. Make the script executable:
-
-   .. code-block:: bash
-
-      chmod +x start_qemu.sh
-
-#. Start the |CL| KVM virtual machine:
-
-   .. code-block:: bash
-
-      sudo ./start_qemu.sh clear-<version>-kvm.img
-
-#. Log in as ``root`` user and set a new password.
-
-SSH access into the virtual machine
-***********************************
-
-To interact with the |CL| VM through SSH instead of the console it was
-launched from, follow these steps.
-
-#. Configure SSH in the |CL| VM to allow root login:
-
-   .. code-block:: bash
-
-      cat > /etc/ssh/sshd_config << EOF
-        PermitRootLogin yes
-        EOF
-
-#. Enable and start SSH server in the |CL| VM:
-
-   .. code-block:: bash
-
-      systemctl enable sshd
-      systemctl start sshd
-
-#. Determine the IP address of the host on which you will launch the VM.
-   Substitute <ip-addr-of-kvm-host> in the next step with this information.
-
-   .. code-block:: bash
-
-      ip a
-
-#. SSH into the |CL| VM using the default port of  `10022`:
-
-   .. code-block:: bash
-
-      ssh -p 10022 root@<ip-addr-of-kvm-host>
-
-Optional: Add the GNOME Display Manager (GDM)
-*********************************************
-
-To add :abbr:`GDM (GNOME Display Manager)` to the |CL| VM, follow these steps:
-
-#. Shutdown the active |CL| VM.
-
-   .. code-block:: bash
-
-      poweroff
-
-#. Install the Spice viewer on the local host or remote system. Below are some
-   example distros.
-
-   * On Clear Linux:
-
-     .. code-block:: bash
-
-        sudo swupd bundle-add virt-viewer
-
-   * On Ubuntu\* 18.04 LTS Desktop:
-
-     .. code-block:: bash
-
-        sudo apt-get install virt-viewer
-
-   * On Mint\* 19.1 “Cinnamon” Desktop:
-
-     .. code-block:: bash
-
-        sudo apt-get install virt-viewer
-
-   * On Fedora\* 30 Workstation:
-
-     .. code-block:: bash
-
-        sudo dnf install virt-viewer
-
-#. Modify the :file:`start_qemu.sh` script to increase memory (`-m`), add
-   graphics driver (`-vga`), and add Spice (`-spice`, `-usb`, and
-   `-device`) support.
-
-   .. code-block:: console
-
-      qemu-system-x86_64 \
-          -enable-kvm \
-          ${UEFI_BIOS} \
-          -smp sockets=1,cpus=4,cores=2 -cpu host \
-          -m 4096 \
-          -vga qxl \
-          -nographic \
-          -spice port=5924,disable-ticketing \
-          -usb \
-          -device usb-tablet,bus=usb-bus.0 \
-          -drive file="$IMAGE",if=virtio,aio=threads,format=raw \
-          -netdev user,id=mynet0,hostfwd=tcp::${VMN}0022-:22,hostfwd=tcp::${VMN}2375-:2375 \
-          -device virtio-net-pci,netdev=mynet0 \
-          -debugcon file:debug.log -global isa-debugcon.iobase=0x402 $@
-
-#. Due to changes in the :file:`start_qemu.sh` script from the previous step,
-   using the same OVMF files will result in the VM not booting properly and
-   you end up in the the UEFI shell.  The easiest way to avoid this is to delete
-   the OVMF files and restore the originals before relaunching the VM.
-
-#. Increase the size of the VM by 10GB to accommodate the GDM installation:
-
-   .. code-block:: bash
-
-      qemu-img resize -f raw clear-<version>-kvm.img +10G
-
-#. Relaunch the |CL| VM:
-
-   .. code-block:: bash
-
-      sudo ./start_qemu.sh clear-<version>-kvm.img
-
-#. Determine the IP address of the host on which you will launch the VM.
-   Substitute <ip-addr-of-kvm-host> in the next step with this information.
-
-   .. code-block:: bash
-
-      ip a
-
-#. From the local host or remote system, open a new terminal emulator window
-   and connect into the |CL| VM using the Spice viewer:
-
-   .. code-block:: bash
-
-      remote-viewer spice://<ip-address-of-kvm-host>:5924
-
-#. Log in as `root` user into the |CL| VM.
-
-#. Follow these steps from :ref:`increase-virtual-disk-size` to resize the partition of the virtual disk of the VM.
-
-#. Add GDM to the |CL| VM:
-
-   .. code-block:: bash
-
-      swupd bundle-add desktop-autostart
-
-#. Reboot the |CL| VM to start GDM:
-
-   .. code-block:: bash
-
-      reboot
-
-#. Go through the GDM out-of-box experience (OOBE).
-
-#. The default aspect ratio of the GDM GUI for the |CL| VM is 4:3. To change
-   it, use GDM's `Devices > Displays` setting tool (located at the top-right corner).
-
-
-.. _Intel® Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
-.. _Intel® Virtualization Technology for Directed I/O: https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices
-.. _start_qemu.sh: https://cdn.download.clearlinux.org/image/start_qemu.sh

_sources/get-started/virtual-machine-install/vmw-player-preconf.rst.txt

@@ -1,308 +0,0 @@
-.. _vmw-player-preconf:
-
-Run pre-configured |CL-ATTR| image as a VMware\* Workstation Player guest OS
-############################################################################
-
-This page explains how to deploy a pre-configured |CL| VMware image on
-`VMware Workstation 14 Player`_.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-VMware Workstation 14 Player is a type 2 hypervisor. It runs on top of
-another operating system such as Windows\* or Linux\*. With VMware ESXi, you
-can create, configure, manage, and run |CL-ATTR| :abbr:`VMs (Virtual Machines)`
-on your local system.
-
-.. note::
-
-   Screenshots in this document show VMware Workstation 14 Player for Windows.
-   Menus and prompts in the Linux version have minor wording differences.
-
-Install the VMware Workstation Player hypervisor
-************************************************
-
-#. Enable :abbr:`Intel® VT (Intel® Virtualization Technology)` and
-   :abbr:`Intel® VT-d (Intel® Virtualization Technology for Directed I/O)` in
-   your system's BIOS.
-
-#. `VMware Workstation 14 Player`_ is available for Windows and Linux.
-   Download your preferred version.
-
-#. Depending on which OS you're running, install it by following one of these
-   instructions:
-
-   * On supported Linux distros:
-
-     #. Enable a GUI desktop.
-
-     #. Start a terminal emulator.
-
-     #. Start the installer by issuing the command below and following the
-        guided steps.
-
-        .. code-block:: bash
-
-           sudo sh ./VMware-Player-[version number].x86_64.bundle
-
-   * On Windows:
-
-     #. Start the installer.
-     #. Follow the setup wizard.
-
-For additional help, see the `VMware Workstation Player Documentation`_.
-
-Download the latest |CL| VMware image
-*************************************
-
-Get the latest |CL| VMware image from the `image`_ repository.
-Look for :file:`clear-[version number]-vmware.vmdk.xz`. You can also use
-this command: 
-
-.. code-block:: bash
-
-   curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep vmware)
-
-Visit :ref:`image-types` for additional information about all available |CL| images.
-
-.. include:: ../../guides/maintenance/download-verify-decompress.rst
-   :Start-after: verify-windows:
-
-We also provide instructions for other operating systems:
-
-* :ref:`download-verify-decompress-linux`
-
-Create and configure a new VM
-*****************************
-
-#. Start the `VMware Workstation Player` app.
-#. On the home screen, click :guilabel:`Create a New Virtual Machine`. See
-   figure 1.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-01.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Create a new virtual machine
-
-      Figure 1: VMware Workstation 14 Player - Create a new virtual machine
-
-#. On the :guilabel:`Welcome to the New Virtual Machine Wizard` screen,
-   select the :guilabel:`I will install the operating system later` option.
-   See figure 2.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-02.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Select install operating system
-
-      Figure 2: VMware Workstation 14 Player - Select install operating
-      system later.
-
-#. Click the :guilabel:`Next` button.
-
-#. On the :guilabel:`Select a Guest Operating System` screen, set the
-   :guilabel:`Guest operating system` setting to :guilabel:`Linux`.
-   See figure 3.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-03.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Select guest operating system type
-
-      Figure 3: VMware Workstation 14 Player - Select guest operating system
-      type
-
-#. Set :guilabel:`Version` setting to
-   :guilabel:`Other Linux 3.x or later kernel 64-bit`.
-
-#. Click the :guilabel:`Next` button.
-
-#. On the :guilabel:`Name the Virtual Machine` screen, give your new VM a
-   name. See figure 4.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-04.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Name virtual machine
-
-      Figure 4: VMware Workstation 14 Player - Name virtual machine
-
-#. Click the :guilabel:`Next` button.
-
-#. On the :guilabel:`Specify Disk Capacity` screen, click 
-   the :guilabel:`Next` button. Keep the default disk settings unchanged.
-   When we attach the pre-configured |CL| VMware image, we will remove the
-   default virtual disk and replace it with the pre-configured one. See
-   figure 5.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-05.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Set disk capacity
-
-      Figure 5: VMware Workstation 14 Player - Set disk capacity
-
-#. On the :guilabel:`Ready to Create Virtual Machine` screen, click the
-   :guilabel:`Customize Hardware...` button. See figure 6.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-06.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Customize hardware
-
-      Figure 6: VMware Workstation 14 Player - Customize hardware
-
-#. Under the :guilabel:`Device` list, select :guilabel:`Processors`. See
-   figure 7.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-07.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Set virtualization engine option
-
-      Figure 7: VMware Workstation 14 Player - Set virtualization engine
-      option
-
-#. Under the :guilabel:`Virtualization engine` section,
-   check :guilabel:`Virtualize Intel VT-x/EPT or AMD-V/RVI`.
-
-#. To disconnect the virtual CD/DVD (IDE) since it is not needed, under the
-   :guilabel:`Device` list, select :guilabel:`New CD/DVD (IDE)`. See figure 8.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-08.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Disconnect CD/DVD (IDE)
-
-      Figure 8: VMware Workstation 14 Player - Disconnect CD/DVD (IDE)
-
-#. Under the :guilabel:`Device status` section, uncheck
-   :guilabel:`Connect at power on`.
-
-#. Click the :guilabel:`Close` button.
-
-#. Click the :guilabel:`Finish` button.
-
-Attach the pre-configured |CL| VMware image
-*******************************************
-
-#. Move the downloaded and decompressed pre-configured |CL| VMware image file
-   :file:`clear-[version number]-basic.vmdk` to the directory where your
-   newly-created VM resides.
-
-   .. note::
-
-      Depending on the OS, you can typically find the VMware VM files under:
-
-      * On Linux distros: :file:`/home/username/vmware`
-      * On Windows: :file:`C:\Users\username\Documents\Virtual Machines`
-
-#. On the :guilabel:`VMware Workstation Player` home screen, select your 
-   newly-created VM. See figure 9.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-09.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Edit virtual machine settings
-
-      Figure 9: VMware Workstation 14 Player - Edit virtual machine settings
-
-#. Click :guilabel:`Edit virtual machine settings`.
-
-#. To remove the default hard disk, under the :guilabel:`Device` list, select
-   :guilabel:`Hard Disk (SCSI)`. See figure 10.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-10.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Remove hard drive
-
-      Figure 10: VMware Workstation 14 Player - Remove hard drive
-
-#. Click the :guilabel:`Remove` button.
-
-#. To add a new hard disk and attach the pre-configured |CL| VMware image,
-   click the :guilabel:`Add...` button. See Figure 11.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-11.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Add new hard drive
-
-      Figure 11: VMware Workstation 14 Player - Add new hard drive
-
-#. Under the :guilabel:`Hardware types` section, select :guilabel:`Hard Disk`.
-
-#. Click the :guilabel:`Next` button.
-
-#. Select your preferred :guilabel:`Virtual disk type`. See figure 12.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-12.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Select virtual disk type
-
-      Figure 12: VMware Workstation 14 Player - Select virtual disk type
-
-#. Select the :guilabel:`Use an existing virtual disk` option. See figure 13.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-13.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Use existing virtual disk
-
-      Figure 13: VMware Workstation 14 Player - Use existing virtual disk
-
-#. Click the :guilabel:`Browse` button and select the pre-configured |CL|
-   VMware image file. See figure 14.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-14.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Select ready-made VMware |CL|
-
-      Figure 14: VMware Workstation 14 Player - Select ready-made VMware |CL|
-      image file
-
-#. Click the :guilabel:`Finish` button.
-
-   .. note::
-
-      When asked to convert the existing virtual disk to a newer format,
-      selecting either option works.
-
-Enable UEFI boot support
-************************
-
-|CL| needs UEFI support to boot. To enable it, add the
-following line to the end of your VM's :file:`.vmx` file:
-
-.. code-block:: console
-
-   firmware = "efi"
-
-.. note::
-
-   Depending on the OS, you can typically find the VMware VM files under:
-
-   * On Linux distros: :file:`/home/username/vmware`
-   * On Windows: :file:`C:\\Users\\username\\Documents\\Virtual Machines`
-
-Power on the VM
-***************
-
-After configuring the settings above, power on your |CL| virtual machine.
-
-#. On the :guilabel:`VMware Workstation Player` home screen, select your 
-   VM. See figure 15.
-
-   .. figure:: figures/vmw-player-preconf/vmw-player-preconf-15.png
-      :scale: 100%
-      :alt: VMware Workstation 14 Player - Power on virtual machine
-
-      Figure 15: VMware Workstation 14 Player - Power on virtual machine
-
-#. Click :guilabel:`Play virtual machine`.
-
-Related topics
-**************
-
-For other guides on using the VMWare Player and ESXi, see:
-
-* :ref:`vmw-player`
-* :ref:`vmware-esxi-install-cl`
-* :ref:`vmware-esxi-preconfigured-cl-image`
-
-.. _VMware ESXi: https://www.vmware.com/products/esxi-and-esx.html
-.. _VMware Workstation 14 Player: https://www.vmware.com/products/workstation-player.html
-.. _VMware Workstation Player Documentation: https://docs.vmware.com/en/VMware-Workstation-Player/index.html

_sources/get-started/virtual-machine-install/vmw-player.rst.txt

@@ -1,296 +0,0 @@
-.. _vmw-player:
-
-Install |CL-ATTR| as a VMware\* Workstation Player guest OS
-###########################################################
-
-This page explains how to create a new VM and install |CL| on it with the
-VMware Workstation Player hypervisor.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-`VMware Workstation Player`_ is a type 2 hypervisor. It runs on top of
-Windows\* or Linux\* operating systems. With VMware ESXi, you can
-create, configure, manage, and run |CL-ATTR| :abbr:`VMs (Virtual Machines)`
-on your local system.
-
-VMware offers a type 1 hypervisor called `VMware ESXi`_ designed for the
-cloud environment. For information on how to install |CL| as guest OS on
-it, see :ref:`vmware-esxi-install-cl`.
-
-.. note::
-
-   The screenshots on this document show the Windows version of the
-   VMware Workstation 15 Player. The menus and prompts are similar to those
-   in other versions and for the Linux OS save some minor wording differences.
-
-If you prefer to use a pre-configured |CL| VMware image instead,
-see our :ref:`vmw-player-preconf` guide.
-
-Install the VMware Workstation Player hypervisor
-************************************************
-
-#. Enable :abbr:`Intel® VT (Intel® Virtualization Technology)` and
-   :abbr:`Intel® VT-d (Intel® Virtualization Technology for Directed I/O)` in
-   your system's BIOS.
-
-#. `VMware Workstation Player`_ is available for Windows and Linux.
-   Download your preferred version.
-
-   .. note::
-
-      By default, selecting download means you receive the latest version
-      of this application. Commands may differ based on the version.
-
-#. Install VMware Workstation Player following the instructions
-   appropriate for your system's OS:
-
-   * On supported Linux distros:
-
-     #. Enable a GUI desktop.
-     #. Start a terminal emulator.
-     #. Start the installer by issuing the command below and follow the
-        guided steps.
-
-        .. code-block:: console
-
-           sudo sh ./VMware-Player-[version number].x86_64.bundle
-
-   * On Windows:
-
-     #. Start the installer.
-     #. Follow the setup wizard.
-
-For additional help, see the `VMware Workstation Player Documentation`_.
-
-Download the latest |CL| installer
-**********************************
-
-Get the latest installer with |CL| OS Desktop  from the `downloads`_ page.
-
-Visit :ref:`image-types` for additional information about all available |CL| images.
-
-We also provide instructions for downloading and verifying a Clear Linux ISO.
-For more information, refer to :ref:`download-verify-decompress`.
-
-Create and configure a new VM
-*****************************
-
-#. Start the `VMware Workstation Player` app.
-
-#. On the home screen, click :guilabel:`Create a New Virtual Machine`. See
-   Figure 1.
-
-   .. figure:: figures/vmw-player/vmw-player-01.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Create a new virtual machine
-
-      Figure 1: VMware Workstation Player - Create a new virtual
-      machine
-
-#. On the :guilabel:`Welcome to the New Virtual Machine Wizard` screen,
-   select the :guilabel:`Installer disc image file (iso)` option.
-   See Figure 2.
-
-   .. figure:: figures/vmw-player/vmw-player-02.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Select |CL| installer ISO
-
-      Figure 2: VMware Workstation Player - Select |CL| installer ISO
-
-#. Click the :guilabel:`Browse` button and select the decompressed |CL|
-   installer ISO.
-
-#. Click the :guilabel:`Next` button.
-
-#. On the :guilabel:`Select a Guest Operating System`, set the
-   :guilabel:`Guest operating system` setting to :guilabel:`Linux`. See
-   Figure 3.
-
-   .. figure:: figures/vmw-player/vmw-player-03.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Select guest operating system type
-
-      Figure 3: VMware Workstation Player - Select guest operating system
-      type
-
-#. Set the :guilabel:`Version` setting to
-   :guilabel:`Other Linux 4.x or later kernel 64-bit`.
-
-#. Click the :guilabel:`Next` button.
-
-#. On the :guilabel:`Name the Virtual Machine` screen, name the new VM. See
-   Figure 4.
-
-   .. figure:: figures/vmw-player/vmw-player-04.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Name virtual machine
-
-      Figure 4: VMware Workstation Player - Name virtual machine
-
-#. Click the :guilabel:`Next` button.
-
-#. On the :guilabel:`Specify Disk Capacity` screen, set the VM's maximum disk
-   size. See Figure 5.
-
-   .. figure:: figures/vmw-player/vmw-player-05.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Set disk capacity
-
-      Figure 5: VMware Workstation Player - Set disk capacity
-
-   .. note::
-
-      For optimal performance with the |CL| Desktop image, we recommend 32GB
-      of drive space. See :ref:`system-requirements` for more details.
-
-#. Click the :guilabel:`Next` button.
-
-#. On the :guilabel:`Ready to Create Virtual Machine` screen, click the
-   :guilabel:`Customize Hardware...` button. See Figure 6.
-
-   .. figure:: figures/vmw-player/vmw-player-06.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Customize hardware
-
-      Figure 6: VMware Workstation Player - Customize hardware
-
-#. Select :guilabel:`Memory` and set the size to 2GB. See Figure 7.
-
-   .. figure:: figures/vmw-player/vmw-player-07.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Set memory size
-
-      Figure 7: VMware Workstation Player - Set memory size
-
-   .. note::
-      The |CL| installer ISO needs a minimum of 2GB of RAM.
-      After completing installation, |CL| can run on as little as
-      128MB of RAM. Thus, you can reduce the memory size if needed.
-      See :ref:`system-requirements` for more details.
-
-#. Under the :guilabel:`Device` list, select :guilabel:`Processors`. See
-   Figure 8.
-
-   .. figure:: figures/vmw-player/vmw-player-08.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Set virtualization engine option
-
-      Figure 8: VMware Workstation Player - Set virtualization engine
-      option
-
-#. Under the :guilabel:`Virtualization engine` section,
-   check :guilabel:`Virtualize Intel VT-x/EPT or AMD-V/RVI`.
-
-#. Click the :guilabel:`Close` button.
-
-#. Click the :guilabel:`Finish` button.
-
-Install |CL| into the new VM
-****************************
-
-#. Select the newly-created VM and click the :guilabel:`Play virtual machine`
-   button. See Figure 9.
-
-   .. figure:: figures/vmw-player/vmw-player-09.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Power on virtual machine
-
-      Figure 9: VMware Workstation Player - Power on virtual machine
-
-#. Follow the :ref:`install-on-target-start` guide to complete the
-   installation of |CL|.
-
-#. After the installation completes, reboot the VM. This reboot restarts the
-   |CL| installer.
-
-Detach the |CL| installer ISO from the VM
-*****************************************
-
-#. To enable the mouse pointer so you access VMware Workstation Player's
-   menus, press :kbd:`<CTRL>` + :kbd:`<ALT>` on the keyboard.
-
-#. To disconnect the CD/DVD to stop it from booting the |CL| installer ISO
-   again, click the :guilabel:`Player` menu. See Figure 10.
-
-   .. figure:: figures/vmw-player/vmw-player-10.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Edit CD/DVD settings
-
-      Figure 10: VMware Workstation Player - Edit CD/DVD settings
-
-#. Go to :menuselection:`Removable Devices-->CD/DVD (IDE)-->Disconnect`.
-
-#. Click the :guilabel:`OK` button.
-
-Enable UEFI boot support
-************************
-
-|CL| needs UEFI support to boot. To enable UEFI:
-
-#. Power off the VM. click the :guilabel:`Player` menu. See Figure 11.
-
-   .. figure:: figures/vmw-player/vmw-player-11.png
-      :scale: 100%
-      :alt: VMware Workstation Player - Power off virtual machine
-
-      Figure 11: VMware Workstation Player - Power off virtual machine
-
-#. Go to :guilabel:`Power` and select :guilabel:`Shut Down Guest`.
-
-#. Add the following line to the end of your VM's :file:`.vmx` file:
-
-   .. code-block:: console
-
-      firmware = "efi"
-
-   .. note::
-
-      Depending on the OS, you can typically find the VMware VM files under:
-
-      * On Linux distros: :file:`/home/username/vmware`
-      * On Windows: :file:`C:\\Users\\username\\Documents\\Virtual Machines`
-
-
-#. After configuring the settings above, power on your |CL| virtual machine.
-   On the :guilabel:`VMware Workstation Player` home screen, select your
-   VM. See Figure 9.
-
-#. Click :guilabel:`Play virtual machine`.
-
-#. Install Open VM Tools. You may want to install the `open-vm-tools` in
-   your virtual machine. The Open Virtual Machine Tools (open-vm-tools) are
-   the open source implementation of VMware Tools for Linux guest operating
-   systems. In |CL| you can use the following to install the bundle in your VM
-
-   .. code-block:: console
-
-      sudo swupd bundle-add os-cloudguest-vmware
-      sudo systemctl enable --now open-vm-tools
-
-More information is available on the `VMWare Tools Product Documentation`_ site.
-
-Related topics
-**************
-
-For other guides on using the VMWare Player and ESXi, see:
-
-* :ref:`vmw-player-preconf`
-* :ref:`vmware-esxi-install-cl`
-* :ref:`vmware-esxi-preconfigured-cl-image`
-
-.. _VMware ESXi: https://www.vmware.com/products/esxi-and-esx.html
-
-.. _VMware Workstation Player:
-   https://www.vmware.com/products/workstation-player.html
-
-.. _VMware Workstation Player Documentation:
-   https://docs.vmware.com/en/VMware-Workstation-Player/index.html
-
-.. _downloads: https://clearlinux.org/downloads
-
-.. _VMWare Tools Product Documentation: https://docs.vmware.com/en/VMware-Tools/10.1.0/com.vmware.vsphere.vmwaretools.doc/GUID-8B6EA5B7-453B-48AA-92E5-DB7F061341D1.html

_sources/get-started/virtual-machine-install/vmware-esxi-install-cl.rst.txt

@@ -1,288 +0,0 @@
-.. _vmware-esxi-install-cl:
-
-Install |CL-ATTR| as a VMware\* ESXi guest OS
-#############################################
-
-This page explains how to create a new :abbr:`VM (Virtual Machine)` and
-manually install |CL-ATTR| on the new VM with VMware ESXi 6.5.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-`VMware ESXi`_ is a type 1 bare-metal hypervisor that runs directly on top
-of server hardware. With VMware ESXi, you can create, configure, manage, and
-run |CL| virtual machines in the cloud.
-
-Manually installing |CL| on a new VM gives additional configuration flexibility
-during installation. For example: alternate disk sizes, number of partitions,
-pre-installed bundles, etc.
-
-If you prefer to use a preconfigured |CL| VMware image instead, refer to
-:ref:`vmware-esxi-preconfigured-cl-image`.
-
-.. note::
-
-   VMware also offers a type 2 hypervisor designed for the desktop environment,
-   called `VMware Workstation Player`_. Refer to :ref:`vmw-player-preconf` or
-   :ref:`vmw-player` for more information.
-
-   Visit :ref:`image-types` to learn more about all available images.
-
-Download the latest |CL| installer ISO
-**************************************
-
-Get the latest |CL| installer ISO image from the `image`_ repository.
-Look for :file:`clear-[version number]-installer.iso.xz`.
-
-We also provide instructions for downloading and verifying a Clear Linux ISO.
-For more information, refer to :ref:`download-verify-decompress`.
-
-Upload the |CL| installer ISO to the VMware server
-**************************************************
-
-#.  Connect to the VMware server and log into an account with sufficient 
-    permission to create and manage VMs.  
-#.  Under the :guilabel:`Navigator` window, select :guilabel:`Storage`. 
-    See Figure 1.
-#.  Under the :guilabel:`Datastores` tab, click the :guilabel:`Datastore browser` 
-    button.   
-    
-    .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-1.png
-      :scale: 100 %
-      :alt: VMware ESXi - Navigator > Storage 
-
-      Figure 1: VMware ESXi - Navigator > Storage 
-
-#.  Click the :guilabel:`Create directory` button and name the directory `ISOs`.
-    See Figure 2.
-
-    .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-2.png
-      :scale: 100 %
-      :alt: VMware ESXi - Datastore > Create directory 
-
-      Figure 2: VMware ESXi - Datastore > Create directory 
-   
-#.  Select the newly-created directory and click the :guilabel:`Upload` button.
-    See Figure 3.
-
-    .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-3.png
-      :scale: 100 %
-      :alt: VMware ESXi - Datastore > Upload ISO 
-
-      Figure 3: VMware ESXi - Datastore > Upload ISO 
-   
-#.  Select the decompressed |CL| installer ISO file :file:`clear-[version number]-installer.iso` 
-    and upload it.
-
-Create and configure a new VM
-*****************************
-
-In this section, you will create a new VM, configure its basic parameters such 
-as drive size, number of CPUs, memory size, and then attach the |CL| installer ISO. 
-
-#.  Under the :guilabel:`Navigator` window, select :guilabel:`Virtual Machines`.
-    See Figure 4.
-#.  In the right window, click the :guilabel:`Create / Register VM` button.
-
-    .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-4.png
-      :scale: 100 %
-      :alt: VMware ESXi - Navigator > Virtual Machines
-
-      Figure 4: VMware ESXi - Navigator > Virtual Machines
-   
-#.  On the :guilabel:`Select creation type` step:
-    
-    #.  Select the :guilabel:`Create a new virtual machine` option.
-        See Figure 5.
-    #.  Click the :guilabel:`Next` button.
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-5.png
-          :scale: 100 %
-          :alt: VMware ESXi - Create a new virtual machine
-
-          Figure 5: VMware ESXi - Create a new virtual machine
-   
-#.  On the :guilabel:`Select a name and guest OS` step:
-
-    #.  Give the new VM a name in the :guilabel:`Name` field. See Figure 6.
-    #.  Set the :guilabel:`Compatability` option to :guilabel:`ESXi 6.5 virtual machine`.
-    #.  Set the :guilabel:`Guest OS family` option to :guilabel:`Linux`.
-    #.  Set the :guilabel:`Guest OS version` option to :guilabel:`Other 3.x or later Linux (64-bit)`.
-    #.  Click the :guilabel:`Next` button.
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-6.png
-          :scale: 100 %
-          :alt: VMware ESXi - Give a name and select guest OS type
-
-          Figure 6: VMware ESXi - Give a name and select guest OS type
-
-#.  On the :guilabel:`Select storage` step:
-
-    #.  Accept the default option.
-    #.  Click the :guilabel:`Next` button.
-
-#.  On the :guilabel:`Customize settings` step:
-    
-    #.  Click the :guilabel:`Virtual Hardware` button. See Figure 7.
-    #.  Expand the :guilabel:`CPU` setting and enable :guilabel:`Hardware virtualization` by 
-        checking :guilabel:`Expose hardware assisted virtualization to the guest OS`.
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-7.png
-          :scale: 100 %
-          :alt: VMware ESXi - Enable hardware virtualization
-      
-          Figure 7: VMware ESXi - Enable hardware virtualization
-
-    #.  Set :guilabel:`Memory` size to 2048MB (2GB). See Figure 8.
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-8.png
-          :scale: 100 %
-          :alt: VMware ESXi - Set memory size
-
-          Figure 8: VMware ESXi - Set memory size
-
-        .. note:: 
-
-          The |CL| installer ISO needs a minimum of 2GB of RAM to work properly.
-          You can reduce the memory size after the installation completes if you want, 
-          because a minimum |CL| installation can function on as little as 128MB of RAM.
-          See :ref:`system-requirements` for more details.  
-
-    #.  Set :guilabel:`Hard disk 1` to the desired capacity. See Figure 9.
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-9.png
-          :scale: 100 %
-          :alt: VMware ESXi - Set hard disk size
-
-          Figure 9: VMware ESXi - Set hard disk size
-
-        .. note::
-
-          A minimum |CL| installation can exist on 600MB of drive space.  
-          See :ref:`system-requirements` for more details.       
-
-    #.  Attach the |CL| installer ISO.  For the :guilabel:`CD/DVD Drive 1` setting, 
-        click the drop-down list to the right of it and select the :guilabel:`Datastore ISO file`
-        option.  Then select the |CL| installer ISO :file:`clear-[version number]-installer.iso` 
-        that you previously uploaded to the VMware server. See Figure 10.
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-10.png
-          :scale: 100 %
-          :alt: VMware ESXi - Set CD/DVD to boot installer ISO
-
-          Figure 10: VMware ESXi - Set CD/DVD to boot installer ISO
-
-#.  Click the :guilabel:`Next` button.
-#.  Click the :guilabel:`Finish` button.
-
-Install |CL| into the new VM
-****************************
-
-#.  Power on the VM.
-    
-    #.  Under the :guilabel:`Navigator` window, select :guilabel:`Virtual Machines`.
-        See Figure 11.
-    #.  In the right window, select the newly-created VM.
-    #.  Click the :guilabel:`Power on` button.  
-    #.  Click on the icon representing the VM to bring it into view and maximize
-        its window.  
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-11.png
-          :scale: 100 %
-          :alt: VMware ESXi - Navigator > Virtual Machines > Power on VM
-
-          Figure 11: VMware ESXi - Navigator > Virtual Machines > Power on VM
-
-#.  Follow the :ref:`install-on-target-start` guide to complete the installation of 
-    |CL|.
-#.  After the installation is complete, follow the |CL| instruction to reboot it.  
-    This will restart the installer again. 
-
-Reconfigure the VM's settings to boot the newly-installed |CL|
-**************************************************************
-
-After |CL| has been installed using the installer ISO, it must be detached so
-it will not run again.  Also, in order to boot the newly-installed |CL|, you must
-enable UEFI support. 
-
-#.  Power off the VM.
-
-    #.  Click the :guilabel:`Actions` button - located on the top-right corner 
-        of the VM's windows - and go to the :guilabel:`Power` setting and  
-        select the :guilabel:`Power off` option. See Figure 12. 
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-12.png
-          :scale: 100 %
-          :alt: VMware ESXi - Actions > Power off
-
-          Figure 12: VMware ESXi - Actions > Power off
-
-#.  Edit the VM settings.
-
-    #.  Click the :guilabel:`Actions` button again and select :guilabel:`Edit settings`.  
-        See Figure 13.
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-13.png
-          :scale: 100 %
-          :alt: VMware ESXi - Actions > Edit settings
-
-          Figure 13: VMware ESXi - Actions > Edit settings
-
-#.  Disconnect the CD/DVD to stop it from booting the |CL| installer ISO again.
-    
-    #.  Click the :guilabel:`Virtual Hardware` button.  See Figure 14.
-    #.  For the :guilabel:`CD/DVD Drive 1` setting, uncheck the 
-        :guilabel:`Connect` checkbox.
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-14.png
-          :scale: 100 %
-          :alt: VMware ESXi - Disconnect the CD/DVD drive
-
-          Figure 14: VMware ESXi - Disconnect the CD/DVD drive
-
-#.  |CL| needs UEFI support in order to boot.  Enable it.
-
-    #.  Click the :guilabel:`VM Options` button. See Figure 15.
-    #.  Expand the :guilabel:`Boot Options` setting.
-    #.  For the :guilabel:`Firmware` setting, click the drop-down list to the right 
-        of it and select the :guilabel:`EFI` option.
-
-        .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-15.png
-          :scale: 100 %
-          :alt: VMware ESXi - Set boot firmware to EFI
-
-          Figure 15: VMware ESXi - Set boot firmware to EFI
-
-#.  Click the :guilabel:`Save` button.
-
-Power on the VM and boot |CL|
-*****************************
-
-After configuring the settings above, power on the VM.  
-
-#.  Under the :guilabel:`Navigator` window, select :guilabel:`Virtual Machines`.
-    See Figure 16.
-#.  In the right window, select the VM.
-#.  Click the :guilabel:`Power on` button.  
-#.  Click on the icon representing the VM to bring it into view and maximize
-    its window.  
-
-    .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-16.png
-      :scale: 100 %
-      :alt: VMware ESXi - Navigator > Virtual Machines > Power on VM
-
-      Figure 16: VMware ESXi - Navigator > Virtual Machines > Power on VM
-
-Related topics
-**************
-
-* :ref:`vmware-esxi-preconfigured-cl-image`
-
-
-.. _VMware ESXi: https://www.vmware.com/products/esxi-and-esx.html
-.. _VMware Workstation Player: https://www.vmware.com/products/workstation-player.html
-.. _image: https://cdn.download.clearlinux.org/image

_sources/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst.txt

@@ -1,288 +0,0 @@
-.. _vmware-esxi-preconfigured-cl-image:
-
-Run preconfigured |CL-ATTR| image as a VMware\* ESXi guest OS
-#############################################################
-
-This page explains how to deploy a preconfigured |CL| VMware
-:abbr:`VM (Virtual Machine)` image on a VMware ESXi 6.5 host.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-`VMware ESXi`_ is a type 1 bare-metal hypervisor which runs directly on top
-of server hardware.  With VMware ESXi, you can create, configure, manage,
-and run |CL-ATTR| virtual machines at scale.
-
-We provide a preconfigured |CL| VMware image that can be run on a VMware ESXi
-6.5 host.
-
-If manuall installation is preferred, refer to :ref:`vmware-esxi-install-cl`.
-
-.. note::
-
-   VMware also offers a type 2 hypervisor designed for the desktop environment,
-   called `VMware Workstation Player`_. Refer to :ref:`vmw-player-preconf` or
-   :ref:`vmw-player` for more information.
-
-Download the latest |CL| VMware image
-*************************************
-
-Get the latest |CL| VMware prebuilt image from the `image`_ repository.
-Look for :file:`clear-[version number]-vmware.vmdk.xz`. You can also use
-this command:
-
-.. code-block:: bash
-
-   curl -O https://cdn.download.clearlinux.org/image/$(curl https://cdn.download.clearlinux.org/image/latest-images | grep vmware)
-
-Visit :ref:`image-types` for additional information about all available |CL| images.
-
-We also provide instructions for downloading and verifying a Clear Linux ISO.
-For more information, refer to :ref:`download-verify-decompress`.
-
-Upload the |CL| image to the VMware server
-******************************************
-
-Once the |CL| VMware prebuilt image has been downloaded and 
-decompressed on your local system, it must be uploaded to a datastore 
-on the VMware ESXi server.
-
-The steps in this section can also be referenced from the VMware documentation
-`Using Datastore File Browser in the VMware Host Client`_.
-
-#. Connect to the VMware ESXi server and login to an account with sufficient
-   permission to create and manage VMs.
-
-#. Under the :guilabel:`Navigator` window on the left side, 
-   select :guilabel:`Storage`.
-   See Figure 1
-
-#. Under the :guilabel:`Datastores` tab, click 
-   the :guilabel:`Datastore browser` button.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-1.png
-      :scale: 100 %
-      :alt: VMware ESXi - Navigator > Storage
-
-      Figure 1: VMware ESXi - Navigator > Storage
-
-#. Click the :guilabel:`Create directory` button and name the directory
-   `Clear Linux VM`. See Figure 2.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-2.png
-      :scale: 100 %
-      :alt: VMware ESXi - Datastore > Create directory
-
-      Figure 2: VMware ESXi - Datastore > Create directory
-
-#. Select the newly-created directory and click the :guilabel:`Upload`
-   button. See Figure 3.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-3.png
-      :scale: 100 %
-      :alt: VMware ESXi - Datastore > Upload VMware image
-
-      Figure 3: VMware ESXi - Datastore > Upload VMware image
-
-#. Select the decompressed |CL| VMware image file
-   :file:`clear-[version number]-vmware.vmdk` and upload it.
-
-Convert the |CL| image to an ESXi-supported format
-**************************************************
-
-Once the |CL| VMware prebuilt image has been uploaded to the VMware ESXi
-datastore, it must be converted to a format for usable with VMware's ESXi 
-hypervisor. 
-
-The steps in this section can also be referenced from the VMware documentation on `Cloning and converting virtual machine disks with vmkfstools`_
-
-#. SSH into the `vSphere Management Assistant`_  appliance that is managing
-   the ESXi host or connect to the vSphere hosting using the `vSphere CLI`_.
-
-   .. note::
-
-      If there is no :abbr:`vMA (vSphere Management Assistant)` appliance or :abbr:`vCLI (vSphere CLI)` configured and available, 
-      you can temporarily enable SSH directly on the ESXi host by following the
-      steps described in `Enable the Secure Shell (SSH) in the VMware Host Client`_ .
-
-      As a security best practice, remember to disable SSH access after following the steps in this section. 
-
-
-#. Locate the uploaded image, which is typically found in
-   :file:`/vmfs/volumes/datastore1`.
-
-#. Use the :command:`vmkfstools` command to perform the conversion, as
-   shown below:
-
-   .. code-block:: console
-
-      vmkfstools -i clear-[version number]-vmware.vmdk -d zeroedthick clear-[version number]-esxi.vmdk
-
-   Two files should result from this:
-
-   * :file:`clear-[version number]-esxi-flat.vmdk`
-   * :file:`clear-[version number]-esxi.vmdk`
-
-   The :file:`clear-[version number]-esxi.vmdk` file will be used in the
-   next section when you create a new VM.
-
-Create and configure a new VM
-*****************************
-
-In this section, you will create a new VM, configure its basic parameters
-such as number of CPUs, memory size, and then attach the converted |CL| 
-VMware image. Also, in order to boot |CL|, you must enable UEFI support. 
-
-#. Under the :guilabel:`Navigator` window, select 
-   :guilabel:`Virtual Machines`. See Figure 4.
-
-#. In the right window, click the :guilabel:`Create / Register VM` button.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-4.png
-      :scale: 100 %
-      :alt: VMware ESXi - Navigator > Virtual Machines
-
-      Figure 4: VMware ESXi - Navigator > Virtual Machines
-
-#. On the :guilabel:`Select creation type` step:
-
-   #. Select the :guilabel:`Create a new virtual machine` option. See
-      Figure 5.
-
-   #. Click the :guilabel:`Next` button.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-5.png
-      :scale: 100 %
-      :alt: VMware ESXi - Create a new virtual machine
-
-      Figure 5: VMware ESXi - Create a new virtual machine
-
-#. On the :guilabel:`Select a name and guest OS` step:
-
-#. Give the new VM a name in the :guilabel:`Name` field. See Figure 6.
-
-#. Set the :guilabel:`Compatability` option to
-   :guilabel:`ESXi 6.5 virtual machine`.
-#. Set the :guilabel:`Guest OS family` option to :guilabel:`Linux`.
-#. Set the :guilabel:`Guest OS version` option to 
-   :guilabel:`Other 3.x or later Linux (64-bit)`.
-#. Click the :guilabel:`Next` button.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-6.png
-      :scale: 100 %
-      :alt: VMware ESXi - Give a name and select guest OS type
-
-      Figure 6: VMware ESXi - Give a name and select guest OS type
-
-#. On the :guilabel:`Select storage` step:
-
-   #. Accept the default option.
-   #. Click the :guilabel:`Next` button.
-
-#. On the :guilabel:`Customize settings` step:
-
-   #. Click the :guilabel:`Virtual Hardware` button. See Figure 7.
-   #. Expand the :guilabel:`CPU` setting and enable 
-      :guilabel:`Hardware virtualization` by checking 
-      :guilabel:`Expose hardware assisted virtualization to the guest OS`.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-7.png
-      :scale: 100 %
-      :alt: VMware ESXi - Enable hardware virtualization
-
-      Figure 7: VMware ESXi - Enable hardware virtualization
-
-   #. Remove the default :guilabel:`Hard drive 1` setting by clicking
-      the `X` icon on the right side. See Figure 8.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-8.png
-      :scale: 100 %
-      :alt: VMware ESXi - Remove hard drive
-
-      Figure 8: VMware ESXi - Remove hard drive
-
-   #. Since a preconfigured image will be used, 
-      the :guilabel:`CD/DVD Drive 1` setting will not be needed.  Disable it 
-      by unchecking the :guilabel:`Connect` checkbox. See Figure 9.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-9.png
-      :scale: 100 %
-      :alt: VMware ESXi - Disconnect the CD/DVD drive
-
-      Figure 9: VMware ESXi - Disconnect the CD/DVD drive
-
-   #. Attach the :file:`clear-[version number]-esxi.vmdk` file that was
-      converted from the preconfigured |CL| VMware image.
-
-      #. Click the :guilabel:`Add hard disk` button and select the
-         :guilabel:`Existing hard drive` option. See Figure 10.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-10.png
-      :scale: 100 %
-      :alt: VMware ESXi - Add an existing hard drive
-
-      Figure 10: VMware ESXi - Add an existing hard drive
-
-      #. Select the converted :file:`clear-[version number]-esxi.vmdk`
-         file. Do not use the original unconverted 
-         :file:`clear-[version number]-vmware.vmdk` file. See Figure 11.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-11.png
-      :scale: 100 %
-      :alt: VMware ESXi - Select the converted `vmdk` file
-
-      Figure 11: VMware ESXi - Select the converted 
-      :file:`clear-[version number]-esxi.vmdk` file
-
-#. |CL| needs UEFI support in order to boot.  Enable UEFI boot support.
-
-   #. Click the :guilabel:`VM Options` button. See Figure 12.
-   #. Expand the :guilabel:`Boot Options` setting.
-   #. For the :guilabel:`Firmware` setting, click the drop-down list to
-      the right of it and select the :guilabel:`EFI` option.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-12.png
-      :scale: 100 %
-      :alt: VMware ESXi - Set boot firmware to EFI
-
-      Figure 12: VMware ESXi - Set boot firmware to EFI
-
-#. Click the :guilabel:`Save` button.
-#. Click the :guilabel:`Next` button.
-#. Click the :guilabel:`Finish` button.
-
-Power on the VM and boot |CL|
-*****************************
-
-After configuring the settings above, power on the VM.
-
-#. Under the :guilabel:`Navigator` window, select 
-   :guilabel:`Virtual Machines`. See Figure 13.
-#. In the right window, select the newly-created VM.
-#. Click the :guilabel:`Power on` button.
-#. Click on the icon representing the VM to bring it into view and maximize
-   its window.
-
-   .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-13.png
-      :scale: 100 %
-      :alt: VMware ESXi - Navigator > Virtual Machines > Power on VM
-
-      Figure 13: VMware ESXi - Navigator > Virtual Machines > Power on VM
-
-Related topics
-**************
-
-* :ref:`vmware-esxi-install-cl`
-
-.. _VMware ESXi: https://www.vmware.com/products/esxi-and-esx.html
-.. _Using Datastore File Browser in the VMware Host Client: https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.html.hostclient.doc/GUID-7533A767-8396-4844-A3F2-206047D254EA.html
-.. _vSphere Management Assistant: https://www.vmware.com/support/developer/vima/
-.. _vSphere CLI: https://www.vmware.com/support/developer/vcli/
-.. _Cloning and converting virtual machine disks with vmkfstools: https://kb.vmware.com/kb/1028042
-.. _Enable the Secure Shell (SSH) in the VMware Host Client: https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.html.hostclient.doc/GUID-B649CB74-832F-467B-B6A4-8BA67AD5C1F0.html
-.. _VMware Workstation Player: https://www.vmware.com/products/workstation-player.html
-.. _image: https://cdn.download.clearlinux.org/image

_sources/guides/clear/autospec.rst.txt

@@ -1,511 +0,0 @@
-.. _autospec:
-
-autospec
-########
-
-**autospec** is a tool used to assist with the automated creation and maintenance of
-RPM packaging in |CL-ATTR|. Where a standard :abbr:`RPM (RPM Package Manager)` build process using
-:command:`rpmbuild` requires a tarball and :file:`.spec` file to start, autospec
-requires only a tarball and package name to start.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Description
-***********
-
-The autospec tool attempts to infer the requirements of the :file:`.spec` file
-by analyzing the source code and :file:`Makefile` information. It 
-continuously runs updated builds based on new information discovered from build
-failures until it has a complete and valid :file:`.spec` file. If needed, you
-can influence the behavior of autospec and customize the build by providing
-optional `control files`_ to the autospec tool.
-
-autospec uses **mock** as a sandbox to run the builds. Visit the `mock wiki`_ for
-additional information on using mock.
-
-For a general understanding of how an RPM works, visit 
-the `rpm website`_ or the `RPM Packaging Guide`_ .
-
-How it works
-************
-
-Learn the autospec tool set up and process.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Prerequisites
-=============
-
-The setup for building source in |CL| must be completed before using the
-autospec tool.
-
-Refer to `Setup environment to build source`_ for instructions on completing
-the setup.
-
-Create an RPM
-=============
-
-The basic autospec process is described in the following steps:
-
-#. The :command:`make autospec` command generates a :file:`.spec` file based on
-   the analysis of code and existing control files.
-
-   Any control files should be located in the same directory as the resulting
-   :file:`.spec` file.
-
-   View the `autospec README`_ for more information on `control files`_.
-
-#. autospec creates a build root with mock config.
-
-#. autospec attempts to build an RPM from the generated :file:`.spec`.
-
-#. autospec detects any missed declarations in the :file:`.spec`.
-
-#. If build errors occur, autospec scans the build log to try to detect
-   the root cause.
-
-#. If autospec detects the root cause and knows how to continue, it restarts
-   the build automatically at step 1 with updated build instructions.
-
-#. Otherwise, autospec stops the build for user inspection to resolve the
-   errors. Respond to the build process output by fixing source code issues
-   and/or editing control files to resolve issues, which may include
-   dependencies or exclusions. See `autospec README`_ for more information on
-   control files.
-
-   The user resumes the process at step 1 after errors are resolved.
-
-   If a binary dependency doesn't exist in |CL|, you must build it
-   before running autospec again.
-
-Following these steps, autospec continues to rebuild the package, based on
-new information discovered from build failures, until it has a valid
-:file:`.spec`. If no build errors occur, RPM packages are successfully built.
-
-Examples
-********
-
-Complete `Setup environment to build source`_ before using these examples.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Example 1: Build RPM with an existing spec file
-===============================================
-
-This example shows how to build a RPM from a pre-packaged upstream package with
-an existing spec file. The example uses the ``dmidecode`` package.
-
-#. Navigate to the autospec workspace and clone the ``dmidecode`` package:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux
-      make clone_dmidecode
-
-   .. note::
-
-      You can clone all package repos at once using the following command:
-
-      .. code-block:: bash
-
-         make [-j NUM] clone-packages
-
-      The optional NUM is the number of threads to use.
-
-      For a list of available packages, view the
-      :file:`~/clearlinux/projects/common/packages` file.
-
-#. Navigate to the local copy of the ``dmidecode`` package and build it:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux/packages/dmidecode/
-      make build
-
-#. The resulting RPMs are in :file:`./rpms`. Build logs and additional RPMs are
-   in :file:`./results`.
-
-Example 2: Build a new RPM
-==========================
-
-This example shows how to build a new RPM with no spec file. The example will
-create a simple helloclear RPM.
-
-#. Navigate to the autospec workspace and build the helloclear RPM. The
-   :file:`Makefile` provides a :command:`make autospecnew` that can
-   automatically generate an RPM package using the autospec tool. You must pass
-   the URL to the source tarball and the NAME of the RPM you wish to create:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux
-      make autospecnew URL="https://github.com/clearlinux/helloclear/archive/helloclear-v1.0.tar.gz" NAME="helloclear"
-
-   The resulting RPMs are in :file:`./packages/helloclear/rpms`. Build logs and
-   additional RPMs are in :file:`./packages/helloclear/results`.
-
-Example 3: Generate a new spec file with a pre-defined package
-==============================================================
-
-This example shows how to modify an existing package to create a custom RPM. In
-this example you will make a simple change to the ``dmidecode`` package and
-rebuild the package.
-
-#. Navigate to the autospec workspace and clone the ``dmidecode`` package:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux
-      make clone_dmidecode
-
-#. Navigate into the *dmidecode* directory:
-
-   .. code-block:: bash
-
-      cd packages/dmidecode
-
-#. Open the :file:`excludes` file with an editor and add these lines:
-
-   .. code-block:: console
-
-      /usr/bin/biosdecode
-      /usr/bin/ownership
-      /usr/bin/vpddecode
-      /usr/share/man/man8/biosdecode.8
-      /usr/share/man/man8/ownership.8
-      /usr/share/man/man8/vpddecode.8
-
-   .. note::
-
-      These files aren't needed by dmidecode, so we can remove them without
-      any issues.
-
-#. In the :file:`dmidecode` directory, build the modified ``dmidecode`` package:
-
-   .. code-block:: bash
-
-      make autospec
-
-#. The resulting RPMs are in :file:`./rpms`. Logs are in :file:`./results`.
-
-Example 4: Provide control files to autospec
-============================================
-
-This example shows how to modify control files to correct build failures that
-autospec is unable to resolve. In this example, you will add a missing license
-and dependencies so autospec can complete a successful build.
-
-#. Navigate to the autospec workspace:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux
-
-#. If you have not already, clone all upstream package repos:
-
-   .. code-block:: bash
-
-      make [-j NUM] clone-packages
-
-   The optional NUM is the number of threads to use.
-
-   .. note::
-
-      In a later step of this example, we will search the cloned package repos
-      for a missing dependency.
-
-#. Build the opae-sdk RPM:
-
-   .. code-block:: bash
-
-      make autospecnew URL="https://github.com/OPAE/opae-sdk/archive/0.13.0.tar.gz" NAME="opae-sdk"
-
-   This results in an error for a missing license file:
-
-   .. code-block:: console
-
-      [FATAL]    Cannot find any license or opae-sdk.license file!
-
-#. Navigate to the package with build failures:
-
-   .. code-block:: bash
-
-      cd packages/opae-sdk
-
-#. Add one or more valid license identifiers from the
-   `SPDX License List <https://spdx.org/licenses/>`_.
-   In the example below, two different licenses are appropriate based on the 
-   opae-sdk project licensing:
-
-   .. code-block:: bash
-
-      echo "BSD-3-Clause MIT" > opae-sdk.license
-
-#. Run autospec again:
-
-   .. code-block:: bash
-
-      make autospec
-
-   This results in a generic error:
-
-   .. code-block:: console
-
-      [FATAL]    Build failed, aborting
-
-#. Open the build log to view the error details:
-
-   .. code-block:: bash
-
-      cat ./results/build.log
-
-   The build log contains details for the specific failures. In this
-   instance, there are missing dependencies:
-
-   .. code-block:: console
-
-      CMake Error: The following variables are used in this project, but they are set to NOTFOUND.  Please set them or make sure they are set and tested correctly in the CMake files:
-      CJSON_LIBRARY
-         linked by target "opae-c++-utils" in directory /builddir/build/BUILD/opae-sdk-0.13.0/tools/c++utilslib
-      json-c_LIBRARIES
-         linked by target "opae-c" in directory /builddir/build/BUILD/opae-sdk-0.13.0/libopae
-      libuuid_LIBRARIES
-         linked by target "opae-c" in directory /builddir/build/BUILD/opae-sdk-0.13.0/libopae
-
-#. Search the spec files of upstream |CL| packages to see if the json-c library
-   is available. In this case, it does exist and we'll add the json-c 'dev'
-   package into the buildreq_add:
-
-   .. code-block:: bash
-
-      grep 'json-c\.so$' ~/clearlinux/packages/*/*.spec
-      echo "json-c-dev" >> buildreq_add
-
-   .. note::
-
-      This search step works only if the user cloned all of the upstream package
-      repos. In this example, upstream package repos were cloned in a previous
-      step.
-
-#. Search the spec files of upstream |CL| packages to see if the libuuid library
-   is available. In this case, it exists in the util-linux package, so we'll add
-   util-linux-dev package into the buildreq_add:
-
-   .. code-block:: bash
-
-      grep 'libuuid\.so$' ~/clearlinux/packages/*/*.spec
-      echo "util-linux-dev" >> buildreq_add
-
-#. Run autospec again and find the successfully-generated RPMs in the :file:`rpms`
-   directory:
-
-   .. code-block:: bash
-
-      make autospec
-
-.. note::
-
-   If you need a dependency that does not exist in the |CL| repo, you must first
-   build it manually (see `Example 2: Build a new RPM`_), then add the repo so
-   that autospec knows the package exists. For example:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux/packages/<package-name>
-      make repoadd
-      make repostatus
-
-   You only need to add the dependency to the :file:`buildreq_add` control file
-   if autospec is not able to automatically find the correct dependency on its
-   own.
-
-Test packaged software
-**********************
-
-After software has been packaged with autospec, the resulting RPMs can be
-tested for functionality before being integrated and deployed into a |CL|
-image with the :ref:`Mixer tool <mixer>`.
-
-The |CL| development tooling offers two ways to quickly test autospec
-generated RPMs.
-
-.. note::
-   The methods outlined below should only be used for temporary testing on
-   development systems. 
-
-
-Test in a |CL| virtual machine
-==============================
-
-The |CL| development tooling includes a method to install RPMs into a |CL|
-virtual machine running on the KVM hypervisor. Using a :abbr:`VM (Virtual
-Machine)` allows testing in a completely isolated environment. 
-
-To test an autospec-created package inside a VM:
-
-#. Download the |CL| KVM image into the :file:`~/clearlinux` directory as
-   :file:`clear.img`. The location and name :file:`clear.img.xz` is important
-   for the tooling to work:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux
-      curl -o clear.img.xz https://download.clearlinux.org/image/$(curl https://download.clearlinux.org/image/latest-images | grep '[0-9]'-kvm)
-
-#. Extract the downloaded |CL| KVM image:
-
-   .. code-block:: bash
-
-      unxz -v clear.img.xz
-
-#. Copy the QEMU start script and virtual firmware needed for KVM into the
-   :file:`~/clearlinux` directory:
-
-   .. code-block:: bash
-
-      cp ~/clearlinux/projects/common/start_qemu.sh .
-      cp /usr/share/qemu/OVMF.fd .
-
-#. Run :command:`make install` from the package's autospec directory. The
-   :command:`make install` command mounts the downloaded |CL| KVM image and
-   installs the autospec-created RPM into it:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux/packages/<package-name>
-      make install
-
-   The code that makes this possible can be viewed by searching for the
-   *install:*  target in the `Makefile.common`_ file on GitHub.
-
-#. Return to the :file:`~/clearlinux` directory and start the |CL| VM:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux/
-      sudo ./start_qemu.sh clear.img
-
-#. A new |CL| VM will launch in the console. Log into the VM as *root* and set
-   a new pasword for the VM.
-
-#. Check that the software is installed in the |CL| VM as expected and perform
-   any relevant tests.
-
-#. After testing has been completed, the |CL| VM can be powered off and
-   deleted:
-
-   .. code-block:: bash
-      
-      poweroff 
-      rm clear.img
-
-
-Test directly on a development machine
-======================================
-
-The |CL| development tooling also includes a method to extract
-autospec-created RPMs locally onto a |CL| development system for testing.
-Extracting an RPM directly onto a system  offers quicker testing; however
-conflicts may occur and responsibility to remove the software after testing is
-up to the developer.
-
-To test an autospec created package directly on the |CL| development system:
-
-#. Run :command:`make install-local` from the package's autospec directory.
-   The :command:`make install-local` command extracts the RPM directly onto
-   the filesystem of the running |CL| system:
-
-   .. code-block:: bash
-
-      cd ~/clearlinux/packages/<package-name>
-      make install-local
-
-   The code that makes this possible can be viewed by searching for the
-   *install-local:*  target in the `Makefile.common`_  file on GitHub.
-
-#. Check that the software is installed as expected and perform any relevant
-   tests.
-
-#. After testing has been completed, the software and any related files must
-   be identified and deleted. The :command:`swupd repair --picky`
-   command can help restore the state of the :file:`/usr` directory (see
-   :ref:`swupd <swupd-about>`) however any other files must be cleaned up
-   manually.
-
-
-References
-**********
-
-Reference the `autospec README`_ for details regarding `autospec` commands and options.
-
-Setup environment to build source
-=================================
-
-.. _install-tooling-after-header:
-
-Setup of the workspace and tooling used for building source in |CL| is mostly
-automated for you with a setup script. It uses tools from the
-:command:`os-clr-on-clr` bundle.
-
-The setup script creates a workspace in the :file:`clearlinux` folder, with the
-subfolders :file:`Makefile`, :file:`packages`, and :file:`projects`. The
-:file:`projects` folder contains the main tools used for making packages in
-|CL| :file:`autospec` and :file:`common`.
-
-Follow these steps to setup the workspace and tooling for building source:
-
-#. Install the :command:`os-clr-on-clr` bundle:
-
-   .. code-block:: bash
-
-        sudo swupd bundle-add os-clr-on-clr
-
-#. Download the :file:`user-setup.sh` script:
-
-   .. code-block:: bash
-
-      curl -O https://raw.githubusercontent.com/clearlinux/common/master/user-setup.sh
-
-#. Make :file:`user-setup.sh` executable:
-
-   .. code-block:: bash
-
-      chmod +x user-setup.sh
-
-#. Run the script as an unprivileged user:
-
-   .. code-block:: bash
-
-      ./user-setup.sh
-
-#. After the script completes, log out and log in again to complete the setup
-   process.
-
-#. Set your Git user email and username for the repos on your system:
-
-   .. code-block:: bash
-
-      git config --global user.email "you@example.com"
-      git config --global user.name "Your Name"
-
-   This global setting is used by |CL| tools that make use of Git.
-
-.. _install-tooling-end:
-
-Related topics
-**************
-
-* :ref:`Mixer tool <mixer>`
-
-.. _`Makefile.common`: https://github.com/clearlinux/common/blob/master/Makefile.common
-.. _autospec README: https://github.com/clearlinux/autospec
-.. _control files: https://github.com/clearlinux/autospec#control-files
-.. _mock wiki: https://github.com/rpm-software-management/mock/wiki
-.. _rpm website: http://rpm.org
-.. _RPM Packaging Guide: https://rpm-packaging-guide.github.io/

_sources/guides/clear/ister.rst.txt

@@ -1,93 +0,0 @@
-.. _ister:
-
-ister.py image builder
-######################
-
-The `ister.py`_ tool is a template-based installer used by |CL-ATTR| to produce
-images for each release. The same ister tool is available for use in |CL| to
-create custom images based on an upstream image.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Description
-***********
-
-|CL| is a rolling release and produces an average of 10 releases per week using the
-ister tool. With each release we produce multiple
-:ref:`image types for different environments <image-types>` and use cases such
-as installers, Hyper-V, KVM, or VMWare.
-
-Each image has a JSON configuration file that is used by ister to generate the 
-image. These JSON configuration files describe the image type, partitions, version,
-and bundles that will be preinstalled by default with the image. For each image
-type we produce, the corresponding JSON configuration file for the image also is
-published.
-
-The :ref:`mixer<mixer>` tool also uses ister to build images for your custom
-mix. Like upstream images, a JSON configuration file is defined for the image,
-which ister uses to generate the image. Refer to the :ref:`mixer<mixer>` guide
-for instructions on using ister to build an image for a custom mix.
-
-Examples
-********
-
-Recreate an upstream image
-==========================
-
-The published configuration files for upstream images may be used to recreate an
-image. Here are some examples:
-
-* Use an older version of |CL| and the image is no longer available (only after
-  March 2017).
-* Customize the partitions of an image.
-* Customize the bundles preinstalled in an image.
-* Run your own post installation script.
-
-
-Follow these steps to recreate an upstream image based on the image's JSON
-configuration file:
-
-#. Install the :command:`os-installer` bundle. Refer to :ref:`swupd-guide` for
-   more information on installing bundles.
-
-#. Download the `ister.py`_ tool and grant it sudo privileges.
-
-#. Download the JSON configuration file for the desired image (located in
-   :file:`config/image/`):
-
-   * `Current release`_
-   * `Previous releases`_ (only after March 2017)
-
-   For a previous release, navigate to `Previous releases`_, select the version
-   you want, and find the JSON configuration file under
-   :file:`/clear/config/image`. For example:
-   ``https://cdn.download.clearlinux.org/releases/15700/clear/config/image/``
-
-#. Download the “PostNonChroot” script (if applicable).
-
-   The JSON configuration file for the image may have an accompanying
-   “PostNonChroot” script that is executed at the end of the image creation
-   process. If it does, download the script and make it executable.
-
-#. Edit the JSON configuration file as needed.
-
-#. If your configuration file has an accompanying "PostNonChroot" script, change
-   the default path of the script to match your path.
-
-#. Generate the new image with the following command:
-
-   .. code-block:: bash
-
-   	sudo ister.py -t [JSON configuration]
-
-Related topics
-**************
-
-* :ref:`mixer`
-* :ref:`bulk-provision`
-
-.. _ister.py: https://github.com/bryteise/ister
-.. _Current release: https://cdn.download.clearlinux.org/current/
-.. _Previous releases: https://cdn.download.clearlinux.org/releases/

_sources/guides/clear/mixer.rst.txt

@@ -1,859 +0,0 @@
-.. _mixer:
-
-mixer
-#####
-
-**mixer** is the tool used by the |CL-ATTR| team to generate official update
-content and releases. The update content generated by mixer is then consumed
-by swupd on a downstream client. The same mixer tool is available as part of
-|CL| to create your own customized update content and releases.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Description
-***********
-
-mixer uses the following sources as inputs to generate update content:
-
-* Upstream |CL| bundles with their corresponding RPM packages
-* Locally-defined bundles with their corresponding local RPM packages
-* Locally-defined bundles with upstream RPM packages
-
-Using the mixer tool, you select which set of content from these sources
-will be part of your update. You can select content from each of these sources to make a unique combination of functionality for your custom update content, known as a **mix**.
-
-The update content that mixer generates consists of various pieces of OS
-content, update metadata, as well as a complete image. The OS content
-includes all files in an update, as well as zero- and delta-packs for improved update performance. The update metadata, stored as manifests, describes all of the bundle information for the update. Update content produced by mixer is then published to a web server and consumed by clients via swupd. Refer to :ref:`swupd <swupd-guide>` for additional information regarding updates and update content.
-
-How it works
-************
-
-Learn the mixer tool set up and workflow.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Prerequisites
-=============
-
-* :command:`mixer` bundle
-
-  Add the mixer tool with the :command:`mixer` bundle. Refer to
-  :ref:`swupd-guide` for more information on installing bundles.
-
-* Docker\* container
-
-  mixer by default runs all build commands in a Docker container to ensure
-  the correct tool versions are used. This also allows custom mixes to
-  automatically perform downstream format bumps when the upstream releases a
-  format bump. See `Format version`_ for additional information regarding
-  format bumps.
-
-  Refer to `Configure and enable Docker`_ for instruction.
-
-* Docker proxy (optional)
-
-  If you use a proxy server, you must set your proxy environment variables and
-  create a proxy configuration file for the Docker daemon and container.
-
-  Consult your IT department for the correct values if you are behind a
-  corporate proxy.
-
-  Refer to `Configure Docker proxy info`_ for instruction.
-
-* Location to host the update content and images
-
-  In order for swupd to make use of your mix, the update content for your mix
-  must be hosted on a web server. Your mix will be configured with an update
-  location URL, which swupd will use to pull down updates.
-
-  Refer to `Set up a nginx web server for mixer`_ for an simple example of
-  setting up an update location.
-
-Mix setup
-==========
-
-Follow these steps to create and initialize the mixer workspace. Complete
-the setup before you create a mix.
-
-#. Create workspace.
-
-   The mixer tool uses a simple workspace to contain all input and output in a
-   basic directory structure. The workspace is simply an empty folder from
-   which you execute the mixer commands. Each mix uses its own separate
-   workspace.
-
-#. Initialize the workspace and mix.
-
-   Before you create a mix, you must explicitly initialize the mixer workspace.
-   During initialization, the mixer workspace is configured and the base for
-   your mix is defined. By default, your mix is based on the latest
-   upstream version and starts with the minimum set of bundles. Your first custom
-   mix version number starts at 10. Alternatively, you can select other
-   versions or bundle sets from which to start.
-
-   Initialization creates the directory structure within the workspace and adds
-   the :file:`builder.conf` file, which is used to configure the mixer tool.
-
-   View the `mixer.init man page`_ for more information on mixer
-   initialization.
-
-   View the list of suitable `releases`_ from which to mix.
-
-#. Edit builder.conf.
-
-   :file:`builder.conf` tells the mixer tool how to configure the mix. For
-   example, it allows you to configure where mixer output is located and where
-   swupd update content will be located.
-
-   At minimum, set the URL of your update server so your custom OS knows where
-   to get update content.
-
-   Refer to the `builder.conf`_ section for more information.
-
-Create a mix
-============
-
-A mix is created with the following steps:
-
-#. Add custom RPMs and set up local repo (optional).
-
-   If you are adding custom RPMs to your mix, you must add the RPMs to
-   your mix workspace and set up a corresponding local repository.
-
-   Go to the :ref:`autospec<autospec>` guide to learn to build RPMs from
-   scratch. If the RPMs are not built on |CL|, make sure your
-   configuration and toolchain builds them correctly for |CL|. Otherwise there
-   is no guarantee they will be compatible.
-
-   Refer to the :ref:`autospec` guide for more information on using autospec to
-   build RPMs.
-
-#. Update and build bundles.
-
-   Add, edit, or remove bundles that will be part of your content and build
-   them. mixer automatically updates the :file:`mixbundles` file when you
-   update the bundles in your mix.
-
-   View the `mixer.bundle man page`_ for more information on configuring bundles
-   in a mix.
-
-   View the `mixer.build man page`_ for more information on building bundles.
-
-   View the `Bundles`_ section for more information on how mixer manages
-   bundles.
-
-#. Create the update content.
-
-   mixer creates update content with this step. Zero-packs are created
-   automatically, and delta-packs can be optionally created at the same time
-   (for all builds after version 0).
-
-   A zero-pack is the full set of content needed to go from mix version 0
-   (nothing) to the mix version for which you just built content.
-
-   A delta-pack provides the content *delta* between a `PAST_VERSION` to a
-   `MIX_VERSION` that allows the transition from one mix version to another.
-
-   View :ref:`swupd-guide`  for more information on update content.
-
-#. Create image.
-
-   mixer creates a bootable image from your updated content using
-   the :ref:`ister` tool. In this step you can specify which bundles you want
-   *preinstalled* in the image. Users can later install other bundles available
-   in your mix.
-
-#. Make update available.
-
-   Deploy update content and images to your update server.
-
-   View the `Example 3: Deploy updates to target`_ for a simple deployment
-   scenario.
-
-Maintain or modify mix
-======================
-
-Update or modify your content to a new version by following the steps to
-create a mix. Increment the mix version number for the next mix.
-
-Examples
-********
-
-The following examples are designed to work together and in order. The examples
-use:
-
-* A stock installation of |CL|.
-* A web server that comes with |CL| to host the content updates.
-* A simple VM that updates against the locally produced content created in
-  Example 2.
-
-Complete all `Prerequisites`_ before using these examples.
-
-Example 1: Mix set up
-======================
-
-This example shows the basic steps for the first-time setup of 
-mixer for a new mix.
-
-#. Create an empty directory to use as a workspace for mixer:
-
-   .. code-block:: bash
-
-      mkdir ~/mixer
-
-#. In your mixer workspace, generate an initial mix based on the latest upstream
-   |CL| version, with minimum bundles. In the initialization output, be aware 
-   that your initial mix version is set to 10 and that the minimum bundles have 
-   been added.
-
-   .. code-block:: bash
-
-      cd ~/mixer
-      mixer init
-
-#. Edit :file:`builder.conf` to set the value of CONTENTURL and VERSIONURL to
-   the IP address of  the nginx\* server you set up in the prerequisite
-   `Set up a nginx web server for mixer`_. For example:
-
-   .. code-block:: console
-
-      CONTENTURL="http://192.168.25.52"
-      VERSIONURL="http://192.168.25.52"
-
-Example 2: Create a simple mix
-==============================
-
-This example shows how to create a simple custom mix using upstream content.
-We'll create an image for a QEMU virtual machine that we can use later to test
-our mix.
-
-We can use the default bundles that were added during initialization, but these
-include the :command:`native-kernel` bundle that is intended to be used on a
-bare metal system instead of a VM. So we will modify the default bundle
-set to get a smaller kernel image, which will also be faster to load.
-
-#. Update bundles in mix:
-
-   .. code-block:: bash
-
-      mixer bundle remove kernel-native
-      mixer bundle add kernel-kvm
-
-#. In this case, we will add the `editors` bundle from upstream, but we will
-   remove the `joe` editor.
-
-   .. code-block:: bash
-
-      mixer bundle add editors
-      mixer bundle edit editors
-
-#. Use an editor and manually remove `joe` from the bundle definition.
-
-   .. code-block:: bash
-
-      $EDITOR ./local-bundles/editors
-
-#. List the bundles in the mix again to confirm removal.
-
-   .. code-block:: bash
-
-      mixer bundle list  --tree
-
-
-#. Build bundles:
-
-   .. code-block:: bash
-
-      mixer build bundles
-
-   Look in ~/mixer/update/image/<mix version>/full for the full chroot after the
-   :command:`build` command completes.
-
-#. Build update content. Browse to your \http://localhost site and you'll see
-   the web page is now up, but with no update content. Build the update content:
-
-   .. code-block:: bash
-
-      mixer build update
-
-   Refresh your \http://localhost site and now you can see the update
-   content for mix version 10.
-
-   Look in ~/mixer/update/www/<mix version> to see the update content in your
-   workspace.
-
-#. Configure image. Edit the ister configuration file for your image to include
-   all of the bundles you want preinstalled in the image. If this is the first
-   time creating an image, first get a copy of the
-   :file:`release-image-config.json` template file:
-
-   .. code-block:: bash
-
-      curl -O https://raw.githubusercontent.com/bryteise/ister/master/release-image-config.json
-
-   For this example, edit :file:`release-image-config.json` so that the root
-   partition size is "5G" and replace the "kernel-native" bundle with
-   "kernel-kvm".
-
-   .. code-block:: console
-
-      {
-        "DestinationType" : "virtual",
-        "PartitionLayout" : [ { "disk" : "release.img", "partition" : 1, "size" : "32M", "type" : "EFI" },
-                              { "disk" : "release.img", "partition" : 2, "size" : "16M", "type" : "swap" },
-                              { "disk" : "release.img", "partition" : 3, "size" : "5G", "type" : "linux" } ],
-        "FilesystemTypes" : [ { "disk" : "release.img", "partition" : 1, "type" : "vfat" },
-                              { "disk" : "release.img", "partition" : 2, "type" : "swap" },
-                              { "disk" : "release.img", "partition" : 3, "type" : "ext4" } ],
-        "PartitionMountPoints" : [ { "disk" : "release.img", "partition" : 1, "mount" : "/boot" },
-                                   { "disk" : "release.img", "partition" : 3, "mount" : "/" } ],
-        "Version": "latest",
-        "Bundles": ["kernel-kvm", "os-core", "os-core-update"]
-      }
-
-#. Build the image.
-
-   .. code-block:: bash
-
-      sudo mixer build image
-
-   The output from this step will be :file:`release.img`, which is a live image.
-
-#. Make the next mix. Create a new version of your mix, for the live image to
-   update to. Increment your mix version by 10:
-
-   .. code-block:: bash
-
-      mixer versions update
-
-   Repeat steps 1-3 to add the upstream :command:`curl` bundle to the mix:
-
-   .. code-block:: bash
-
-      mixer bundle add curl
-      mixer build bundles
-      mixer build update
-
-   Build optional delta-packs, which helps reduce client update time:
-
-   .. code-block:: bash
-
-      mixer build delta-packs --from 10 --to 20
-
-   Refresh your \http://localhost site to see the update content for
-   mix version 20.
-
-   Look in ~/mixer/update/www/<mix version> to see the update content in your
-   workspace.
-
-Example 3: Deploy updates to target
-===================================
-
-The image created in Example 2 is directly bootable in QEMU. In this example,
-we'll boot the image from Example 2 to verify it, and update the image from
-mix version 10 (from which the image was built), to mix version 20.
-
-#. Set up the QEMU environment.
-
-   Install the :command:`kvm-host` bundle to your |CL|:
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add kvm-host
-
-   Get the virtual EFI firmware, download the image launch script, and make it
-   executable:
-
-   .. code-block:: bash
-
-      curl -O https://download.clearlinux.org/image/OVMF.fd
-      curl -O https://download.clearlinux.org/image/start_qemu.sh
-      chmod +x start_qemu.sh
-
-#. Start your VM image (created in Example 2):
-
-   .. code-block:: bash
-
-      sudo ./start_qemu.sh release.img
-
-#. Log in as root and set a password
-
-#. Try out your mix.
-
-   Take a look at the default bundles installed in your mix:
-
-   .. code-block:: bash
-
-      swupd info
-      swupd bundle-list
-      swupd bundle-list -a
-
-#. Now we will add the `editors` bundle that we modified.
-
-   .. code-block:: bash
-
-      swupd bundle add editors
-
-#. Try to start the `joe` editor.  It should not appear because we removed it
-   from the original `editors` bundle.
-
-#. Next we will update from version 10 to 20 to capture the newly
-   available bundles. Use :command:`swupd` to update your mix:
-
-   .. code-block:: bash
-
-      swupd check-update
-      swupd update
-      swupd bundle-list -a
-
-#. Now your mix should be at version 20 and curl is now available. Try using
-   curl. This will fail because curl is not yet installed:
-
-   .. code-block:: console
-
-      curl: command not found
-      To install curl use: swupd bundle-add curl
-
-   Add the new bundle from your update server to your VM. Retry curl. It works!
-
-   .. code-block:: bash
-
-      swupd bundle-add curl
-      curl -O https://download.clearlinux.org/image/start_qemu.sh
-
-   Shutdown your VM:
-
-   .. code-block:: bash
-
-      poweroff
-
-
-.. Example: Create a mix with custom RPM
-.. -------------------------------------
-.. TODO future example to show copy into local-rpms...
-
-References
-**********
-
-Reference the `mixer man page`_ for details regarding mixer commands and options.
-
-.. contents::
-   :local:
-   :depth: 1
-
-.. rst-class:: content-collapse
-
-builder.conf
-============
-
-mixer initialization creates a :file:`builder.conf` that stores the basic
-configuration for the mixer tool. The items of primary interest are CONTENTURL
-and VERSIONURL, which will be used by systems updating against your custom
-content.
-
-.. code-block:: console
-
-   #builder.conf
-
-   #VERSION 1.0
-
-   [Builder]
-     CERT = "/home/clr/mix/Swupd_Root.pem"
-     SERVER_STATE_DIR = "/home/clr/mix/update"
-     VERSIONS_PATH = "/home/clr/mix"
-     YUM_CONF = "/home/clr/mix/.yum-mix.conf"
-
-   [Swupd]
-     BUNDLE = "os-core-update"
-     CONTENTURL = "<URL where the content will be hosted>"
-     VERSIONURL = "<URL where the version of the mix will be hosted>"
-
-   [Server]
-     DEBUG_INFO_BANNED = "true"
-     DEBUG_INFO_LIB = "/usr/lib/debug"
-     DEBUG_INFO_SRC = "/usr/src/debug"
-
-   [Mixer]
-     LOCAL_BUNDLE_DIR = "/home/clr/mix/local-bundles"
-     LOCAL_REPO_DIR = ""
-     LOCAL_RPM_DIR = ""
-     DOCKER_IMAGE_PATH = "clearlinux/mixer"
-
-Additional explanation of variables in :file:`builder.conf` is provided in Table
-1.
-
-+-------------------------------+----------------------------------------------------------+
-| **Variable**                  | **Explanation**                                          |
-+-------------------------------+----------------------------------------------------------+
-| `CERT`                        | Sets the path where mixer stores the certificate file    |
-|                               | used to sign content for verification. mixer             |
-|                               | automatically generates the certificate if you do not    |
-|                               | provide the path to an existing one, and signs the       |
-|                               | :file:`Manifest.MoM` file to provide security for the    |
-|                               | updated content you create.                              |
-|                               |                                                          |
-|                               | chroot-builder uses the certificate file to sign         |
-|                               | the root :file:`Manifest.MoM` file to provide            |
-|                               | security for content verification.                       |
-|                               |                                                          |
-|                               | swupd uses this certificate to verify the                |
-|                               | :file:`Manifest.MoM` file's signature.                   |
-|                               |                                                          |
-|                               | For now, we strongly recommend that you do not modify    |
-|                               | this variable, as swupd expects a certificate with a     |
-|                               | very specific configuration to sign and verify           |
-|                               | properly.                                                |
-+-------------------------------+----------------------------------------------------------+
-| `CONTENTURL` and `VERSIONURL` | Set these variables to the IP address of the web server  |
-|                               | hosting the update content.                              |
-|                               |                                                          |
-|                               | VERSIONURL is the IP address where the swupd client      |
-|                               | looks to determine if a new version is available.        |
-|                               |                                                          |
-|                               | CONTENTURL is the location from which swupd pulls        |
-|                               | content updates.                                         |
-|                               |                                                          |
-|                               | If the web server is on the same machine as the          |
-|                               | SERVER_STATE_DIR directory, you can create a symlink to  |
-|                               | the directory in your web server's document root to      |
-|                               | easily host the content.                                 |
-|                               |                                                          |
-|                               | These URLs are embedded in the images created by mixer.  |
-+-------------------------------+----------------------------------------------------------+
-| `DOCKER_IMAGE_PATH`           | Sets the base name of the docker image that mixer pulls  |
-|                               | down to run builds in the proper container.              |
-+-------------------------------+----------------------------------------------------------+
-| `LOCAL_BUNDLE_DIR`            | Sets the path where mixer stores the local bundle        |
-|                               | definition files. The bundle definition files include    |
-|                               | any new, original bundles you create, along with any     |
-|                               | edited versions of upstream bundles.                     |
-+-------------------------------+----------------------------------------------------------+
-| `SERVER_STATE_DIR`            | Sets the path to which mixer outputs content. By         |
-|                               | default, mixer automatically sets the path.              |
-+-------------------------------+----------------------------------------------------------+
-| `VERSIONS_PATH`               | Sets the path for the mix version and upstream version's |
-|                               | two state files: :file:`mixversion` and                  |
-|                               | :file:`upstreamversion`. mixer creates both files for    |
-|                               | you when you set up the workspace.                       |
-+-------------------------------+----------------------------------------------------------+
-| `YUM_CONF`                    | Sets the path where mixer automatically generates the    |
-|                               | :file:`.yum-mix.conf` file.                              |
-|                               |                                                          |
-|                               | The yum configuration file points the chroot-builder to  |
-|                               | where the RPMs are stored.                               |
-+-------------------------------+----------------------------------------------------------+
-| **Table 1**: *Variables in builder.conf*                                                 |
-+-------------------------------+----------------------------------------------------------+
-
-Format version
---------------
-
-Compatible versions of an OS are tracked with an OS *compatibility epoch*.
-Versions of an OS within an epoch are fully compatible and can update to any
-other version within that epoch. The compatibility epoch is set as the
-`Format` variable in the :file:`mixer.state` file. Variables in the
-:file:`mixer.state` are used by mixer between executions and should not be
-manually changed.
-
-A format bump is like modifying the foundation of a house to create a new
-level. If `Format` increments to a new epoch (a "format bump"), the OS has
-changed in such a way that updating from build A in format X to build B in
-format Y will not work.
-
-A format bump is required when:
-
-* The software updater, :command:`swupd`, or the software is no longer
-  compatible with the previous update scheme
-
-* A package is removed from the update stream and the update must ensure the
-  files associated with that package are removed from the system
-
-Using a format increment, we make sure pre- and co-requisite changes flow out
-with proper ordering. The updated client will only update to the latest
-release in its respective format version, unless overridden by command line
-flags. In this way, we can guarantee that all clients update to the final
-version in their given format.
-
-The given format *must* contain all the changes needed to understand the content built in the next format. Only after reaching the final release in the old format can a client continue to update to releases in the new format.
-
-The format version is incremented only when a compatibility breakage is
-introduced. Normal updates, such as updating a software package, do not require a format increment.
-
-.. rst-class:: content-collapse
-
-Bundles
-=======
-
-mixer stores information about the bundles included in a mix in a flat file
-called :file:`mixbundles`, which is located in the path set by the VERSIONS_PATH variable in :file:`builder.conf`. :file:`mixbundles` is automatically created when the mix is initiated. mixer will refresh the file each time you change the bundles in the mix.
-
-Bundles can include other bundles. Nested bundles can themselves include
-other bundles. If you see an unexpected bundle in your mix, it is likely a
-nested bundle in one of the bundles you explicitly added.
-
-A bundle will fill into one of two categories: upstream or local. Upstream
-bundles are those provided by |CL|. Local bundles are either modified upstream bundles or new local bundles.
-
-Upstream bundles
-----------------
-
-mixer automatically downloads and caches upstream bundle definition files.
-These definition files are stored in the upstream-bundles directory in the
-workspace. Do not modify the files in this directory. This directory is
-simply a mirror for mixer to use. mixer will automatically delete the
-contents of this directory before repopulating it on-the-fly if a new
-version must be downloaded.
-
-The mixer tool automatically caches the bundles for the |CL| version
-configured in the :file:`upstreamversion` file. mixer also cleans up old
-versions once they are no longer needed.
-
-Local bundles
--------------
-
-Local bundles are bundles that you create, or are edited versions of upstream
-bundles. Local bundle definition files are stored in the local-bundles
-directory in the workspace. The LOCAL_BUNDLE_DIR variable sets the path of this directory in the :file:`builder.conf` file.
-
-*mixer always checks for local bundles first and the upstream bundles
-second.* So bundles in the local-bundles directory will always take
-precedence over any upstream bundles that have the same name. This
-precedence enables you to copy upstream bundles locally, and edit into a
-local variation.
-
-Bundle configuration
---------------------
-
-mixer provides commands to configure the bundles for a mix, such as to add a
-bundle to a mix, to create a new bundle for a mix, or to remove a bundle from a
-mix. View the `mixer.bundle man page`_ for a full list of commands and more
-information on configuring bundles in a mix.
-
-Editing an existing local bundle is as simple as opening the bundle definition
-file in your favorite editor, making the desired edits, and saving your changes.
-
-.. note::
-
-   Removing bundles from a mix: By default, removing a bundle will only
-   remove the bundle from the mix. The local bundle definition file will
-   still remain. To completely remove a bundle, including its local bundle definition file, use the :command:`--local` flag.
-
-   If you remove the bundle definition file for a local, edited version of an
-   upstream bundle in a mix, the mix reverts to reference the original upstream version of the bundle.
-
-.. rst-class:: content-collapse
-
-Configure and enable Docker
-===========================
-
-Use these steps to enable Docker for the mixer tool. Make sure to
-`Configure Docker proxy info`_ first if needed.
-
-#. Start the Docker daemon:
-
-   .. code-block:: bash
-
-      sudo systemctl start docker
-      sudo chmod 777 /var/run/docker.sock
-      sudo docker info
-
-#. Add user to the docker group
-
-   .. code-block:: bash
-
-      sudo usermod -G docker -a <username>
-
-Pull Docker container manually (optional)
------------------------------------------
-
-By default, mixer automatically pulls a Docker container for mixing if one
-does not already exist. If you need to troubleshoot the mixer container, it
-may be useful to manually pull a mixer Docker container.
-
-Versions of the mixer Docker container are available under the tags for the
-`clearlinux/mixer repo <https://hub.docker.com/r/clearlinux/mixer/tags/>`_
-on Docker Hub. Each version of the mixer Docker container is named after the
-associated |CL| upstream format version. Refer to `Format version`_ for
-additional information on upstream format versions.
-
-Use the following steps to manually pull a mixer Docker container:
-
-#. Find the version of the container you need by viewing the tags for the
-   `clearlinux/mixer repo <https://hub.docker.com/r/clearlinux/mixer/tags/>`_
-   on Docker Hub.
-
-#. Pull the latest container version:
-
-   .. code-block:: bash
-
-      docker pull clearlinux/mixer:<upstream-format-version>
-
-#. View local docker images:
-
-   .. code-block:: bash
-
-      docker images
-
-.. rst-class:: content-collapse
-
-Configure Docker proxy info
-===========================
-
-If needed, use these steps to configure the Docker proxy information.
-
-#. Create the Docker daemon proxy config directory:
-
-   .. code-block:: bash
-
-      sudo mkdir -p /etc/systemd/system/docker.service.d
-
-#. Create :file:`/etc/systemd/system/docker.service.d/http-proxy.conf` and
-   add the following using your own proxy values:
-
-   .. code-block:: console
-
-      [Service]
-      Environment="HTTP_PROXY=<HTTP proxy URL>:<port number>"
-      Environment="HTTPS_PROXY=<HTTPS proxy URL>:<port number>"
-
-#. Reload the Docker daemon:
-
-   .. code-block:: bash
-
-      sudo systemctl daemon-reload
-
-Configure the Docker container proxies, to pass proxy settings to
-containers:
-
-#. Create a directory for your container config:
-
-   .. code-block:: bash
-
-      mkdir ~/.docker
-
-#. Create the config file :file:`~/.docker/config.json` and add the following
-   entries, using your own proxy values:
-
-   .. code-block:: console
-
-      {
-        "proxies":
-        {
-          "default":
-          {
-            "httpProxy": "<proxy-url>:<port>",
-            "httpsProxy": "<proxy-url>:<port>"
-          }
-        }
-      }
-
-#. Set ownership and permission on the docker config directory:
-
-   .. code-block:: bash
-
-      sudo chown "$USER":"$USER" /home/"$USER"/.docker -R
-      sudo chmod g+rwx "$HOME/.docker" -R
-
-Configure proxies to allow mixer to access upstream content from behind
-a firewall.
-
-#. Open your :file:`$HOME/.bashrc` file and add proxy and port values for the
-   following:
-
-   .. code-block:: console
-
-      export http_proxy="<proxy-url>:<port>"
-      export https_proxy="<proxy-url>:<port>"
-      export HTTP_PROXY="<proxy-url>:<port>"
-      export HTTPS_PROXY="<proxy-url>:<port>"
-      export no_proxy="<...>"
-
-#. Log out and log back in for the proxies to take effect.
-
-.. rst-class:: content-collapse
-
-Set up a nginx web server for mixer
-===================================
-
-A web server is needed to host your update content. In this example, we use
-the nginx web server, which comes with |CL|.
-
-Set up a nginx web server for mixer with the following steps:
-
-#. Install the :command:`nginx` bundle:
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add nginx
-
-#. Make the directory where mixer updates will reside:
-
-   .. code-block:: bash
-
-      sudo mkdir -p /var/www
-
-#. Create a symbolic link between your workspace updates and the updates on
-   the local nginx web server. In this example, `$HOME/mixer` is the
-   workspace for the mix.
-
-   .. code-block:: bash
-
-      sudo ln -sf $HOME/mixer/update/www /var/www/mixer
-
-#. Set up ``nginx`` configuration:
-
-   .. code-block:: bash
-
-      sudo mkdir -p  /etc/nginx/conf.d
-
-#. Copy the default example configuration file:
-
-   .. code-block:: bash
-
-      sudo cp -f /usr/share/nginx/conf/nginx.conf.example /etc/nginx/nginx.conf
-
-#. Configure the mixer update server. Create and add the following server
-   configuration content to :file:`/etc/nginx/conf.d/mixer.conf` (sudo required):
-
-   .. code-block:: console
-
-      server {
-           server_name localhost;
-           location / {
-                     root /var/www/mixer;
-                     autoindex on;
-           }
-      }
-
-#. Restart the daemon, enable nginx on boot, and start the service.
-
-   .. code-block:: bash
-
-      sudo systemctl daemon-reload
-
-      sudo systemctl enable nginx
-
-      sudo systemctl start nginx
-
-#. Verify the web server is running at \http://localhost. At this point
-   you should no longer see a "404 Not Found" message.
-
-Related topics
-**************
-
-* :ref:`About mixer <mixer-about>`
-* :ref:`autospec-about`
-* :ref:`bundles-about`
-* :ref:`swupd-about`
-
-.. _Docker Hub: https://hub.docker.com/r/clearlinux/mixer/tags/
-.. _mixer man page: https://github.com/clearlinux/mixer-tools/blob/master/docs/mixer.1.rst
-.. _mixer.init man page: https://github.com/clearlinux/mixer-tools/blob/master/docs/mixer.init.1.rst
-.. _mixer.bundle man page: https://github.com/clearlinux/mixer-tools/blob/master/docs/mixer.bundle.1.rst
-.. _mixer.build man page: https://github.com/clearlinux/mixer-tools/blob/master/docs/mixer.build.1.rst
-.. _releases: https://github.com/clearlinux/clr-bundles/releases

_sources/guides/guides.rst.txt

@@ -1,58 +0,0 @@
-.. _guides:
-
-Guides
-######
-
-The following guides provide step-by-step instructions on using |CL|.
-
-.. note::
-
-   As of 22 May 2019 :file:`mixin` is no longer supported.
-
-Clear Linux
-===========
-
-.. toctree:: 
-   :maxdepth: 1
-   :glob:
-
-   clear/*
-   telemetrics/*
-
-Maintenance
-===========
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   maintenance/*
-   deploy-at-scale
-
-Network
-=======
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   network/*
-
-Kernel
-=======
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   kernel/*
-
-Stacks
-=======
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   stacks/*
-   stacks/dlrs/*

_sources/guides/kernel/kernel-development.rst.txt

@@ -1,454 +0,0 @@
-.. _kernel-development:
-
-Kernel development
-##################
-
-This guide shows how to obtain and compile a Linux\* kernel source using
-|CL-ATTR| development tooling.
-
-.. contents::
-   :local:
-   :depth: 1
-   :backlinks: top
-
-Overview
-********
-
-The :ref:`compatible-kernels` available in |CL| aim to be performant and
-practical. In some cases, it may be necessary to modify the kernel to suit your
-specific needs or test new kernel code as a developer.
-
-`Source RPMs (SRPMS)`_ are also available for all |CL| kernels, and can be
-used for development instead.
-
-Request changes be included with the |CL| kernel
-************************************************
-
-If the kernel modification you need is already open source and likely to be
-useful to others, consider submitting a request to include it in the
-|CL| kernels. If your change request is accepted, you do not need to maintain
-your own modified kernel.
-
-Make enhancement requests to the |CL| `Distribution Project`_ on GitHub\*.
-
-Set up kernel development environment
-*************************************
-
-In some cases, it may be necessary to modify the kernel to suit your specific
-needs or to test new kernel code.
-
-You can build and install a custom kernel; however you must:
-
-* Disable Secure Boot
-* Maintain any updates to the kernel going forward
-
-To create a custom kernel, start with the |CL| development environment.
-Then make changes to the kernel, build it, and install it.
-
-
-Install the |CL| development tooling framework
-==============================================
-
-.. include:: ../clear/autospec.rst
-   :start-after: install-tooling-after-header:
-   :end-before: install-tooling-end:
-
-Clone the kernel package
-========================
-
-Clone the existing kernel package repository from |CL| as a starting point.
-
-#. Clone the Linux kernel package from |CL|. Using the
-   :command:`make clone_<PACKAGENAME>` command in the
-   :file:`clearlinux/` directory clones the package from the
-   `clearlinux-pkgs`_ repo on GitHub.
-
-   .. code-block:: bash
-
-      cd ~/clearlinux
-      make clone_linux
-
-#. Navigate into the cloned package directory.
-
-   .. code-block:: bash
-
-      cd ~/clearlinux/packages/linux
-
-
-The "linux" package is the kernel that comes with |CL| in the :command:`kernel-native`
-bundle. Alternatively, you can use a different kernel variant as the base for
-modification. For a list of kernel package names which you can clone instead,
-see the `clearlinux-pkgs`_ repo on GitHub.
-
-.. note::
-
-   The latest version of the |CL| kernel package is pulled as a starting
-   point. An older version can pulled by switching to different git tag by using
-   :command:`git checkout tag/<TAG_NAME>`.
-
-Change the kernel version
-=========================
-
-|CL| tends to use the latest kernel available from `kernel.org`_, the Linux
-upstream. The kernel version that will be built can be changed in the
-RPM SPEC file. While most packages in Clear Linux are typically packaged
-using :ref:`autospec-about`, the kernel is not. This means control files
-provided by autospec are not available and changes must be made manually.
-
-#. Open the Linux kernel package RPM SPEC file in an editor.
-
-   .. code-block:: bash
-
-      $EDITOR linux.spec
-
-#. Modify the Version, Release, and Source0 URL entries at the top of the
-   file to change the version of Linux kernel that will be compiled.
-
-   A list of current and available kernel release can be found on
-   `kernel.org`_.
-
-   .. code-block:: bash
-
-      Name:           linux
-      Version:        4.20.8
-      Release:        696
-      License:        GPL-2.0
-      Summary:        The Linux kernel
-      Url:            http://www.kernel.org/
-      Group:          kernel
-      Source0:        https://cdn.kernel.org/pub/linux/kernel/v4.x/linux-4.20.8.tar.xz
-      Source1:        config
-      Source2:        cmdline
-
-      %define ktarget  native
-
-   .. note::
-      - Consider changing the Name from *linux* in the RPM spec file to easily
-        identify a modified kernel.
-
-      - Consider changing the ktarget from *native* in the RPM spec file to
-        easily identify a modified kernel.
-
-#. Commit and save the changes to the file.
-
-.. _pull-copy-kernel-source:
-
-Pull a copy of the Linux kernel source code
-===========================================
-
-Obtain a local copy of the source code to make modifications against.
-
-#. Run make sources to pull the kernel source code specified in the RPM
-   SPEC file. In the example, it downloads the :file:`linux-4.20.8.tar.xz` file.
-
-   .. code-block:: bash
-
-      make sources
-
-
-#. Extract the kernel source code archive. This will create a working copy
-   of the Linux source that you can modify.
-
-   .. code-block:: bash
-
-      tar -xvf linux-4.20.8.tar.xz
-
-#. Navigate to the extracted directory. In this example, it has been
-   extracted into a :file:`linux-4.20.8` directory.
-
-   .. code-block:: bash
-
-      cd linux-4.20.8/
-
-
-Customize the Linux kernel source
-*********************************
-
-After the kernel sources have been obtained, customizations to the kernel
-configuration or source code can be made for inclusion with the kernel
-build. These customizations are optional.
-
-Modify kernel configuration
-===========================
-
-The kernel source has many configuration options available to pick support for
-different hardware and software features.
-
-These configuration values must be provided in the :file:`.config` file at
-compile time. You will need to make modifications to the :file:`.config`
-file, and include it in the kernel package.
-
-
-#. Make sure you have followed the steps to :ref:`pull-copy-kernel-source`
-   and are in the kernel source working directory.
-
-
-#. If you have an existing :file:`.config` file from an old kernel, copy it
-   into the working directory as :file:`.config` for comparison.
-   Otherwise, use the |CL| kernel configuration file as template
-
-   .. code-block:: bash
-
-      cp ~/clearlinux/packages/linux/config .config
-
-
-#. Make any desired changes to the :file:`.config` using a kernel
-   configuration tool. Below are some popular options:
-
-   - :command:`$EDITOR .config` - the .config file can be directly edited
-     for simple changes with names that are already known.
-
-   - :command:`make config` - a text-based tool that asks questions
-     one-by-one to decide configuration options.
-
-   - :command:`make menuconfig` - a terminal user interface that provides
-     menus to decide configuration options.
-
-   - :command:`make xconfig` - a graphical user interface that provides
-     tree views to decide configuration options.
-
-
-   More configuration tools can be found by looking at the make help:
-   :command:`make help | grep config`
-
-#. Commit and save the changes to the :file:`.config` file.
-
-#. Copy the :file:`.config` file from the kernel source directory into
-   the kernel package directory as :file:`config` for inclusion in the build.
-
-   .. code-block:: bash
-
-      cp .config ../config
-
-Modify kernel source code
-=========================
-
-Changes to kernel code are applied with patch files. Patch files are
-formatted git commits that can be applied to the main source code.
-
-You will need to obtain a copy of the source code,
-make modifications, generate patch file(s), and add them to the RPM SPEC
-file for inclusion during the kernel build.
-
-If you have a large number of patches or a more complex workflow,
-consider using a patch management tool in addition to Git such as
-`Quilt`_.
-
-
-#. Make sure you have followed the steps to :ref:`pull-copy-kernel-source` and
-   are in the kernel source working directory.
-
-
-#. Initialize the kernel source directory as a new git repo and create a
-   commit with all the existing source files to begin tracking changes.
-
-   .. code-block:: bash
-
-      git init
-      git add -A
-      git commit -m "Initial commit of Linux kernel source"
-
-
-#. Apply patches provided by the |CL| kernel package to the kernel source
-   in the working directory.
-
-   .. code-block:: bash
-
-      git am ../*.patch
-
-
-#. Make any of your desired code changes to the Linux source code files.
-
-
-#. Track and commit your changes to the local git repo.
-
-   .. code-block:: bash
-
-      git add <FILENAME>
-      git commit -m "My patch for driver A" <FILENAME>
-
-
-#. Generate a patch file based on your git commits.
-   <n> represents the number of local commits to create patch file.
-   See the `git-format-patch`_ documentation for detailed information
-   on using :command:`git format-patch`
-
-   .. code-block:: bash
-
-      git format-patch -<n>
-
-#. Copy the patch files from the patches directory in the linux
-   source tree to the RPM build directory.
-
-   .. code-block:: bash
-
-      cp *.patch ~/clearlinux/packages/linux/
-
-
-#. Navigate back to the RPM build directory.
-
-   .. code-block:: bash
-
-      cd ~/clearlinux/packages/linux/
-
-#. Open the Linux kernel package RPM SPEC file in an editor.
-
-   .. code-block:: bash
-
-      $EDITOR linux.spec
-
-#. Locate the section of the SPEC file that contains existing patch
-   variable definitions and append your patch file name. Ensure the
-   patch number does not collide with an existing patch.
-   In this example, the patch file is called
-   :file:`2001-my-patch-for-driver-A.patch`
-
-   .. code-block:: bash
-
-      #
-      # Small Clear Linux Tweaks
-      #
-      Patch0501: 0501-zero-extra-registers.patch
-      Patch0502: 0502-locking-rwsem-spin-faster.patch
-
-      #Serie1.name WireGuard
-      #Serie1.git  https://git.zx2c4.com/WireGuard
-      #Serie1.tag  00bf4f8c8c0ec006633a48fd9ee746b30bb9df17
-      Patch1001: 1001-WireGuard-fast-modern-secure-kernel-VPN-tunnel.patch
-      #Serie1.end
-
-      Patch2001: 2001-my-patch-for-driver-A.patch
-
-
-#. Locate the section of the SPEC file further down that contains
-   patch application and append your patch file number used in the step above.
-   In this example, patch2001 is added.
-
-   .. code-block:: bash
-
-      #
-      # Small tweaks
-      #
-      %patch0501 -p1
-      %patch0502 -p1
-
-      #Serie1.patch.start
-      %patch1001 -p1
-      #Serie1.patch.end
-
-      %patch2001 -p1
-
-
-#. Commit and save the changes to the RPM SPEC file.
-
-Modify kernel boot parameters
-=============================
-The kernel boot options are passed from the bootloader to the kernel with
-command-line parameters.
-
-While temporary changes can be made to kernel parameters on a running
-system or on a during boot, you can also modify the default parameters that
-are persistent and distributed with a customized kernel.
-
-
-#. Open the kernel :file:`cmdline` file in an editor.
-
-   .. code-block:: bash
-
-      $EDITOR cmdline
-
-
-#. Make any desired change to the kernel parameters.
-   For example, you can remove the :command:`quiet` parameter to see more
-   verbose output of kernel log messages during the boot process.
-
-#. Commit and save the changes to the :file:`cmdline` file.
-
-See the `kernel parameters`_  documentation for a list of available
-parameters.
-
-Build and install the kernel
-****************************
-After changes have been made to the kernel source and RPM SPEC file,
-the kernel is ready to be compiled and packaged into an RPM.
-
-The |CL| development tooling makes use of :command:`mock` environments to
-isolate building of packages in a sanitized workspace.
-
-#. Start the compilation process by issuing the :command:`make build`
-   command. This process is typically resource intensive and will take a while.
-
-   .. code-block:: bash
-
-      make build
-
-   .. note::
-      The mock plugin `ccache`_ can be enabled to help speed up any future
-      rebuilds of the kernel package by caching compiler outputs and reusing
-      them.
-
-
-#. The result will be multiple :file:`.rpm` files in the :file:`rpms`
-   directory as output.
-
-   .. code-block:: bash
-
-      ls rpms/
-
-   The kernel RPM will be named
-   :file:`linux<NAME>-<VERSION>-<RELEASE>.x86_64.rpm`
-
-
-#. The kernel RPM file can be input to the :ref:`mixer` to create a
-   custom bundle and mix of |CL|.
-
-Alternatively, the kernel RPM bundle can be installed manually on a local
-machine for testing. This approach works well for individual development or
-testing. For a more scalable and customizable approach, consider using the
-:ref:`mixer` to provide a custom kernel with updates.
-
-#. Install the kernel onto the local system by extracting the RPM with the
-   :command:`rpm2cpio` command.
-
-   .. code-block:: bash
-
-      rpm2cpio linux<NAME>-<VERSION>-<RELEASE>.x86_64.rpm | (cd /; sudo cpio -i -d -u -v);
-
-
-#. Update the |CL| boot manager using :command:`clr-boot-manager` and reboot.
-
-   .. code-block:: bash
-
-      sudo clr-boot-manager list-kernels
-      sudo clr-boot-manager set-kernel org.clearlinux.<TARGET>.<VERSION>-<RELEASE>
-
-      sudo reboot
-
-
-#. After a reboot, verify the customized kernel is running.
-
-   .. code-block:: bash
-
-      uname -a
-
-Related topics
-**************
-
-* :ref:`kernel-modules`
-* :ref:`mixer`
-
-.. _Distribution Project: https://github.com/clearlinux/distribution/issues/new/choose
-
-.. _Source RPMs (SRPMS): https://cdn.download.clearlinux.org/current/source/SRPMS/
-
-.. _Quilt: http://savannah.nongnu.org/projects/quilt
-
-.. _clearlinux-pkgs: https://github.com/clearlinux-pkgs
-
-.. _kernel.org: https://www.kernel.org/
-
-.. _kernel parameters: https://www.kernel.org/doc/Documentation/admin-guide/kernel-parameters.txt
-
-.. _ccache: https://fedoraproject.org/wiki/Mock/Plugin/CCache?rd=Subprojects/Mock/Plugin/CCache
-
-.. _git-format-patch: https://git-scm.com/docs/git-format-patch

_sources/guides/maintenance/assign-static-ip.rst.txt

@@ -1,184 +0,0 @@
-.. _assign-static-ip:
-
-Assign a static IP address
-##########################
-
-
-This guide explains how to assign a static IP address. This may be helpful in
-scenarios such as a network with no DHCP server.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Identify which program is managing the interface
-************************************************
-
-New installations of |CL-ATTR| use NetworkManager as the default network interface
-manager for all network connections.
-
-.. note:: 
-
-   * The cloud |CL| images continue to use `systemd-networkd` to manage
-     network connections.
-
-   * In earlier |CL| versions, `systemd-network` was used to manage Ethernet
-     interfaces and NetworkManager was used for wireless interfaces.
-
-
-Before defining a configuration for assigning a static IP address, verify which
-program is managing the network interface.
-
-#. Check the output of :command:`nmcli device` to see if NetworkManager is
-   managing the device.
-
-   .. code-block:: bash
-
-      nmcli device status
-
-   If the STATE column for the device shows *connected* or *disconnected*, the
-   network configuration is being managed by NetworkManager, then use the
-   instructions for :ref:`using NetworkManager <nm-static-ip>`.
-
-   If the STATE column for the device shows *unmanaged*, then check if the
-   device is being managed by systemd-networkd.
-
-
-#. Check the output of :command:`networkctl list` to see if
-   `systemd-networkd` is managing the device.
-
-   .. code-block:: bash
-
-      networkctl list 
-
-   If the SETUP column for the device shows *configured*, the network
-   configuration is being managed by `systemd-networkd`, then use the
-   instructions for :ref:`using systemd-networkd <networkd-static-ip>`.
-
-
-.. _nm-static-ip:
-
-Using NetworkManager
-********************
-
-Network connections managed by NetworkManager are stored as files with the
-:file:`.nmconnection` file extension in the
-:file:`/etc/NetworkManager/system-connections/` directory.
-
-A few tools exists to aid to manipulate network connections managed by
-NetworkManager:
-
-* nmcli - a command-line tool 
-
-* nmtui - a text user interface that provides a pseudo graphical menu in the
-  terminal
-
-* nm-connection-editor - a graphical user interface
-
-The method below uses the command line tool nmcli to modify network
-connection. 
-
-
-#. Identify the existing connection name:
-
-   .. code:: bash
-
-      nmcli connection show
-
-   Sample output:
-
-   .. code:: bash
-
-      NAME                UUID                                  TYPE            DEVICE 
-      Wired connection 1  00000000-0000-0000-0000-000000000000  802-3-etherneten01
-
-   If a connection does not exist, create it with the
-   :command:`nmcli connection add` command.
-
-
-#. Modify the connection to use a static IP address. Replace the variables in
-   brackets with the appropriate values. Replace *[CONNECTION_NAME]* with the
-   NAME from the command above.
-
-   .. code::
-
-      sudo nmcli connection modify "[CONNECTION_NAME]" \
-      ipv4.method "manual" \
-      ipv4.addresses "[IP_ADDRESS]/[CIDR_NETMASK]" \
-      ipv4.gateway "[GATEWAY_IP_ADDRESS]" \
-      ipv4.dns "[PRIMARY_DNS_IP],[SECONDARY_DNS_IP]"
-
-
-   See the `nmcli developer page <https://developer.gnome.org/NetworkManager/stable/nmcli.html>`_ for more
-   configuration options. For advanced configurations, the
-   :file:`/etc/NetworkManager/system-connections/*.nmconnection`. can be edited
-   directly.
-
-
-#. Restart the NetworkManager server to reload the DNS servers:
-
-   .. code-block:: bash
-
-      sudo systemctl restart NetworkManager
-
-
-#. Verify your static IP address details have been set:
-
-   .. code-block:: bash
-
-      nmcli
-
-
-
-.. _networkd-static-ip:
-
-Using systemd-networkd
-**********************
-
-Network connections managed by systemd-networkd are stored as files with the
-:file:`.network` file extension the :file:`/etc/systemd/network/` directory.
-
-Files to manipulate network connections managed by systemd-networkd must be
-created manually. 
-
-#. Create the :file:`/etc/systemd/network` directory if it does not already exist:
-
-   .. code-block:: bash
-
-      sudo mkdir -p /etc/systemd/network
-
-#. Create a :file:`.network` file and add the following content. Replace the
-   variables in brackets with the appropriate values. Replace *[INTERFACE_NAME]*
-   with LINK from the output of the :command:`networkctl list` command that was
-   run previously.
-
-   .. code-block:: bash
-
-      sudo $EDITOR /etc/systemd/network/70-static.network
-
-      [Match]
-      Name=[INTERFACE_NAME]
-
-      [Network]
-      Address=[IP_ADDRESS]/[CIDR_NETMASK]
-      Gateway=[GATEWAY_IP_ADDRESS]
-      DNS=[PRIMARY_DNS_IP]
-      DNS=[SECONDARY_DNS_IP]
-
-   See the `systemd-network man page
-   <https://www.freedesktop.org/software/systemd/man/systemd.network.html>`_
-   for more configuration options.
-
-#. Restart the `systemd-networkd` service:
-
-   .. code-block:: bash
-
-      sudo systemctl restart systemd-networkd
-
-
-#. Verify your static IP address details have been set:
-
-   .. code-block:: bash
-
-      networkctl status
-

_sources/guides/maintenance/bulk-provision.rst.txt

@@ -1,172 +0,0 @@
-.. _bulk-provision:
-
-Bulk provision
-##############
-
-This guide explains how to perform a bulk provision of |CL-ATTR| using a
-combination of the |CL| installer, Ister, and
-:abbr:`ICIS (Ister Cloud Init Service)`.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-To configure a bulk provision:
-
-* Define Ister configuration files to customize the installation process
-* Define cloud-init\* files to customize the installation instance
-* Host the configuration files in ICIS to allow Ister to use them during
-  the installation
-
-Figure 1 depicts the flow of information between a PXE server and a PXE
-client that needs to be set up to perform a bulk provision.
-
-.. figure:: ./figures/bulk-provision-flow.png
-   :alt: Bulk provision information flow
-
-   Figure 1: Bulk provision information flow
-
-Prerequisites
-*************
-
-Before performing a bulk provision, verify you have a PXE server capable
-of performing network boots of |CL|. Please refer to our
-:ref:`guide on how to perform an iPXE boot<ipxe-install>` using
-:abbr:`NAT (network address translation)` for details.
-
-Because a bulk provision relies on a reboot, ensure the following
-preparations have been made:
-
-* No existing disks are bootable.
-* The network boot option must come immediately after the disk boot option
-  on any computer performing the installation.
-
-Configuration
-*************
-
-#. Install ICIS by following the getting started guide on the
-   `ICIS`_ GitHub\* repository.
-
-#. Create an Ister installation file and save it to the
-   :file:`static/ister` directory within the web hosting directory for
-   ICIS. The installation file is a JSON block and provides Ister
-   with the steps it needs to perform an installation. The file outlines
-   what partitions, file systems, and mount points Ister should set
-   up. Lastly, the file outlines which bundles to install. See our
-   :ref:`bundles` document for the list of available bundles. The
-   following example shows the contents of an Ister installation file:
-
-   .. code-block:: json
-
-      {
-          "DestinationType":"physical",
-          "PartitionLayout":[
-              {"disk":"sda", "partition":1, "size":"512M", "type":"EFI"},
-              {"disk":"sda", "partition":2, "size":"512M", "type":"swap"},
-              {"disk":"sda", "partition":3, "size":"rest", "type":"linux"}
-          ],
-          "FilesystemTypes":[
-              {"disk":"sda", "partition":1, "type":"vfat"},
-              {"disk":"sda", "partition":2, "type":"swap"},
-              {"disk":"sda", "partition":3, "type":"ext4"}
-          ],
-          "PartitionMountPoints":[
-              {"disk":"sda", "partition":1, "mount":"/boot"},
-              {"disk":"sda", "partition":3, "mount":"/"}
-          ],
-          "Version":"latest",
-          "Bundles":[
-              "kernel-native",
-              "os-core",
-              "os-core-update",
-              "os-cloudguest"
-          ],
-          "IsterCloudInitSvc":"http://192.168.1.1:60000/icis/"
-      }
-
-   .. important::
-
-      Every Ister installation file hosted on ICIS must contain the
-      the `IsterCloudInitSvc` parameter as well as the :command:`os-cloudguest`
-      bundle. These entries allow Ister to customize an instance of of an
-      install.
-
-#. Create an Ister configuration file to define the location of the
-   Ister installation file. Save it to the :file:`static/ister` directory
-   within the web hosting directory of ICIS. The following example shows
-   an Ister configuration file:
-
-   .. code-block:: none
-
-      template=http://192.168.1.1:60000/icis/static/ister/ister.json
-
-#. Modify the iPXE boot script by adding a kernel parameter to the command line
-   for booting the network image. Add the kernel parameter `isterconf` with
-   the location of the Ister configuration file hosted on ICIS as the
-   kernel parameter value.  The following example shows an iPXE boot script
-   with the `isterconf` parameter:
-
-   .. code-block:: none
-
-      #!ipxe
-      kernel linux quiet init=/usr/lib/systemd/systemd-bootchart initcall_debug tsc=reliable no_timer_check noreplace-smp rw initrd=initrd isterconf=http://192.168.1.1:60000/icis/static/ister/ister.conf
-      initrd initrd
-      boot
-
-   .. note::
-
-      After the network image of |CL| boots, Ister inspects the
-      parameters used during boot in :file:`/proc/cmdline` to find the
-      location of the Ister configuration file.
-
-#. Write a cloud-init document to customize the instance of the installation
-   according to your requirements. The `cloud-init`_ documentation provides a
-   guide on how to write a cloud-init document. The guide covers the
-   customization options provided by cloud-init after an installation.
-
-#. Save the cloud-init document to the :file:`static/roles` directory within
-   the web hosting directory for ICIS with the name of a role you would
-   like to create. For example, a role may be "database", "web", or "ciao".
-
-#. After creating the roles, also known as cloud-init files, assign roles to
-   MAC addresses of PXE clients. To do so, modify the :file:`config.txt` file
-   in the :file:`static` directory within the web hosting directory of ICIS.
-   The following example shows an example assignment:
-
-   .. code-block:: none
-
-      # MAC address,role
-      00:01:02:03:04:05,ciao
-
-   If MAC addresses of PXE clients are not listed within the
-   :file:`config.txt` file, a default role for those MAC address may be
-   defined as follows:
-
-   .. code-block:: none
-
-      # MAC address,role
-      default,ciao
-
-#. Verify the following URLs are accessible on your local network:
-
-   * \http://192.168.1.1:60000/icis/static/ister/ister.conf
-   * \http://192.168.1.1:60000/icis/static/ister/ister.json
-   * \http://192.168.1.1:60000/icis/get_config/<MAC address>
-   * \http://192.168.1.1:60000/icis/get_role/<role>
-   * \http://192.168.1.1:60000/ipxe/ipxe_boot_script.txt
-
-#. Power on the PXE client and watch it boot and install |CL|.
-
-#. Power-cycle the PXE client and watch it customize the |CL| installation.
-
-**Congratulations!** You have successfully performed a bulk provision of |CL|.
-
-
-.. _ICIS:
-   https://github.com/clearlinux/ister-cloud-init-svc
-
-.. _cloud-init:
-   https://cloudinit.readthedocs.io

_sources/guides/maintenance/cpu-performance.rst.txt

@@ -1,208 +0,0 @@
-.. _cpu-performance:
-
-CPU Power and Performance
-#########################
-
-This guide explains the CPU power and performance mechanisms in |CL-ATTR|.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-Modern x86 :abbr:`CPUs (central processing units)` employ a number of features
-and technologies to balance performance, energy, and thermal efficiencies.
-
-By default, |CL| prioritizes maximum CPU performance with the philosophy that
-the faster the program finishes execution, the faster the CPU can return to a
-low energy idle state. It is important to understand and evaluate all of these
-technologies when troubleshooting or considering changing the defaults.
-
-.. contents::
-   :local:
-   :depth: 1
-
-CPU power saving mechanisms
-***************************
-
-C-states and P-states are both CPU power saving mechanisms that are entered
-under different operating conditions. The tradeoff is a slightly longer time
-to exit these states when the CPU is needed once again.
-
-.. _c-states-section:
-
-C-states (idle states)
-======================
-
-C-states are hardware sleep states that are entered when it is determined that
-the CPU is idle and not executing instructions.
-
-C-states aim to reduce power utilization by increasingly reducing clock
-frequency, voltages, and features in each state.
-
-Although C-states can typically be limited or disabled in a system's UEFI or
-BIOS configuration, these settings are overridden when the `intel_idle driver`_
-is in use.
-
-To view the current cpuidle driver run this command in a terminal:
-
-.. code:: bash
-
-   cat /sys/devices/system/cpu/cpuidle/current_driver
-
-For troubleshooting, C-states can be limited with a kernel command line boot
-parameter by adding :command:`processor.max_cstate=N intel_idle.max_cstate=N`
-or completely disabled with :command:`idle=poll`.
-
-.. note::
-
-   * :command:`processor.max_cstate=0` is changed to :command:`processor.max_cstate=1`
-     by the kernel to be a valid value.
-
-   * :command:`intel_idle.max_cstate=0` disables the Intel Idle driver, not set
-     it to C-state 0.
-
-.. _p-states-section:
-
-P-states (performance states)
-=============================
-
-P-states, also known as *Intel SpeedStep® technology* on Intel processors or
-*Cool'n'Quiet* on AMD processors, are states entered while the CPU is active and
-executing instructions.
-
-P-states aim to reduce power utilization by adjusting CPU clock frequency and
-voltages based on CPU demand.
-
-P-states can typically be limited or disabled in a system's firmware (UEFI/BIOS).
-
-Turbo boost
------------
-
-`Intel® Turbo Boost Technology`_, found on some modern Intel CPUs, allows core(s) on
-a processor to temporarily operate at a higher than rated CPU clock frequency
-to accommodate demanding workloads if the CPU is under defined power and
-thermal thresholds.
-
-Turbo boost is an extension of P-states. As such, changing or limiting
-C-states or P-states impact the ability of a process to enter Turbo boost.
-
-Turbo boost can be disabled in a system's UEFI or BIOS. Turbo boost can also
-be disabled within |CL| with the command:
-
-.. code:: bash
-
-   echo 1 | sudo tee /sys/devices/system/cpu/intel_pstate/no_turbo
-
-Linux CPU clock frequency scaling
-*********************************
-
-The CPUFreq subsystem in Linux allows the OS to control :ref:`C-states
-<c-states-section>` and :ref:`P-states <P-states-section>`
-via CPU drivers and governors that provide algorithms that define how and when
-to enter these states.
-
-Scaling driver
-==============
-
-Linux uses the `Intel P-state driver`_, :command:`intel_pstate`, for modern Intel
-processors from the Sandy Bridge generation or newer. Other processors may
-default to the :command:`acpi-cpufreq*` driver which reads values from the systems
-UEFI or BIOS.
-
-To view the current CPU frequency scaling driver run this command in a terminal:
-
-.. code:: bash
-
-   cat /sys/devices/system/cpu/cpu*/cpufreq/scaling_driver
-
-Scaling governor
-================
-
-|CL| sets the CPU governor to *performance* which calls for the CPU to operate
-at maximum clock frequency. In other words, P-state P0. While this may sound
-wasteful at first, it is important to remember that power utilization does not
-increase significantly simply because of a locked clock frequency without a
-workload.
-
-To view the current CPU frequency scaling governor run this command in a terminal:
-
-.. code:: bash
-
-   cat /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor
-
-To change the CPU frequency scaling governor:
-
-#. Disable |CL| enforcement of certain power and performance settings:
-
-   .. code:: bash
-
-      sudo systemctl mask clr-power.timer
-
-#. Change the governor. In the example below, the governor is set to
-   *performance*:
-
-   .. code:: bash
-
-      echo performance | sudo tee /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor
-
-The list of all governors can be found in the Linux kernel documentation on
-`CPUFreq Governors`_.
-
-.. note::
-
-   The intel_pstate driver only supports *performance* and *powersave* governors.
-
-Thermal management
-******************
-
-`thermald`_ is a Linux thermal management daemon used to prevent the
-overheating of platforms. When temperature thresholds are exceeded, thermald
-forces a C-state by inserting CPU sleep cycles and adjusts available cooling
-methods. This can be especially desirable for laptops.
-
-By default, thermald is disabled in |CL| and starts automatically if battery
-power is detected. thermald can be manually enabled using the systemd service
-by running the command:
-
-.. code:: bash
-
-   sudo systemctl enable thermald
-   sudo systemctl start thermald
-
-For more information, see the thermald man page:
-
-.. code:: bash
-
-   man thermald
-
-`ThermalMonitor`_ is a GUI application that can visually graph and log
-temperatures from thermald. To use ThermalMonitor, add the
-:command:`desktop-apps-extras` bundle and add your user account to the power
-group:
-
-.. code:: bash
-
-   sudo swupd bundle-add desktop-apps-extras
-   sudo usermod -a -G power <USER>
-   ThermalMonitor
-
-.. note::
-
-   After adding a new group, you must log out and log back in for the new group
-   to take effect.
-
-
-.. _`Intel P-state driver`: https://www.kernel.org/doc/Documentation/cpu-freq/intel-pstate.txt
-
-.. _`CPUFreq Governors`: https://www.kernel.org/doc/Documentation/cpu-freq/governors.txt
-
-.. _thermald: https://01.org/linux-thermal-daemon
-
-.. _`intel_idle driver`: https://github.com/torvalds/linux/blob/master/drivers/idle/intel_idle.c
-
-.. _`ThermalMonitor`: https://github.com/intel/thermal_daemon/tree/master/tools/thermal_monitor
-
-.. _`Intel® Turbo Boost Technology`: https://www.intel.com/content/www/us/en/architecture-and-technology/turbo-boost/turbo-boost-technology.html

_sources/guides/maintenance/developer-workstation.rst.txt

@@ -1,112 +0,0 @@
-.. _developer-workstation:
-
-Developer Workstation
-#####################
-
-This guide helps you find the minimum set of bundles needed to start your
-|CL-ATTR| development project.
-
-Before continuing, review the :ref:`swupd <swupd-guide>` guide to learn more
-about the swupd tool and how |CL| simplifies software versioning compared to
-other Linux\* distributions.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Workstation Setup
-*****************
-
-After installing the minimum set of bundles required to get started, you can add
-more bundles relevant to your specific use case.
-
-To run any process required for |CL| development, you can add the large bundle
-:ref:`*os-clr-on-clr* <enable-user-space>`. However, given how many packages this
-bundle contains, you may want to deploy a leaner OS with only bundles relevant to
-your project.
-
-Use Table 1, *Developer Profiles*, to identify the *minimum
-required bundles* to get started developing based on your role or project.
-While your role may not neatly fit in one of these categories, consider
-Table 1 as a starting point.
-
-.. list-table:: **Table 1. Developer Profiles**
-   :widths: 20, 20, 20, 20
-   :header-rows: 1
-
-   * - |CL| Bundle
-     - *Internet of Things (IoT)*
-     - *System Administrator*
-     - *Client/Cloud/Web Developer*
-
-   * - :command:`editors`
-     - ✓
-     - ✓
-     - ✓
-
-   * - :command:`network-basic`
-     - ✓
-     - ✓
-     - ✓
-
-   * - :command:`openssh-server`
-     - ✓
-     - ✓
-     - ✓
-
-   * - :command:`webserver-basic`
-     -
-     - ✓
-     - ✓
-
-   * - :command:`application-server`
-     -
-     - ✓
-     - ✓
-
-   * - :command:`database-basic`
-     -
-     - ✓
-     - ✓
-
-   * - :command:`desktop-autostart`
-     - ✓
-     - ✓
-     - ✓
-
-   * - :command:`dev-utils`
-     -
-     -
-     - ✓
-
-swupd search
-************
-
-We recommend learning about :ref:`swupd <swupd-guide>`, to learn the
-commands to search for and add bundles relevant to your project.
-
-The guide provides an :ref:`example <swupd-guide-example-install-bundle>`
-that shows you how to:
-
-* Use swupd to search for bundles
-* Use swupd to add bundles
-
-Core Concepts
-*************
-
-We recommend that you understand these core concepts in |CL| *before*
-developing your project.
-
-* :ref:`Software update <swupd-guide>`
-* :ref:`Mixer <mixer>`
-* :ref:`Autospec <autospec>`
-
-Other resources for developers
------------------------------------
-
-* `Developer Tooling Framework`_ for |CL|
-* `Bundle Definition Files`_
-
-.. _Bundle Definition Files: https://github.com/clearlinux/clr-bundles
-
-.. _Developer Tooling Framework: https://github.com/clearlinux/common

_sources/guides/maintenance/fix-broken-install.rst.txt

@@ -1,91 +0,0 @@
-.. _fix-broken-install:
-
-Fix a broken installation
-#########################
-
-This guide explains how to fix a broken installation of |CL-ATTR| using a live
-desktop image on a USB.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-This guide assumes you have installed |CL| on a target system, but the OS
-does not boot or function properly.
-
-The process described in this guide can only verify and fix files that
-:ref:`swupd<swupd-guide>` owns in :file:`/usr`. Files outside of this path, such
-as :file:`/home/`, :file:`/etc`, :file:`/var`, etc., cannot be repaired by this
-process.
-
-Prerequisites
-*************
-
-* Download and install the live desktop image on a USB. See
-  :ref:`bare-metal-install-desktop` for install instructions.
-
-Boot a live desktop image to fix target system
-**********************************************
-
-#. Boot the |CL| live desktop image.
-
-.. include:: ../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.rst
-   :start-after: install-on-target-start:
-   :end-before: install-on-target-end:
-
-Mount root partition, verify, and fix
-*************************************
-
-#. Open a Terminal window.
-
-#. Ensure the system is connected to the network.
-
-#. Mount the system’s root partition.
-
-   #. To find the root partition, run:
-
-      .. code-block:: bash
-
-         lsblk
-
-      We'll use :file:`/dev/sda3/` as the root partition example.
-
-   #. Next, mount the partition to the :file:`/mnt` folder.
-
-      .. code-block:: bash
-
-         sudo mount /dev/sda3 /mnt
-
-#. Verify that you mounted the correct root partition by checking for some
-   files commonly found on |CL| systems.
-
-   .. code-block:: bash
-
-      cat /mnt/usr/lib/os-release
-      ls /mnt/usr/share/clear/bundles
-
-#. Next, run swupd to fix any issues on the target system.
-
-   .. code-block:: bash
-
-      sudo swupd repair --picky --path=/mnt
-
-   :ref:`Learn more about how swupd works <swupd-guide>`.
-
-#. After the process is complete, unmount the root partition:
-
-   .. code-block:: bash
-
-      sudo umount /mnt
-
-#. Reboot the system, remove the live desktop USB drive,
-   and boot into the repaired system.
-
-   .. code-block:: bash
-
-      sudo reboot
-
-**Congratulations!** You successfully restored |CL|.

_sources/guides/maintenance/increase-virtual-disk-size.rst.txt

@@ -1,174 +0,0 @@
-.. _increase-virtual-disk-size:
-
-Increase virtual disk size of an image
-######################################
-
-This guide describes how to increase the disk size of your prebuilt |CL-ATTR|
-image if you need more capacity.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Determine the partition order and sizes of the prebuilt image
-*************************************************************
-
-|CL| prebuilt images come in different sizes, ranging from 300 MB to 20
-GB.
-
-There are two methods to find the order and sizes of partitions virtual disk
-of your prebuilt |CL| image.
-
-In both examples, the prebuilt Hyper-V image has a disk size of 8.5 GB with
-:file:`/dev/sda3` being the partition for the root filesystem (/)
-
-Checking :command:`lsblk` on the VM
-===================================
-
-The first method is to boot up your :abbr:`VM (Virtual Machine)` and
-execute the :command:`lsblk` command as shown below:
-
-.. code-block:: bash
-
-   sudo lsblk
-
-An example output of the :command:`lsblk` command:
-
-.. code-block:: console
-
-   NAME   MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
-   sda      8:0   0    8.5G  0 disk
-   ├─sda1   8:1   0    512M  0 part
-   ├─sda2   8:2   0     32M  0 part [SWAP]
-   └─sda3   8:3   0      8G  0 part /
-
-An example of this can also be seen in Figure 1.
-
-Checking :file:`config.json` used to build the image
-====================================================
-
-The second method to determine partition to check the :file:`config.json`
-file used to create prebuilt image, located in the `releases`_ repository.
-For example, to find the size of the Hyper-V\* image version number 20450,
-follow these steps:
-
-#. Go to the `releases`_ repository.
-#. Drill down into the `20450 > clear > config > image` directory.
-#. Open the :file:`hyperv-config.json` file.
-#. Locate the `PartitionLayout` key.
-
-   The example shows 512 MB for the EFI partition, 32 MB for the swap
-   partition, and 8 GB for the root partition.
-
-
-   .. code-block:: console
-
-      "PartitionLayout" : [ { "disk" : "hyperv.img",
-                              "partition" : 1,
-                              "size" : "512M",
-                              "type" : "EFI" },
-                              { "disk" : "hyperv.img",
-                              "partition" : 2,
-                              "size" : "32M",
-                              "type" : "swap" },
-                              { "disk" : "hyperv.img",
-                              "partition" : 3,
-                              "size" : "8G",
-                              "type" : "linux" } ],
-
-Increase virtual disk size
-**************************
-Once you have determined the disk and partition to be increased, you are
-ready to perform the actual increase of the disk, partition, and filesystem.
-
-Power off VM and increase virtual disk size
-===========================================
-
-To increase the virtual disk size for a prebuilt image, perform the steps
-below:
-
-#. Shut down your VM if it is running.
-#. Use the process defined by your hypervisor  or cloud provider to increase
-   the virtual disk size of your |CL| VM.
-#. Power up the VM.
-
-
-Resize the partition of the virtual disk
-========================================
-
-#. Log in to an account with root privileges.
-#. Open a terminal emulator.
-#. Add the :command:`storage-utils` bundle to install the
-   :command:`parted` and :command:`resize2fs` tools.
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add storage-utils
-
-#. Launch the `parted` tool.
-
-   .. code-block:: bash
-
-      sudo parted
-
-#. In the `parted` tool, perform these steps:
-
-   #. Press :command:`p` to print the partitions table.
-   #. If the warning message below is displayed, enter :command:`Fix`.
-
-      .. code-block:: console
-
-         Warning: Not all of the space available to :file:`/dev/sda` appears to be
-         used, you can fix the GPT to use all of the space (an extra ...
-         blocks) or continue with the current setting?
-
-         Fix/Ignore?
-
-   #. Enter :command:`resizepart [partition number]` where
-      *[partition number]* is the partition number of the partition to modify.
-   #. Enter :command:`yes` when prompted.
-   #. Enter the new End size.
-
-      .. note::
-
-         If you want a partition to take up the remaining disk space, then
-         enter the total size of the disk. When you print the partitions
-         table with the :command:`p` command, the total disk size is shown
-         after the :guilabel:`Disk` label.
-
-         An example of this can be seen in Figure 1.
-
-   #. Enter :command:`q` to exit `parted` when you are finished resizing the
-      image.
-
-      Figure 1 depicts the described steps  to resize the partition of the virtual disk from 8.5GB to 20GB.
-
-      .. figure:: figures/increase-virtual-disk-size-1.png
-         :scale: 100 %
-         :alt: Increase root partition size
-
-         Figure 1: Increase root partition size.
-
-Resize the filesystem
-=====================
-
-#. Enter :command:`sudo resize2fs -p /dev/[modified partition name]` where
-   *[modified partition name]* is the partition that was changed in the `parted`
-   tool.
-
-#. Run the :command:`df -h` to verify that the filesystem size has
-   increased.
-
-   Figure 2 depicts the described steps to resize the partition of the virtual
-   disk from 8.5GB to 20GB.
-
-   .. figure:: figures/increase-virtual-disk-size-2.png
-      :scale: 100 %
-      :alt: Increase root filesystem with resize2fs
-
-      Figure 2: Increase root filesystem size after partition has been expanded.
-
-**Congratulations!** You have resized the disk, partition, and filesystem. At
-this point, the increase in disk capacity is usable.
-
-.. _releases: https://cdn.download.clearlinux.org/releases/

_sources/guides/maintenance/time.rst.txt

@@ -1,59 +0,0 @@
-.. _time:
-
-Set the time
-############
-
-This guide describes how to reset the time in your |CL-ATTR| system when
-the default :abbr:`NTP (Network Time Protocol)` servers cannot be reached.
-
-|CL| uses the `systemd-timesyncd.service` daemon to synchronize time.
-
-
-#. Install the :command:`sysadmin-basic` bundle.
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add sysadmin-basic
-
-#. Set your time zone. This example uses Los Angeles.
-
-   .. code-block:: bash
-
-      timedatectl set-timezone America/Los_Angeles
-
-   .. note::
-
-      To see a list of time zones, use the command:
-      :command:`timedatectl list-timezones | grep <locale>`
-
-#. Create a :file:`/etc/systemd/` directory.
-
-   .. code-block:: bash
-
-      sudo mkdir -p /etc/systemd/
-
-#. Create a new file named :file:`/etc/systemd/timesyncd.conf` and enter the
-   following text.
-
-   .. code-block:: console
-
-      [Time]
-      NTP=<Preferred Server>
-      FallbackNTP=<backup server 1> <backup server 2>
-
-#. Enable the `systemd-timesyncd` service.
-
-   .. code-block:: bash
-
-      timedatectl set-ntp true
-
-.. note::
-
-   To check the service status, use the :command:`timedatectl status` command.
-
-   To restart the `timesyncd` daemon, enter :command:`systemctl restart
-   systemd-timesyncd` into your terminal emulator.
-
-**Congratulations!** You successfully set up the time in your |CL| system.
-
-

_sources/guides/network/custom-clear-container.rst.txt

@@ -1,326 +0,0 @@
-.. _custom-clear-container:
-
-Build a custom |CL-ATTR| based Docker container image
-#######################################################
-
-This guide contains the steps to build a custom container image. The official
-base |CL-ATTR| container image is published on Docker\* Hub and is updated on a
-regular basis.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Prerequisites
-*************
-
-* You must perform these steps on a |CL| system because the
-  :abbr:`swupd (software updater)` is used to manage bundles in the
-  container.
-* You must install the :file:`containers-basic` bundle on the |CL| system
-  or Docker will not work.
-* You have a basic understanding of Docker.
-
-Build the base container image
-******************************
-
-#. Log in and get root privileges.
-
-   .. code-block:: bash
-
-      sudo -s
-
-#. Verify Docker is installed and running.
-
-   .. code-block:: bash
-
-      docker info
-
-   If Docker is installed and running, the output is similar to
-   this example:
-
-   .. code-block:: console
-
-      Containers: 0
-       Running: 0
-       Paused: 0
-       Stopped: 0
-      Images: 4
-      Server Version: 17.05.0-ce
-      Storage Driver: overlay
-       Backing Filesystem: extfs
-       Supports d_type: true
-      Logging Driver: json-file
-      Cgroup Driver: cgroupfs
-      Plugins:
-       Volume: local
-       Network: bridge host macvlan null overlay
-      Swarm: inactive
-      Runtimes: runc
-      Default Runtime: runc
-      Init Binary: docker-init
-      containerd version:  (expected: 9048e5e50717ea4497b757314bad98ea3763c145)
-      runc version: N/A (expected: 9c2d8d184e5da67c95d601382adf14862e4f2228)
-      init version: N/A (expected: )
-      Kernel Version: 4.12.7-377.native
-      Operating System: Clear Linux OS for Intel Architecture
-      OSType: linux
-      Architecture: x86_64
-      CPUs: 4
-      Total Memory: 15.62GiB
-      Name: clr-os
-      ID: XQHJ:DYEM:3Q4D:DKLM:JOA4:RUSF:GAFR:DLPA:HOJP:W5FF:ULEE:7HZ3
-      Docker Root Dir: /var/lib/docker
-      Debug Mode (client): false
-      Debug Mode (server): false
-      Registry: https://index.docker.io/v1/
-      Experimental: false
-      Insecure Registries:
-       127.0.0.0/8
-      Live Restore Enabled: false
-
-   If Docker is not installed, enter the commands:
-
-   .. code-block:: bash
-
-      swupd bundle-add containers-basic
-      systemctl start docker
-
-#. Use :command:`os-install` to download and install the bundles.
-
-   .. code-block:: bash
-
-      swupd os-install --url https://cdn.download.clearlinux.org/update --statedir "$PWD"/swupd-state --no-boot-update --version 29790 -B os-core-update,editors,network-basic base
-
-
-   The swupd example uses the following flags:
-
-   * :command:`os-install` tells swupd to download and install.
-   * :command:`-V / --version` specifies the version of the |CL| bundles.
-   * :command:`--url` specifies the URL of the bundles repository.
-   * :command:`--statedir` specifies the state directory where downloaded bundles
-     and any state information are stored.
-   * :command:`--no-boot-update` tells swupd to skip updating boot files because
-     boot files are not required for a container.
-
-   For more information on swupd flags, enter the :command:`swupd os-install -h`
-   command.
-
-   Example output:
-
-   .. code-block:: console
-
-      swupd-client software verify 3.12.2
-      Copyright (C) 2012-2017 Intel Corporation
-
-      Verifying version 17870
-      Attempting to download version string to memory
-      Downloading packs...
-
-      Extracting python-basic pack for version 17820
-        ...14%
-      Extracting perl-basic pack for version 17790
-        ...28%
-      Extracting openssh-server pack for version 17660
-        ...42%
-      Extracting editors pack for version 17850
-        ...57%
-      Extracting network-basic pack for version 17650
-        ...71%
-      Extracting os-core pack for version 17870
-        ...85%
-      Extracting os-core-update pack for version 17870
-        ...100%
-      Adding any missing files
-        ...88%
-      Inspected 33982 files
-        33974 files were missing
-          33974 of 33974 missing files were replaced
-          0 of 33974 missing files were not replaced
-      Calling post-update helper scripts.
-      WARNING: boot files update skipped due to --no-boot-update argument
-      Fix successful
-
-   .. note::
-
-      The WARNING message is expected and can be ignored.
-
-#. Create a tarball and compress it.
-
-   .. code-block:: bash
-
-      tar -C base -cf base.tar .
-      xz -v -T0 base.tar
-
-#. Create the Dockerfile to build the image.
-
-   .. code-block:: bash
-
-      cat > Dockerfile << EOF
-      FROM scratch
-      MAINTAINER First Last <first.last@example.com>
-      ADD base.tar.xz /
-      CMD ["/bin/bash"]
-      EOF
-
-#. Build the |CL| container image.
-
-   .. code-block:: bash
-
-      docker build -t my-custom-clear-linux-container .
-
-   Example output:
-
-   .. code-block:: console
-
-      Sending build context to Docker daemon  806.5MB
-      Step 1/4 : FROM scratch
-        --->
-      Step 2/4 : MAINTAINER First Last <first.last@example.com>
-        ---> Running in 7238f35abcd0
-        ---> ec5064287c60
-      Removing intermediate container 7238f35abcd0
-      Step 3/4 : ADD base.tar.xz /
-        ---> 2723b7d20716
-      Removing intermediate container 16e3ed0df8da
-      Step 4/4 : CMD /bin/bash
-        ---> Running in efa893350647
-        ---> 5414c3a12993
-      Removing intermediate container efa893350647
-      Successfully built 5414c3a12993
-      Successfully tagged my-custom-clear-linux-container:latest
-
-#. List the newly created |CL| container image.
-
-   .. code-block:: bash
-
-      docker images
-
-   Example output:
-
-   .. code-block:: console
-
-      REPOSITORY                        TAG                 IMAGE ID            CREATED              SIZE
-      my-custom-clear-linux-container   latest              5414c3a12993        About a minute ago   616MB
-
-#. Launch the built |CL| container.
-
-   .. code-block:: bash
-
-      docker run -it my-custom-clear-linux-container
-
-Manage bundles in a container
-*****************************
-
-You can add and remove bundles from a |CL| container using the
-:command:`RUN swupd` command in the Dockerfile.
-
-Add a bundle
-============
-
-This example Dockerfile adds the :file:`pxe-server` bundle to an existing |CL|
-Docker image:
-
-.. code-block:: bash
-
-   cat > Dockerfile << EOF
-   FROM my-customer-clear-linux-container
-   MAINTAINER First Last <first.last@example.com>
-   RUN swupd bundle-add pxe-server
-   CMD ["/bin/bash/bash"]
-   EOF
-
-Example output:
-
-.. code-block:: console
-
-   docker build -t my-clearlinux-with-pxe-server-bundle .
-
-   Sending build context to Docker daemon  806.5MB
-   Step 1/4 : FROM my-custom-clear-linux-container
-    ---> 5414c3a12993
-   Step 2/4 : MAINTAINER First Last <first.last@example.com>
-    ---> Running in 19b4411cf4bd
-    ---> 08d400baffde
-   Removing intermediate container 19b4411cf4bd
-   Step 3/4 : RUN swupd bundle-add pxe-server
-    ---> Running in 3e634d6e0792
-   swupd-client bundle adder 3.12.2
-      Copyright (C) 2012-2017 Intel Corporation
-
-   Attempting to download version string to memory
-   Downloading packs...
-
-   Extracting pxe-server pack for version 17820
-   .
-   Installing bundle(s) files...
-   ..............................................................................
-   ..............................................................................
-   ..............................................................................
-   ..............................................................................
-   ..............................................................................
-   ..............................................................................
-   Calling post-update helper scripts.
-   WARNING: systemctl not operable, unable to run systemd update triggers
-   Bundle(s) installation done.
-    ---> 8ead5f2c0c33
-   Removing intermediate container 3e634d6e0792
-   Step 4/4 : CMD /bin/bash
-    ---> Running in 0ceae320279b
-    ---> dcd9adb40611
-   Removing intermediate container 0ceae320279b
-   Successfully built dcd9adb40611
-   Successfully tagged my-clearlinux-with-pxe-server-bundle:latest
-
-.. note::
-
-   The WARNING message can be ignored because systemd does not run inside
-   a container.
-
-Remove a bundle
-===============
-
-This example Dockerfile removes the :file:`pxe-server` bundle from an existing
-|CL| Docker image:
-
-.. code-block:: bash
-
-   cat > Dockerfile << EOF
-   FROM my-clearlinux-with-pxe-server-bundle
-   MAINTAINER First Last <first.last@example.com>
-   RUN swupd bundle-remove pxe-server
-   CMD ["/bin/bash/bash"]
-   EOF
-
-Example output:
-
-.. code-block:: console
-
-   docker build -t my-clearlinux-remove-pxe-server-bundle .
-
-   Sending build context to Docker daemon  806.5MB
-   Step 1/4 : FROM my-clearlinux-with-pxe-server-bundle
-    ---> dcd9adb40611
-   Step 2/4 : MAINTAINER First Last <first.last@example.com>
-    ---> Running in 71b60f15003e
-    ---> 742192751c1a
-   Removing intermediate container 71b60f15003e
-   Step 3/4 : RUN swupd bundle-remove pxe-server
-    ---> Running in ad28a3390ecc
-   swupd-client bundle remover 3.12.2
-      Copyright (C) 2012-2017 Intel Corporation
-
-   Removing bundle: pxe-server
-   Deleting bundle files...
-   Total deleted files: 92
-   Untracking bundle from system...
-   Success: Bundle removed
-   1 bundle(s) were removed successfully
-    ---> d6ee7903e14d
-   Removing intermediate container ad28a3390ecc
-   Step 4/4 : CMD /bin/bash
-    ---> Running in 7694989e97de
-    ---> ec23189ef954
-   Removing intermediate container 7694989e97de
-   Successfully built ec23189ef954
-   Successfully tagged my-clearlinux-remove-pxe-server-bundle:latest

_sources/guides/network/ipxe-install.rst.txt

@@ -1,340 +0,0 @@
-.. _ipxe-install:
-
-Install over the network with iPXE
-##################################
-
-This guide describes how to install |CL-ATTR| using :abbr:`PXE (Pre-boot
-Execution Environment)` over the network.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-PXE is an industry standard that describes client-server interaction with
-network-boot software and uses the DHCP and TFTP protocols. This guide shows one
-method of using the PXE environment to install |CL|.
-
-The PXE extension called `iPXE`_ adds support for additional protocols such as
-HTTP, :abbr:`iSCSI (Internet Small Computer Systems Interface)`, :abbr:`AoE
-(ATA over Ethernet\*)`, and :abbr:`FCoE (Fiber Channel over Ethernet\*)`. iPXE
-enables network booting on computers with no built-in PXE support.
-
-To install |CL| through iPXE, you must create a PXE client. Figure 1 depicts
-the flow of information between a PXE server and a PXE client.
-
-.. figure:: ./figures/network-boot-flow.png
-   :alt: PXE information flow
-
-   Figure 1: PXE information flow.
-
-.. caution::
-
-   The |CL| image that boots through the PXE process automatically erases all
-   data and partitions on the PXE client system and creates 3 new partitions
-   to install onto.
-
-Prerequisites
-*************
-
-Before booting with iPXE, make the following preparations.
-
-Connect the PXE server and PXE clients to a switch on a private network, as
-shown in figure 2.
-
-.. figure:: ./figures/network-boot-setup.png
-   :alt: Network topology
-
-   Figure 2: Network topology.
-
-Your PXE client must have a boot order where the network boot option is
-prioritized before the disk boot option.
-
-Your PXE server must have:
-
-* Ethernet/LAN boot option.
-* At least two network adapters.
-* Connection to a public network.
-* Secure boot option disabled.
-
-.. note::
-
-   You must disable the secure boot option in the BIOS because the UEFI
-   binaries used to boot |CL| are not signed.
-
-
-Configuration
-*************
-
-To set up |CL| using iPXE automatically, use the :file:`configure-ipxe.sh`
-script included with :abbr:`ICIS (Ister Cloud Init Service)`. For additional
-instructions on the script, refer to the guide on the `ister-cloud-init-svc`_
-GitHub\* repository.
-
-To set up |CL| manually, perform the steps below.
-
-#. Define the variables used for iPXE boot configuration.
-
-   .. code-block:: console
-
-      ipxe_app_name=ipxe
-      ipxe_port=50000
-      web_root=/var/www
-      ipxe_root=$web_root/$ipxe_app_name
-      tftp_root=/srv/tftp
-      external_iface=eno1
-      internal_iface=eno2
-      pxe_subnet=192.168.1
-      pxe_internal_ip=$pxe_subnet.1
-      pxe_subnet_mask_ip=255.255.255.0
-      pxe_subnet_bitmask=16
-
-#. Log in and get root privilege.
-
-   .. code-block:: bash
-
-      sudo -s
-
-#. Add the :command:`pxe-server` bundle to your |CL| system. The bundle contains all
-   files needed to run a PXE server.
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add pxe-server
-
-#. Download the latest network-bootable release of |CL| and extract the
-   files.
-
-   .. code-block:: bash
-
-      sudo mkdir -p $ipxe_root
-      sudo curl -o /tmp/clear-pxe.tar.xz \
-        https://cdn.download.clearlinux.org/current/clear-$(curl \
-        https://cdn.download.clearlinux.org/latest)-pxe.tar.xz
-      sudo tar -xJf /tmp/clear-pxe.tar.xz -C $ipxe_root
-      sudo ln -sf $(ls $ipxe_root | grep 'org.clearlinux.*') $ipxe_root/linux
-
-   .. note::
-
-      Ensure that the initial ramdisk file is named :file:`initrd` and
-      the kernel file is named :file:`linux`, which is a symbolic link to the
-      actual kernel file.
-
-#. Create an iPXE boot script with the following contents. During an iPXE
-   boot, the iPXE boot script directs the PXE client to download the files to
-   boot and install |CL|. Use the names previously given to the initial
-   ramdisk and kernel files.
-
-   .. code-block:: console
-
-      sudo cat > $ipxe_root/ipxe_boot_script.ipxe << EOF
-      #!ipxe
-      kernel linux quiet init=/usr/lib/systemd/systemd-bootchart \
-      initcall_debug tsc=reliable no_timer_check noreplace-smp rw \
-      initrd=initrd
-      initrd initrd
-      boot
-      EOF
-
-#. The :command:`pxe-server` bundle contains a lightweight web-server known as
-   nginx. Create a configuration file for nginx to serve |CL| to PXE
-   clients with the following contents:
-
-   .. code-block:: console
-
-      sudo mkdir -p /etc/nginx/conf.d
-      sudo cat > /etc/nginx/conf.d/$ipxe_app_name.conf << EOF
-      server {
-        listen $ipxe_port;
-        server_name localhost;
-        location /$ipxe_app_name/ {
-          root $web_root;
-          autoindex on;
-        }
-      }
-      EOF
-
-      sudo cp /usr/share/nginx/conf/nginx.conf.example /etc/nginx/nginx.conf
-
-   .. note::
-
-      Create a separate nginx configuration file to serve network-bootable
-      images on a non-standard port number. This action saves existing nginx
-      configurations.
-
-#. Start nginx and enable the startup on boot option.
-
-   .. code-block:: bash
-
-      sudo systemctl start nginx
-      sudo systemctl enable nginx
-
-#. The :command:`pxe-server` bundle contains a lightweight DNS server which
-   conflicts with the DNS stub listener provided in `systemd-resolved`.
-   Disable the DNS stub listener and temporarily stop `systemd-resolved`.
-
-   .. code-block:: console
-
-      sudo mkdir -p /etc/systemd
-      sudo cat > /etc/systemd/resolved.conf << EOF
-      [Resolve]
-      DNSStubListener=no
-      EOF
-
-      sudo systemctl stop systemd-resolved
-
-#. Assign a static IP address to the network adapter for the private network
-   and restart `systemd-networkd` with the following commands:
-
-   .. code-block:: console
-
-      sudo mkdir -p /etc/systemd/network
-      sudo cat > /etc/systemd/network/70-internal-static.network << EOF
-      [Match]
-      Name=$internal_iface
-      [Network]
-      DHCP=no
-      Address=$pxe_internal_ip/$pxe_subnet_bitmask
-      EOF
-
-      sudo systemctl restart systemd-networkd
-
-#. Configure :abbr:`NAT (Network Address Translation)` to route traffic from
-   the private network to the public network. This action makes the PXE
-   server act as a router. To make these changes persistent during reboots, save the
-   changes to the firewall with the following commands:
-
-   .. code-block:: bash
-
-      sudo iptables -t nat -F POSTROUTING
-      sudo iptables -t nat -A POSTROUTING -o $external_iface -j MASQUERADE
-      sudo systemctl enable iptables-save.service
-      sudo systemctl restart iptables-save.service
-      sudo systemctl enable iptables-restore.service
-      sudo systemctl restart iptables-restore.service
-
-   .. note::
-
-      The firewall masks packets to make them appear as coming from the PXE
-      server and hides PXE clients from the public network.
-
-#. Configure the kernel to forward network packets to different
-   interfaces. Otherwise, NAT will not work.
-
-   .. code-block:: bash
-
-      sudo mkdir -p /etc/sysctl.d
-      sudo echo net.ipv4.ip_forward=1 > /etc/sysctl.d/80-nat-forwarding.conf
-      sudo echo 1 > /proc/sys/net/ipv4/ip_forward
-
-#. The :command:`pxe-server` bundle contains iPXE firmware images that allow computers
-   without an iPXE implementation to perform an iPXE boot. Create a TFTP
-   hosting directory and populate the directory with the iPXE firmware images
-   with the following commands:
-
-   .. code-block:: bash
-
-      sudo mkdir -p $tftp_root
-      sudo ln -sf /usr/share/ipxe/undionly.kpxe $tftp_root/undionly.kpxe
-
-#. The :command:`pxe-server` bundle contains a lightweight TFTP, DNS, and DHCP
-   server known as `dnsmasq`. Create a configuration file for `dnsmasq`
-   to listen on a dedicated IP address for those functions. PXE clients on
-   the private network will use this IP address.
-
-   .. code-block:: console
-
-      sudo cat > /etc/dnsmasq.conf << EOF
-      listen-address=$pxe_internal_ip
-      EOF
-
-#. Add the options to serve iPXE firmware images to PXE clients over TFTP to
-   the `dnsmasq` configuration file.
-
-   .. code-block:: console
-
-      sudo cat >> /etc/dnsmasq.conf << EOF
-      enable-tftp
-      tftp-root=$tftp_root
-      EOF
-
-#. Add the options to host a DHCP server for PXE clients to the :file:`dnsmasq`
-   configuration file.
-
-   .. code-block:: console
-
-      sudo cat >> /etc/dnsmasq.conf << EOF
-      dhcp-leasefile=/var/db/dnsmasq.leases
-
-      dhcp-authoritative
-      dhcp-option=option:router,$pxe_internal_ip
-      dhcp-option=option:dns-server,$pxe_internal_ip
-
-      dhcp-match=set:pxeclient,60,PXEClient*
-      dhcp-range=tag:pxeclient,$pxe_subnet.2,$pxe_subnet.253,$pxe_subnet_mask_ip,15m
-      dhcp-range=tag:!pxeclient,$pxe_subnet.2,$pxe_subnet.253,$pxe_subnet_mask_ip,6h
-
-      dhcp-match=set:ipxeboot,175
-      dhcp-boot=tag:ipxeboot,http://$pxe_internal_ip:$ipxe_port/$ipxe_app_name/ipxe_boot_script.ipxe
-      dhcp-boot=tag:!ipxeboot,undionly.kpxe,$pxe_internal_ip
-      EOF
-
-
-   The configuration provides the following important functions:
-
-   * Directs PXE clients without an iPXE implementation to the TFTP server
-     to acquire architecture-specific iPXE firmware images that allow them
-     to perform an iPXE boot.
-   * Activates only on the network adapter that has an IP address on the
-     defined subnet.
-   * Directs PXE clients to the DNS server.
-   * Directs PXE clients to the PXE server for routing via NAT.
-   * Divides the private network into two pools of IP addresses. One pool
-     is for network boot and one pool is used after boot. Each pool has
-     their own lease times.
-
-#. Create a file for `dnsmasq` to record the IP addresses it provides
-   to PXE clients.
-
-   .. code-block:: bash
-
-      sudo mkdir -p /var/db
-      sudo touch /var/db/dnsmasq.leases
-
-#. Start `dnsmasq` and enable startup on boot.
-
-   .. code-block:: bash
-
-      sudo systemctl enable dnsmasq
-      sudo systemctl restart dnsmasq
-
-#. Start `systemd-resolved`.
-
-   .. code-block:: bash
-
-      sudo systemctl start systemd-resolved
-
-   .. note::
-
-      `systemd-resolved` dynamically updates the list of DNS servers for the
-      private network if you use the `dnsmasq` DNS server. The setup creates a
-      pass-through DNS server that relies on the DNS servers listed in
-      :file:`/etc/resolv.conf`.
-
-#. Power on the PXE client and watch the client boot and install |CL|.
-
-   After booting, |CL| automatically partitions the hard drive,
-   installs itself, updates to the latest version, and reboots.
-
-
-**Congratulations!** You have successfully installed and configured a PXE
-server that enables PXE clients to boot and install |CL| over the network.
-
-
-.. _iPXE:
-   http://ipxe.org/
-
-.. _ister-cloud-init-svc:
-   https://github.com/clearlinux/ister-cloud-init-svc

_sources/guides/stacks/dars.rst.txt

@@ -1,133 +0,0 @@
-.. _dars:
-
-Data Analytics Reference Stack
-##############################
-
-This guide explains how to use the :abbr:`DARS (Data Analytics Reference Stack)`,
-and to optionally build your own DARS container image.
-
-Any system that supports Docker\* containers can be used with DARS. This steps
-in this guide use |CL-ATTR| as the host system.
-
-.. contents::
-   :local:
-   :depth: 1
-
-The Data Analytics Reference Stack release
-******************************************
-
-The Data Analytics Reference Stack (DARS) provides developers and enterprises a straightforward, highly optimized software stack for storing and processing large
-amounts of data.  More detail is available on the
-`DARS architecture and performance benchmarks`_.
-
-The Data Analytics Reference Stack provides two pre-built Docker images,
-available on `Docker Hub`_:
-
-* A |CL|-derived `DARS with OpenBlas`_ stack optimized for `OpenBLAS`_
-* A |CL|-derived  `DARS with Intel® MKL`_ stack optimized for `MKL`_
-
-We recommend you view the latest component versions for each image in the
-:file:`README` found in the `Data Analytics Reference Stack`_ GitHub\*
-repository. Because |CL| is a rolling distribution, the package version numbers
-in the |CL|-based containers may not be the latest released by |CL|.
-
-.. note::
-
-   The Data Analytics Reference Stack is a collective work, and each piece
-   of software within the work has its own license.  Please see the
-   `DARS Terms of Use`_ for more details about licensing and usage of the Data
-   Analytics Reference Stack.
-
-Using the Docker images
-***********************
-
-#. To immediately start using the latest stable DARS images, pull an image
-   directly from `Docker Hub`_. This example uses the
-   `DARS with Intel® MKL`_ Docker image.
-
-#. Once you have downloaded the image, you can run it with
-
-   .. code-block:: bash
-
-      docker run -it --ulimit nofile=1000000:1000000 --name mkl <name of image>
-
-   This will launch the image and drop you into a bash shell inside the
-   container.  You will see output similar to the following:
-
-   .. code-block:: console
-
-      root@fd5155b89857 /root # spark-shell
-      spark-shell
-      Config directory: /usr/share/defaults/spark/
-      Welcome to
-        ____              __
-       / __/__  ___ _____/ /__
-       _\ \/ _ \/ _ `/ __/  '_/
-      /___/ .__/\_,_/_/ /_/\_\   version 2.4.0
-         /_/
-
-      Using Scala version 2.12.7 (OpenJDK 64-Bit Server VM, Java 1.8.0-internal)
-      Type in expressions to have them evaluated.
-      Type :help for more information.
-
-      scala>
-
-   The :command:`--ulimit nofile` parameter is currently required in order to
-   increase the number of open files opened at certain point by the spark
-   engine.
-
-Building DARS images
-********************
-
-If you choose to build your own DARS container images, you can customize
-them as needed. Use the provided Dockerfile as a baseline.
-
-To construct images with |CL|, start with a |CL| development platform that
-has the :command:`containers-basic-dev` bundle installed. Learn more about
-bundles and installing them by using :ref:`swupd-guide`.
-
-#. Clone the `Data Analytics Reference Stack`_ GitHub\* repository.
-
-   .. code-block:: bash
-
-      git clone https://github.com/clearlinux/dockerfiles/tree/master/stacks/dars -b master
-
-#. Inside the DARS directory, run :command:`make` to build OpenBLAS and MKL images.
-
-   .. code-block:: bash
-
-      make
-
-   Run :command:`make baseline` to build the baseline CentOS image. Depending on
-   the system, it may take a while to finish building.
-
-   .. code-block:: bash
-
-      make baseline
-
-#. Once completed, check the resulting images with :command:`Docker`
-
-   .. code-block:: bash
-
-      docker images | grep dars
-
-#. You can use any of the resulting images to launch fully functional containers.
-   If you need to customize the containers, you can edit the provided :file:`Dockerfile`.
-
-.. _Data Analytics Reference Stack: https://github.com/clearlinux/dockerfiles/tree/master/stacks/dars
-
-.. _Docker Hub: https://hub.docker.com/
-
-.. _OpenBLAS: http://www.openblas.net/
-
-.. _MKL: https://software.intel.com/en-us/mkl
-
-.. _CentOS: https://www.centos.org/
-
-.. _DARS with OpenBLAS: https://hub.docker.com/r/clearlinux/stacks-dars-openblas/
-
-.. _DARS with Intel® MKL: https://hub.docker.com/r/clearlinux/stacks-dars-mkl/
-
-.. _DARS architecture and performance benchmarks: https://clearlinux.org/stacks/data-analytics-stack-v1
-
-.. _DARS Terms of Use: https://clearlinux.org/stacks/data-analytics/terms-of-use

_sources/guides/stacks/dlrs/dlrs.rst.txt

@@ -1,592 +0,0 @@
-.. _dlrs:
-
-Deep Learning Reference Stack
-#############################
-
-This guide describes how to run benchmarking workloads for TensorFlow\*,
-PyTorch\*, and Kubeflow in |CL-ATTR| using the Deep Learning Reference Stack.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-We created the Deep Learning Reference Stack to help AI developers deliver
-the best experience on Intel® Architecture. This stack reduces complexity
-common with deep learning software components, provides flexibility for
-customized solutions, and enables you to quickly prototype and deploy Deep
-Learning workloads. Use this guide to run benchmarking workloads on your
-solution.
-
-The Deep Learning Reference Stack is available in the following versions:
-
-* `Intel MKL-DNN-VNNI`_, which is optimized using Intel® Math Kernel Library
-  for Deep Neural Networks (Intel® MKL-DNN) primitives and introduces support
-  for Intel® AVX-512 Vector Neural Network Instructions (VNNI).
-* `Intel MKL-DNN`_, which includes the TensorFlow framework optimized using
-  Intel® Math Kernel Library for Deep Neural Networks (Intel® MKL-DNN)
-  primitives.
-* `Eigen`_, which includes `TensorFlow`_ optimized for Intel® architecture.
-* `PyTorch with OpenBLAS`_, which includes PyTorch with OpenBlas.
-* `PyTorch with Intel MKL-DNN`_, which includes PyTorch optimized using Intel®
-  Math Kernel Library (Intel® MKL) and Intel MKL-DNN.
-
-.. important::
-
-   To take advantage of the Intel® AVX-512 and VNNI functionality with the Deep
-   Learning Reference Stack, you must use the following hardware:
-
-   * Intel® AVX-512 images require an Intel® Xeon® Scalable Platform
-   * VNNI requires a 2nd generation Intel® Xeon® Scalable Platform
-
-Stack features
-==============
-
-* `DLRS V3.0`_  release announcement.
-* Deep Learning Reference Stack v2.0 including current
-  `PyTorch benchmark`_.
-* Deep Learning Reference Stack v1.0 including current
-  `TensorFlow benchmark`_ results.
-* `DLRS Release notes`_  on Github\* for the latest release of Deep Learning
-  Reference Stack.
-
-.. note::
-
-   The Deep Learning Reference Stack is a collective work, and each piece of
-   software within the work has its own license.  Please see the `DLRS Terms of Use`_
-   for more details about licensing and usage of the Deep Learning Reference Stack.
-
-Prerequisites
-=============
-
-* :ref:`Install <bare-metal-install-desktop>` |CL| on your host system
-* :command:`containers-basic` bundle
-* :command:`cloud-native-basic` bundle
-
-In |CL|, :command:`containers-basic` includes Docker\*, which is required for
-TensorFlow and PyTorch benchmarking. Use the :command:`swupd` utility to
-check if :command:`containers-basic` and :command:`cloud-native-basic` are
-present:
-
-.. code-block:: bash
-
-   sudo swupd bundle-list
-
-To install the :command:`containers-basic` or :command:`cloud-native-basic`
-bundles, enter:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add containers-basic cloud-native-basic
-
-Docker is not started upon installation of the :command:`containers-basic`
-bundle. To start Docker, enter:
-
-.. code-block:: bash
-
-   sudo systemctl start docker
-
-To ensure that Kubernetes is correctly installed and configured, follow the
-instructions in :ref:`kubernetes`.
-
-Version compatibility
-=====================
-
-We validated these steps against the following software package versions:
-
-* |CL| 26240 (Minimum supported version)
-* Docker 18.06.1
-* Kubernetes 1.11.3
-* Go 1.11.12
-
-
-.. note::
-
-   The Deep Learning Reference Stack was developed to provide the best user
-   experience when executed on a |CL| host.  However, as the stack runs in a
-   container environment, you should be able to complete the following sections of this guide on other Linux* distributions, provided they comply with the Docker*, Kubernetes* and Go* package versions listed above. Look for your distribution documentation on how to update packages and manage Docker services.
-
-TensorFlow single and multi-node benchmarks
-*******************************************
-
-This section describes running the `TensorFlow Benchmarks`_ in single node.
-For multi-node testing, replicate these steps for each node. These steps
-provide a template to run other benchmarks, provided that they can invoke
-TensorFlow.
-
-.. note::
-
-   Performance test results for the Deep Learning Reference Stack and for this
-   guide were obtained using `runc` as the runtime.
-
-#. Download either the `Eigen`_ or the `Intel MKL-DNN`_ Docker image
-   from `Docker Hub`_.
-
-#. Run the image with Docker:
-
-   .. code-block:: bash
-
-      docker run --name <image name>  --rm -i -t <clearlinux/
-      stacks-dlrs-TYPE> bash
-
-   .. note::
-
-      Launching the Docker image with the :command:`-i` argument starts
-      interactive mode within the container. Enter the following commands in
-      the running container.
-
-#. Clone the benchmark repository in the container:
-
-   .. code-block:: bash
-
-      git clone http://github.com/tensorflow/benchmarks -b cnn_tf_v1.12_compatible
-
-#. Execute the benchmark script:
-
-   .. code-block:: bash
-
-      python benchmarks/scripts/tf_cnn_benchmarks/tf_cnn_benchmarks.py --device=cpu --model=resnet50 --data_format=NHWC
-
-.. note::
-
-   You can replace the model with one of your choice supported by the
-   TensorFlow benchmarks.
-
-   If you are using an FP32 based model, it can be converted to an int8 model
-   using `Intel® quantization tools`_.
-
-PyTorch single and multi-node benchmarks
-****************************************
-
-This section describes running the `PyTorch benchmarks`_ for Caffe2 in
-single node.
-
-#. Download either the `PyTorch with OpenBLAS`_ or the `PyTorch with Intel
-   MKL-DNN`_ Docker image from `Docker Hub`_.
-
-#. Run the image with Docker:
-
-   .. code-block:: bash
-
-      docker run --name <image name>  --rm -i -t <clearlinux/stacks-dlrs-TYPE> bash
-
-   .. note::
-
-      Launching the Docker image with the :command:`-i` argument starts
-      interactive mode within the container. Enter the following commands in
-      the running container.
-
-#. Clone the benchmark repository:
-
-   .. code-block:: bash
-
-      git clone https://github.com/pytorch/pytorch.git
-
-#. Execute the benchmark script:
-
-   .. code-block:: bash
-
-       cd pytorch/caffe2/python
-       python convnet_benchmarks.py --batch_size 32 \
-                             --cpu \
-                             --model AlexNet
-
-Kubeflow multi-node benchmarks
-******************************
-
-The benchmark workload runs in a Kubernetes cluster. The guide uses
-`Kubeflow`_ for the Machine Learning workload deployment on three nodes.
-
-.. warning::
-
-   If you choose the Intel® MKL-DNN or Intel® MKL-DNN-VNNI image, your platform
-   must support the Intel® AVX-512 instruction set. Otherwise, an
-   *illegal instruction* error may appear, and you won’t be able to complete this guide.
-
-
-Kubernetes setup
-================
-
-Follow the instructions in the :ref:`kubernetes` tutorial to get set up on
-|CL|. The Kubernetes community also has instructions for creating a cluster,
-described in `Creating a single control-plane cluster with kubeadm`_.
-
-Kubernetes networking
-=====================
-
-We used `flannel`_ as the network provider for these tests. If you
-prefer a different network layer, refer to the Kubernetes network documentation
-described in `Creating a single control-plane cluster with kubeadm`_ for setup.
-
-Kubectl
-=======
-
-You can use kubectl to run commands against your Kubernetes cluster.  Refer to
-the `Overview of kubectl`_ for details on syntax and operations. Once you have a
-working cluster on Kubernetes, use the following YAML script to start a pod with
-a simple shell script, and keep the pod open.
-
-#. Copy this example.yaml script to your system:
-
-   .. code-block:: console
-
-      apiVersion: v1
-      kind: Pod
-      metadata:
-        name: example-pod
-        labels:
-          app: ex-pod
-      spec:
-        containers:
-        - name: ex-pod-container
-          image: clearlinux/stacks-dlrs-mkl:latest
-          command: ['/bin/bash', '-c', '--']
-          args: [ "while true; do sleep 30; done" ]
-
-#. Execute the script with kubectl:
-
-   .. code-block:: bash
-
-      kubectl apply –f <path-to-yaml-file>/example.yaml
-
-This script opens a single pod. More robust solutions would create a deployment
-or inject a python script or larger shell script into the container.
-
-Images
-======
-
-You must add `launcher.py`_ to the Docker image to include the Deep
-Learning Reference Stack and put the benchmarks repo in the correct
-location. Note that this guide uses Kubeflow v0.4.0, and cannot guarantee results if you use a different version.
-
-From the Docker image, run the following:
-
-.. code-block:: bash
-
-   mkdir -p /opt
-   git clone https://github.com/tensorflow/benchmarks.git /opt/tf-benchmarks
-   cp launcher.py /opt
-   chmod u+x /opt/*
-
-Your entry point becomes: :file:`/opt/launcher.py`.
-
-This builds an image that can be consumed directly by TFJob from Kubeflow.
-
-ksonnet\*
-=========
-
-Kubeflow uses ksonnet\* to manage deployments, so you must install it
-before setting up Kubeflow.
-
-ksonnet was added to the :command:`cloud-native-basic` bundle in |CL| version
-27550. If you are using an older |CL| version (not recommended), you must
-manually install ksonnet as described below.
-
-On |CL|, follow these steps:
-
-.. code-block:: bash
-
-   swupd bundle-add go-basic-dev
-   export GOPATH=$HOME/go
-   export PATH=$PATH:$GOPATH/bin
-   go get github.com/ksonnet/ksonnet
-   cd $GOPATH/src/github.com/ksonnet/ksonnet
-   make install
-
-After the ksonnet installation is complete, ensure that binary `ks` is
-accessible across the environment.
-
-Kubeflow
-========
-
-Once you have Kubernetes running on your nodes, set up `Kubeflow`_ by
-following these instructions from the `Getting Started with Kubeflow`_ guide.
-
-.. code-block:: bash
-
-   export KUBEFLOW_SRC=$HOME/kflow
-   export KUBEFLOW_TAG="v0.4.1"
-   export KFAPP="kflow_app"
-   export K8S_NAMESPACE="kubeflow"
-
-   mkdir ${KUBEFLOW_SRC}
-   cd ${KUBEFLOW_SRC}
-   ks init ${KFAPP}
-   cd ${KFAPP}
-   ks registry add kubeflow github.com/kubeflow/kubeflow/tree/${KUBEFLOW_TAG}/kubeflow
-   ks pkg install kubeflow/common
-   ks pkg install kubeflow/tf-training
-
-Next, deploy the primary package for our purposes: tf-job-operator.
-
-.. code-block:: bash
-
-   ks env rm default
-   kubectl create namespace ${K8S_NAMESPACE}
-   ks env add default --namespace "${K8S_NAMESPACE}"
-   ks generate tf-job-operator tf-job-operator
-   ks apply default -c tf-job-operator
-
-This creates the CustomResourceDefinition (CRD) endpoint to launch a TFJob.
-
-Run a TFJob
-===========
-
-#. Get the ksonnet registries for deploying TFJobs from `dlrs-tfjob`_.
-
-#. Install the TFJob components as follows:
-
-   .. code-block:: bash
-
-      ks registry add dlrs-tfjob github.com/clearlinux/dockerfiles/tree/master/stacks/dlrs/kubeflow/dlrs-tfjob
-
-      ks pkg install dlrs-tfjob/dlrs-bench
-
-#. Export the image name to use for the deployment:
-
-   .. code-block:: bash
-
-      export DLRS_IMAGE=<docker_name>
-
-   .. note::
-
-      Replace <docker_name> with the image name you specified in previous steps.
-
-#. Generate Kubernetes manifests for the workloads and apply them using these
-   commands:
-
-   .. code-block:: bash
-
-      ks generate dlrs-resnet50 dlrsresnet50 --name=dlrsresnet50 --image=${DLRS_IMAGE}
-      ks generate dlrs-alexnet dlrsalexnet --name=dlrsalexnet --image=${DLRS_IMAGE}
-      ks apply default -c dlrsresnet50
-      ks apply default -c dlrsalexnet
-
-This replicates and deploys three test setups in your Kubernetes cluster.
-
-Results of running this guide
-=============================
-
-You must parse the logs of the Kubernetes pod to retrieve performance
-data. The pods will still exist post-completion and will be in
-‘Completed’ state. You can get the logs from any of the pods to inspect the
-benchmark results. More information about Kubernetes logging is available
-in the Kubernetes `Logging Architecture`_ documentation.
-
-Use Jupyter Notebook
-********************
-
-This example uses the `PyTorch with OpenBLAS`_ container image. After it is
-downloaded, run the Docker image with :command:`-p` to specify the shared port
-between the container and the host. This example uses port 8888.
-
-.. code-block:: bash
-
-   docker run --name pytorchtest --rm -i -t -p 8888:8888 clearlinux/stacks-pytorch-oss bash
-
-After you start the container, launch the Jupyter Notebook. This
-command is executed inside the container image.
-
-.. code-block:: bash
-
-   jupyter notebook --ip 0.0.0.0 --no-browser --allow-root
-
-After the notebook has loaded, you will see output similar to the following:
-
-.. code-block:: console
-
-   To access the notebook, open this file in a browser: file:///.local/share/jupyter/runtime/nbserver-16-open.html
-   Or copy and paste one of these URLs:
-   http://(846e526765e3 or 127.0.0.1):8888/?token=6357dbd072bea7287c5f0b85d31d70df344f5d8843fbfa09
-
-From your host system, or any system that can access the host's IP address,
-start a web browser with the following. If you are not running the browser on
-the host system, replace :command:`127.0.0.1` with the IP address of the host.
-
-.. code-block:: bash
-
-  http://127.0.0.1:8888/?token=6357dbd072bea7287c5f0b85d31d70df344f5d8843fbfa09
-
-Your browser displays the following:
-
-.. figure:: figures/dlrs-fig-1.png
-   :scale: 50 %
-   :alt: Jupyter Notebook
-
-Figure 1: :guilabel:`Jupyter Notebook`
-
-
-To create a new notebook, click :guilabel:`New` and select :guilabel:`Python 3`.
-
-.. figure:: figures/dlrs-fig-2.png
-   :scale: 50%
-   :alt: Create a new notebook
-
-Figure 2: Create a new notebook
-
-A new, blank notebook is displayed, with a cell ready for input.
-
-.. figure:: figures/dlrs-fig-3.png
-   :scale: 50%
-   :alt: New blank notebook
-
-
-To verify that PyTorch is working, copy the following snippet into the blank
-cell, and run the cell.
-
-.. code-block:: console
-
-   from __future__ import print_function
-   import torch
-   x = torch.rand(5, 3)
-   print(x)
-
-.. figure:: figures/dlrs-fig-4.png
-   :scale: 50%
-   :alt: Sample code snippet
-
-When you run the cell, your output will look something like this:
-
-.. figure:: figures/dlrs-fig-5.png
-   :scale: 50%
-   :alt: code output
-
-You can continue working in this notebook, or you can download existing
-notebooks to take advantage of the Deep Learning Reference Stack's optimized
-deep learning frameworks. Refer to `Jupyter Notebook`_ for details.
-
-Uninstallation
-**************
-
-To uninstall the Deep Learning Reference Stack, you can choose to stop the
-container so that it is not using system resources, or you can stop the
-container and delete it to free storage space.
-
-To stop the container, execute the following from your host system:
-
-#. Find the container's ID
-
-   .. code-block:: bash
-
-      docker container ls
-
-   This will result in output similar to the following:
-
-   .. code-block:: console
-
-      CONTAINER ID        IMAGE                        COMMAND               CREATED             STATUS              PORTS               NAMES
-      e131dc71d339        clearlinux/stacks-dlrs-oss   "/bin/sh -c 'bash'"   23 seconds ago      Up 21 seconds                           oss
-
-#. You can then use the ID or container name to stop the container. This example
-   uses the name "oss":
-
-   .. code-block:: bash
-
-      docker container stop oss
-
-
-#. Verify that the container is not running
-
-   .. code-block:: bash
-
-      docker container ls
-
-
-#. To delete the container from your system you need to know the Image ID:
-
-   .. code-block:: bash
-
-      docker images
-
-   This command results in output similar to the following:
-
-   .. code-block:: console
-
-      REPOSITORY                   TAG                 IMAGE ID            CREATED             SIZE
-      clearlinux/stacks-dlrs-oss   latest              82757ec1648a        4 weeks ago         3.43GB
-      clearlinux/stacks-dlrs-mkl   latest              61c178102228        4 weeks ago         2.76GB
-
-#. To remove an image use the image ID:
-
-   .. code-block:: bash
-
-      docker rmi 82757ec1648a
-
-   .. code-block:: console
-
-      # docker rmi 827
-      Untagged: clearlinux/stacks-dlrs-oss:latest
-      Untagged: clearlinux/stacks-dlrs-oss@sha256:381f4b604537b2cb7fb5b583a8a847a50c4ed776f8e677e2354932eb82f18898
-      Deleted: sha256:82757ec1648a906c504e50e43df74ad5fc333deee043dbfe6559c86908fac15e
-      Deleted: sha256:e47ecc039d48409b1c62e5ba874921d7f640243a4c3115bb41b3e1009ecb48e4
-      Deleted: sha256:50c212235d3c33a3c035e586ff14359d03895c7bc701bb5dfd62dbe0e91fb486
-
-
-   Note that you can execute the :command:`docker rmi` command using only the first few characters of the image ID, provided they are unique on the system.
-
-#. Once you have removed the image, you can verify it has been deleted with:
-
-   .. code-block:: bash
-
-       docker images
-
-
-Related topics
-**************
-
-* `DLRS V3.0`_ release announcement
-* `TensorFlow Benchmarks`_
-* `PyTorch benchmarks`_
-* `Kubeflow`_
-* :ref:`kubernetes` tutorial
-* `Jupyter Notebook`_
-
-.. _TensorFlow: https://www.tensorflow.org/
-
-.. _Kubeflow: https://www.kubeflow.org/
-
-.. _Docker Hub: https://hub.docker.com/
-
-.. _TensorFlow Benchmarks: https://www.tensorflow.org/guide/performance/benchmarks
-
-.. _PyTorch benchmarks: https://github.com/pytorch/pytorch/blob/master/caffe2/python/convnet_benchmarks.py
-
-.. _Creating a single control-plane cluster with kubeadm: https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/
-
-.. _flannel: https://github.com/coreos/flannel
-
-.. _Getting Started with Kubeflow: https://www.kubeflow.org/docs/started/getting-started/
-
-.. _Eigen: https://hub.docker.com/r/clearlinux/stacks-dlrs-oss/
-
-.. _Intel MKL-DNN: https://hub.docker.com/r/clearlinux/stacks-dlrs-mkl/
-
-.. _PyTorch with OpenBLAS: https://hub.docker.com/r/clearlinux/stacks-pytorch-oss
-
-.. _PyTorch with Intel MKL-DNN: https://hub.docker.com/r/clearlinux/stacks-pytorch-mkl
-
-.. _Intel MKL-DNN-VNNI: https://hub.docker.com/r/clearlinux/stacks-dlrs-mkl-vnni
-
-.. _DLRS V3.0:  https://clearlinux.org/stacks/deep-learning-reference-stack-v3
-
-.. _dlrs-tfjob: https://github.com/clearlinux/dockerfiles/tree/master/stacks/dlrs/kubeflow/dlrs-tfjob
-
-.. _Logging Architecture: https://kubernetes.io/docs/concepts/cluster-administration/logging/
-
-.. _TensorFlow benchmark: https://clearlinux.org/stacks/deep-learning-reference-stack
-
-.. _PyTorch benchmark: https://clearlinux.org/stacks/deep-learning-reference-stack-pytorch
-
-.. _Jupyter Notebook: https://jupyter.org/
-
-.. _Overview of kubectl: https://kubernetes.io/docs/reference/kubectl/overview/
-
-.. _launcher.py: https://github.com/clearlinux/dockerfiles/tree/master/stacks/dlrs/kubeflow
-
-.. _DLRS Terms of Use: https://clearlinux.org/stacks/deep-learning/terms-of-use
-
-.. _DLRS Release notes: https://github.com/clearlinux/dockerfiles/blob/master/stacks/dlrs/releasenote.md
-
-.. _Intel® quantization tools:  https://github.com/IntelAI/tools/blob/master/tensorflow_quantization/README.md#quantization-tools

_sources/guides/stacks/greengrass.rst.txt

@@ -1,423 +0,0 @@
-.. _greengrass:
-
-Enable AWS Greengrass\* and OpenVINO™ toolkit
-#############################################
-
-This guide explains how to enable AWS Greengrass\* and OpenVINO™ toolkit.
-Specifically, the guide demonstrates how to:
-
-* Set up the Intel® edge device with |CL-ATTR|
-* Install the OpenVINO™ toolkit and Amazon Web Services\* (AWS\*)
-  Greengrass\* software stacks
-* Use AWS Greengrass\* and AWS Lambda\* to deploy the FaaS samples from
-  the cloud
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-Hardware accelerated Function-as-a-Service (FaaS) enables cloud developers to
-deploy inference functionalities [1] on Intel® IoT edge devices with
-accelerators (CPU, Integrated GPU, Intel® FPGA, and Intel® Movidius™
-technology). These functions provide a great developer experience and
-seamless migration of visual analytics from cloud to edge in a secure manner
-using a containerized environment. Hardware-accelerated FaaS provides the
-best-in-class performance by accessing optimized deep learning libraries on
-Intel® IoT edge devices with accelerators.
-
-Supported platforms
-*******************
-
-*	Operating System: |CL| latest release
-*	Hardware:	Intel® core platforms (that support inference on CPU only)
-
-Sample description
-==================
-
-The AWS Greengrass samples are located at `Edge-Analytics-FaaS`_. This
-guide uses the 1.0 version of the source code.
-
-|CL| provides the following AWS Greengrass samples:
-
-* `greengrass_classification_sample.py`_
-
-  This AWS Greengrass sample classifies a video stream using classification
-  networks such as AlexNet and GoogLeNet and publishes top-10 results on AWS\*
-  IoT Cloud every second.
-
-* `greengrass_object_detection_sample_ssd.py`_
-
-  This AWS Greengrass sample detects objects in a video stream and
-  classifies them using single-shot multi-box detection (SSD) networks such
-  as SSD Squeezenet, SSD Mobilenet, and SSD300. This sample publishes
-  detection outputs such as class label, class confidence, and bounding box
-  coordinates on AWS IoT Cloud every second.
-
-
-Install the OS on the edge device
-*********************************
-
-Start with a clean installation of |CL| on a new system, using the
-:ref:`bare-metal-install-desktop`, found in :ref:`get-started`.
-
-Create user accounts
-====================
-
-After |CL| is installed, create two user accounts. Create an administrative
-user in |CL| and create a user account for the Greengrass services to use (
-see Greengrass user below).
-
-#. Create a new user and set a password for that user. Enter the following
-   commands as ``root``:
-
-   .. code-block:: bash
-
-      useradd <userid>
-      passwd <userid>
-
-#. Next, enable the :command:`sudo` command for your new <userid>. Add
-   <userid> to the `wheel` group:
-
-   .. code-block:: bash
-
-      usermod -G wheel -a <userid>
-
-#. Create a :file:`/etc/fstab` file.
-
-   .. code-block:: bash
-
-      touch /etc/fstab
-
-   .. note::
-
-      By default, |CL| does not create an :file:`/etc/fstab` file.
-      You must create this file before the Greengrass service runs.
-
-Add required bundles
-====================
-
-Use the :command:`swupd` software updater utility to add the prerequisite bundles
-for the OpenVINO software stack:
-
-.. code-block:: bash
-
-   swupd bundle-add os-clr-on-clr desktop-autostart computer-vision-basic
-
-.. note::
-
-   Learn more about how to :ref:`swupd-guide`.
-
-The :command:`computer-vision-basic` bundle installs the OpenVINO™ toolkit,
-and the sample models optimized for Intel® edge platforms.
-
-Convert deep learning models
-============================
-
-Locate sample models
---------------------
-
-There are two types of provided models that can be used in conjunction with
-AWS Greengrass for this guide: classification or object detection.
-
-To complete this guide using an image classification model,
-download the BVLC AlexNet model files `bvlc_alexnet.caffemodel`_ and
-`deploy.prototxt`_ to the default model_location at
-:file:`/usr/share/openvino/models`. Any custom pre-trained classification models
-can be used with the classification sample.
-
-For object detection, the sample models optimized for Intel® edge platforms
-are included with the computer-vision-basic bundle installation at
-:file:`/usr/share/openvino/models`. These models are provided as an example;
-you may also use a custom SSD model with the Greengrass object detection sample.
-
-Run model optimizer
--------------------
-
-Follow the instructions in the `Model Optimizer Developer Guide`_ for converting
-deep learning models to Intermediate Representation using Model Optimizer. To
-optimize either of the sample models described above, run one of the following commands.
-
-For classification using BVLC AlexNet model:
-
-.. code-block:: bash
-
-   python3 mo.py --framework caffe --input_model
-   <model_location>/bvlc_alexnet.caffemodel --input_proto
-   <model_location>/deploy.prototxt --data_type <data_type> --output_dir
-   <output_dir> --input_shape [1,3,227,227]
-
-For object detection using SqueezeNetSSD-5Class model:
-
-.. code-block:: bash
-
-   python3 mo.py --framework caffe --input_model
-   <model_location>/'SqueezeNet 5-Class detection'/SqueezeNetSSD-5Class.caffemodel
-   --input_proto <model_location>/'SqueezeNet 5-Class detection'/SqueezeNetSSD-5Class.prototxt
-   --data_type <data_type> --output_dir <output_dir>
-
-In these examples:
-
-* `<model_location>` is :file:`/usr/share/openvino/models`.
-
-* `<data_type>` is FP32 or FP16, depending on target device.
-
-* `<output_dir>` is the directory where the Intermediate Representation
-  (IR) is stored. IR contains .xml format corresponding to the network
-  structure and .bin format corresponding to weights. This .xml file should be
-  passed to :command:`<PARAM_MODEL_XML>`.
-
-* In the BVLC AlexNet model, the prototxt defines the input shape with
-  batch size 10 by default. In order to use any other batch size, the
-  entire input shape must be provided as an argument to the model
-  optimizer. For example, to use batch size 1, you must provide:
-  `--input_shape [1,3,227,227]`
-
-
-Configure AWS Greengrass group
-******************************
-
-For each Intel® edge platform, you must create a new AWS Greengrass group
-and install AWS Greengrass core software to establish the connection between
-cloud and edge.
-
-#. To create an AWS Greengrass group, follow the instructions in
-   `Configure AWS IoT Greengrass on AWS IoT`_.
-
-#. To install and configure AWS Greengrass core on edge platform, follow
-   the instructions in `Start AWS Greengrass on the Core Device`_. In
-   step 8(b), download the x86_64 Ubuntu\* configuration of the AWS Greengrass
-   core software.
-
-   .. note::
-
-      You do not need to run the :file:`cgroupfs-mount.sh` script in step #6
-      of Module 1 of the `AWS Greengrass Developer Guide`_ because this is
-      enabled already in |CL|.
-
-#. Be sure to download both the security resources and the AWS Greengrass
-   core software.
-
-   .. note::
-
-      Security certificates are linked to your AWS account.
-
-
-Create and package Lambda function
-**********************************
-
-#. Complete steps 1-4 of the AWS Greengrass guide at
-   `Create and Package a Lambda Function`_.
-
-   .. note::
-
-      This creates the tarball needed to create the AWS Greengrass
-      environment on the edge device.
-
-
-#. In step 5, replace :file:`greengrassHelloWorld.py` with the classification or
-   object detection Greengrass sample from `Edge-Analytics-Faas`_:
-
-   * Classification: `greengrass_classification_sample.py`_
-
-   * Object Detection: `greengrass_object_detection_sample_ssd.py`_
-
-#. Zip the selected Greengrass sample with the extracted Greengrass SDK folders
-   from the previous step into :file:`greengrass_sample_python_lambda.zip`.
-
-   The zip should contain:
-
-   * greengrasssdk
-
-   * greengrass classification or object detection sample
-
-   For example:
-
-   .. code-block:: bash
-
-      zip -r greengrass_lambda.zip greengrasssdk
-      greengrass_object_detection_sample_ssd.py
-
-#. Return to the AWS documentation section called
-   `Create and Package a Lambda Function`_ and complete the procedure.
-
-   .. note::
-
-      In step 9(a) of the AWS documentation, while uploading the zip file,
-      make sure to name the handler to one of the following, depending on the
-      AWS Greengrass sample you are using:
-
-      * greengrass_object_detection_sample_ssd.function_handler
-      * greengrass_classification_sample.function_handler
-
-
-Configure Lambda function
-*************************
-
-After creating the Greengrass group and the Lambda function, start
-configuring the Lambda function for AWS Greengrass.
-
-#. Follow steps 1-8 in `Configure the Lambda Function for AWS IoT Greengrass`_
-   in the AWS documentation.
-
-#. In addition to the details mentioned in step 8, change the Memory limit
-   to 2048 MB to accommodate large input video streams.
-
-#. Add the following environment variables as key-value pairs when editing
-   the Lambda configuration and click on update:
-
-   .. list-table:: **Table 1.  Environment variables: Lambda configuration**
-      :widths: 20 80
-      :header-rows: 1
-
-      * - Key
-        - Value
-      * - PARAM_MODEL_XML
-        - <MODEL_DIR>/<IR.xml>, where <MODEL_DIR> is user specified and
-          contains IR.xml, the Intermediate Representation file from Intel® Model Optimizer.
-          For this guide, <MODEL_DIR> should be set to '/usr/share/openvino/models'
-          or one of its subdirectories.
-      * - PARAM_INPUT_SOURCE
-        - <DATA_DIR>/input.webm to be specified by user. Holds both input and
-           output data. For webcam, set PARAM_INPUT_SOURCE to ‘/dev/video0’
-      * - PARAM_DEVICE
-        - "CPU"
-      * - PARAM_CPU_EXTENSION_PATH
-        - /usr/lib64/libcpu_extension.so
-      * - PARAM_OUTPUT_DIRECTORY
-        - <DATA_DIR> to be specified by user. Holds both input and output
-          data
-      * - PARAM_NUM_TOP_RESULTS
-        - User specified for classification sample.
-          (e.g. 1 for top-1 result, 5 for top-5 results)
-
-#. Add subscription to subscribe, or publish messages from AWS Greengrass
-   Lambda function by completing the procedure in `Configure the Lambda Function for AWS IoT Greengrass`_.
-
-   .. note::
-
-      The optional topic filter field is the topic mentioned inside the Lambda function. In this guide, sample topics include the following:
-      :command:`openvino/ssd` or :command:`openvino/classification`
-
-Add local resources
-===================
-
-Refer to the AWS documentation `Access Local Resources with Lambda Functions and Connectors`_
-for details about local resources and access privileges.
-
-The following table describes the local resources needed for the CPU:
-
-.. list-table:: **Local resources**
-    :widths: 20, 20, 20, 20
-    :header-rows: 1
-
-    * - Name
-      - Resource type
-      - Local path
-      - Access
-
-    * - ModelDir
-      - Volume
-      - <MODEL_DIR> to be specified by user
-      - Read-Only
-
-    * - Webcam
-      - Device
-      - /dev/video0
-      - Read-Only
-
-    * - DataDir
-      - Volume
-      - <DATA_DIR> to be specified by user. Holds both input and output
-        data.
-      - Read and Write
-
-Deploy Lambda function
-**********************
-
-Refer to the AWS documentation `Deploy Cloud Configurations to an AWS IoT Greengrass Core Device`_ for instructions on how to deploy the lambda function to AWS
-Greengrass core device. Select *Deployments* on the group page and follow the instructions.
-
-Output consumption
-==================
-
-There are four options available for output consumption. These options are
-used to report, stream, upload, or store inference output at an interval
-defined by the variable :command:`reporting_interval` in the AWS Greengrass samples.
-
-#. IoT cloud output:
-
-   This option is enabled by default in the AWS Greengrass samples using the 
-   :command:`enable_iot_cloud_output` variable. You can use it to verify the lambda
-   running on the edge device. It enables publishing messages to IoT cloud
-   using the subscription topic specified in the lambda. (For example, topics
-   may include :command:`openvino/classification` for classification and :command:`openvino/ssd`
-   for object detection samples.) For classification, top-1 result with class
-   label are published to IoT cloud. For SSD object detection, detection
-   results such as bounding box coordinates of objects, class label, and
-   class confidence are published.
-
-   Refer to the AWS documentation
-   `Verify the Lambda Function Is Running on the Device`_ for instructions on
-   how to view the output on IoT cloud.
-
-#. Kinesis streaming:
-
-   This option enables inference output to be streamed from the edge device
-   to cloud using Kinesis [3] streams when :command:`enable_kinesis_output` is set
-   to True. The edge devices act as data producers and continually push
-   processed data to the cloud. You must set up and specify
-   Kinesis stream name, Kinesis shard, and AWS region in the AWS Greengrass
-   samples.
-
-#. Cloud storage using AWS S3 bucket:
-
-   When the :command:`enable_s3_jpeg_output` variable is set to True, it enables
-   uploading and storing processed frames (in jpeg format) in an AWS S3
-   bucket. You must set up and specify the S3 bucket name in the AWS
-   Greengrass samples to store the JPEG images. The images are named using the
-   timestamp and uploaded to S3.
-
-#. Local storage:
-
-   When the :command:`enable_s3_jpeg_output` variable is set to True, it enables
-   storing processed frames (in jpeg format) on the edge device. The images
-   are named using the timestamp and stored in a directory specified by
-   :command:`PARAM_OUTPUT_DIRECTORY`.
-
-References
-**********
-
-#. AWS Greengrass: https://aws.amazon.com/greengrass/
-#. AWS Lambda: https://aws.amazon.com/lambda/
-#. AWS Kinesis: https://aws.amazon.com/kinesis/
-
-.. _Edge-Analytics-FaaS: https://github.com/intel/Edge-Analytics-FaaS/tree/v1.0/AWS%20Greengrass
-
-.. _bvlc_alexnet.caffemodel: http://dl.caffe.berkeleyvision.org/bvlc_alexnet.caffemodel
-
-.. _deploy.prototxt: https://github.com/BVLC/caffe/blob/master/models/bvlc_alexnet/deploy.prototxt
-
-.. _greengrass_classification_sample.py: https://github.com/intel/Edge-Analytics-FaaS/blob/v1.0/AWS%20Greengrass/greengrass_classification_sample.py
-
-.. _greengrass_object_detection_sample_ssd.py: https://github.com/intel/Edge-Analytics-FaaS/blob/v1.0/AWS%20Greengrass/greengrass_object_detection_sample_ssd.py
-
-.. _Model Optimizer Developer Guide: https://software.intel.com/en-us/articles/OpenVINO-ModelOptimizer
-
-.. _AWS Greengrass Developer Guide: https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html
-
-.. _Configure AWS IoT Greengrass on AWS IoT: https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-config.html
-
-.. _Start AWS Greengrass on the Core Device: https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-device-start.html
-
-.. _Configure the Lambda Function for AWS IoT Greengrass: https://docs.aws.amazon.com/greengrass/latest/developerguide/config-lambda.html
-
-.. _Access Local Resources with Lambda Functions and Connectors: https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html
-
-.. _Deploy Cloud Configurations to an AWS IoT Greengrass Core Device: https://docs.aws.amazon.com/greengrass/latest/developerguide/configs-core.html
-
-.. _Verify the Lambda Function Is Running on the Device: https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-check.html
-
-.. _Create and Package a Lambda Function: https://docs.aws.amazon.com/greengrass/latest/developerguide/create-lambda.html

_sources/index.rst.txt

@@ -1,47 +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:`about`
-    Clear Linux is a little different from other distros. Here are some
-    important tools and concepts for managing your install.
-
-: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.
-
-:ref:`faq`
-    Refer to our FAQ section to read commonly asked questions and answers.
-
-.. toctree::
-    :maxdepth: 2
-    :hidden:
-
-    get-started/get-started
-    about
-    guides/guides
-    tutorials/tutorials
-    reference/reference
-    FAQ/faq

_sources/reference/bundle-commands.rst.txt

@@ -1,47 +0,0 @@
-.. _bundle-commands:
-
-Useful bundle commands
-######################
-
-To see a list of currently installed bundles, enter:
-
-.. code-block:: bash
-
-   sudo swupd bundle-list
-
-To see the list of all available bundles, enter:
-
-.. code-block:: bash
-
-   sudo swupd bundle-list --all
-
-Alternatively, you can view our :ref:`available bundles <bundles>`
-webpage.
-
-To search for bundles and their contents, enter:
-
-.. code-block:: bash
-
-   sudo swupd search [bundle name]
-
-To add a bundle, enter:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add [bundle name]
-
-Additional information
-======================
-
-For additional :command:`swupd` commands, enter:
-
-.. code-block:: bash
-
-   swupd --help
-
-To reference the :command:`swupd` man page, enter:
-
-.. code-block:: bash
-
-   man swupd
-

_sources/reference/bundles/bundles.rst.txt

@@ -1,18 +0,0 @@
-.. _bundles:
-
-Available bundles
-#################
-
-This document provides a current list of available bundles. View the `clr-bundles repo`_ on GitHub\*, or select the bundle
-:file:`Name` for more details.
-
-To learn more about how |CL-ATTR| uses bundles for software deployment, visit
-:ref:`bundles-about`.
-
-Bundle list
-===========
-
-.. raw:: html
-   :file: bundles.html.txt
-
-.. _clr-bundles repo: https://github.com/clearlinux/clr-bundles/tree/master/bundles

_sources/reference/collaboration/collaboration.rst.txt

@@ -1,83 +0,0 @@
-.. _collaboration:
-
-Documentation guidelines
-########################
-
-See a missing topic in the documentation? Find an existing document that could
-be improved? Help us out by contributing! If you haven't contributed before,
-take a moment to review our `Contribution guidelines`_.
-
-Do you have questions about the documentation that were not answered by these
-guidelines? Send your question to the `mailing list`_.
-
-Contribution guidelines
-***********************
-
-The |CL| documentation is hosted in GitHub and is written using
-reStructuredText. Use our guidelines and best practices to write consistent,
-readable documentation.
-
-.. toctree::
-   :maxdepth: 1
-
-   Writing guide: Describes the style we use to keep our documents clear and concise. <writing-guide>
-   Structure and formatting guide: Explains how we organize and format content, using reStructuredText and Sphinx. <structure-formatting>
-
-How to contribute
-*****************
-
-There are multiple ways to contribute and help improve our documentation:
-
-* **Make a suggestion**: Have a documentation suggestion but no time to write it
-  yourself? Send your suggestion to the `mailing list`_.
-* **Log an issue**: If you find a problem in our documentation (such as typos or
-  out-of-date information), log an issue in the `documentation repository`_.
-* **Contribute directly via GitHub**: Whether you've found a typo, have better
-  instructions or examples, or have a new page to add, submit your improvement
-  or addition as a pull request on the `documentation repository`_.
-* **Test documentation**: Step through our instructional guides and tutorials to
-  verify the instructions. Log or correct any out-of-date information.
-
-All contributions must follow our `code of conduct`_.
-
-Contribute via GitHub
-*********************
-
-Our documentation is hosted in GitHub and we follow the standard `GitHub flow`_:
-
-#. Clone the `documentation repository`_.
-
-#. Create your own fork of the repository.
-
-#. Create a branch for your contribution.
-
-#. Add your commits.
-
-#. Open a pull request.
-
-#. Discuss, review, and update your contributions.
-
-#. Once the maintainer approves, your contribution is merged and published as
-   part of the documentation.
-
-.. _references:
-
-References
-**********
-
-We use the following references to guide the grammar, style, and formatting of
-our documentation:
-
-* `Microsoft Writing Style Guide`_
-* `Merriam-Webster Dictionary`_
-* The Chicago Manual of Style (15th edition), The University of Chicago Press
-* Microsoft Press Computer Dictionary, Microsoft Press
-* Read Me First!, Oracle Technical Publications
-
-
-.. _`code of conduct`: https://clearlinux.org/community/code-of-conduct
-.. _mailing list: https://lists.clearlinux.org/mailman/listinfo/dev
-.. _GitHub flow: https://guides.github.com/introduction/flow/
-.. _documentation repository: https://github.com/clearlinux/clear-linux-documentation
-.. _Microsoft Writing Style Guide: https://docs.microsoft.com/en-us/style-guide/welcome/
-.. _Merriam-Webster Dictionary: https://www.merriam-webster.com/

_sources/reference/collaboration/structure-formatting.rst.txt

@@ -1,482 +0,0 @@
-.. _structure-formatting:
-
-Structure and formatting
-########################
-
-Content should be organized to support scanning. Consistent organization,
-formatting, and writing style helps readers quickly find what they need and to
-understand the content more effectively. This document describes our
-organization and formatting guidelines.
-
-Refer to :ref:`writing-guide` to learn how we keep our documents clear and
-concise.
-
-.. contents:: :local:
-   :depth: 1
-
-Markup
-******
-
-Our documentation is written in the reStructuredText markup language, using
-Sphinx roles and directives. We use Sphinx to generate the final documentation.
-You can read more about reStructuredText and Sphinx on their respective
-websites:
-
-* `Sphinx documentation`_
-* `reStructuredText Primer`_
-
-You can view the content directly in the .rst markup files, or generate the HTML
-content by installing and building the documentation locally. To run the
-documentation locally, follow the instructions found in the
-`documentation repository`_ README.
-
-New pages
-=========
-
-There are a few additional steps to consider when adding a new page to the
-documentation. First, identify where your new page should be located within the
-existing `Documentation organization`_. Second, make sure the new page is picked
-up in the Sphinx build and easily linkable from other content.
-
-Each page must be included in a `Sphinx toctree`_ in order to be included in the
-documentation content tree. Typically, pages are added to the section landing
-page toctree.
-
-For example, the :ref:`collaboration` page toctree looks like:
-
-.. code-block:: rest
-
-   .. toctree::
-      :maxdepth: 1
-
-      writing-guide
-      structure-formatting
-
-Additionally, each page must include a uniquely named reST label directly before
-the page title, to enable the `Sphinx ref role`_ for linking to a page.
-
-For example, this page "Structure and formating" has the label
-``.. _structure-formatting``:
-
-.. code-block:: rest
-
-   .. _structure-formatting:
-
-   Structure and formatting
-   ########################
-
-This page can then be referenced from other pages in the documentation using the
-`:ref:` role:
-
-.. code-block:: rest
-
-   :ref:`structure-formatting`
-
-Documentation organization
-**************************
-
-The documentation is organized into five general sections:
-
-#. **Concepts**: Introduction and overview of |CL| specific concepts or
-   features.
-#. **Get started**: Information about getting started with |CL|.
-#. **Guides**: Detailed information and instruction on using |CL| features.
-#. **Tutorials**: Step-by-step instruction for using |CL| in specific use cases.
-#. **Reference**: Supplementary and reference information for |CL|.
-
-Page structure
-==============
-
-Each page in the documentation should follow the basic format of:
-
-* Overview: 1-2 sentences describing what this page shows and why it matters
-* Prerequisites: Describe any pre-work necessary to the content (if appropriate)
-* Content
-* Next steps: List links to next steps (if appropriate)
-* Related topics: List links to related content (if appropriate)
-
-Headings
-========
-
-Use headings to section and organize your content for better readability and
-clarity.
-
-* All files must have a top level heading, which is the title for the page.
-* Up to three additional levels of headings are allowed under the title heading.
-* Each heading should be followed by at least one paragraph of content. Avoid
-  two or more consecutive headings.
-
-Refer to the :ref:`writing-guide` for tips on using headings to create
-:ref:`scannable content <scannable-content>`.
-
-To mark up headings in the .rst file:
-
-* Use hash-tags to underline the file's main title:
-
-  .. code-block:: rest
-
-     Main title
-     ##########
-
-* Use asterisks to underline the file's first level headings:
-
-  .. code-block:: rest
-
-     First level heading
-     *******************
-
-* Use equal signs to underline the file's second level of headings:
-
-  .. code-block:: rest
-
-     Second level heading
-     ====================
-
-* Use dashes to underline the file's third level of headings:
-
-  .. code-block:: rest
-
-     Third level heading
-     -------------------
-
-In-page navigation
-==================
-
-If a page has three or more sections, provide quick links to each section. Place
-the quick links after the overview section.
-
-Use the standard `reST contents directive`_ with depth: 1 for quick links.
-
-Inline text formatting
-**********************
-
-We use the `Microsoft Writing Style Guide`_ as our starting point for text
-formatting. We apply the formatting using reST and Sphinx markup.
-
-Use our quick reference for the most commonly used inline text elements:
-
-+--------------------------------+---------------------------------------+-----------------------------+
-| **Element**                    | **Convention**                        | **reST/Sphinx**             |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Acronyms                       | Define acronym when first used. After | Use the ``:abbr:`` role, in |
-|                                | first use and definition, use the     | the following format:       |
-|                                | acronym only.                         |                             |
-|                                |                                       | ``:abbr:`Acronym (Def)```   |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Bundle names                   | Bold                                  | Use the ``:command:`` role. |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Callouts                       |                                       | Use ``.. note::``           |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Code/command examples          | Monospace, visually distinct          | Use ``.. code-block::``     |
-|                                | from rest of text. Use an             | with the correct language   |
-|                                | indented call-out box.                | setting.                    |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Commands                       | Bold                                  | Use the ``:command:`` role. |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Command flags                  | Bold                                  | Use the ``:command:`` role. |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Console output                 | Monospace, visual distinction         | Use ``.. code-block::``     |
-|                                | from rest of text. Use an             | with console as the         |
-|                                | indented call-out box.                | language setting.           |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Emphasis                       | Italic                                | ``*strong*``                |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Environment variables          | Use the case format of the            | Use ``:envvar:``            |
-|                                | environment variable.                 |                             |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Example commands with          | Use angle brackets for swapping       |                             |
-| optional or replaceable        | in the specific name,                 |                             |
-| parts                          | e.g. <package-name>.                  |                             |
-|                                |                                       |                             |
-|                                | Use square brackets for optional      |                             |
-|                                | parts,                                |                             |
-|                                | e.g. [--build].                       |                             |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Example URLs (not linked)      | Plain text                            |                             |
-+--------------------------------+---------------------------------------+-----------------------------+
-| File extensions                | Lowercase                             |                             |
-+--------------------------------+---------------------------------------+-----------------------------+
-| File names, directories, paths | Title style capitalization            | Use the ``:file:`` role.    |
-+--------------------------------+---------------------------------------+-----------------------------+
-| GUI labels                     |                                       | Use ``:guilabel:``          |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Inline comments                |                                       | Use ``..``                  |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Keystrokes                     |                                       | Use ``:kbd:``               |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Local navigation               |                                       | ``.. contents:: :local:``   |
-|                                |                                       | with a depth of 1           |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Menu selection                 |                                       | Use ``:menuselection:``     |
-+--------------------------------+---------------------------------------+-----------------------------+
-| New terms                      | Italic for first use, normal for all  | ``*term*``                  |
-|                                | subsequent uses.                      |                             |
-|                                |                                       |                             |
-|                                | If it is used outside of the source   |                             |
-|                                | of definition, link the term.         |                             |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Product name                   | Follow correct trademark and          |                             |
-|                                | attribution guidelines.               |                             |
-+--------------------------------+---------------------------------------+-----------------------------+
-| Tool names                     | Correctly capitalized, no quotes,     |                             |
-|                                | bold, or italics as the basic rule.   |                             |
-|                                |                                       |                             |
-|                                | If the tool name is the command, like |                             |
-|                                | most Linux tools, treat it like a     |                             |
-|                                | command.                              |                             |
-|                                |                                       |                             |
-|                                | If the tool name is lowercase and     |                             |
-|                                | used at the start of a sentence, use  |                             |
-|                                | bold.                                 |                             |
-+--------------------------------+---------------------------------------+-----------------------------+
-
-White space and line length
-===========================
-
-Limit line length to 78 characters. The GitHub web interface forces this
-limitation for readability.
-
-Remove trailing whitespace from your documents.
-
-Code blocks and examples
-************************
-
-When providing example code or commands use the `Sphinx code-block directive`_.
-Select the appropriate syntax highlighting for the example command or code.
-
-For example, if showing console output, use console highlighting:
-
-.. code-block:: rest
-
-   .. code-block:: console
-
-Sphinx provides other ways of `marking up example code`_ if needed.
-
-Lists and instructions
-**********************
-
-Use a numbered list when the order or priority of the items is important, such
-as step-by-step instructions.
-
-Use a bulleted list when the order of the items is not important.
-
-For both list types, keep all items in the list parallel. See
-:ref:`parallelism`.
-
-Use standard `reST list markup`_.
-
-Numbered lists
-==============
-
-Numbered lists are most frequently used for procedures. Use numbered lists to
-show sequence for the items. Follow our guidelines for numbered lists:
-
-* Make sure the list is sequential and not just a collection of items.
-* Introduce a numbered list with a sentence. End the setup text with a
-  colon. Example: "To configure the unit, perform the following steps:"
-* Each item in the list should be parallel.
-* Treat numbered list items as full sentences with correct ending
-  punctuation.
-* You may interrupt numbered lists with other content, if relevant,
-  e.g. explanatory text, commands, or code.
-* Second-level steps are acceptable; avoid third-level steps.
-* Avoid single-step procedures; the minimum number of steps in a procedure
-  is two.
-* Do not create numbered lists that emulate flowcharts. The reader should be
-  able to execute the list of steps from first to last without branching or
-  looping.
-* Avoid over-using numbered lists, except in procedural documents such as
-  tutorials and step-by-step guides.
-
-Bulleted lists
-==============
-
-Use bulleted lists to reduce wordiness and paragraph density, especially when
-a sequence is not required. Here are some guidelines for bulleted lists:
-
-* Introduce a bulleted list with a sentence. End the setup text with a
-  colon. Example: "To repair the unit, you will need the following items:"
-* Each item in the list should be parallel.
-* Avoid interrupting bulleted lists with other paragraph styles.
-* Second-level bullets are acceptable; avoid third-level bullets.
-
-Use the correct ending punctuation for sentence style bullet lists. For example:
-
-**Use this:**
-
-::
-
-  When setting the user code, remember:
-
-  * Use a number that has a meaning for you.
-  * Change the code once a month.
-  * Do not disclose the user code to anyone, including the security company.
-
-**Not this:**
-
-::
-
-  When setting the user code remember:
-
-  * make the user code easy to remember. Use a number that has a meaning for you
-  * change the code once a month
-  * do not disclose the user code to anyone else. This includes the security
-    company
-
-Instructions
-============
-
-When presenting instructions, such as in a tutorial, present them in a numbered
-list according to these guidelines:
-
-* Each step (list item) should describe one action.
-
-* If the same steps are repeated, refer to the earlier steps rather than
-  repeating them.
-
-* When a step includes a command or code block as an example, put the command
-  or code block after the step that includes them.
-
-* Use supporting images where appropriate. If the series of steps is supported
-  by one figure, refer to the figure in the introductory text.
-
-  For example: "See Figure 15 and do the following:"
-
-  When a series of steps is supported by two or more figures, refer to the
-  specific figure in the relevant step and show the figure immediately after
-  the reference. **Do not write**: "See figures 15 through 22 and do the
-  following:"
-
-Notices
-*******
-
-We use four special types of notices: notes, cautions, warnings, and dangers.
-Here are some specific rules and tips regarding use of these notices:
-
-* Do not use a notice directly after a heading. Notices must follow a variant of
-  body text.
-* Do not include more than one notice in a single notice block.
-* Avoid back-to-back notices.
-* If back-to-back notices are not avoidable, make sure each distinct notice in
-  the notice block is clearly defined.
-
-Use the standard `reST admonition directive`_.
-
-Notes, cautions, and warnings
-=============================
-
-Use notes sparingly. Avoid having more than one note per section. If you exceed
-this number consistently, consider rewriting the notes as main body text.
-
-Use cautions and warnings to alert readers of potential problems or pitfalls.
-Use conditional phrases in cautions and warnings, such as "If you do X, then Y
-will occur."
-
-These are examples of typical notices and the conditions for their usage:
-
-.. note::
-   Notes are extra bits of information that supplement the main content. Notes
-   should be relatively short.
-
-.. caution::
-   Cautions are low-level hazard messages that alert the user of possible
-   equipment, product, and software damage, including loss of data.
-
-.. warning::
-   Warnings are mid-level hazards that are likely to cause product damage.
-
-Links
-*****
-
-Use the standard `reST markup for links`_.
-
-To add a cross-reference to another documentation page, use the `:ref:` role:
-
-.. code-block:: rest
-
-   :ref:`structure-formatting`
-
-To add an external link, we use named references that refer to a defined
-link/label at the bottom of the page.
-
-For example, an external link is defined at the bottom of the page like this:
-
-.. code-block:: rest
-
-   .. _wiki about dogs: https://en.wikipedia.org/wiki/Dog
-
-The defined link is then used in the content like this:
-
-.. code-block:: rest
-
-   Check out the great `wiki about dogs`_.
-
-Images
-******
-
-Use images or figures to convey information that may be difficult to explain
-using words alone. Well-planned graphics reduce the amount of text required to
-explain a topic or example.
-
-Follow these guidelines when using graphics in support of your documentation:
-
-* Keep it simple. Use images that serve a specific purpose in your document,
-  and contain only the information the reader needs.
-
-* Avoid graphics that will need frequent updating. Don't include information in
-  a graphic that might change with each release, such as product versions.
-
-* Use either PNG or JPEG bitmap files for screenshots and SVG files for vector
-  graphics.
-
-* Place the image immediately after the text it helps clarify, or as close as
-  possible.
-
-* Use the `Sphinx figure directive`_ to insert images and figures into the
-  document. Include both alt text, a figure name, and caption.
-
-  For example:
-
-  .. code-block:: rest
-
-     .. figure:: figures/topic-1.png
-        :alt: An image supporting the topic.
-
-        Figure 1: This is the figure 1 caption.
-
-* Include at least one direct reference to an image from the main text, using
-  the figure number. For example:
-
-  **Use this:** ::
-
-    Figure 1
-
-  **Not this:** ::
-
-    The figure above or below
-
-Images should follow these naming and location conventions:
-
-* Save the image files in a :file:`figures` folder at the same level as the file
-  that will reference the image.
-* Name image files according to the following rules:
-
-  * Use only lower case letters.
-  * Separate multiple words in filenames using dashes.
-  * Name images using the filename of the file they appear on and add a number
-    to indicate their place in the file. For example, the third figure added to
-    the :file:`welcome.rst` file must be named :file:`welcome-3.png`.
-
-.. _Sphinx documentation: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
-.. _reStructuredText Primer: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
-.. _documentation repository: https://github.com/clearlinux/clear-linux-documentation
-.. _Sphinx toctree: https://www.sphinx-doc.org/en/master/usage/quickstart.html?highlight=toctree#defining-document-structure
-.. _Sphinx ref role: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref
-.. _reST contents directive: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents
-.. _Microsoft Writing Style Guide: https://docs.microsoft.com/en-us/style-guide/welcome/
-.. _Sphinx code-block directive: http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block
-.. _marking up example code: http://www.sphinx-doc.org/en/1.6/markup/code.html
-.. _reST list markup: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks
-.. _reST admonition directive: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives
-.. _reST markup for links: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks
-.. _Sphinx figure directive: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives

_sources/reference/collaboration/writing-guide.rst.txt

@@ -1,410 +0,0 @@
-.. _writing-guide:
-
-Writing guide
-#############
-
-We want our documentation to be easy to read and understand. This document
-describes guidelines for writing documentation that is clear, concise,
-confident, and courteous.
-
-Refer to :ref:`structure-formatting` for details on organizing content and how
-we use reStructuredText and Sphinx.
-
-.. contents:: :local:
-   :depth: 1
-
-Use simple English
-******************
-
-Write using simple English: Be brief and communicate only the information that
-is needed. Be friendly and informative. Emphasize clarity and avoid
-unecessary complicated or technical terms. Make the content accessible to
-non-native speakers.
-
-Be brief
-========
-
-Use short sentences and paragraphs. Stick to the principle of one main
-idea per sentence, plus one additional point if needed. Each paragraph
-should address one main idea. Remember the basic structure of a paragraph:
-Introduction, body, and conclusion.
-
-Be friendly
-===========
-
-We write for our peers and want to be familiar. Take a personal tone as if you
-were speaking directly to the reader. Use "you" to address the reader and "we"
-to refer to our view. Be professional, respectful, and cooperative.
-
-Assume your audience has the same level of technical understanding and expertise
-as you did when you first started collaborating. Do not talk down to our
-readers, but also do not assume they know everything about the subject. Offer
-brief explanations or summaries of common knowledge if a significant portion of
-readers might benefit.
-
-Use simple words
-================
-
-Use simple words to increase reader comprehension and reduce ambiguity. Follow
-our tips for making good word choices:
-
-* **Avoid jargon**: Write for your audience, using everyday language where
-  possible, and technical terms where appropriate. Avoid clichés, idioms, and
-  metaphors.
-* **Be consistent**: Use one term for each concept or action and use it
-  consistently.
-* **Avoid "fancy" words and phrases**: If there is a simpler word or phrase,
-  use it.
-
-  For example:
-
-  ===================     ===================
-   Use this                Not this
-  ===================     ===================
-   start, begin            commence
-   so                      consequently
-   more than               in excess of
-   if                      in the event of
-   before                  prior to
-   if you want             should one wish
-   use                     utilize
-   example                 instance
-  ===================     ===================
-
-Avoid overuse of product name
-=============================
-
-Use product names only when necessary. Typically, you can rewrite sentences to
-remove the product name with no change in meaning, which keeps the content
-concise and scannable.
-
-Avoid using the product name in page titles and headings.
-
-.. _scannable-content:
-
-Make content scannable
-**********************
-
-Organize your content to make it scannable for the reader, which helps them find
-what they need quickly, and to understand the information more efficiently.
-
-* **Put the most important content first.** Make sure your introduction clearly
-  communicates what the reader can find on the page. Present the point of the
-  document first, and organize supporting information towards the end of the
-  page.
-* **Write scannable headings.** Expect readers of documentation to skim and scan
-  the content, and to leave if they dont find what they need quickly. Good
-  headings add organization to your content and help the reader to find and
-  understand content more effectively. Follow our guidelines for writing
-  effective `Headings`_.
-* **Write great link text.** Great link text tells the reader what they can
-  expect when they click on a link. It also helps make the page more scannable.
-  Follow our guidelines for writing `Link text`_.
-
-Headings
-========
-
-Use these guidelines to write effective headings:
-
-* **Be concise and descriptive.** Use only the words necessary to describe the
-  section.
-* **Use sentence case.** Capitalize only the first word and proper nouns in a
-  heading.
-* **Avoid punctuation.** Unless your heading is a question, don't use sentence
-  punctuation in headings.
-* **Use parallel structure.** Headings at the same level should use the same
-  grammatical pattern. This provides structure to the document and helps users
-  find information more easily. See :ref:`parallelism`.
-* **Use strong verbs.** Strong, active verbs get to the point. Avoid -ing verbs,
-  such as *Running*, *Testing*, etc.
-
-For example, two headings at the same level:
-
-**Use this:** ::
-
-  Install software
-
-  Configure software
-
-**Not this:** ::
-
-  Installing the Software on the Platform
-
-  Software Configuration.
-
-Link text
-=========
-
-All links in content should follow these guidelines:
-
-* **Write descriptive link text**: Link text should describe where the link
-  goes, without having to read the surrounding text.
-* **Keep link text concise**: Use only the words needed to accurately describe
-  the destination.
-* **Use unique link text**: Each link on a page should be unique. If users see
-  the same link text twice on a page, they'll assume it goes to the same place.
-* **Start link text with keywords**: Frontload the link text with the most
-  important words to help users scan the text.
-* **Avoid generic text**: Don't use generic, uninformative link text such as
-  "click here" or "read more".
-
-For example:
-
-**Use this:** ::
-
-  For more information about dogs, read the `dog wiki article`_.
-
-**Not this:** ::
-
-  For more information about dogs, `click here`_.
-
-Use strong verbs
-****************
-
-Passive verbs make writing stuffy and formal. Use strong verbs to get to the
-point and avoid unnecessary words and phrases.
-
-Use imperatives
-===============
-
-Commands, also called imperatives, are the fastest and most direct way of giving
-someone instructions. For example:
-
-**Use this:** ::
-
-  Send it to me.
-
-**Not this:** ::
-
-  I would appreciate it if you would send it to me.
-
-Use present tense
-=================
-
-Use simple present tense instead of future tense for most text. Search for the
-words "will" or "shall" to find future tense instances. Future tense is
-acceptable for conditional statements, such as in a caution or a warning. For
-example:
-
-**Use this:** ::
-
-  The system operates at a nominal temperature of 180 degrees Fahrenheit.
-
-**Not this:** ::
-
-  The system will operate at a nominal temperature of 180 degrees Fahrenheit.
-
-Avoid nominalizations
-=====================
-
-Avoid nominalizations, which are nouns formed from verbs.
-
-For example:
-
-===================== =====================
- Verb 				         Nominalization
-===================== =====================
- complete  			       completion
- provide  			       provision
- fail  				         failure
- install  			       installation
-===================== =====================
-
-For example:
-
-**Use this:** ::
-
-  We discussed the matter.
-
-**Not this:** ::
-
-  We had a discussion about the matter.
-
-Or:
-
-**Use this:** ::
-
-  IT has installed the software.
-
-**Not this:** ::
-
-  IT has completed the installation of the software.
-
-Avoid words ending in -ing
-==========================
-
-Avoid using words ending in -ing unless they are part of a technical name. For
-example:
-
-**Use this:** ::
-
-  There is no way to verify this.
-
-**Not this:** ::
-
-  There is no way of verifying this.
-
-Use the active voice
-====================
-
-Use active voice whenever possible to show who or what is performing an
-action.
-
-* Active voice follows standard English word order: SUBJECT–VERB–OBJECT
-  (where the OBJECT is optional).
-* Passive voice reverses the order and weakens the verb: OBJECT–be VERB–by
-  SUBJECT (where the OBJECT is optional).
-
-For example:
-
-**Use this:** ::
-
-  I made a mistake.
-
-**Not this:** ::
-
-  A mistake was made. *(By whom?)*
-
-Or:
-
-**Use this:** ::
-
-  We released version 2.0 in June.
-
-**Not this:** ::
-
-  Version 2.0 was released in June.
-
-Avoid long noun phrases
-***********************
-
-Noun phrases (a noun and other words that describe or modify it) can be
-difficult to understand. Try to limit the number of modifiers in a noun phrase
-to two. For example:
-
-**Use this:** ::
-
-  Integration policies for power management mechanisms.
-
-**Not this:** ::
-
-  Power management mechanism integration policies.
-
-.. _parallelism:
-
-Parallelism
-***********
-
-Parallelism refers to the practice of using similar patterns of grammar, and
-sometimes length, to coordinate words, phrases, and clauses.
-
-Use parallel construction in lists. The table below shows some unparallel
-structures and how they can be made parallel with a little rewording.
-
-+----------------------------------+----------------------------------+
-| Parallel (do)                    | Unparallel (don't)               |
-+==================================+==================================+
-| 1. Mount the panel.              | 1. Mount the panel.              |
-| 2. Install the battery.          | 2. Battery installation.         |
-| 3. Wire the keypad.              | 3. Wiring the keypad.            |
-+----------------------------------+----------------------------------+
-| I like practicing my accordion,  | I like practicing my accordion,  |
-| reading sci-fi, and eating       | reading sci-fi, and to eat       |
-| peanut butter and pickle         | peanut butter and pickle         |
-| sandwiches.                      | sandwiches.                      |
-+----------------------------------+----------------------------------+
-| For breakfast he likes coffee    | For breakfast he likes coffee    |
-| and bacon.                       | and to fry bacon.                |
-+----------------------------------+----------------------------------+
-| Apples or bananas are a good     | Apples or a banana are a good    |
-| snack.                           | snack.                           |
-+----------------------------------+----------------------------------+
-
-Grammar and punctuation
-***********************
-
-This section covers common grammatical topics relevant to our
-documentation. For detailed explanations of correct grammar and punctuation,
-use one of our :ref:`preferred references <references>`.
-
-Capitalization
-==============
-
-The capitalization style for all documentation is sentence case. Words should
-only be capitalized when they are proper nouns or refer to trademarked product
-names.
-
-.. note::
-   Do not capitalize a word to indicate it is more important than other
-   words. Never change the case of variable, function or file names - always
-   keep the original case.
-
-Menu capitalization
--------------------
-
-When referring to software menu items by name, use the same capitalization as
-seen in the actual menu.
-
-A few other tips when referring to menu items:
-
-* Reference the specific menu item using "Select :menuselection:`File --> New`."
-
-* Put the option to be selected last. "Select
-  :menuselection:`View --> Side Bar --> Hide Side Bar`"
-
-* Do not include more than 3 navigation steps in a menu selection. If
-  more than three steps are needed, divide the steps using
-  ``:guilabel:`` or ``:menuselection:``.
-
-  For example: "Go to :guilabel:`File` and select
-  :menuselection:`Print --> Print Preview --> Set Up`."
-
-Software version capitalization
--------------------------------
-
-When listing software or hardware version numbers, the word “version” or letter
-"v" are lowercase. The v is closed with the number (no period).
-
-For example:
-
-* Widget Pro version 5.0
-* Widget Master v2.1.12
-
-Contractions
-============
-
-Avoid using contractions, such as it's, they're, and you're, because they may be
-unclear to non-native English-speaking audiences.
-
-Quotation marks
-===============
-
-Follow these guidelines for quotation marks:
-
-* Restrict use of quotation marks to terms as terms.
-* Do not use quotation marks for emphasis; use *italics* for emphasis.
-* Avoid using single-quote marks.
-
-Commas and colons
-=================
-
-This section addresses common use of commas, semicolons, and colons in our
-documentation. Refer to one of our :ref:`preferred references <references>`
-for further details.
-
-Use the serial comma
---------------------
-
-When writing a series of items, use the serial comma before the final *and* and
-*or* to avoid confusion and ambiguity. For example:
-
-**Use this:** ::
-
-  Mom, Dad, and I are going to the game.
-
-**Not this:** ::
-
-  Mom, Dad and I are going to the game.
-
-.. _click here: https://en.wikipedia.org/wiki/Dog
-.. _dog wiki article: https://en.wikipedia.org/wiki/Dog

_sources/reference/reference.rst.txt

@@ -1,31 +0,0 @@
-.. _reference:
-
-Reference
-#########
-
-This section provides additional information on the |CL| project and
-features.
-
-.. toctree::
-   :maxdepth: 1
-
-   compatible-hardware
-   bundle-commands
-   bundles/bundles
-   bundles/openssh-server
-   collaboration/collaboration
-   system-requirements
-   image-types
-
-.. _concepts:
-
-Clear Linux concepts
-********************
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   ../concepts/*
-   ../guides/clear/stateless
-   ../guides/clear/security

_sources/reference/system-requirements.rst.txt

@@ -1,79 +0,0 @@
-.. _system-requirements:
-
-Recommended minimum system requirements
-#######################################
-
-|CL-ATTR| can run on most modern hardware and is capable of running with
-modest hardware resources. Out of the box, |CL| can run on a single CPU core, 1
-GB RAM, and 2 GB of disk space.  
-
-For use cases requiring minimal resources, |CL| :ref:`about <about>` can
-be used to create a highly customized installation that can even run on a
-system with a 128MB of memory and 600MB of disk space, for example.
-
-
-Installer requirements
-**********************
-
-The *live desktop* installer requires at least 1 GB of RAM because more
-resources are required to run in live mode than after |CL| is installed onto
-persistent storage.
-
-For hardware with less resources, use the *live server* installer because it
-has a smaller memory footprint.
-
-See https://clearlinux.org/downloads for more download options.
-
-
-System requirements
-*******************
-
-|CL| requires an x86 64-bit processor which supports Intel® Streaming SIMD
-Extensions 4.1 (Intel® SSE 4.1), and it requires a system that supports UEFI.
-
-The |CL| installer performs a system compatibility check upon booting. To
-manually verify system compatibility with |CL|, run the :ref:`compatibility
-check tool<compatibility-check>` or go to http://ark.intel.com and check for
-these features:
-
-* Instruction Set:
-
-  - 64-bit
-  
-* Instruction Set Extensions:
-
-  - Supplemental Streaming SIMD Extension 3 (Intel® SSSE3)
-  - Intel® Streaming SIMD Extensions 4.1 (Intel® SSE 4.1)
-  - Intel® Streaming SIMD Extensions 4.2 (Intel® SSE 4.2)
-  - Intel® Advanced Encryption Standard New Instructions (Intel® AES-NI)
-  - Carry-less Multiplication (PCLMUL)
-
-The following processor families have been verified to run |CL|:
-
-* Intel® Core™ Processor Family (2nd generation or greater)
-* Intel® Xeon® E3-xxxx processor
-* Intel® Xeon® E5-xxxx processor
-* Intel® Xeon® E7-xxxx processor
-* Intel® Atom® processor C Series
-* Intel® Atom® processor E Series
-
-
-Recommended configurations
-**************************
-
-For general |CL| desktop use the recommended minimum requirements include:
-
-=========    ===============================
-Component    Configuration
----------    -------------------------------
-Processor    Compatible x86 64-bit processor
----------    -------------------------------
-Memory       4GB RAM
----------    -------------------------------
-Disk         20 GB
----------    -------------------------------
-Graphics     Device with openGL support (e.g. Intel HD/UHD Graphics)
----------    -------------------------------
-Network      Active Internet connection
-=========    ===============================
-

_sources/tutorials/azure.rst.txt

@@ -1,544 +0,0 @@
-.. _azure:
-
-Run |CL-ATTR| using Microsoft Azure CLI 2.0
-###########################################
-
-|CL-ATTR| is available for you to use in the Microsoft* Azure* marketplace and
-is offered with three different images, also known as a
-:abbr:`SKU (Stock Keeping Unit)`.
-
-* |CL| Basic - This SKU consists of a bare-bones system which can be used as a
-  starting point for those wanting to explore and build out a system with
-  additional software bundles of their choosing.
-
-* |CL| Containers - This SKU comes with the containers-basic software bundle
-  already installed.
-
-* |CL| Machine-learning - This SKU comes pre-loaded with popular open source
-  tools for developing machine learning applications.
-
-You can access these images directly from your MS Azure dashboard through the
-`Azure portal`_ or by using the MS Azure :abbr:`CLI (Command Line Interface)`
-2.0. If you do not already have an account set up with MS Azure, you can sign
-up for a `MS Azure free account`_ to access the |CL|
-:abbr:`VM(Virtual Machine)` images.
-
-The Azure CLI offers the ability to create and manage resources in MS Azure
-from the command line. In this tutorial you learn to:
-
-#. Install the latest MS Azure CLI on your |CL| machine.
-
-#. Log into MS Azure using the CLI 2.0 interface.
-
-#. Create a MS Azure resource group.
-
-#. Locate the |CL| images.
-
-#. Create and log into the |CL| virtual machine.
-
-#. Stop and deallocate the |CL| VM and resources.
-
-To use the MS Azure CLI 2.0 on your |CL| system, your system must have the
-following packages installed:
-
-* Python 2.7 or later
-
-* libffi
-
-* OpenSSL 1.0.2
-
-You can check to see what versions you have installed on your system by
-running the individual commands as follows:
-
-.. code-block:: bash
-
-   python --version
-
-.. code-block:: console
-
-   python 2.7.12
-
-.. code-block:: bash
-
-   openssl version
-
-.. code-block:: console
-
-   OpenSSL 1.0.2n 7 Dec 2017
-
-.. code-block:: bash
-
-   ls -l /usr/lib64/libffi*
-
-.. code-block:: console
-
-   lrwxrwxrwx 1 root root    15 Jan 12  2017 /usr/lib64/libffi.so.6 -> libffi.so.6.0.4
-   -rwxr-xr-x 1 root root 38792 Jan 12  2017 /usr/lib64/libffi.so.6.0.4
-
-If you do not have these packages installed on your |CL| system, install the
-sysadmin-basic software bundle using the :command:`swupd` command:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add sysadmin-basic
-
-.. note::
-
-   These instructions are for installing the MS Azure CLI 2.0 tools on a |CL|
-   system. If you are installing the CLI on another platform, follow the
-   instructions in the `MS Azure Install Azure CLI tutorial`_ for your
-   specific operating system.
-
-Install MS Azure CLI 2.0 on |CL|
-********************************
-
-#. To install the MS Azure CLI 2.0 on |CL|, use the :command:`curl` command as
-   follows:
-
-   .. code-block:: bash
-
-      curl -L https://aka.ms/InstallAzureCli | bash
-
-   If you get an error message from :command:`curl` related to the -L
-   parameter or an error message is generated that includes the text "Object
-   Moved", use the full URL instead of the aka.ms redirect address:
-
-   .. code-block:: bash
-
-      curl https://azurecliprod.blob.core.windows.net/install | bash
-
-#. The installation script begins and prompts you several times during
-   execution for information.
-
-   .. note::
-
-      The console output from the script displays your username instead of the
-      **[user]** variable shown on this tutorial.
-
-   .. code-block:: console
-
-      ===> In what directory would you like to place the install? (leave blank to use '/home/[user]/lib/azure-cli'):
-
-   Press the :kbd:`Enter` key to accept the default or you can chose another
-   directory to install the MS Azure CLI 2.0 tools into.
-
-   .. code-block:: console
-
-      ===> In what directory would you like to place the 'az' executable? (leave blank to use '/home/[user]/bin'):
-
-   Press the :kbd:`Enter` key to accept the default or you can chose another
-   directory to install the :command:`az` executable in.
-
-#. The installation downloads and builds all required tools and when complete
-   prompts you with:
-
-   .. code-block:: console
-
-      ===> Modify profile to update your $PATH and enable shell/tab completion now? (Y/n): Y
-
-   Type :kbd:`Y` and press the :kbd:`Enter` key to allow this modification.
-
-   .. code-block:: console
-
-      ===> Enter a path to an rc file to update (leave blank to use '/home/[user]/.bashrc'):
-
-   Press the :kbd:`Enter` key to accept the default or enter the pathname to
-   your :file:`.bashrc` file. The installation completes with the final output
-   shown below:
-
-   .. code-block:: console
-
-      -- Backed up '/home/[user].bashrc' to '/home/[user]/.bashrc.backup'
-      -- Tab completion set up complete.
-      -- If tab completion is not activated, verify that '/home/[user]/.bashrc' is sourced by your shell.
-      --
-      -- ** Run `exec -l $SHELL` to restart your shell. **
-      --
-      -- Installation successful.
-      -- Run the CLI with /home/[user]/bin/az --help
-
-#. The installation program finishes and you must restart your shell for
-   the changes to take effect. When the installation is successful, run the
-   following command to restart your shell.
-
-   .. code-block:: bash
-
-      exec -l $SHELL
-
-With the MS Azure CLI 2.0 executable successfully built and installed, run
-the :command:`az` command.
-
-.. code-block:: bash
-
-   az
-
-The output from the :command:`az` command is shown below:
-
-.. code-block:: console
-
-
-        /\
-       /  \    _____   _ _ __ ___
-      / /\ \  |_  / | | | \'__/ _ \
-     / ____ \  / /| |_| | | |  __/
-    /_/    \_\/___|\__,_|_|  \___|
-
-
-   Welcome to the cool new Azure CLI!
-
-   Here are the base commands:
-
-       account          : Manage Azure subscription information.
-       acr              : Manage Azure Container Registries.
-       acs              : Manage Azure Container Services.
-       ad               : Synchronize on-premises directories and manage Azure Active Directory
-                          resources.
-       advisor          : (PREVIEW) Manage Azure Advisor.
-       aks              : Manage Kubernetes clusters.
-       appservice       : Manage App Service plans.
-       backup           : Commands to manage Azure Backups.
-       batch            : Manage Azure Batch.
-       batchai          : Batch AI.
-       billing          : Manage Azure Billing.
-       cdn              : Manage Azure Content Delivery Networks (CDNs).
-       cloud            : Manage registered Azure clouds.
-       cognitiveservices: Manage Azure Cognitive Services accounts.
-       configure        : Display and manage the Azure CLI 2.0 configuration. This command is
-                          interactive.
-       consumption      : Manage consumption of Azure resources.
-       container        : (PREVIEW) Manage Azure Container Instances.
-       cosmosdb         : Manage Azure Cosmos DB database accounts.
-       disk             : Manage Azure Managed Disks.
-       dla              : (PREVIEW) Manage Data Lake Analytics accounts, jobs, and catalogs.
-       dls              : (PREVIEW) Manage Data Lake Store accounts and filesystems.
-       eventgrid        : Manage Azure Event Grid topics and subscriptions.
-       extension        : Manage and update CLI extensions.
-       feature          : Manage resource provider features.
-       feedback         : Loving or hating the CLI?  Let us know!
-       find             : Find Azure CLI commands.
-       functionapp      : Manage function apps.
-       group            : Manage resource groups and template deployments.
-       image            : Manage custom virtual machine images.
-       interactive      : Start interactive mode.
-       iot              : (PREVIEW) Manage Internet of Things (IoT) assets.
-       keyvault         : Safeguard and maintain control of keys, secrets, and certificates.
-       lab              : Manage Azure DevTest Labs.
-       lock             : Manage Azure locks.
-       login            : Log in to Azure.
-       logout           : Log out to remove access to Azure subscriptions.
-       managedapp       : Manage template solutions provided and maintained by Independent Software
-                          Vendors (ISVs).
-       monitor          : Manage the Azure Monitor Service.
-       mysql            : Manage Azure Database for MySQL servers.
-       network          : Manage Azure Network resources.
-       policy           : Manage resource policies.
-       postgres         : Manage Azure Database for PostgreSQL servers.
-       provider         : Manage resource providers.
-       redis            : Access to a secure, dedicated Redis cache for your Azure applications.
-       reservations     : Manage Azure Reservations.
-       resource         : Manage Azure resources.
-       role             : Manage user roles for access control with Azure Active Directory and service
-                          principals.
-       sf               : Manage and administer Azure Service Fabric clusters.
-       snapshot         : Manage point-in-time copies of managed disks, native blobs, or other
-                          snapshots.
-       sql              : Manage Azure SQL Databases and Data Warehouses.
-       storage          : Manage Azure Cloud Storage resources.
-       tag              : Manage resource tags.
-       vm               : Provision Linux or Windows virtual machines.
-       vmss             : Manage groupings of virtual machines in an Azure Virtual Machine Scale Set
-                          (VMSS).
-       webapp           : Manage web apps.
-
-Log into your Microsoft Azure account
-*************************************
-
-#. With the :command:`az` command properly installed and functional, login to
-   your MS Azure account using the :command:`az login` command shown below:
-
-   .. code-block:: bash
-
-      az login
-
-   The output from this command is:
-
-   .. code-block:: console
-
-      To sign in, use a web browser to open the page https://aka.ms/devicelogin and enter the code BQ9MG442B to authenticate.
-
-#. Open your browser and enter the page `https://aka.ms/devicelogin` as shown
-   in figure 1:
-
-   .. figure:: azure/figures/azure-1.png
-      :scale: 50 %
-      :alt: Microsoft Device Login
-
-      Figure 1: :guilabel:`Microsoft Device Login`
-
-#. Enter the code `BQ9MG442B` to authenticate your device as shown in figure
-   2. The code `BQ9MG442B` is a random authentication code generated for each
-   session login and will be different each time you log into MS Azure using
-   the :command:`az login` command.
-
-   .. figure:: azure/figures/azure-2.png
-      :scale: 50 %
-      :alt: Microsoft Device Login - Azure CLI
-
-      Figure 2: :guilabel:`Microsoft Device Login - Azure CLI`
-
-#. Once you enter the authentication code, the website changes to a screen to
-   enter your existing Microsoft Azure credentials.
-
-#. Log in with your existing MS Azure account credentials. Once complete, the
-   browser screen changes again as shown in figure 3. The screen shows you
-   have signed into the Microsoft Cross-platform Command Line Interface
-   application on your device and you can close the window.
-
-   .. figure:: azure/figures/azure-3.png
-      :scale: 50 %
-      :alt: Microsoft Azure Cross-platform CLI
-
-      Figure 3: :guilabel:`Microsoft Azure Cross-platform CLI`
-
-The MS Azure CLI 2.0 interface is now active using your existing MS Azure
-account credentials.
-
-Create a MS Azure resource group
-********************************
-
-To learn more about MS Azure resource groups, visit the
-`Azure Resource Manager overview`_ for an overview and detailed description
-of resources within MS Azure.
-
-#. To create our new resource group, run the :command:`az group create ...`
-   command shown below to create a resource group named `ClearResourceGroup`
-   using the `-n` parameter and locate it in the `westus` region using the
-   `-l` parameter.
-
-   .. code-block:: bash
-
-      az group create -n ClearResourceGroup -l westus
-
-#. When the command has completed, the output from this command is similar to
-   the following:
-
-   .. code-block:: console
-
-      {
-        "id": "/subscriptions/{unique-id}/resourceGroups/ClearResourceGroup",
-        "location": "westus",
-        "managedBy": null,
-        "name": "ClearResourceGroup",
-        "properties": {
-          "provisioningState": "Succeeded"
-        },
-        "tags": null
-      }
-
-Create and log into the |CL| virtual machine
-********************************************
-
-For this tutorial, we are using the |CL| Basic SKU for our VM.
-
-#. To locate the available |CL| Basic VM SKU images in the MS Azure
-   marketplace, run the :command:`az vm image ...` command:
-
-   .. code-block:: bash
-
-      az vm image list --offer clear-linux --sku basic --all --output table
-
-   This command may take some time to finish. The output lists all available
-   |CL| Basic images available in the Microsoft Azure marketplace as shown
-   below:
-
-   .. code-block:: console
-
-      Offer           Publisher            Sku               Urn                                                            Version
-      --------------  -------------------  ----------------  -------------------------------------------------------------  ---------
-      clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:15780.0.0             15780.0.0
-      clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:15960.0.0             15960.0.0
-      clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:16050.0.0             16050.0.0
-      clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:16150.0.0             16150.0.0
-      clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:16500.0.0             16500.0.0
-      clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:16810.0.0             16810.0.0
-      clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:18080.0.0             18080.0.0
-      clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:18620.0.0             18620.0.0
-      clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:18860.0.0             18860.0.0
-
-   .. note::
-
-      The output list shows current offerings. New versions are added to the
-      MS Azure marketplace all the time. To reference the latest version of an
-      image, you can use the version label `latest` when specifying an image.
-
-#. The information shown in the `Urn` column lists the
-   `Publisher:Offer:Sku:Version` for each image available and this is the
-   information we want to create the |CL| Basic VM. Since we are creating a
-   |CL| Basic VM, highlight the `clear-linux-project:clear-linux-os:basic:`
-   string and copy it to your clipboard. Use the label
-   `latest` instead of referencing a specific version.
-
-#. Create the new |CL| Basic VM. Run the :command:`az vm create ...`
-   command using the URN `:clear-linux-project:clear-linux-os:basic:latest`
-   that we copied to the clipboard on the previous step.
-
-   .. code-block:: bash
-
-      az vm create --resource-group ClearResourceGroup --name ClearVM --image clear-linux-project:clear-linux-os:basic:latest --generate-ssh-keys
-
-   .. note::
-
-      If you have already defined your public/private SSH key pair and they
-      are stored in your :file:`$HOME/.ssh` directory, you do not need to
-      include the *--generate-ssh-keys* option.
-
-   Your output from this command will look similar to this output, where
-   [user] is your user name:
-
-   .. code-block:: console
-
-      SSH key files '/home/[user]/.ssh/id_rsa' and '/home/[user]/.ssh/id_rsa.pub' have been generated under ~/.ssh to allow SSH access to the VM. If using machines without permanent storage, back up your keys to a safe location.
-
-      running...
-
-      {
-        "fqdns": "",
-        "id": "/subscriptions/{unique-id}/resourceGroups/ClearResourceGroup/providers/Microsoft.Compute/virtualMachines/ClearVM",
-        "location": "westus",
-        "macAddress": "00-0D-3A-37-C7-59",
-        "powerState": "VM running",
-        "privateIpAddress": "10.0.0.4",
-        "publicIpAddress": "13.91.4.245",
-        "resourceGroup": "ClearResourceGroup",
-        "zones": ""
-      }
-
-   Take note of the public IP address from the output.
-
-#. Login into the new |CL| Basic VM, run the :command:`ssh` command with the
-   public IP address obtained from the previous step as shown:
-
-   .. code-block:: bash
-
-      ssh [user]@13.91.4.245
-
-   You may see the following message about the authenticity of the host. If
-   this appears, type `yes` to proceed connecting to your new |CL| VM.
-
-   .. code-block:: console
-
-      The authenticity of host '13.91.4.245 (13.91.4.245)' can't be established.
-      RSA key fingerprint is SHA256:{unique-number}.
-      Are you sure you want to continue connecting (yes/no)? yes
-      Warning: Permanently added '13.91.4.245' (RSA) to the list of known hosts.
-
-      [user]@ClearVM ~ $
-
-   You are now logged into your new |CL| VM as [user], where [user] is your
-   user name. To check which software bundles are included with
-   this VM image, run the :command:`sudo swupd bundle-list` command inside the VM:
-
-   .. code-block:: bash
-
-      sudo swupd bundle-list
-
-   The output shown should be similar to:
-
-   .. code-block:: console
-
-      swupd-client bundle list 3.14.1
-         Copyright (C) 2012-2017 Intel Corporation
-
-      bootloader
-      editors
-      kernel-hyperv
-      network-basic
-      openssh-server
-      os-cloudguest-azure
-      os-core
-      os-core-update
-      perl-basic
-      python-basic
-      python3-basic
-      storage-utils
-      sysadmin-basic
-      Current OS version: 19600
-
-   When you are finished using your new |CL| VM, type :command:`exit` to close
-   the :command:`SSH` terminal and logout.
-
-Stop and deallocate the |CL| VM and resources
-*********************************************
-
-When you finish using your new |CL| instance, you must stop the VM and
-deallocate the resources in your resource group. If you only stop a VM, the OS
-image shuts down but the resources associated with it in your resource group
-remain allocated and incurring charges. For instance, if you stop and then
-later start the VM using the :command:`az vm start...` without deallocating
-the resources, the IP address is retained and you can access the VM using that
-same IP address. To release the resources associated with the VM and stop
-incurring charges for them, you must deallocate the resources as well.
-
-#. At the command prompt, enter the :command:`az vm stop...` command as
-   follows:
-
-   .. code-block:: bash
-
-      az vm stop --resource-group ClearResourceGroup --name ClearVM
-
-   This will stop the VM and then output text similar to:
-
-   .. code-block:: console
-
-      {
-        "endTime": "2017-12-13T23:04:02.346676+00:00",
-        "error": null,
-        "name": "{unique-name}",
-        "startTime": "2017-12-13T23:03:59.018536+00:00",
-        "status": "Succeeded"
-      }
-
-#. Once the VM stops, deallocate the VM resources to stop incurring
-   charges for the |CL| instance. Enter the following command:
-
-   .. code-block:: console
-
-      az vm deallocate --resource-group ClearResourceGroup --name ClearVM
-
-**Congratulations!**
-
-You are up and running with |CL| on MS Azure using the Azure
-CLI 2.0 command line tools.
-
-Next steps
-**********
-
-To see use cases you can fulfill with your |CL| instance, visit our
-:ref:`tutorials <tutorials>` section.
-
-For additional information visit the |CL|
-`Azure Partner Mini Case Study`_ and the `Azure Partner Datasheet`_.
-
-To learn more about the MS Azure CLI 2.0 tool and options that are available,
-visit the `MS Azure documentation and tutorials`_ website.
-
-.. _`Azure Portal`:
-   https://portal.azure.com
-
-.. _`MS Azure free account`:
-   https://azure.microsoft.com/en-us/free/
-
-.. _`MS Azure documentation and tutorials`:
-   https://docs.microsoft.com/en-us/cli/azure/overview?view=azure-cli-latest
-
-.. _`MS Azure Install Azure CLI tutorial`:
-   https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest
-
-.. _`Azure Resource Manager overview`:
-   https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview
-
-.. _Azure Partner Datasheet:
-   http://download.microsoft.com/download/D/9/E/D9E22342-96D9-4455-BB15-99A1AF514DDD/Microsoft%20Azure%20Partner%20Datasheet%20-%20Intel%20Clear%20Linux.pdf
-
-.. _Azure Partner Mini Case Study:
-   http://download.microsoft.com/download/D/9/E/D9E22342-96D9-4455-BB15-99A1AF514DDD/Microsoft%20Azure%20Partner%20Mini%20Case%20Study%20-%20Intel%20Clear%20Linux.pdf

_sources/tutorials/flatpak/flatpak.rst.txt

@@ -1,103 +0,0 @@
-.. _flatpak:
-
-Use Flatpak\* to install applications on |CL-ATTR|
-##################################################
-
-This tutorial provides all the required steps to install Flatpak as well as
-downloading, installing, and running LibreOffice\* on |CL-ATTR|.
-
-Please visit the `Flatpak website`_ for more information about Flatpak and
-how to use it. You can also `download it here`_.
-
-Before you begin
-****************
-
-This tutorial assumes you have installed |CL| on your host system.
-For detailed instructions on installing |CL| on a bare metal system, visit
-our :ref:`bare metal installation guide <bare-metal-install-desktop>`.
-
-Install Flatpak on your host system
-===================================
-
-Flatpak is included as part of the bundle `desktop`. To install the
-application, log in to your user account and enter the following command:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add desktop
-
-Install and run the LibreOffice Flatpak image
-=============================================
-
-Application developers have the option to bundle their applications using
-Flatpak to allow the installation of a single distribution of their
-application on different distributions of Linux, including |CL|.
-Flatpak provides a `list of applications`_ available through Flathub.
-
-|CL| enables the Flathub repository by default.
-
-
-Installing using gnome software
--------------------------------
-
-All you need to do is to launch `gnome software`, search for the LibreOffice
-app, and click the install button.
-
-.. figure:: figures/01-install-libreoffice.gif
-   :alt: install libreoffice step by step
-
-   Figure 1: Installing LibreOffice using gnome-software
-
-
-
-Installing using the command line
----------------------------------
-
-Open the `gnome-terminal` and type the following command to install the
-LibreOffice app.
-
-.. code-block:: bash
-
-   flatpak install --user flathub org.libreoffice.LibreOffice
-   Installing in user:
-   org.libreoffice.LibreOffice/x86_64/stable        flathub 2aff77bd5cf1
-     permissions: ipc, network, pulseaudio, wayland, x11, dri
-     file access: host, xdg-run/dconf
-     dbus access: ca.desrt.dconf, org.gtk.vfs.*
-     dbus ownership: org.libreoffice.LibreOfficeIpc0
-   org.libreoffice.LibreOffice.Locale/x86_64/stable flathub 924157b3b009
-   Is this ok [y/n]: y
-   Installing for user: org.libreoffice.LibreOffice/x86_64/stable from flathub
-   [####################] 403 metadata, 4661 content objects fetched; 222574 KiB transferred in 99 seconds
-   Now at 2aff77bd5cf1.
-   Installing for user: org.libreoffice.LibreOffice.Locale/x86_64/stable from flathub
-   [####################] 10 metadata, 71 content objects fetched; 1013 KiB transferred in 3 seconds
-   Now at 924157b3b009.
-
-
-Launch LibreOffice
-==================
-A new set of icons will appear in your Gnome applications list titled :guilabel:`LibreOffice.` To
-execute the application, highlight the application and click on the :guilabel:`LibreOffice` icon.
-LibreOffice will start normally.
-
-.. figure:: figures/02-openlibreoffice.gif
-   :alt: Opening LibreOffice app
-
-   Figure 2: Select :guilabel:`LibreOffice` app
-
-Using the command line
-----------------------
-
-.. code-block:: bash
-
-   flatpak run org.libreoffice.LibreOffice
-
-
-.. _Flatpak website: http://flatpak.org
-
-.. _list of applications: http://flatpak.org/apps.html
-
-.. _download it here:
-   http://download.documentfoundation.org/libreoffice/flatpak/latest/LibreOffice.flatpak
-

_sources/tutorials/fmv.rst.txt

@@ -1,273 +0,0 @@
-.. _fmv:
-
-Use the function multi-version patch generator
-##############################################
-
-CPU architectures often gain interesting new instructions as they evolve but
-application developers find it difficult to take advantage of those
-instructions. The reluctance to lose backward-compatibility is one of the
-main roadblocks slowing developers from using advancements in newer computing
-architectures. :abbr:`FMV (Function Multi-Versioning)`, which first appeared
-in `GCC`_ 4.8, is a way to have multiple implementations of a function, each
-using a different architecture specialized instruction-set extensions. GCC
-6 introduces changes to FMV to make it even easier to bring architecture-
-based optimizations to the application code.
-
-In this tutorial we will use FMV on general code and on
-:abbr:`FFT (Fast Fourier Transform)` library code (FFTW). Upon completing the
-tutorial, you will be able to use this technology on your code and use the
-libraries to deploy architecture-based optimizations to your application code.
-
-Install and configure a |CL| host on bare metal
-***********************************************
-First, follow our guide to :ref:`bare-metal-install-desktop`. Once the bare
-metal installation and initial configuration are complete, add the
-`desktop-dev` bundle to the system. `desktop-dev`: contains the necessary
-development tools like GCC and Perl\*.
-
-To install the bundles, run the following command in the :file:`$HOME`
-directory:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add desktop-dev
-
-Detect loop vectorization candidates
-************************************
-
-Now, we need to detect the loop vectorization candidates to be cloned for
-multiple platforms with FMV. As an example, we will use the following
-simple C code:
-
-.. code-block:: c
-   :linenos:
-
-    #include <stdio.h>
-    #include <stdlib.h>
-    #include <sys/time.h>
-    #define MAX 1000000
-
-    int a[256], b[256], c[256];
-
-    void foo(){
-        int i,x;
-        for (x=0; x<MAX; x++){
-            for (i=0; i<256; i++){
-                a[i] = b[i] + c[i];
-            }
-        }
-    }
-
-
-    int main(){
-        foo();
-        return 0;
-    }
-
-Save the example code as :file:`example.c` in the current directory and build
-with the following flags:
-
-.. code-block:: bash
-
-        gcc -O3  -fopt-info-vec  example.c -o example
-
-The build generates the following output:
-
-.. code-block:: console
-
-    example.c:11:9: note: loop vectorized
-    example.c:11:9: note: loop vectorized
-
-The output shows that line 11 is a good candidate for vectorization:
-
-.. code-block:: c
-
-    for (i=0; i<256; i++){
-        a[i] = b[i] + c[i];
-
-Generate the FMV patch
-**********************
-
-To generate the FMV patch with the `make-fmv-patch`_ project, we
-must clone the project and generate a log file with the loop vectorized
-information:
-
-.. code-block:: bash
-
-        git clone https://github.com/clearlinux/make-fmv-patch.git
-        gcc -O3  -fopt-info-vec  example.c -o example &> log
-
-To generate the patch files, execute:
-
-.. code-block:: bash
-
-        perl ./make-fmv-patch/make-fmv-patch.pl log .
-
-The :file:`make-fmv-patch.pl` script takes two arguments: `<buildlog>` and
-`<sourcecode>`. Replace `<buildlog>` and `<sourcecode>` with the proper
-values and execute:
-
-.. code-block:: bash
-
-        perl make-fmv-patch.pl <buildlog> <sourcecode>
-
-The command generates the following :file:`example.c.patch` patch:
-
-.. code-block:: console
-
-    --- ./example.c 2017-09-27 16:05:42.279505430 +0000
-    +++ ./example.c~    2017-09-27 16:19:11.691544026 +0000
-    @@ -5,6 +5,7 @@
-
-     int a[256], b[256], c[256];
-
-    +__attribute__((target_clones("avx2","arch=atom","default")))
-     void foo(){
-         int i,x;
-         for (x=0; x<MAX; x++){
-
-We recommend you use the :file:`make-fmv-patch` script to add the attribute
-generating the target clones on the function `foo`. Thus, we can have the
-following code:
-
-.. code-block:: c
-
-    #include <stdio.h>
-    #include <stdlib.h>
-    #include <sys/time.h>
-    #define MAX 1000000
-
-    int a[256], b[256], c[256];
-
-    __attribute__((target_clones("avx2","arch=atom","default")))
-    void foo(){
-        int i,x;
-        for (x=0; x<MAX; x++){
-            for (i=0; i<256; i++){
-                a[i] = b[i] + c[i];
-            }
-        }
-    }
-
-
-    int main(){
-        foo();
-        return 0;
-    }
-
-Changing the value of the `$avx2` variable, we can change the target
-clones when adding the patches or in the :file:`make-fmv-patch.pl` script:
-
-.. code-block:: perl
-
-    my $avx2 = '__attribute__((target_clones("avx2","arch=atom","default")))'."\n";
-
-Compile the code again with FMV and add the option to analyze the `objdump`
-log:
-
-.. code-block:: bash
-
-    gcc -O3 example.c -o example -g
-    objdump -S example | less
-
-You can see the multiple clones of the `foo` function:
-
-.. code-block:: console
-
-    foo
-    foo.avx2.0
-    foo.arch_atom.1
-
-The cloned functions use AVX2 registers and vectorized instructions. To
-verify, enter the following commands:
-
-::
-
-    vpaddd (%r8,%rax,1),%ymm0,%ymm0
-    vmovdqu %ymm0,(%rcx,%rax,1)
-
-FFT project example using FFTW
-******************************
-
-To follow the same approach with a package like FFTW, we must use the
-`-fopt-info-vec` flag to get a build log file similar to:
-
-.. code-block:: bash
-
-    ~/make-fmv-patch/make-fmv-patch.pl results/build.log fftw-3.3.6-pl2/
-
-    patching fftw-3.3.6-pl2/libbench2/verify-lib.c @ lines (36 114 151 162 173 195 215 284)
-    patching fftw-3.3.6-pl2/tools/fftw-wisdom.c @ lines (150)
-    patching fftw-3.3.6-pl2/libbench2/speed.c @ lines (26)
-    patching fftw-3.3.6-pl2/tests/bench.c @ lines (27)
-    patching fftw-3.3.6-pl2/libbench2/util.c @ lines (181)
-    patching fftw-3.3.6-pl2/libbench2/problem.c @ lines (229)
-    patching fftw-3.3.6-pl2/tests/fftw-bench.c @ lines (101 147 162 249)
-    patching fftw-3.3.6-pl2/libbench2/mp.c @ lines (79 190 215)
-    patching fftw-3.3.6-pl2/libbench2/caset.c @ lines (5)
-    patching fftw-3.3.6-pl2/libbench2/verify-r2r.c @ lines (44 187 197 207 316 333 723)
-
-For example, the :file:`fftw-3.3.6-pl2/tools/fftw-wisdom.c.patch` file
-generates the following patches:
-
-.. code-block:: diff
-   :linenos:
-
-       --- fftw-3.3.6-pl2/libbench2/verify-lib.c   2017-01-27 21:08:13.000000000 +0000
-       +++ fftw-3.3.6-pl2/libbench2/verify-lib.c~  2017-09-27 17:49:21.913802006 +0000
-       @@ -33,6 +33,7 @@
-
-        double dmax(double x, double y) { return (x > y) ? x : y; }
-
-       +__attribute__((target_clones("avx2","arch=atom","default")))
-        static double aerror(C *a, C *b, int n)
-        {
-            if (n > 0) {
-       @@ -111,6 +112,7 @@
-       }
-
-       /* make array hermitian */
-       +__attribute__((target_clones("avx2","arch=atom","default")))
-       void mkhermitian(C *A, int rank, const bench_iodim *dim, int stride)
-       {
-            if (rank == 0)
-       @@ -148,6 +150,7 @@
-       }
-
-       /* C = A + B */
-       +__attribute__((target_clones("avx2","arch=atom","default")))
-       void aadd(C *c, C *a, C *b, int n)
-       {
-            int i;
-       @@ -159,6 +162,7 @@
-       }
-
-       /* C = A - B */
-       +__attribute__((target_clones("avx2","arch=atom","default")))
-       void asub(C *c, C *a, C *b, int n)
-       {
-            int i;
-       @@ -170,6 +174,7 @@
-       }
-
-       /* B = rotate left A (complex) */
-       +__attribute__((target_clones("avx2","arch=atom","default")))
-       void arol(C *b, C *a, int n, int nb, int na)
-       {
-            int i, ib, ia;
-       @@ -192,6 +197,7 @@
-            }
-       }
-
-With these patches, we can select where to apply the FMV technology making
-bringing architecture-based optimizations to application code even easier.
-
-**Congratulations!**
-
-You have successfully installed an FMV development environment on |CL|.
-Furthermore, you used cutting edge compiler technology to improve the
-performance of your application based on Intel Architecture technology and
-profiling of the specific execution of your application.
-
-.. _GCC:  https://gcc.gnu.org
-.. _make-fmv-patch: https://github.com/clearlinux/make-fmv-patch

_sources/tutorials/hadoop.rst.txt

@@ -1,256 +0,0 @@
-.. _hadoop:
-
-Set up a single node cluster with Hadoop\*
-##########################################
-
-This tutorial walks you through the process of installing, configuring, and
-running Apache\* Hadoop on |CL-ATTR|. The Apache Hadoop software library is a
-framework for distributed processing of large data sets across clusters of
-computers using simple programming models. It is designed to scale up from
-single servers to thousands of machines, with each machine offering local
-computation and storage.
-
-Prerequisites
-*************
-
-Before following this tutorial, you should follow the
-:ref:`bare-metal-install-desktop` to ensure you have installed |CL|.
-
-Before you install any new packages, update |CL| with the following command:
-
-.. code-block:: bash
-
-   sudo swupd update
-
-For the purposes of this tutorial, we will install Hadoop in a single machine
-running both the master and slave daemons.
-
-Install Apache Hadoop
-*********************
-
-Apache Hadoop is included in the `big-data-basic` bundle. To install the
-framework, enter the following command:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add big-data-basic
-
-Configure Apache Hadoop
-***********************
-
-#. To create the configuration directory, enter the following command:
-
-   .. code-block:: bash
-
-      sudo mkdir /etc/hadoop
-
-#. Copy the defaults from :file:`/usr/share/defaults/hadoop` to
-   :file:`/etc/hadoop` with the following command:
-
-   .. code-block:: bash
-
-      $ sudo cp /usr/share/defaults/hadoop/* /etc/hadoop
-
-   .. note:: Since |CL| is a stateless system, you should never modify the
-      files under the :file:`/usr/share/defaults` directory. The software
-      updater will overwrite those files.
-
-Once all the configuration files are in :file:`/etc/hadoop`, we must edit
-them to fit our needs. The `NameNode` server is the master server. It manages
-the namespace of the files system and regulates the clients' access to files.
-The first file we edit, :file:`/etc/hadoop/core-site.xml`, informs the Hadoop
-daemon where `NameNode` is running.
-
-In this tutorial, our `NameNode` runs in our `localhost`. Follow these steps
-to set it up correctly:
-
-#. Open the :file:`/etc/hadoop/core-site.xml` file using the editor of your
-   choice and modify the file as follows:
-
-   .. code-block:: xml
-
-      <?xml version="1.0" encoding="UTF-8"?>
-      <?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
-      <configuration>
-      <property>
-      <name>fs.default.name</name>
-      <value>hdfs://localhost:9000</value>
-      </property>
-      </configuration>
-
-#. Edit the :file:`/etc/hadoop/hdfs-site.xml` file. This file configures the
-   :abbr:`HDFS (Hadoop Distributed File System)` daemons. This configuration
-   includes the list of permitted and excluded data nodes and the size of
-   said blocks. In this example, we are setting the number of block
-   replication to 1 from the default of 3 as follows:
-
-   .. code-block:: xml
-      :emphasize-lines: 6
-
-      <?xml version="1.0" encoding="UTF-8"?>
-      <?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
-      <configuration>
-      <property>
-      <name>dfs.replication</name>
-      <value>1</value>
-      </property>
-      <property>
-      <name>dfs.permission</name>
-      <value>false</value>
-      </property>
-      </configuration>
-
-#. Edit the :file:`/etc/hadoop/mapred-site.xml` file. This file configures
-   all daemons related to `MapReduce`: `JobTracker` and `TaskTrackers`. With
-   `MapReduce`, Hadoop can process big amounts of data in multiple systems. In
-   our example, we set :abbr:`YARN (Yet Another Resource Manager)` as our
-   runtime framework for executing `MapReduce` jobs as follows:
-
-   .. code-block:: xml
-      :emphasize-lines: 5,6
-
-      <?xml version="1.0" encoding="UTF-8"?>
-      <?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
-      <configuration>
-      <property>
-      <name>mapreduce.framework.name</name>
-      <value>yarn</value>
-      </property>
-      </configuration>
-
-#. Edit the :file:`/etc/hadoop/yarn-site.xml` file. This file configures all
-   daemons related to `YARN`: `ResourceManager` and `NodeManager`. In our
-   example, we implement the `mapreduce_shuffle` service, which is the
-   default as follows:
-
-   .. code-block:: xml
-      :emphasize-lines: 4,5,8,9
-
-      <?xml version="1.0"?>
-      <configuration>
-      <property>
-      <name>yarn.nodemanager.aux-services</name>
-      <value>mapreduce_shuffle</value>
-      </property>
-      <property>
-      <name>yarn.nodemanager.auxservices.mapreduce.shuffle.class</name>
-      <value>org.apache.hadoop.mapred.ShuffleHandler</value>
-      </property>
-      </configuration>
-
-Configure your SSH key
-**********************
-
-#. Create a SSH key. If you already have one, skip this step.
-
-   .. code-block:: bash
-
-      sudo ssh-keygen -t rsa
-
-
-#. Copy the key to your authorized keys.
-
-   .. code-block:: bash
-
-      sudo cat /root/.ssh/id_rsa.pub | sudo tee -a /root/.ssh/authorized_keys
-
-#. Log into the localhost. If no password prompt appears, you are ready to
-   run the Hadoop daemons.
-
-   .. code-block:: bash
-
-      sudo ssh localhost
-
-Run the Hadoop daemons
-**********************
-
-With all the configuration files properly edited, we are ready to start the
-daemons.
-
-When we format the `NameNode` server, it formats the meta-data related to
-data nodes. Thus, all the information on the data nodes is lost and the nodes
-can be reused for new data.
-
-#. Format the `NameNode` server with the following command:
-
-   .. code-block:: bash
-
-      sudo hdfs namenode -format
-
-#. Start the DFS in `NameNode` and `DataNodes` with the following command:
-
-   .. code-block:: bash
-
-      sudo start-dfs.sh
-
-#. The console output should be similar to:
-
-   .. code-block:: console
-
-      Starting namenodes on [localhost]
-      The authenticity of host 'localhost (::1)' can't be established.
-      ECDSA key fingerprint is
-      SHA256:97e+7TnomsS9W7GjFPjzY75HGBp+f1y6sA+ZFcOPIPU.
-      Are you sure you want to continue connecting (yes/no)?
-
-   Enter `yes` to continue.
-
-#. Start the `YARN` daemons `ResourceManager` and `NodeManager` with the
-   following command:
-
-   .. code-block:: bash
-
-      sudo start-yarn.sh
-
-#. Ensure everything is running as expected with the following command:
-
-   .. code-block:: bash
-
-      sudo jps
-
-#. The console output should be similar to:
-
-   .. code-block:: console
-
-      22674 DataNode
-      26228 Jps
-      22533 NameNode
-      23046 ResourceManager
-      22854 SecondaryNameNode
-      23150 NodeManager
-
-Run the MapReduce wordcount example
-***********************************
-
-#. Create the input directory.
-
-   .. code-block:: bash
-
-      sudo hdfs dfs -mkdir -p /user/root/input
-
-#. Copy a file from the local file system to the HDFS.
-
-   .. code-block:: bash
-
-      sudo hdfs dfs -copyFromLocal local-file /user/root/input
-
-#. Run the `wordcount` example.
-
-   .. code-block:: bash
-
-      sudo hadoop jar /usr/share/hadoop/mapreduce/hadoop-mapreduce-examples-2.8.0.jar wordcount input output
-
-#. Read output file "part-r-00000". This file contains the number of times
-   each word appears in the file.
-
-   .. code-block:: bash
-
-      sudo hdfs dfs -cat /user/root/output/part-r-00000
-
-**Congratulations!**
-
-You successfully installed and setup a single node Hadoop cluster.
-Additionally, you ran a simple wordcount example.
-
-Your single node Hadoop cluster is up and running!
-

_sources/tutorials/kata.rst.txt

@@ -1,116 +0,0 @@
-  .. _kata:
-
-Install Kata Containers\*
-#########################
-
-This tutorial describes how to install, configure, and run `Kata Containers`_
-on |CL-ATTR|. Kata Containers is an open source project developing a
-lightweight implementation of :abbr:`VMs (Virtual Machines)` that offer the
-speed of containers and the security of VMs.
-
-Prerequisites
-*************
-
-This tutorial assumes you have installed |CL| on your host system.
-For detailed instructions on installing |CL| on a bare metal system, follow
-the :ref:`bare metal installation tutorial<bare-metal-install-desktop>`.
-
-If you have Clear Containers installed on your |CL| system, then follow the
-:ref:`migrate Clear Containers to Kata Containers tutorial<kata_migration>`.
-
-Before you install any new packages, update |CL| with the following command:
-
-.. code-block:: bash
-
-   sudo swupd update
-
-Install Kata Containers
-***********************
-
-Kata Containers is included in the :file:`containers-virt` bundle.
-To install the framework, enter the following command:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add containers-virt
-
-Restart the Docker\* and Kata Containers systemd services.
-
-.. code-block:: bash
-
-   sudo systemctl daemon-reload
-   sudo systemctl restart docker
-
-Run Kata Containers
-*******************
-
-.. code-block:: bash
-
-   sudo docker run -ti busybox sh
-
-.. note::
-
-   If you use a proxy server and your proxy environment variables are already
-   set, run the following commands as a shell script to configure Docker:
-
-   .. code-block:: bash
-
-      docker_service_dir="/etc/systemd/system/docker.service.d/"
-      sudo mkdir -p "$docker_service_dir"
-      cat <<EOF | sudo tee "$docker_service_dir/proxy.conf"
-      [Service]
-      Environment="HTTP_PROXY=$http_proxy"
-      Environment="HTTPS_PROXY=$https_proxy"
-      EOF
-      echo "Reloading unit files and starting docker service"
-      sudo systemctl daemon-reload
-      sudo systemctl restart docker
-      sudo docker info
-
-**Congratulations!**
-
-You've successfully installed and set up Kata Containers on |CL|.
-
-More information about Docker
-*****************************
-
-Docker on |CL| provides a :file:`docker.service` file to start the Docker
-daemon. The daemon will use runc or kata-runtime depending on the
-environment:
-
-*  If you are running |CL| on bare metal or on a VM with Nested
-   Virtualization activated, Docker uses kata-runtime as the
-   default runtime.
-*  If you are running |CL| on a VM without Nested Virtualization,
-   Docker uses runc as the default runtime.
-
-You do not need to manually configure the runtime for Docker, because
-it automatically uses the runtime supported by the system.
-
-Troubleshooting
-===============
-
-- To change the Docker storage driver, see
-  :ref:`additional-docker-configuration`.
-
-- For some |CL| versions before 27000, you may need to manually
-  configure Docker\* to use Kata Containers by default.
-
-  To do so, enter:
-
-  .. code-block:: bash
-
-     sudo mkdir -p /etc/systemd/system/docker.service.d/
-     cat <<EOF | sudo tee /etc/systemd/system/docker.service.d/50-runtime.conf
-     [Service]
-     Environment="DOCKER_DEFAULT_RUNTIME=--default-runtime kata-runtime"
-     EOF
-
-- To check the version of |CL| on your system, enter:
-
-  .. code-block:: bash
-
-     sudo swupd info
-
-
-.. _Kata Containers: https://katacontainers.io/

_sources/tutorials/kubernetes/kubernetes-bp.rst.txt

@@ -1,92 +0,0 @@
-.. _kubernetes-bp:
-
-Kubernetes Best Practices on |CL|
-#################################
-
-Use swupd to update clusters
-****************************
-
-This tutorial shows you how to manage your Kubernetes cluster while using
-:command:`swupd` to update |CL-ATTR|.
-
-In our tutorial :ref:`kubernetes`, we explain how to set up a Kubernetes
-cluster on |CL| using `kubeadm`. `Kubeadm documentation`_ often builds on the
-assumption that the distribution uses a traditional package manager (e.g.,
-RPM/DEB).
-
-In contrast, |CL| uses `swupd` to update the OS, which in this case updates
-all of the kubernetes node and client binaries simultaneously, as part of
-the `cloud-native-basic` bundle (e.g., kubectl, kubeadm, kubelet). Running
-:command:`sudo swupd update` requires special care to ensure the OS
-incorporates the latest Kubernetes upgrades.
-
-This document describes best practices to manage cluster upgrades with
-`kubeadm` on a |CL|-based cluster.
-
-Prerequisites
-*************
-
-Assure that you:
-
-* Completed :ref:`kubernetes`
-* Installed the bundle `cloud-native-basic`
-
-.. note::
-
-   Other Linux\* distros shown in Kubernetes upgrade documentation reflect
-   `apt-get update`, `apt-mark hold kubeadm`, and similar commands; however, such commands **are not valid** on |CL|.
-
-Update the control plane
-************************
-
-#. Read kubernetes documentation `before you begin`_.
-
-#. On your master node, run the command:
-
-   .. code-block:: bash
-
-      sudo swupd update
-
-   .. note::
-
-      If the minor version of Kubernetes changes, |CL| shows a message-of-the-day, or `motd`. When the `motd` appears, you **must postpone** a kubelet restart on master and nodes until the control plane is properly updated. :command:`swupd update` does not restart services automatically unless explicitly configured to do so.
-
-#. Now follow these instructions in kubernetes documentation.
-
-   * `Upgrade control plane`_
-   * `Drain control plane node`_
-   * `Restart Kubelet and undrain node`_
-
-Update worker nodes
-*******************
-
-#. On each worker node, run the command:
-
-   .. code-block:: bash
-
-      sudo swupd update
-
-#. Now follow these instructions in kubernetes documentation:
-
-   * `Drain node`_
-   * `Update kubelet configuration`_
-   * `Restart Kubelet and undrain node`_
-
-.. _Kubeadm documentation: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-upgrade/
-
-.. _Restart Kubelet and undrain node: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#restart-the-kubelet-for-all-nodes
-
-.. _Update kubelet configuration: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#upgrade-the-kubelet-config-on-worker-nodes
-
-.. _Drain node: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#drain-control-plane-and-worker-nodes
-
- .. _Restart kubelet and undrain node: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#restart-the-kubelet-for-all-nodes
-
-.. _Upgrade control plane: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#upgrade-the-control-plane-node
-
-.. _Drain control plane node: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#drain-control-plane-and-worker-nodes
-
-.. _Kubeadmn documentation: https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm/
-
-.. _before you begin: https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-13/#before-you-begin
-

_sources/tutorials/nvidia.rst.txt

@@ -1,324 +0,0 @@
-.. _nvidia:
-
-Install NVIDIA\* Drivers
-########################
-
-NVIDIA manufactures graphics processing units (GPU), also known as
-graphics cards. 
-
-NVIDIA devices on Linux\* have two popular device driver options: the
-opensource drivers from the `nouveau project`_ or the proprietary drivers
-published by NVIDIA. The nouveau drivers are built into the |CL-ATTR|
-kernel and are loaded automatically at system boot if a compatible card
-is detected. 
-
-These instructions show how to use the proprietary NVIDIA drivers, which
-require a manual installation.
-
-.. warning::
-  
-   Software installed outside of :ref:`swupd <swupd-about>` is not updated
-   with |CL| updates and must be updated and maintained manually.
-
-   For example, the file :file:`/usr/lib/libGL.so` conflicts with the file
-   provided by the mesa package in |CL| and the file NVIDIA provides. If a |CL|
-   update overwrites these files, a reinstallation of the NVIDIA driver might
-   be required.
-
-
-
-.. contents:: :local:
-    :depth: 2
-
-
-
-Prerequisites 
-*************
-
-* A |CL| system with a desktop installed
-* An NVIDIA device installed
-
-
-Install DKMS
-************
-
-The :ref:`Dynamic Kernel Module System (DKMS)
-<kernel-modules-dkms>` allows the NVIDIA kernel modules to be automatically
-integrated when kernel updates occur in |CL|. 
-
-Install the appropriate DKMS bundle using the instructions below:
-
-.. note::
-   The Long Term Support (LTS) kernel variant is more likely to remain
-   compatible between updates with NVIDIA drivers.
-
-
-.. include:: /guides/kernel/kernel-modules-dkms.rst
-   :start-after: kernel-modules-dkms-install-begin:
-   :end-before: kernel-modules-dkms-install-end:
-
-
-Download and install the NVIDIA drivers
-***************************************
-
-
-Download the NVIDIA drivers for Linux
-=====================================
-
-#. Identify the NVIDIA GPU model that is installed.
-
-   .. code-block:: bash
-
-      sudo lshw -C display
-
-
-#. Go to the `NVIDIA Driver Downloads website`_ . Search for and download the
-   appropriate driver based on the NVIDIA GPU model you have with *Linux
-   64-bit* selected as the Operating System . 
-
-
-#. Open a terminal and navigate to where the
-   :file:`NVIDIA-Linux-x86_64-<VERSION>.run` file was saved. In this
-   example, it was saved in the Downloads folder.
-
-   .. code-block:: bash
-
-      cd ~/Downloads/
-
-#. Make the :file:`NVIDIA-Linux-x86_64-<VERSION>.run` file executable.
-
-   .. code-block:: bash
-
-      chmod +x :file:`NVIDIA-Linux-x86_64-<VERSION>.run`
-
-
-Disable the nouveau driver
-==========================
-
-The proprietary NVIDIA driver is incompatible with the nouveau driver and
-must be disabled before installation can continue.
-
-#. Disable the nouveau driver by creating a blacklist file under
-   :file:`/etc/modprobe.d` and reboot.
-
-   .. code-block:: bash
-
-      sudo mkdir /etc/modprobe.d
-
-      printf "blacklist nouveau \noptions nouveau modeset=0 \n" | sudo tee --append /etc/modprobe.d/disable-nouveau.conf
-      
-
-#. Reboot the system and log back in. It is normal for the graphical
-   environment not to start without the NVIDIA driver loaded.
-
-
-
-
-Configure alternative software paths
-====================================
-
-The NVIDIA installer is directed to install files under
-:file:`/opt/nvidia` as much as possible to keep its contents isolated from the
-rest of the |CL| system files under :file:`/usr`.  The dynamic linker and X
-server must be configured to use the content under
-:file:`/opt/nvidia`.
-
-
-#. Configure the dynamic linker to look for and to cache shared libraries under
-   :file:`/opt/nvidia/lib` and :file:`/opt/nvidia/lib32` in addition to the
-   default paths.
-
-   .. code-block:: bash
-      
-      echo "include /etc/ld.so.conf.d/*.conf" |  sudo tee --append /etc/ld.so.conf
-      
-      sudo mkdir /etc/ld.so.conf.d
-      printf "/opt/nvidia/lib \n/opt/nvidia/lib32 \n" | sudo tee --append /etc/ld.so.conf.d/nvidia.conf
-
-#. Reload the dynamic linker run-time bindings and library cache. 
-
-   .. code-block:: bash
-
-      sudo ldconfig
-
-#. Create a Xorg configuration file to search for modules under
-   :file:`/opt/nvidia` in addition to the default path.
-
-   .. code-block:: bash
-
-      sudo mkdir -p /etc/X11/xorg.conf.d/
-      
-      sudo tee /etc/X11/xorg.conf.d/nvidia-files-opt.conf > /dev/null <<'EOF'
-      Section "Files"
-              ModulePath      "/usr/lib64/xorg/modules"
-              ModulePath      "/opt/nvidia/lib64/xorg/modules"
-      EndSection
-      EOF
-
-
-Install the NVIDIA drivers
-==========================
-
-
-#. A terminal not running on */dev/tty1* is useful to view uninterrupted
-   installation progress. Switch to a secondary virtual terminal by pushing
-   :command:`CTRL + ALT + F2` or remotely login over SSH. 
-
-
-#. Navigate to the directory where the NVIDIA installer was downloaded.
-
-   .. code-block:: bash
-
-      cd ~/Downloads/   
-
-
-#. Run the installer with the advanced options below.
-
-   .. code-block:: bash
-      
-      sudo ./NVIDIA-Linux-x86_64-<VERSION>.run \
-      --utility-prefix=/opt/nvidia \
-      --opengl-prefix=/opt/nvidia \
-      --compat32-prefix=/opt/nvidia \
-      --compat32-libdir=lib32 \
-      --x-prefix=/opt/nvidia \
-      --x-module-path=/opt/nvidia/lib64/xorg/modules \
-      --x-library-path=/opt/nvidia/lib64 \
-      --x-sysconfig-path=/etc/X11/xorg.conf.d \
-      --documentation-prefix=/opt/nvidia \
-      --application-profile-path=/etc/nvidia \
-      --no-precompiled-interface \
-      --no-nvidia-modprobe \
-      --no-distro-scripts \
-      --force-libglx-indirect \
-      --glvnd-egl-config-path=/etc/glvnd/egl_vendor.d \
-      --egl-external-platform-config-path=/etc/egl/egl_external_platform.d  \
-      --dkms \
-      --silent
-
-#. The graphical interface may automatically start after the NVIDIA driver
-   is loaded. Return to the working terminal and log back in if necessary.
-
-
-#. Confirm that the NVIDIA kernel modules are loaded.
-
-   .. code-block:: bash
-
-      lsmod | grep ^nvidia      
-
-
-#. Run a |CL| system verification to restore files that the NVIDIA installer
-   likely deleted.
-
-   .. code-block:: bash
-
-      sudo swupd repair --quick --bundles=lib-opengl
-
-.. note::
-
-   The NVIDIA software places some files under the :file:`/usr` subdirectory
-   that are not managed by |CL| and conflict with the |CL| stateless design.
-
-   Although a limited version of :command:`swupd repair` is run above,
-   other uses of the :command:`swupd repair` command should be avoided
-   with the proprietary NVIDIA drivers installed.
-
-
-Updating the NVIDIA drivers
-***************************
-
-The proprietary NVIDIA drivers are installed manually outside of :ref:`swupd
-<swupd-about>` and must be updated manually when needed.
-
-Updating the NVIDIA drivers follows the same steps as initial installation,
-however the desktop environment must first be stopped so that the drivers are
-not in use. 
-
-#. Follow the steps in the `Download the NVIDIA Drivers for Linux`_ section
-   to get the latest NVIDIA drivers.
-
-#. Temporarily set the default boot target to the *multi-user*, which is
-   a non-graphical runtime.
-
-   .. code-block:: bash
-
-      sudo systemctl set-default multi-user.target
-
-
-#. Reboot the system and log back in. It is normal for the graphical
-   environment not to start.
-
-#. Follow the steps in the `Install the NVIDIA Drivers`_ section to update
-   the NVIDIA drivers. This installation will overwrite the previous NVIDIA
-   drivers and files.
-
-#. Set the default boot target back to the *graphical* target.
-
-   .. code-block:: bash
-
-      sudo systemctl set-default graphical.target
-
-
-#. Reboot the system and log back in. 
-
-#. Trigger a flatpak update that will download the runtime corresponding
-   with the new NVIDIA drivers for the flatpak apps that require it.
-
-   .. code-block:: bash
-
-      flatpak update
-
-
-Uninstalling the NVIDIA drivers
-*******************************
-
-The NVIDIA drivers and associated software can be uninstalled and nouveau
-driver restored with the instructions in this section. 
-
-#. Remove the :file:`modprobe.d` file that prevents nouveau from loading.
-
-   .. code-block:: bash
-
-      sudo rm /etc/modprobe.d/disable-nouveau.conf
-
-
-#. Remove the :file:`xorg.conf.d` file that adds a search path for X modules.
-
-   .. code:: bash
-
-      sudo rm /etc/X11/xorg.conf.d/nvidia-files-opt.conf
-
-#. Run the :command:`sudo /opt/nvidia/bin/nvidia-uninstall`
-
-#. Follow the prompts on the screen and reboot the system. 
-
-
-Debugging installation of NVIDIA drivers 
-****************************************
-
-* The NVIDIA driver places installer and uninstaller logs under
-  :file:`/var/log/nvidia-install` and :file:`/var/log/nvidia-uninstall`.
-
-* :file:`NVIDIA-Linux-x86_64-<VERSION>.run --advanced-options` shows many
-  parameters to control installation behavior. 
-
-* :file:`NVIDIA-Linux-x86_64-<VERSION>.run --extract-only` extracts
-  installation files into a directory named
-  :file:`NVIDIA-Linux-x86_64-<VERSION>`. 
-
-
-
-Additional resources
-********************
-
-* `Why aren't the NVIDIA Linux drivers open source? <https://nvidia.custhelp.com/app/answers/detail/a_id/1849/kw/Linux>`_
-
-* `Where can I get support for NVIDIA Linux drivers? <https://nvidia.custhelp.com/app/answers/detail/a_id/44/kw/linux>`_
-
-* `NVIDIA Accelerated Linux Graphics Driver Installation Guides <https://download.nvidia.com/XFree86/Linux-x86_64/>`_
-
-.. _`nouveau project`:  https://nouveau.freedesktop.org/wiki/
-
-.. _`NVIDIA Driver Downloads website`: https://www.nvidia.com/download/index.aspx
-
-

_sources/tutorials/smb/smb.rst.txt

@@ -1,131 +0,0 @@
-.. _clear-samba-share-to-Windows:
-
-Enable simple file sharing with a Windows\* machine using Samba\*
-#################################################################
-
-This tutorial describes how to enable simple file sharing from a system
-running |CL-ATTR| to a Windows machine using Samba. For more advanced sharing,
-refer to the `Samba guide`_.
-
-Prerequisites
-*************
-
-This tutorial assumes you have installed |CL| on your host system. For
-detailed instructions, follow the steps in :ref:`bare-metal-install-desktop`.
-
-Before you install any new packages, update |CL| with the following command:
-
-.. code-block:: bash
-
-   sudo swupd update
-
-
-Set up file sharing
-*******************
-
-#.	Log in and get root privileges.
-
-	.. code-block:: bash
-
-		sudo -s
-
-#.	Add the storage-utils bundle, which includes the Samba binaries.
-
-	.. code-block:: bash
-
-		swupd bundle-add storage-utils
-
-	.. note::
-
-		The os-clr-on-clr bundle also includes the Samba binaries.
-
-#.	Create a configuration file called :file:`/etc/samba/smb.conf`. In this
-	example, `[Downloads]` enables a folder share with a specific user.
-	`[Documents]` enables a folder share with any user. The example assumes that a
-	user account `clearlinuxuser` already exists.
-
-	If `valid users` is not specified, then anyone with a user account on the
-	machine and with their Samba password already set can access the folder.
-	However, the account is only able to access files and folders for which
-	they have appropriate permissions.
-
-	Use :command:`chown` or :command:`chmod` to change either the owner of the
-	file or the permissions to allow other users to access the file.
-
-	.. code-block:: console
-
-		[Global]
-		map to guest = bad user
-
-		[Downloads]
-		path=/home/clearlinuxuser/Downloads
-		read only = no
-		guest ok = no
-		valid users = clearlinuxuser
-
-		[Documents]
-		path=/home/clearlinuxuser/Documents
-		read only = no
-		browsable = yes
-		guest ok = yes
-
-#.	Enable the Samba daemon to start every time.
-
-	.. code-block:: bash
-
-		systemctl enable smb
-		systemctl start smb
-
-#.	Use :command:`smbpasswd` to add the initial password for the user
-	account to access the share. Be aware that Samba maintains its own list of
-	passwords for user accounts. The Samba password list can be different than
-	the password used to log in.
-
-	.. code-block:: bash
-
-		smbpasswd -a clearlinuxuser
-
-Setup is complete and a Windows machine on the same network can access the
-shares. Windows uses the format :file:`\\\\[server IP or hostname]\\folder` to
-access shares. Access the shares directly with Windows Explorer or by
-mapping a network drive.
-
-Use the IP address of the |CL| machine for an easy access method. If the
-|CL| machine is behind an Active Directory domain controller or a DNS server,
-use the hostname of the |CL| machine. For other ways to access shares using a
-hostname instead of an IP address, see `Chapter 7 of the Samba guide`_.
-
-
-Map |CL| drive in Windows
-*************************
-
-#.	Open Windows Explorer and click on the left sidebar on :guilabel:`This PC`
-	to change the options available at the top.
-
-#.	Click the :guilabel:`Map Network Drive` icon and enter the path in the
-	format: :file:`\\\\[server IP or hostname]\\[shared folder]`
-
-#.	Check the box :guilabel:`Connect using different credentials`. Enter
-	the Samba user `clearlinuxuser` and the password created with
-	:command:`smbpasswd`. See Figure 1 for details.
-
-	.. figure:: figures/smb-1.png
-		:scale: 70%
-		:alt: Map a network drive in Windows Explorer
-
-		Figure 1: Map a network drive in Windows Explorer.
-
-When complete, Windows Explorer displays the share drive as shown in Figure 2.
-
-.. figure:: figures/smb-2.png
-	:scale: 70%
-	:alt: View a share drive in Windows Explorer
-
-	Figure 2: View a share drive in Windows Explorer.
-
-
-
-
-
-.. _Samba guide: https://www.samba.org/samba/docs/using_samba/ch00.html
-.. _Chapter 7 of the Samba guide: https://www.samba.org/samba/docs/using_samba/ch07.html

_sources/tutorials/tutorial-proxy.rst.txt

@@ -1,115 +0,0 @@
-.. _tutorial-proxy:
-
-Setting up proxy
-################
-
-This tutorial shows you how to configure your system for use behind an
-outbound proxy to access the Internet. 
-
-|CL| applications already benefit from the :ref:`autoproxy`
-feature. 
-
-.. contents:: 
-    :local:
-    :depth: 1
-
-Prerequisites
-*************
-
-This tutorial assumes you have installed |CL| on your host system.
-For detailed instructions on installing |CL| on a bare metal system, visit
-the :ref:`bare metal installation guide <bare-metal-install-desktop>`.
-
-Shells and programs in a desktop session
-****************************************
-
-Terminal
-========
-
-Add the following to your ~/.bashrc:
-
-.. code-block:: bash
-
-    export http_proxy=http://your.http-proxy.url:port
-    export https_proxy=http://your.https-proxy.url:port
-    export ftp_proxy=http://your.ftp-proxy.url:port
-    export socks_proxy=http://your.socks-proxy.url:port
-    export no_proxy=".your-company-domain.com,localhost"
-    export HTTP_PROXY=$http_proxy
-    export HTTPS_PROXY=$https_proxy
-    export FTP_PROXY=$ftp_proxy
-    export SOCKS_PROXY=$socks_proxy
-    export NO_PROXY=$no_proxy
-
-wget
-****
-
-Run this command to enable downloading from websites from the terminal:
-
-.. code-block:: bash
-
-    echo >> ~/.wgetrc <<EOF
-    http_proxy = your.http-proxy.url:port
-    https_proxy = your.https-proxy.url:port
-    ftp_proxy = your.http-proxy.url:port
-    no_proxy = your-company-domain.com, localhost
-    EOF
-
-System service (Docker)
-***********************
-
-For Docker (and other services that use systemd), you can follow these steps to configure and check proxy settings:
-
-.. note::
-
-    Be sure to use :command:`sudo`, as you will need elevated permissions.
-
-#. Create :file:`/etc/systemd/system/docker.service.d` directory to host
-   configuration information for the Docker service.
-
-#. Create :file:`/etc/systemd/system/docker.service.d/http-proxy.conf` and add:
-
-    .. code-block:: bash
-
-        [Service]
-        Environment="HTTP_PROXY=http://your.http-proxy.url:port/"
-        Environment="HTTPS_PROXY=http://your.https-proxy.url:port/"
-
-#. Load the changes and restart the service:
-
-    .. code-block:: bash
-
-        sudo systemctl daemon-reload
-        sudo systemctl restart docker
-
-#. Verify that changes have loaded:
-
-    .. code-block:: bash
-
-        systemctl show --property=Environment docker
-
-    .. code-block:: console
-
-        Environment=HTTP_PROXY=http://your.http-proxy.url:port/ HTTPS_PROXY=http://your.https-proxy.url:port/
-
-.. note::
-
-   This process enables the ability to successfully run ``docker pull``.
-   Containers themselves must be configured independently.
-
-git over ssh
-************
-
-Add the following to your :file:`~/.ssh/config`:
-
-.. code-block:: bash
-
-    host github.com
-        port 22    
-        user git
-        ProxyCommand connect-proxy -S your.ssh-proxy.url:port %h %p
-
-.. note::
-
-    Though netcat is included with Clear Linux, it is not the BSD version,
-    which is the one usually used to enable git over ssh.

_sources/tutorials/tutorials.rst.txt

@@ -1,28 +0,0 @@
-.. _tutorials:
-
-Tutorials
-#########
-
-Explore our tutorials to discover what you can do with |CL|!
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   wordpress/wordpress
-   flatpak/flatpak
-   machine-learning/machine-learning
-   docker/docker
-   azure
-   hadoop
-   fmv
-   aws-web/aws-web
-   smb/smb*
-   spark
-   kata
-   kata_migration
-   kubernetes/kubernetes*
-   yubikey-u2f
-   nvidia
-   redis
-   tutorial-proxy

_sources/tutorials/wordpress/web-server-install.rst.txt

@@ -1,504 +0,0 @@
-.. _web-server-install:
-
-Set up a LAMP web server on |CL-ATTR|
-#####################################
-
-This tutorial provides instructions on how to set up a
-:abbr:`LAMP (Linux, Apache\*, MySQL, PHP)` web server on |CL-ATTR| and how
-to use phpMyAdmin\* to manage an associated database. Note that this
-tutorial installs MariaDB\*, which is a drop-in replacement for MySQL\*.
-
-In order to create a web server using |CL| as the host OS, your host system
-must be running |CL|. This tutorial assumes you have installed |CL| on your
-host system. For detailed instructions on installing |CL| on a bare metal
-system, visit :ref:`bare-metal-install-desktop`.
-
-This tutorial covers:
-
-.. contents:: :local:
-   :depth: 1
-
-Install Apache
-**************
-
-Apache is an open source HTTP web server application that can run on several
-operating systems, including |CL|. Go to the `Apache HTTP Server Project`_
-for more information.
-
-Install the web-server-basic bundle
-===================================
-
-The **web-server-basic** bundle contains the packages needed to install the
-Apache software bundle on |CL|.
-
-.. note::
-
-   Before you install new packages, update the |CL| with the following
-   console command:
-
-   .. code-block:: bash
-
-      sudo swupd update
-
-#. To install the bundle, enter the following command:
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add web-server-basic
-
-
-#. To start the Apache service, enter the following commands:
-
-   .. code-block:: bash
-
-      sudo systemctl enable httpd.service
-      sudo systemctl start httpd.service
-
-#. To verify that the Apache server application is running, open a web
-   browser and navigate to: \http://localhost.
-
-   If the service is running, a confirmation message will appear, similar to the
-   message shown in figure 1.
-
-   .. figure:: figures/web-server-install-1.png
-      :alt: This web server is operational from host.
-      :scale: 50%
-
-      `Figure 1: Confirmation that the Apache service is running.`
-
-   .. note::
-
-      The :file:`index.html` file is located in the :file:`/var/www/html` directory
-      of your host system. You will copy this file into a new location after you
-      modify the configuration in the next step.
-
-Change the default configuration and data directory
-***************************************************
-
-|CL| is designed to be a :ref:`stateless` operating system which means that you
-must create an optional configuration file to override the default values.
-The default location of the Apache configuration file, :file:`httpd.conf`,
-is located in the :file:`/usr/share/defaults/httpd` directory. |CL| can
-override this directory as part of the stateless paradigm. This default
-:file:`.conf` file includes the following directives that allow for additional
-locations of configuration definitions:
-
-.. code-block:: console
-
-   # Virtual hosts
-   IncludeOptional /usr/share/defaults/httpd/conf.d/*.conf
-   IncludeOptional /usr/share/defaults/httpd/conf.modules.d/*.conf
-   IncludeOptional /etc/httpd/conf.d/*.conf
-   IncludeOptional /etc/httpd/conf.modules.d/*.conf
-
-In this section you will define your own httpd.conf file to override the
-default values, and define a custom DocumentRoot for your web server.
-
-#. Create the directory structure for :file:`/etc/httpd/conf.d`.
-
-   .. code-block:: bash
-
-      sudo mkdir -p /etc/httpd/conf.d
-
-#. Create and open the :file:`httpd.conf` file in your new :file:`/etc/httpd/conf.d`
-   directory.
-
-   .. code-block:: bash
-
-      sudo nano /etc/httpd/conf.d/httpd.conf
-
-#. Add the ``DocumentRoot`` variable to :file:`httpd.conf`. Copy the content
-   listed below into the new :file:`/etc/httpd/conf.d/httpd.conf` file.
-
-   .. code-block:: console
-
-      #
-      # Set a new location for DocumentRoot
-      #
-      DocumentRoot "/var/www/tutorial"
-
-      #
-      # Relax access to content within /var/www/tutorial for this example
-      #
-      <Directory "/var/www/tutorial">
-        AllowOverride none
-        Require all granted
-      </Directory>
-
-#. Create a new ``DocumentRoot`` directory structure and copy the
-   :file:`index.html` file from :file:`/var/www/html` directory to
-   :file:`/var/www/tutorial`.
-
-   .. code-block:: bash
-
-      sudo mkdir –p /var/www/tutorial
-      cd /var/www/tutorial
-      sudo cp /var/www/html/index.html .
-
-#. To ensure a successful setup, edit the new :file:`index.html` file with an
-   obvious change.
-
-   .. code-block:: bash
-
-      sudo nano index.html
-
-   For example, we changed the default message
-
-   "It works!"
-
-   to
-
-   "It works from its new location!"
-
-#. Stop and then restart ``httpd.service``.
-
-   .. code-block:: bash
-
-      sudo systemctl stop httpd.service
-      sudo systemctl start httpd.service
-
-#. Go to \http://localhost to view the new screen. You should see your updated
-   default message from step 5.
-
-#. Change the configuration back to the default :file:`/var/www/html`
-   location. To do this, edit the :file:`/etc/httpd/conf.d/httpd.conf` file
-   again and replace any instance of /var/www/tutorial with /var/www/html.
-
-   .. code-block:: bash
-
-      sudo nano /etc/httpd/conf.d/httpd.conf
-
-#. Stop and then restart ``httpd.service``.
-
-   .. code-block:: bash
-
-      sudo systemctl stop httpd.service
-      sudo systemctl start httpd.service
-
-#. Go to \http://localhost and verify that you can see the default screen
-   again.
-
-#. Optionally, remove the /var/www/tutorial directory you previously created.
-
-   .. code-block:: bash
-
-      sudo rm /var/www/tutorial/index.html
-      sudo rmdir /var/www/tutorial
-
-Install PHP
-***********
-
-An Apache installation allows you to display static web pages. Enabling PHP
-allows you to generate and display dynamic web pages. To add this
-functionality to your web server, install PHP on your system.
-
-#. To get the php components, enter the following command:
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add php-basic
-
-#. To enable PHP, enter the following commands:
-
-   .. code-block:: bash
-
-      sudo systemctl enable php-fpm.service
-      sudo systemctl start php-fpm.service
-      sudo systemctl restart httpd.service
-
-   After restarting the Apache service, test your PHP installation.
-
-#. Create and open a file named :file:`phpinfo.php` in the :file:`/var/www/html/`
-   directory using a text editor.
-
-   .. code-block:: bash
-
-      sudo nano /var/www/html/phpinfo.php
-
-#. Add the following line to the file:
-
-   .. code-block:: php
-
-      <?PHP phpinfo() ?>
-
-#. Go to \http://localhost/phpinfo.php.
-
-#. Verify that the PHP information screen appears, similar to figure 2:
-
-   .. figure:: figures/web-server-install-2.png
-      :alt: PHP information screen
-      :width: 600
-
-      `Figure 2: The PHP information screen.`
-
-If the PHP information screen is displayed, you have successfully installed
-the PHP components and are now ready to add your database application to
-complete your LAMP server implementation.
-
-Install MariaDB
-***************
-
-Install MariaDB to store content. MariaDB is a drop-in replacement for MySQL
-and is available in the database-basic |CL| bundle.
-
-#. To install the database-basic bundle, enter the following command:
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add database-basic
-
-#. To start MariaDB after it is installed, enter the following commands:
-
-   .. code-block:: bash
-
-      sudo systemctl enable mariadb
-      sudo systemctl start mariadb
-
-#. To check the status of MariaDB, enter the following command:
-
-   .. code-block:: bash
-
-      sudo systemctl status mariadb
-
-   Press :kbd:`Ctrl` + :kbd:`c` or :kbd:`q` to exit.
-
-Security hardening
-==================
-
-With the MariaDB service running, we can perform some basic security
-hardening.
-
-#. To add a basic layer of security, enter the following command:
-
-   .. code-block:: bash
-
-      sudo mysql_secure_installation
-
-#. Respond to the questions that appear in the script below.
-
-   .. note::
-
-      Our suggested responses follow each question.
-
-   .. code-block:: bash
-
-      Enter current password for root (enter for none):
-
-   In order to secure MariaDB, we need the current password for the root
-   user. For a newly installed MariaDB without a set root password, the
-   password is blank. Thus, press enter to continue.
-
-   .. code-block:: bash
-
-      OK, successfully used password, moving on...
-
-      Set root password? [Y/n]
-
-   .. _set-password:
-
-   Set the root password to prevent unauthorized MariaDB root user logins.
-   To set a root password, type 'y'.
-
-   .. code-block:: bash
-
-      New password:
-
-   Type the desired password for the root user.
-
-   .. code-block:: bash
-
-      Re-enter new password:
-
-   Re-type the desired password for the root user.
-
-   .. code-block:: bash
-
-      Password updated successfully!
-      Reloading privilege tables..
-      ... Success!
-
-      Remove anonymous users? [Y/n]
-
-   By default, a MariaDB installation includes an anonymous user that allows
-   anyone to log in to MariaDB without a user account. This anonymous user
-   is intended only for testing and for a smoother installation. To remove
-   the anonymous user and make your database more secure, type 'y'.
-
-   .. code-block:: bash
-
-      ... Success!
-      Disallow root login remotely? [Y/n]
-
-   Normally, root should only be allowed to connect from the 'localhost'. This
-   ensures that someone cannot guess the root password from the network. To
-   block any remote root login, type 'y'.
-
-   .. code-block:: bash
-
-      ... Success!
-      Remove test database and access to it? [Y/n]
-
-   By default, MariaDB includes a database named 'test' which anyone can access.
-   This database is also intended only for testing and should be removed. To
-   remove the test database, type 'y'.
-
-   .. code-block:: bash
-
-      - Dropping test database...
-      ... Success!
-      - Removing privileges on test database...
-      ... Success!
-      Reload privilege tables now? [Y/n]
-
-   Reloading the privilege tables ensures all changes made so far take
-   effect immediately. To reload the privilege tables, type 'y'.
-
-   .. code-block:: bash
-
-      ... Success!
-
-      Cleaning up...
-
-   All done!  If you've completed all of the above steps, your MariaDB
-   installation should now be secure.
-
-   Thanks for using MariaDB!
-
-The MariaDB installation is complete, and we can now install phpMyAdmin to
-manage the databases.
-
-Install phpMyAdmin
-******************
-
-The web-based tool phpMyAdmin is a straightforward way to manage MySQL or
-MariaDB databases. Visit the `phpMyAdmin`_ website for the complete
-discussion regarding phpMyAdmin, its documentation, the latest downloads,
-and other useful information.
-
-In this tutorial, we use the latest English version of phpMyAdmin.
-
-#. Download the :file:`phpMyAdmin-<version>-english.tar.gz` file to your
-   :file:`~/Downloads` directory. Here, <version> refers to the current
-   version available at https://www.phpmyadmin.net/downloads.
-
-   .. note::
-
-      This example downloads and uses version 4.6.4.
-
-#. Once the file has been successfully downloaded and verified, decompress
-   the file and directories into the Apache web server document root
-   directory. Use the following commands:
-
-   .. code-block:: bash
-
-      cd /var/www/html
-      sudo tar –xzvf ~/Downloads/phpMyAdmin-4.6.4-english.tar.gz
-
-#. To keep things simple, rename the newly created
-   :file:`phpMyAdmin-4.6.4-english` directory to :file:`phpMyAdmin` with the
-   following command:
-
-   .. code-block:: bash
-
-      sudo mv phpMyAdmin-4.6.4-english phpMyAdmin
-
-Use phpMyAdmin to manage a database
-***********************************
-
-You can use the phpMyAdmin web-based tool to manage your databases. Follow the
-steps below for setting up a database called "WordPress".
-
-#. Verify that a successful installation of all LAMP server components by
-   going to \http://localhost/phpMyAdmin. See figure 3.
-
-#. Log in with your root userid and the password you set up when you ran the
-   :ref:`mysql_secure_installation command <set-password>`. Enter your
-   credentials and select :guilabel:`Go` to log in:
-
-   .. figure:: figures/web-server-install-3.png
-      :alt: phpMyAdmin login page
-      :width:     600
-
-      `Figure 3: The phpMyAdmin login page.`
-
-#. Verify a successful login by confirming that the main phpMyAdmin page
-   displays, as shown in figure 4:
-
-   .. figure:: figures/web-server-install-4.png
-      :alt: phpMyAdmin dashboard
-      :width:     600
-
-      `Figure 4: The phpMyAdmin dashboard.`
-
-#. Set up a database by selecting the :guilabel:`Databases` tab, as shown in
-   figure 5.
-
-#. Enter `WordPress` in the text field below the :guilabel:`Create database`
-   label.
-
-#. Select the :guilabel:`utf8_unicode_ci` option from the
-   :guilabel:`Collation` drop-down menu beside the text field.
-
-#. Click :guilabel:`Create`.
-
-   .. figure:: figures/web-server-install-5.png
-      :alt: Databases tab
-      :width:     600
-
-      `Figure 5: The Databases tab.`
-
-#. Set up user permissions by selecting the :guilabel:`WordPress` database
-   located in the left panel. See figure 6.
-
-#. Select the :guilabel:`Privileges` tab. Figure 6 shows its contents.
-
-   .. figure:: figures/web-server-install-6.png
-      :alt: Privileges tab
-      :width:     600
-
-      `Figure 6: The Privileges tab.`
-
-#. Click :guilabel:`Add user account` located at the bottom of the
-   :guilabel:`Privileges` tab. The `Add user account` page appears, as shown
-   in figure 7.
-
-   .. figure:: figures/web-server-install-7.png
-      :alt: User accounts tab
-      :width:     600
-
-      `Figure 7: The User accounts tab.`
-
-#. Enter the following information in the corresponding fields that appear
-   in figure 7 above:
-
-   * User name: wordpressuser
-
-   * Password: wp-example
-
-   * Re-type: wp-example
-
-#. In the `Database for user account` section, select
-   :guilabel:`Grant all privileges on database “WordPress”.`
-
-#. At the bottom of the page, click :guilabel:`Go`.
-
-If successful, you should see the screen shown in figure 8:
-
-.. figure:: figures/web-server-install-8.png
-   :alt: User added successfully
-   :width:     600
-
-   `Figure 8: The user wordpressuser is successfully added.`
-
-**Congratulations!**
-
-You have now created a fully functional LAMP server along with a
-WordPress\*-ready database using |CL|.
-
-Next steps
-**********
-
-Next, add the WordPress components needed to host a WordPress website with :ref:`wp-install`.
-
-.. _Apache HTTP Server Project: https://httpd.apache.org/
-.. _phpMyAdmin: https://www.phpmyadmin.net/

_sources/tutorials/yubikey-u2f.rst.txt

@@ -1,126 +0,0 @@
-.. _yubikey-u2f:
-
-Enable YubiKey U2F Support 
-##########################
-
-YubiKey\* is a USB security token manufactured by `Yubico`_. Depending on the
-model, a YubiKey can support different authentication protocols including:
-One-Time Password (OTP), Smart card, FIDO2, and Universal 2nd Factor (U2F).
-
-These instructions will go over configuring a YubiKey for U2F authentication
-through a web browser on a |CL-ATTR| system. 
-
-A list of `websites
-accepting U2F authentication with the YubiKey`_ is available on the Yubico
-website. See the Yubico website to learn more about the Yubikey:
-https://www.yubico.com/getstarted/meet-the-yubikey/ 
-
-
-
-.. contents:: :local:
-   :depth: 1
-
-
-
-Prerequisites 
-*************
-
-This tutorial assumes you have: 
-
-#. |CL| installed and running.
-
-#. Mozilla Firefox installed on |CL|. 
-
-#. A YubiKey.
-
-
-
-Enable Linux udev rules for YubiKey 
-***********************************
-
-:command:`udev` is the Linux device manager which handles events when USB
-devices are added and removed. Custom rules needs to be created to properly
-identify the YubiKey and provide applications access.
-
-These instructions are derived from: `Yubico support article Using Your U2F
-YubiKey with Linux
-<https://support.yubico.com/support/solutions/articles/15000006449>`_
-
-
-#. Create the udev rules folder under :file:`/etc`
-   
-   .. code:: bash
-      
-      sudo mkdir -p /etc/udev/rules.d/
-
-
-#. Download the u2f rules from the Yubico GitHub:
-
-   .. code:: bash
-      
-      curl -O https://raw.githubusercontent.com/Yubico/libu2f-host/master/70-u2f.rules
-
-      
-#. Move the downloaded :file:`70-u2f.rules` file into the :file:`/etc/udev`
-   folder
-
-   .. code:: bash
-      
-      sudo mv 70-u2f.rules /etc/udev/rules.d/
-
-
-#. The udev rules should automatically be reloaded. However, they can be
-   manually reloaded or reboot the system:
-
-   .. code:: bash
-      
-      sudo udevadm control --reload-rules && sudo udevadm trigger
-
-
-#. Plugin and validate the YubiKey appears as a USB device:
-
-   .. code:: bash
-      
-      lsusb
-
-
-
-Enable U2F in Mozilla Firefox 
-*****************************
-
-Firefox comes with U2F web authentication support disabled by default. U2F
-needs to be enabled in the advanced settings.
-
-These instructions are derived from: `Yubico support article Enabling U2F
-support in Mozilla Firefox
-<https://support.yubico.com/support/solutions/articles/15000017511-enabling-u2f-support-in-mozilla-firefox>`_
-
-
-#. Launch Mozilla Firefox
-
-#. In the URL bar, type :command:`about:config` to access the advanced
-   settings.
-
-   .. code:: bash
-      
-      about:config
-
-#. Click the *I accept the risk!* button to continue to the advanced settings
-
-#. Search for the :command:`security.webauth.u2f` and double-click it 
-   so *Value* becomes **true**.
-
-
-Your YubiKey is now usable on |CL| with Mozilla Firefox with websites that
-support U2F authentication.
-
-
-Related topics 
-**************
-
-- |CL| :ref:`security`
-
-
-.. _`Yubico`: https://www.yubico.com/
-
-.. _`websites accepting U2F authentication with the YubiKey`: https://www.yubico.com/works-with-yubikey/catalog/#protocol=universal-2nd-factor-(u2f)&usecase=all&key=all

_static/basic.css

@@ -1,676 +0,0 @@
-/*
- * basic.css
- * ~~~~~~~~~
- *
- * Sphinx stylesheet -- basic theme.
- *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
- */
-
-/* -- main layout ----------------------------------------------------------- */
-
-div.clearer {
-    clear: both;
-}
-
-/* -- relbar ---------------------------------------------------------------- */
-
-div.related {
-    width: 100%;
-    font-size: 90%;
-}
-
-div.related h3 {
-    display: none;
-}
-
-div.related ul {
-    margin: 0;
-    padding: 0 0 0 10px;
-    list-style: none;
-}
-
-div.related li {
-    display: inline;
-}
-
-div.related li.right {
-    float: right;
-    margin-right: 5px;
-}
-
-/* -- sidebar --------------------------------------------------------------- */
-
-div.sphinxsidebarwrapper {
-    padding: 10px 5px 0 10px;
-}
-
-div.sphinxsidebar {
-    float: left;
-    width: 230px;
-    margin-left: -100%;
-    font-size: 90%;
-    word-wrap: break-word;
-    overflow-wrap : break-word;
-}
-
-div.sphinxsidebar ul {
-    list-style: none;
-}
-
-div.sphinxsidebar ul ul,
-div.sphinxsidebar ul.want-points {
-    margin-left: 20px;
-    list-style: square;
-}
-
-div.sphinxsidebar ul ul {
-    margin-top: 0;
-    margin-bottom: 0;
-}
-
-div.sphinxsidebar form {
-    margin-top: 10px;
-}
-
-div.sphinxsidebar input {
-    border: 1px solid #98dbcc;
-    font-family: sans-serif;
-    font-size: 1em;
-}
-
-div.sphinxsidebar #searchbox form.search {
-    overflow: hidden;
-}
-
-div.sphinxsidebar #searchbox input[type="text"] {
-    float: left;
-    width: 80%;
-    padding: 0.25em;
-    box-sizing: border-box;
-}
-
-div.sphinxsidebar #searchbox input[type="submit"] {
-    float: left;
-    width: 20%;
-    border-left: none;
-    padding: 0.25em;
-    box-sizing: border-box;
-}
-
-
-img {
-    border: 0;
-    max-width: 100%;
-}
-
-/* -- search page ----------------------------------------------------------- */
-
-ul.search {
-    margin: 10px 0 0 20px;
-    padding: 0;
-}
-
-ul.search li {
-    padding: 5px 0 5px 20px;
-    background-image: url(file.png);
-    background-repeat: no-repeat;
-    background-position: 0 7px;
-}
-
-ul.search li a {
-    font-weight: bold;
-}
-
-ul.search li div.context {
-    color: #888;
-    margin: 2px 0 0 30px;
-    text-align: left;
-}
-
-ul.keywordmatches li.goodmatch a {
-    font-weight: bold;
-}
-
-/* -- index page ------------------------------------------------------------ */
-
-table.contentstable {
-    width: 90%;
-    margin-left: auto;
-    margin-right: auto;
-}
-
-table.contentstable p.biglink {
-    line-height: 150%;
-}
-
-a.biglink {
-    font-size: 1.3em;
-}
-
-span.linkdescr {
-    font-style: italic;
-    padding-top: 5px;
-    font-size: 90%;
-}
-
-/* -- general index --------------------------------------------------------- */
-
-table.indextable {
-    width: 100%;
-}
-
-table.indextable td {
-    text-align: left;
-    vertical-align: top;
-}
-
-table.indextable ul {
-    margin-top: 0;
-    margin-bottom: 0;
-    list-style-type: none;
-}
-
-table.indextable > tbody > tr > td > ul {
-    padding-left: 0em;
-}
-
-table.indextable tr.pcap {
-    height: 10px;
-}
-
-table.indextable tr.cap {
-    margin-top: 10px;
-    background-color: #f2f2f2;
-}
-
-img.toggler {
-    margin-right: 3px;
-    margin-top: 3px;
-    cursor: pointer;
-}
-
-div.modindex-jumpbox {
-    border-top: 1px solid #ddd;
-    border-bottom: 1px solid #ddd;
-    margin: 1em 0 1em 0;
-    padding: 0.4em;
-}
-
-div.genindex-jumpbox {
-    border-top: 1px solid #ddd;
-    border-bottom: 1px solid #ddd;
-    margin: 1em 0 1em 0;
-    padding: 0.4em;
-}
-
-/* -- domain module index --------------------------------------------------- */
-
-table.modindextable td {
-    padding: 2px;
-    border-collapse: collapse;
-}
-
-/* -- general body styles --------------------------------------------------- */
-
-div.body {
-    min-width: 450px;
-    max-width: 800px;
-}
-
-div.body p, div.body dd, div.body li, div.body blockquote {
-    -moz-hyphens: auto;
-    -ms-hyphens: auto;
-    -webkit-hyphens: auto;
-    hyphens: auto;
-}
-
-a.headerlink {
-    visibility: hidden;
-}
-
-h1:hover > a.headerlink,
-h2:hover > a.headerlink,
-h3:hover > a.headerlink,
-h4:hover > a.headerlink,
-h5:hover > a.headerlink,
-h6:hover > a.headerlink,
-dt:hover > a.headerlink,
-caption:hover > a.headerlink,
-p.caption:hover > a.headerlink,
-div.code-block-caption:hover > a.headerlink {
-    visibility: visible;
-}
-
-div.body p.caption {
-    text-align: inherit;
-}
-
-div.body td {
-    text-align: left;
-}
-
-.first {
-    margin-top: 0 !important;
-}
-
-p.rubric {
-    margin-top: 30px;
-    font-weight: bold;
-}
-
-img.align-left, .figure.align-left, object.align-left {
-    clear: left;
-    float: left;
-    margin-right: 1em;
-}
-
-img.align-right, .figure.align-right, object.align-right {
-    clear: right;
-    float: right;
-    margin-left: 1em;
-}
-
-img.align-center, .figure.align-center, object.align-center {
-  display: block;
-  margin-left: auto;
-  margin-right: auto;
-}
-
-.align-left {
-    text-align: left;
-}
-
-.align-center {
-    text-align: center;
-}
-
-.align-right {
-    text-align: right;
-}
-
-/* -- sidebars -------------------------------------------------------------- */
-
-div.sidebar {
-    margin: 0 0 0.5em 1em;
-    border: 1px solid #ddb;
-    padding: 7px 7px 0 7px;
-    background-color: #ffe;
-    width: 40%;
-    float: right;
-}
-
-p.sidebar-title {
-    font-weight: bold;
-}
-
-/* -- topics ---------------------------------------------------------------- */
-
-div.topic {
-    border: 1px solid #ccc;
-    padding: 7px 7px 0 7px;
-    margin: 10px 0 10px 0;
-}
-
-p.topic-title {
-    font-size: 1.1em;
-    font-weight: bold;
-    margin-top: 10px;
-}
-
-/* -- admonitions ----------------------------------------------------------- */
-
-div.admonition {
-    margin-top: 10px;
-    margin-bottom: 10px;
-    padding: 7px;
-}
-
-div.admonition dt {
-    font-weight: bold;
-}
-
-div.admonition dl {
-    margin-bottom: 0;
-}
-
-p.admonition-title {
-    margin: 0px 10px 5px 0px;
-    font-weight: bold;
-}
-
-div.body p.centered {
-    text-align: center;
-    margin-top: 25px;
-}
-
-/* -- tables ---------------------------------------------------------------- */
-
-table.docutils {
-    border: 0;
-    border-collapse: collapse;
-}
-
-table.align-center {
-    margin-left: auto;
-    margin-right: auto;
-}
-
-table caption span.caption-number {
-    font-style: italic;
-}
-
-table caption span.caption-text {
-}
-
-table.docutils td, table.docutils th {
-    padding: 1px 8px 1px 5px;
-    border-top: 0;
-    border-left: 0;
-    border-right: 0;
-    border-bottom: 1px solid #aaa;
-}
-
-table.footnote td, table.footnote th {
-    border: 0 !important;
-}
-
-th {
-    text-align: left;
-    padding-right: 5px;
-}
-
-table.citation {
-    border-left: solid 1px gray;
-    margin-left: 1px;
-}
-
-table.citation td {
-    border-bottom: none;
-}
-
-/* -- figures --------------------------------------------------------------- */
-
-div.figure {
-    margin: 0.5em;
-    padding: 0.5em;
-}
-
-div.figure p.caption {
-    padding: 0.3em;
-}
-
-div.figure p.caption span.caption-number {
-    font-style: italic;
-}
-
-div.figure p.caption span.caption-text {
-}
-
-/* -- field list styles ----------------------------------------------------- */
-
-table.field-list td, table.field-list th {
-    border: 0 !important;
-}
-
-.field-list ul {
-    margin: 0;
-    padding-left: 1em;
-}
-
-.field-list p {
-    margin: 0;
-}
-
-.field-name {
-    -moz-hyphens: manual;
-    -ms-hyphens: manual;
-    -webkit-hyphens: manual;
-    hyphens: manual;
-}
-
-/* -- hlist styles ---------------------------------------------------------- */
-
-table.hlist td {
-    vertical-align: top;
-}
-
-
-/* -- other body styles ----------------------------------------------------- */
-
-ol.arabic {
-    list-style: decimal;
-}
-
-ol.loweralpha {
-    list-style: lower-alpha;
-}
-
-ol.upperalpha {
-    list-style: upper-alpha;
-}
-
-ol.lowerroman {
-    list-style: lower-roman;
-}
-
-ol.upperroman {
-    list-style: upper-roman;
-}
-
-dl {
-    margin-bottom: 15px;
-}
-
-dd p {
-    margin-top: 0px;
-}
-
-dd ul, dd table {
-    margin-bottom: 10px;
-}
-
-dd {
-    margin-top: 3px;
-    margin-bottom: 10px;
-    margin-left: 30px;
-}
-
-dt:target, span.highlighted {
-    background-color: #fbe54e;
-}
-
-rect.highlighted {
-    fill: #fbe54e;
-}
-
-dl.glossary dt {
-    font-weight: bold;
-    font-size: 1.1em;
-}
-
-.optional {
-    font-size: 1.3em;
-}
-
-.sig-paren {
-    font-size: larger;
-}
-
-.versionmodified {
-    font-style: italic;
-}
-
-.system-message {
-    background-color: #fda;
-    padding: 5px;
-    border: 3px solid red;
-}
-
-.footnote:target  {
-    background-color: #ffa;
-}
-
-.line-block {
-    display: block;
-    margin-top: 1em;
-    margin-bottom: 1em;
-}
-
-.line-block .line-block {
-    margin-top: 0;
-    margin-bottom: 0;
-    margin-left: 1.5em;
-}
-
-.guilabel, .menuselection {
-    font-family: sans-serif;
-}
-
-.accelerator {
-    text-decoration: underline;
-}
-
-.classifier {
-    font-style: oblique;
-}
-
-abbr, acronym {
-    border-bottom: dotted 1px;
-    cursor: help;
-}
-
-/* -- code displays --------------------------------------------------------- */
-
-pre {
-    overflow: auto;
-    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
-}
-
-span.pre {
-    -moz-hyphens: none;
-    -ms-hyphens: none;
-    -webkit-hyphens: none;
-    hyphens: none;
-}
-
-td.linenos pre {
-    padding: 5px 0px;
-    border: 0;
-    background-color: transparent;
-    color: #aaa;
-}
-
-table.highlighttable {
-    margin-left: 0.5em;
-}
-
-table.highlighttable td {
-    padding: 0 0.5em 0 0.5em;
-}
-
-div.code-block-caption {
-    padding: 2px 5px;
-    font-size: small;
-}
-
-div.code-block-caption code {
-    background-color: transparent;
-}
-
-div.code-block-caption + div > div.highlight > pre {
-    margin-top: 0;
-}
-
-div.code-block-caption span.caption-number {
-    padding: 0.1em 0.3em;
-    font-style: italic;
-}
-
-div.code-block-caption span.caption-text {
-}
-
-div.literal-block-wrapper {
-    padding: 1em 1em 0;
-}
-
-div.literal-block-wrapper div.highlight {
-    margin: 0;
-}
-
-code.descname {
-    background-color: transparent;
-    font-weight: bold;
-    font-size: 1.2em;
-}
-
-code.descclassname {
-    background-color: transparent;
-}
-
-code.xref, a code {
-    background-color: transparent;
-    font-weight: bold;
-}
-
-h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
-    background-color: transparent;
-}
-
-.viewcode-link {
-    float: right;
-}
-
-.viewcode-back {
-    float: right;
-    font-family: sans-serif;
-}
-
-div.viewcode-block:target {
-    margin: -1px -10px;
-    padding: 0 10px;
-}
-
-/* -- math display ---------------------------------------------------------- */
-
-img.math {
-    vertical-align: middle;
-}
-
-div.body div.math p {
-    text-align: center;
-}
-
-span.eqno {
-    float: right;
-}
-
-span.eqno a.headerlink {
-    position: relative;
-    left: 0px;
-    z-index: 1;
-}
-
-div.math:hover a.headerlink {
-    visibility: visible;
-}
-
-/* -- printout stylesheet --------------------------------------------------- */
-
-@media print {
-    div.document,
-    div.documentwrapper,
-    div.bodywrapper {
-        margin: 0 !important;
-        width: 100%;
-    }
-
-    div.sphinxsidebar,
-    div.related,
-    div.footer,
-    #top-link {
-        display: none;
-    }
-}

_static/css/badge_only.css

@@ -1 +0,0 @@
-.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}

_static/doctools.js

@@ -1,313 +0,0 @@
-/*
- * doctools.js
- * ~~~~~~~~~~~
- *
- * Sphinx JavaScript utilities for all documentation.
- *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
- */
-
-/**
- * select a different prefix for underscore
- */
-$u = _.noConflict();
-
-/**
- * make the code below compatible with browsers without
- * an installed firebug like debugger
-if (!window.console || !console.firebug) {
-  var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
-    "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
-    "profile", "profileEnd"];
-  window.console = {};
-  for (var i = 0; i < names.length; ++i)
-    window.console[names[i]] = function() {};
-}
- */
-
-/**
- * small helper function to urldecode strings
- */
-jQuery.urldecode = function(x) {
-  return decodeURIComponent(x).replace(/\+/g, ' ');
-};
-
-/**
- * small helper function to urlencode strings
- */
-jQuery.urlencode = encodeURIComponent;
-
-/**
- * This function returns the parsed url parameters of the
- * current request. Multiple values per key are supported,
- * it will always return arrays of strings for the value parts.
- */
-jQuery.getQueryParameters = function(s) {
-  if (typeof s === 'undefined')
-    s = document.location.search;
-  var parts = s.substr(s.indexOf('?') + 1).split('&');
-  var result = {};
-  for (var i = 0; i < parts.length; i++) {
-    var tmp = parts[i].split('=', 2);
-    var key = jQuery.urldecode(tmp[0]);
-    var value = jQuery.urldecode(tmp[1]);
-    if (key in result)
-      result[key].push(value);
-    else
-      result[key] = [value];
-  }
-  return result;
-};
-
-/**
- * highlight a given string on a jquery object by wrapping it in
- * span elements with the given class name.
- */
-jQuery.fn.highlightText = function(text, className) {
-  function highlight(node, addItems) {
-    if (node.nodeType === 3) {
-      var val = node.nodeValue;
-      var pos = val.toLowerCase().indexOf(text);
-      if (pos >= 0 &&
-          !jQuery(node.parentNode).hasClass(className) &&
-          !jQuery(node.parentNode).hasClass("nohighlight")) {
-        var span;
-        var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
-        if (isInSVG) {
-          span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
-        } else {
-          span = document.createElement("span");
-          span.className = className;
-        }
-        span.appendChild(document.createTextNode(val.substr(pos, text.length)));
-        node.parentNode.insertBefore(span, node.parentNode.insertBefore(
-          document.createTextNode(val.substr(pos + text.length)),
-          node.nextSibling));
-        node.nodeValue = val.substr(0, pos);
-        if (isInSVG) {
-          var bbox = span.getBBox();
-          var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
-       	  rect.x.baseVal.value = bbox.x;
-          rect.y.baseVal.value = bbox.y;
-          rect.width.baseVal.value = bbox.width;
-          rect.height.baseVal.value = bbox.height;
-          rect.setAttribute('class', className);
-          var parentOfText = node.parentNode.parentNode;
-          addItems.push({
-              "parent": node.parentNode,
-              "target": rect});
-        }
-      }
-    }
-    else if (!jQuery(node).is("button, select, textarea")) {
-      jQuery.each(node.childNodes, function() {
-        highlight(this, addItems);
-      });
-    }
-  }
-  var addItems = [];
-  var result = this.each(function() {
-    highlight(this, addItems);
-  });
-  for (var i = 0; i < addItems.length; ++i) {
-    jQuery(addItems[i].parent).before(addItems[i].target);
-  }
-  return result;
-};
-
-/*
- * backward compatibility for jQuery.browser
- * This will be supported until firefox bug is fixed.
- */
-if (!jQuery.browser) {
-  jQuery.uaMatch = function(ua) {
-    ua = ua.toLowerCase();
-
-    var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
-      /(webkit)[ \/]([\w.]+)/.exec(ua) ||
-      /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
-      /(msie) ([\w.]+)/.exec(ua) ||
-      ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
-      [];
-
-    return {
-      browser: match[ 1 ] || "",
-      version: match[ 2 ] || "0"
-    };
-  };
-  jQuery.browser = {};
-  jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
-}
-
-/**
- * Small JavaScript module for the documentation.
- */
-var Documentation = {
-
-  init : function() {
-    this.fixFirefoxAnchorBug();
-    this.highlightSearchWords();
-    this.initIndexTable();
-    
-  },
-
-  /**
-   * i18n support
-   */
-  TRANSLATIONS : {},
-  PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
-  LOCALE : 'unknown',
-
-  // gettext and ngettext don't access this so that the functions
-  // can safely bound to a different name (_ = Documentation.gettext)
-  gettext : function(string) {
-    var translated = Documentation.TRANSLATIONS[string];
-    if (typeof translated === 'undefined')
-      return string;
-    return (typeof translated === 'string') ? translated : translated[0];
-  },
-
-  ngettext : function(singular, plural, n) {
-    var translated = Documentation.TRANSLATIONS[singular];
-    if (typeof translated === 'undefined')
-      return (n == 1) ? singular : plural;
-    return translated[Documentation.PLURALEXPR(n)];
-  },
-
-  addTranslations : function(catalog) {
-    for (var key in catalog.messages)
-      this.TRANSLATIONS[key] = catalog.messages[key];
-    this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
-    this.LOCALE = catalog.locale;
-  },
-
-  /**
-   * add context elements like header anchor links
-   */
-  addContextElements : function() {
-    $('div[id] > :header:first').each(function() {
-      $('<a class="headerlink">\u00B6</a>').
-      attr('href', '#' + this.id).
-      attr('title', _('Permalink to this headline')).
-      appendTo(this);
-    });
-    $('dt[id]').each(function() {
-      $('<a class="headerlink">\u00B6</a>').
-      attr('href', '#' + this.id).
-      attr('title', _('Permalink to this definition')).
-      appendTo(this);
-    });
-  },
-
-  /**
-   * workaround a firefox stupidity
-   * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
-   */
-  fixFirefoxAnchorBug : function() {
-    if (document.location.hash && $.browser.mozilla)
-      window.setTimeout(function() {
-        document.location.href += '';
-      }, 10);
-  },
-
-  /**
-   * highlight the search words provided in the url in the text
-   */
-  highlightSearchWords : function() {
-    var params = $.getQueryParameters();
-    var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
-    if (terms.length) {
-      var body = $('div.body');
-      if (!body.length) {
-        body = $('body');
-      }
-      window.setTimeout(function() {
-        $.each(terms, function() {
-          body.highlightText(this.toLowerCase(), 'highlighted');
-        });
-      }, 10);
-      $('<p class="highlight-link"><a href="javascript:Documentation.' +
-        'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
-          .appendTo($('#searchbox'));
-    }
-  },
-
-  /**
-   * init the domain index toggle buttons
-   */
-  initIndexTable : function() {
-    var togglers = $('img.toggler').click(function() {
-      var src = $(this).attr('src');
-      var idnum = $(this).attr('id').substr(7);
-      $('tr.cg-' + idnum).toggle();
-      if (src.substr(-9) === 'minus.png')
-        $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
-      else
-        $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
-    }).css('display', '');
-    if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
-        togglers.click();
-    }
-  },
-
-  /**
-   * helper function to hide the search marks again
-   */
-  hideSearchWords : function() {
-    $('#searchbox .highlight-link').fadeOut(300);
-    $('span.highlighted').removeClass('highlighted');
-  },
-
-  /**
-   * make the url absolute
-   */
-  makeURL : function(relativeURL) {
-    return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
-  },
-
-  /**
-   * get the current relative url
-   */
-  getCurrentURL : function() {
-    var path = document.location.pathname;
-    var parts = path.split(/\//);
-    $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
-      if (this === '..')
-        parts.pop();
-    });
-    var url = parts.join('/');
-    return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
-  },
-
-  initOnKeyListeners: function() {
-    $(document).keyup(function(event) {
-      var activeElementType = document.activeElement.tagName;
-      // don't navigate when in search box or textarea
-      if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
-        switch (event.keyCode) {
-          case 37: // left
-            var prevHref = $('link[rel="prev"]').prop('href');
-            if (prevHref) {
-              window.location.href = prevHref;
-              return false;
-            }
-          case 39: // right
-            var nextHref = $('link[rel="next"]').prop('href');
-            if (nextHref) {
-              window.location.href = nextHref;
-              return false;
-            }
-        }
-      }
-    });
-  }
-};
-
-// quick alias for translations
-_ = Documentation.gettext;
-
-$(document).ready(function() {
-  Documentation.init();
-});

_static/documentation_options.js

@@ -1,296 +0,0 @@
-var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '',
-    LANGUAGE: 'None',
-    COLLAPSE_INDEX: false,
-    FILE_SUFFIX: '.html',
-    HAS_SOURCE: true,
-    SOURCELINK_SUFFIX: '.txt',
-    NAVIGATION_WITH_KEYS: false,
-    SEARCH_LANGUAGE_STOP_WORDS: ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]
-};
-
-
-
-/* Non-minified version JS is _stemmer.js if file is provided */ 
-/**
- * Porter Stemmer
- */
-var Stemmer = function() {
-
-  var step2list = {
-    ational: 'ate',
-    tional: 'tion',
-    enci: 'ence',
-    anci: 'ance',
-    izer: 'ize',
-    bli: 'ble',
-    alli: 'al',
-    entli: 'ent',
-    eli: 'e',
-    ousli: 'ous',
-    ization: 'ize',
-    ation: 'ate',
-    ator: 'ate',
-    alism: 'al',
-    iveness: 'ive',
-    fulness: 'ful',
-    ousness: 'ous',
-    aliti: 'al',
-    iviti: 'ive',
-    biliti: 'ble',
-    logi: 'log'
-  };
-
-  var step3list = {
-    icate: 'ic',
-    ative: '',
-    alize: 'al',
-    iciti: 'ic',
-    ical: 'ic',
-    ful: '',
-    ness: ''
-  };
-
-  var c = "[^aeiou]";          // consonant
-  var v = "[aeiouy]";          // vowel
-  var C = c + "[^aeiouy]*";    // consonant sequence
-  var V = v + "[aeiou]*";      // vowel sequence
-
-  var mgr0 = "^(" + C + ")?" + V + C;                      // [C]VC... is m>0
-  var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$";    // [C]VC[V] is m=1
-  var mgr1 = "^(" + C + ")?" + V + C + V + C;              // [C]VCVC... is m>1
-  var s_v   = "^(" + C + ")?" + v;                         // vowel in stem
-
-  this.stemWord = function (w) {
-    var stem;
-    var suffix;
-    var firstch;
-    var origword = w;
-
-    if (w.length < 3)
-      return w;
-
-    var re;
-    var re2;
-    var re3;
-    var re4;
-
-    firstch = w.substr(0,1);
-    if (firstch == "y")
-      w = firstch.toUpperCase() + w.substr(1);
-
-    // Step 1a
-    re = /^(.+?)(ss|i)es$/;
-    re2 = /^(.+?)([^s])s$/;
-
-    if (re.test(w))
-      w = w.replace(re,"$1$2");
-    else if (re2.test(w))
-      w = w.replace(re2,"$1$2");
-
-    // Step 1b
-    re = /^(.+?)eed$/;
-    re2 = /^(.+?)(ed|ing)$/;
-    if (re.test(w)) {
-      var fp = re.exec(w);
-      re = new RegExp(mgr0);
-      if (re.test(fp[1])) {
-        re = /.$/;
-        w = w.replace(re,"");
-      }
-    }
-    else if (re2.test(w)) {
-      var fp = re2.exec(w);
-      stem = fp[1];
-      re2 = new RegExp(s_v);
-      if (re2.test(stem)) {
-        w = stem;
-        re2 = /(at|bl|iz)$/;
-        re3 = new RegExp("([^aeiouylsz])\\1$");
-        re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
-        if (re2.test(w))
-          w = w + "e";
-        else if (re3.test(w)) {
-          re = /.$/;
-          w = w.replace(re,"");
-        }
-        else if (re4.test(w))
-          w = w + "e";
-      }
-    }
-
-    // Step 1c
-    re = /^(.+?)y$/;
-    if (re.test(w)) {
-      var fp = re.exec(w);
-      stem = fp[1];
-      re = new RegExp(s_v);
-      if (re.test(stem))
-        w = stem + "i";
-    }
-
-    // Step 2
-    re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
-    if (re.test(w)) {
-      var fp = re.exec(w);
-      stem = fp[1];
-      suffix = fp[2];
-      re = new RegExp(mgr0);
-      if (re.test(stem))
-        w = stem + step2list[suffix];
-    }
-
-    // Step 3
-    re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
-    if (re.test(w)) {
-      var fp = re.exec(w);
-      stem = fp[1];
-      suffix = fp[2];
-      re = new RegExp(mgr0);
-      if (re.test(stem))
-        w = stem + step3list[suffix];
-    }
-
-    // Step 4
-    re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
-    re2 = /^(.+?)(s|t)(ion)$/;
-    if (re.test(w)) {
-      var fp = re.exec(w);
-      stem = fp[1];
-      re = new RegExp(mgr1);
-      if (re.test(stem))
-        w = stem;
-    }
-    else if (re2.test(w)) {
-      var fp = re2.exec(w);
-      stem = fp[1] + fp[2];
-      re2 = new RegExp(mgr1);
-      if (re2.test(stem))
-        w = stem;
-    }
-
-    // Step 5
-    re = /^(.+?)e$/;
-    if (re.test(w)) {
-      var fp = re.exec(w);
-      stem = fp[1];
-      re = new RegExp(mgr1);
-      re2 = new RegExp(meq1);
-      re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
-      if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
-        w = stem;
-    }
-    re = /ll$/;
-    re2 = new RegExp(mgr1);
-    if (re.test(w) && re2.test(w)) {
-      re = /.$/;
-      w = w.replace(re,"");
-    }
-
-    // and turn initial Y back to y
-    if (firstch == "y")
-      w = firstch.toLowerCase() + w.substr(1);
-    return w;
-  }
-}
-
-
-
-
-
-var splitChars = (function() {
-    var result = {};
-    var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
-         1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
-         2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
-         2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
-         3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
-         3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
-         4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
-         8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
-         11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
-         43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
-    var i, j, start, end;
-    for (i = 0; i < singles.length; i++) {
-        result[singles[i]] = true;
-    }
-    var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
-         [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
-         [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
-         [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
-         [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
-         [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
-         [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
-         [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
-         [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
-         [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
-         [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
-         [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
-         [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
-         [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
-         [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
-         [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
-         [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
-         [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
-         [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
-         [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
-         [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
-         [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
-         [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
-         [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
-         [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
-         [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
-         [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
-         [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
-         [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
-         [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
-         [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
-         [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
-         [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
-         [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
-         [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
-         [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
-         [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
-         [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
-         [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
-         [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
-         [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
-         [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
-         [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
-         [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
-         [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
-         [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
-         [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
-         [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
-         [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
-    for (i = 0; i < ranges.length; i++) {
-        start = ranges[i][0];
-        end = ranges[i][1];
-        for (j = start; j <= end; j++) {
-            result[j] = true;
-        }
-    }
-    return result;
-})();
-
-function splitQuery(query) {
-    var result = [];
-    var start = -1;
-    for (var i = 0; i < query.length; i++) {
-        if (splitChars[query.charCodeAt(i)]) {
-            if (start !== -1) {
-                result.push(query.slice(start, i));
-                start = -1;
-            }
-        } else if (start === -1) {
-            start = i;
-        }
-    }
-    if (start !== -1) {
-        result.push(query.slice(start));
-    }
-    return result;
-}
-
-