Revert "Add Example 5 for updating an existing package in autospec. (#827)"

This reverts commit 7861c356db.

.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.

.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,40 @@
+# 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 -p python$(PY_VERSION) venv;
+	source venv/bin/activate; \
+	pip3 install -r requirements.txt;
+

README.rst

@@ -0,0 +1,103 @@
+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 dependenices and all supported languages.
+
+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.
+
+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://clearlinux.org/documentation/clear-linux/reference/collaboration
+.. _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/bootable-usb/bootable-usb.rst.txt

@@ -1,208 +0,0 @@
-.. _bootable-usb:
-
-Create a bootable USB drive
-###########################
-
-Follow the instructions applicable to your system to create a bootable |CL-ATTR|
-USB drive:
-
-* :ref:`bootable-usb-linux`
-* :ref:`bootable-usb-mac`
-* :ref:`bootable-usb-windows`
-
-Prerequisites
-*************
-
-* Use an **8GB** or larger USB drive.
-* Download the |CL| live boot image or interactive installer image from the
-  `Downloads`_ page.
-
-.. _bootable-usb-linux:
-
-Create a bootable USB drive on Linux\*
-**************************************
-
-Make sure you have have completed all `Prerequisites`_.
-
-Before burning the image onto your USB drive,
-:ref:`verify and decompress your image <verify-linux>`.
-
-Burn the |CL| image onto a USB drive
-====================================
-
-.. caution::
-
-   |CAUTION-BACKUP-USB|
-
-#. Open a terminal emulator and get root privilege.
-
-   .. code-block:: bash
-
-      sudo -s
-
-#. Go to the directory with the decompressed image.
-
-#. Plug in the USB drive.
-
-#. Identify the USB drive using the :command:`lsblk` command. This shows all
-   drives attached to the system, including the primary hard disk. In the
-   example output below, there are 4 drives
-   (`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and `/dev/sdd`) attached, where
-   `/dev/sda` is primary drive. The remaining are three USB drives. The output
-   also shows the mounted partitions (under the `MOUNTPOINT` column) for each
-   drive.
-
-   .. code-block:: bash
-
-      lsblk
-
-   Example output:
-
-   .. code-block:: console
-
-      NAME   MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
-      sdd      8:48   1    15G  0 disk
-      ├─sdd2   8:50   1     5G  0 part /run/media/user1/960c184f-3bb7-42b7-bcaf-0c1282
-      ├─sdd3   8:51   1     8G  0 part /run/media/user1/704f3382-b26d-4f34-af1b-cb9aab
-      └─sdd1   8:49   1     2G  0 part
-      sdb      8:16   1  14.8G  0 disk
-      └─sdb1   8:17   1  14.8G  0 part /run/media/user1/PATRIOT_USB
-      sdc      8:32   1   7.3G  0 disk
-      └─sdc1   8:33   1   7.3G  0 part /run/media/user1/LINUX MINT
-      sda      8:0    0 335.4G  0 disk
-      ├─sda4   8:4    0    28G  0 part
-      ├─sda2   8:2    0   3.7G  0 part [SWAP]
-      ├─sda7   8:7    0     6G  0 part /home
-      ├─sda5   8:5    0     1G  0 part /boot
-      ├─sda3   8:3    0   954M  0 part /boot/efi
-      ├─sda1   8:1    0    28G  0 part
-      ├─sda8   8:8    0    30G  0 part /
-      └─sda6   8:6    0   7.9G  0 part [SWAP]
-
-#. You must unmount a USB drive before burning an image onto it. Note that
-   some Linux distros automatically mount a USB drive when it is plugged in.
-   Unmount a USB drive with the :command:`umount` command followed by the device
-   identifier/partition. For example:
-
-   .. code-block:: bash
-
-      umount /dev/sdd2
-      umount /dev/sdd3
-
-#. Burn the image onto the USB drive. The example below burns an uncompressed
-   image onto `<your USB device>`:
-
-   .. code-block:: bash
-
-      dd if=./clear-[version number]-[image type] of=<your USB device> oflag=sync bs=4M status=progress
-
-.. caution::
-
-   |CAUTION-UNMOUNT-USB-PARTITIONS|
-
-.. _bootable-usb-mac:
-
-Create a bootable USB drive on macOS\*
-**************************************
-
-Make sure you have have completed all `Prerequisites`_.
-
-Before burning the image onto your USB drive,
-:ref:`verify and decompress your image <verify-mac>`.
-
-Burn the |CL| image onto a USB drive
-====================================
-
-.. caution::
-
-   |CAUTION-BACKUP-USB|
-
-#. Launch the Terminal app.
-
-#. Go to the directory with the decompressed image.
-
-#. Plug in a USB drive and get its identifier:
-
-   .. code-block:: bash
-
-      diskutil list
-
-   This will list available disks and their partitions, as shown in Figure 1.
-
-   .. figure:: figures/bootable-usb-mac-01.png
-      :scale: 100 %
-      :alt: Get USB drive identifier
-
-      Figure 1: macOS - Get USB drive identifier
-
-#. Unmount the USB drive identified in the previous step. For example:
-
-   .. code-block:: bash
-
-      diskutil umountDisk /dev/disk2
-
-#. Burn the image onto the drive using the :command:`dd` command.
-   The example below burns an uncompressed image onto `<your USB device>`:
-
-   .. code-block:: bash
-
-      sudo dd if=./clear-[version number]-[image type] of=<your USB device> bs=4m
-
-   To speed up the imaging process, add an ‘r’ in front of the disk identifier.
-   For example `/dev/rdisk2`.
-
-   Press :kbd:`<CTL>-T` to check imaging progress.
-
-#. Eject the USB drive.
-
-   .. code-block:: bash
-
-      diskutil eject /dev/disk2
-
-.. _bootable-usb-windows:
-
-Create a bootable USB drive on Windows\*
-****************************************
-
-Make sure you have have completed all `Prerequisites`_.
-
-Before burning the image onto your USB drive,
-:ref:`verify and decompress your image <verify-windows>`.
-
-Burn the |CL| image onto a USB drive
-====================================
-
-.. caution::
-
-   |CAUTION-BACKUP-USB|
-
-#. Download the `Rufus`_ utility to burn the image onto a USB drive.
-   We use Rufus 3.5 here. **Only use the latest version of Rufus**.
-
-#. Plug in the USB drive and open Rufus.
-
-#. Under `Boot selection`, click the :guilabel:`SELECT` button.
-
-#. Find and select the previously extracted |CL| image file.
-
-#. Click the :guilabel:`START` button. See Figure 2.
-
-   .. figure:: figures/bootable-usb-windows-02.png
-      :scale: 80 %
-      :alt: Rufus utility
-
-      Figure 2: Rufus utility
-
-#. When the dialogue appears, select
-   :guilabel:`Write in ISO image mode (Recommended)`. See Figure 3.
-
-   .. figure:: figures/bootable-usb-windows-03.png
-      :scale: 80 %
-      :alt: ISOHybrid image detected
-
-      Figure 3: ISOHybrid image detected
-
-#. Select the Windows taskbar menu for USB and select eject.
-
-.. _Rufus: https://rufus.ie/
-.. _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/virtualbox-cl-installer.rst.txt

@@ -1,404 +0,0 @@
-.. _virtualbox-cl-installer:
-
-Install a |CL-ATTR| VM in VirtualBox\*
-######################################
-
-This page explains how to create a virtual machine on the `VirtualBox`_
-hypervisor with |CL-ATTR| as the guest operating system. These instructions
-support the |CL| live-server installer to create the |CL| virtual machine (VM).
-
-.. contents::
-   :local:
-   :depth: 1
-
-Prerequisites
-*************
-
-#. Enable virtualization, such as `Intel® Virtualization Technology`_
-   (Intel® VT), on the host system from EFI/BIOS.
-
-#. Download and install |VB| **version 6.0 or greater** from
-   `VirtualBox`_ using the  `VirtualBox Installation Instructions`_ for your
-   platform.
-
-Download and extract the |CL| installer ISO
-*******************************************
-
-#. Download the :file:`clear-<VERSION>-live-server.iso.xz` of
-   |CL| on the `Downloads`_ page.
-
-#. Validate the integrity of the downloaded image by checking the file hash
-   and signatures. Refer to :ref:`validate-signatures` for detailed steps.
-
-#. Decompress the downloaded image.
-
-   - On Windows you can use `7zip`_ to extract the file by right-clicking the
-     file to *Extract Here* (in the same directory)
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-01.png
-      :scale: 100%
-      :alt: 7zip extract here command
-
-      Figure 1: 7zip extract here command
-
-   - On Linux :
-
-     .. code-block:: bash
-
-        xz -d clear-<VERSION>-live-server.iso.xz
-
-#. Delete the originally downloaded compressed file.
-
-Create a new |VB| virtual machine
-*********************************
-
-A new :abbr:`VM (Virtual Machine)` needs to be created in |VBM| where |CL|
-will be installed. General instructions for creating a virtual machine and
-details about using different settings are available in the VirtualBox manual section `Creating Your First Virtual Machine`_.
-
-#. Launch the |VBM| from your host system.
-
-#. Click the :guilabel:`New` button to create a new VM.
-
-#. Choose :guilabel:`Expert mode`.
-
-#. On the :guilabel:`Create Virtual Machine` screen, enter the following settings:
-
-   - **Name**: Choose name (e.g. ClearLinuxOS-VM).
-   - **Type**: Linux
-   - **Version**: **Linux 2.6 / 3.x / 4.x (64-bit)**
-   - **Hard disk**: `Create a virtual hard disk now`
-   - **Memory size default**: 2048 MB (Adjust appropriately.)
-
-     .. note::
-        Later, if you want to change the amount of RAM allocated, power down your VM. Return to :file:`Settings > System` and change
-        :guilabel:`Base Memory` to the desired size.
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-02.png
-      :scale: 100%
-      :alt: Create Virtual Machine
-
-      Figure 2: Create Virtual Machine
-
-#. Click :guilabel:`Create`.
-
-#. On the :guilabel:`Create Virtual Hard Disk` screen, select:
-
-   - **File location**
-   - **File size**: **32.00 GB**. Adjust size to your needs.
-   - **Hard disk file type**: `VDI (VirtualBox Disk Image)`
-   - **Storage on physical hard disk**:`Dynamically allocated`
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-03.png
-      :scale: 100%
-      :alt: Create Virtual Hard Disk
-
-      Figure 3: Create Virtual Hard Disk
-
-#. Click :guilabel:`Create`.
-
-   A new virtual machine will be created and appear in the |VBM|.
-
-#. Click :guilabel:`Settings` to configure the |CL| VM.
-
-#. In the left-hand menu, navigate to the :menuselection:`System` menu.
-
-#. On the :guilabel:`Motherboard` tab, select the :guilabel:`Chipset` menu, and
-   then select :menuselection:`ICH9`. See Figure 4.
-
-   .. note::
-
-      You can select which chipset will be presented to the virtual machine.
-      Consult the `VM VirtualBox User Manual`_ for more details.
-
-#. In :guilabel:`Enabled Features`, check these boxes:
-
-   - **Enable I/O APIC**
-   - **Enable EFI (special OSes only)**
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-04.png
-      :scale: 100%
-      :alt: Settings > System
-
-      Figure 4: Settings > System
-
-   .. note::
-
-      By default, only 1 virtual CPU is allocated to the new VM. Consider
-      increasing the number of virtual processors allocated to the virtual
-      machine under Settings > System > Processor for increased
-      performance.
-
-#. Click :guilabel:`OK`.
-
-Install |CL| on the |VB| VM
-***************************
-
-|CL| is ready to be installed.
-
-Mount the installation ISO
-==========================
-
-The |CL| installer ISO needs to be mounted as a virtual CD-ROM on the VM
-before powering the VM on.
-
-#. From the *ClearLinux-OS* :guilabel:`Settings` menu at left, select
-   :guilabel:`Storage`.
-
-#. From :guilabel:`Storage Devices`, middle column, click the blue
-   disk labeled :guilabel:`Empty`.
-
-#. From the :guilabel:`Attributes` menu, click the blue CD disk next to
-   the :guilabel:`Optical Drive` drop down menu and click
-   :guilabel:`Choose Virtual Optical Disk File...`
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-05.png
-      :scale: 100%
-      :alt: Choose Virtual Optical Disk Drive
-
-      Figure 5: Choose Virtual Optical Disk Drive
-
-#. Where there appears :guilabel:`Please choose a virtual optical disk file`,
-   select the ISO file and click *Open*.
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-06.png
-      :scale: 100%
-      :alt: Mounting an ISO
-
-      Figure 6: Mounting an ISO
-
-#. Click :guilabel:`OK` to exit and return to the main |VBM|.
-
-Install |CL| with live-server installer
-=======================================
-
-#. In the |VBM|, select virtual machine you created and click :guilabel:`Start`.
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-07.png
-      :scale: 100%
-      :alt: Start the installer
-
-      Figure 7: Start the installer
-
-   .. note::
-
-      To release the mouse cursor from the VM console window, press the right
-      :kbd:`Ctrl` key on the keyboard.
-
-#. When :guilabel:`Clear Linux Installer` in boot manager appears,
-   select :kbd:`Enter`. Do not install the bundle `desktop-autostart`.
-
-#. Follow the steps in :ref:`bare-metal-install-server` to
-   install |CL| onto the VM virtual disk. Note:
-
-   #. In :guilabel:`Configure Installation Media`, navigate top
-      VBOX HARDDISK, and then select :guilabel:`Confirm`.
-
-   #. In :menuselection:`Advanced options --> Manage User`, create an
-      administrative user.
-
-   #. Do not install the bundle `desktop-autostart`.
-
-#. When |CL| installation is complete, click :guilabel:`Exit`.
-
-#. At the prompt, enter:
-
-   .. code-block:: bash
-
-      shutdown now
-
-Unmount the ISO
-===============
-
-The |CL| installer ISO needs to be unmounted to allow the VM to boot from the
-virtual hard disk.
-
-#. Return to the |VBM|.
-
-#. Click :guilabel:`Settings` to configure the |CL| VM.
-
-#. From the VM :guilabel:`Settings` window, navigate to the :guilabel:`Storage`
-   pane in the left menu.
-
-#. From the middle :guilabel:`Storage Devices` column, click the blue CD disk
-   labeled :guilabel:`clear-<VERSION>-live-server.iso` under the
-   :guilabel:`Controller: IDE`.
-
-#. From the :guilabel:`Attributes` column at right, in :guilabel:`Optical Drive`,
-   select the blue CD icon beside and click
-   :guilabel:`Remove Disk from Virtual Drive`.
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-08.png
-      :scale: 100%
-      :alt: Remove Disk from Virtual Drive
-
-      Figure 8: Remove Disk from Virtual Drive
-
-#. Click :guilabel:`OK` to exit the :guilabel:`VM Settings` menu and return to
-   the main |VBM|.
-
-Install |VB| Linux Guest Additions
-==================================
-
-|CL| provides Linux Guest Additions drivers for full compatibility using an
-install script in the **kernel-lts** (Long Term Support) bundle by |CL|.
-
-#. From the |VBM| select the |CL| VM, and select :guilabel:`Start`.
-
-#. In the VM Console, log in as the administrative user previously created.
-
-   .. note::
-      A message may appear: "A kernel update is available: you may wish
-      to reboot the system."
-
-      To update the kernel, enter:
-
-      .. code-block:: bash
-
-          sudo reboot
-
-      At initial login, enter the administrative user's password and continue.
-
-#. Validate the installed kernel is **kernel-lts** by checking the output
-   of the :command:`uname -r` command. It should end in **.lts** or **.lts2018**.
-
-   .. code-block:: bash
-
-      uname -r
-      <VERSION>.lts
-
-   If the running kernel is not **lts**: install the LTS kernel manually,
-   update the bootloader, and check again:
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add kernel-lts
-      clr-boot-manager set-kernel $(basename $(realpath /usr/lib/kernel/default-lts))
-      clr-boot-manager update
-      reboot
-
-#. Remove any kernel bundles that do not end in *-lts* or *kernel-install*
-   to simplify and avoid conflicts:
-
-   .. code-block:: bash
-
-      sudo swupd bundle-list | grep kernel
-      sudo swupd bundle-remove <NON-LTS-KERNEL>
-
-#. In the VM Console top menu, click :guilabel:`Devices`, and select
-   :guilabel:`Insert Guest Additions CD image...` to mount the |VB| driver
-   installation to the |CL| VM.
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-09.png
-      :scale: 100%
-      :alt: Insert Guest Additions CD image
-
-      Figure 9: Insert Guest Additions CD image
-
-#. If a dialogue appears, "VBx_GAs_6.0.8... Would you like to run it?",
-   select :guilabel:`Cancel`.
-
-   Instead, we provide a script to patch and install |VB| drivers on |CL|.
-
-#. Open a Terminal and enter the script:
-
-   .. code-block:: bash
-
-      sudo install-vbox-lga
-
-   .. note::
-
-      Successful installation shows: "Guest Additions installation complete".
-      If drivers are already installed, don't re-install them.
-
-#. Shut down the system. Select :menuselection:`Machine --> ACPI Shutdown`.
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-10.png
-      :scale: 100%
-      :alt: Powering off a VirtualBox VM
-
-      Figure 10: Powering off a VirtualBox VM
-
-#. Select :guilabel:`Settings`, :guilabel:`Display`.
-
-#. In :guilabel:`Graphics Controller`, select :guilabel:`VBoxSVGA`
-   to adjust screen size dynamically.
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-11.png
-      :scale: 100%
-      :alt: Remove Disk from Virtual Drive
-
-      Figure 11: VirtualBox hardware acceleration error
-
-#. In the |VBM|, select :guilabel:`Start`.
-
-#. In the VM console, login and verify the |VB| drivers are loaded:
-
-   .. code-block:: bash
-
-      lsmod | grep ^vbox
-
-   You should see drivers loaded with names beginning with **vbox**:
-   (e.g., vboxvideo, vboxguest).
-
-#. Add `desktop-autostart` for a full desktop experience.
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add desktop-autostart
-
-#. Reboot the VM and log in with the administrative user.
-
-   .. code-block:: bash
-
-      sudo reboot
-
-The |CL| VM running on |VB| is ready to develop and explore.
-
-Troubleshooting
-***************
-
-#. **Problem:** On a Microsoft\* Windows\* OS, |VB| encounters an error when
-   trying to start a VM indicating *VT-X/AMD-v hardware acceleration is not
-   available on your system.*
-
-   .. figure:: figures/vbox/virtualbox-cl-installer-12.png
-      :scale: 100%
-      :alt: Remove Disk from Virtual Drive
-
-      Figure 12: VirtualBox hardware acceleration error
-
-   **Solution:** First, double check the `Prerequisites`_ section to make
-   sure *Hardware accelerated virtualization* extensions have been enabled
-   in the host system's EFI/BIOS.
-
-   *Hardware accelerated virtualization*, may get disabled for |VB| when
-   another hypervisor, such as *Hyper-V* is enabled.
-
-   To disable *Hyper-V* execute this command in an
-   **Administrator: Command Prompt or Powershell**, and reboot the system:
-
-   .. code-block:: bash
-
-      bcdedit /set {current} hypervisorlaunchtype off
-
-   To enable Hyper-V again, execute this command in an
-   **Administrator: Command Prompt or Powershell**, and reboot the system:
-
-   .. code-block:: bash
-
-      bcdedit /set {current} hypervisorlaunchtype Auto
-
-.. _VirtualBox Installation Instructions: https://www.virtualbox.org/manual/ch02.html
-
-.. _VirtualBox: https://www.virtualbox.org
-
-.. _Downloads: https://clearlinux.org/downloads
-
-.. _`Creating Your First Virtual Machine`: https://www.virtualbox.org/manual/UserManual.html#gui-createvm
-
-.. _7zip: http://www.7-zip.org/
-
-.. _Intel® Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html
-
-.. _VM VirtualBox User Manual: https://docs.oracle.com/cd/E97728_01/E97727/html/settings-system.html

_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/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/clear/swupd-guide.rst.txt

@@ -1,351 +0,0 @@
-.. _swupd-guide:
-
-swupd
-#####
-
-:command:`swupd` links a |CL-ATTR| installation with upstream updates and
-software.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Description
-***********
-
-:command:`swupd` has two main functions:
-
-#. Manage software and replace APT or YUM, by installing bundles
-   rather than packages.
-#. Check for system updates and install them.
-
-:command:`swupd` manages overlapping dependencies behind the scenes, ensuring
-that all software is compatible across the system. It can be used to verify
-the OS, clean cached files, and fix issues.
-
-:ref:`Bundles <bundles>` contain everything needed to deliver a software
-capability. They are the smallest granularity component that is
-managed by |CL|. A bundle comes with all of its dependencies rather than
-downloading a cascade of package dependencies when installing a piece of
-software.
-
-Versioning
-==========
-
-Using package managers to monitor 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.
-
-A number that represents the **current** release of the OS describes the
-versions of all the software on the OS. Each build is composed of a specific
-set of bundles made from a particular version of packages. On a daily basis,
-this matters to system administrators who need to determine which of their
-systems do not have the latest security fixes, or which combinations of
-software have been tested. Every release of the same number is guaranteed to
-contain the same versions of software, so there's no ambiguity between two
-systems running the same version of |CL|.
-
-Updating
-========
-
-|CL| enforces regular updating of the OS by default and automatically
-checks for updates against a version server. The content server provides the
-file and metadata content for all versions and can be the same as the
-version server. The content url server provides metadata in the form of
-*manifests*, which list and describe file contents, symlinks,
-and directories. Additionally, the actual content is provided to clients
-in the form of archive files.
-
-Software updates with |CL| are also efficient. Unlike package-based
-distributions, :command:`swupd` only updates files that have changed, rather
-than entire packages. For example, it is quite common for an OS security
-patch to be as small as 15 KB. Using binary deltas, |CL| is able to
-apply only what is needed.
-
-For details on how to generate update content for |CL|, see the
-:ref:`mixer <mixer>` tool.
-
-How it works
-************
-
-Prerequisites
-=============
-
-* The device is on a well-connected network.
-* The device is able to connect to an update server. The default server is:
-  http://update.clearlinux.org
-
-Updates
-=======
-
-|CL| updates are automatic by default, but can be set to occur only on
-demand. :command:`swupd` makes sure that regular updates are simple and
-secure. It can also check the validity of currently installed files and
-software, and can correct any problems.
-
-Manifests
----------
-
-The |CL| software update content consists of data and metadata. The data is
-the files that end up in the OS. The metadata contains relevant information to
-properly provision the data to the OS file system, as well as update the
-system and add or remove additional content to the OS.
-
-The manifests are mostly long lists of hashes that describe content.
-Each bundle gets its own manifest file. There is a master manifest
-file that describes all manifests to tie it all together.
-
-Fullfiles, packs, and delta packs
----------------------------------
-
-To speed up updates and optimize content delivery, update data provisioned to
-a system is obtained by one of the following methods:
-
-* *Fullfiles* are always generated for every file in every release. This
-  allows any |CL| to obtain the exact copy of the content
-  for each version directly. This is used if the OS verification
-  needs to replace a single file, for instance.
-
-* *Packs* are available for some releases. They combine many files to speed
-  up the creation of installation media and large updates.
-
-* *Delta packs* are an optimized version of packs that only contain updates
-  (binary diffs). They cannot be used without having the original file content.
-
-Bundle search
-=============
-
-:command:`swupd` searches download manifest data for
-bundles that match the term. Enter only one term, or hyphenated term, per
-search. Use the command :command:`man swupd` to learn more.
-
-Only the base bundle is returned. Bundles can contain other bundles via
-includes. For more details, see `Bundle Definition Files`_ and its
-subdirectory bundles.
-
-Bundles that are already installed are marked **(installed)** in search
-results.
-
-Optionally, you can review our `bundles`_ on GitHub\*.
-
-Examples
-********
-
-Example 1: Disable and enable automatic updates
-===============================================
-
-|CL| updates are automatic by default, but can be set to occur only
-on demand.
-
-#. Verify your current auto-update setting.
-
-   .. code-block:: bash
-
-      sudo swupd autoupdate
-
-   Output:
-
-   .. code-block:: console
-
-      Enabled
-
-#. Disable automatic updates.
-
-   .. code-block:: bash
-
-      sudo swupd autoupdate --disable
-
-   Output:
-
-   .. code-block:: console
-
-      Warning: disabling automatic updates may take you out of compliance with your IT policy
-
-      Running systemctl to disable updates
-      Created symlink /etc/systemd/system/swupd-update.service → /dev/null.
-      Created symlink /etc/systemd/system/swupd-update.timer → /dev/null.
-
-#. Check manually for updates.
-
-   .. code-block:: bash
-
-      sudo swupd check-update
-
-#. Install an update after identifying one that you need.
-
-   .. code-block:: bash
-
-      sudo swupd update --version <version number>
-
-#. Re-enable automatic installs.
-
-   .. code-block:: bash
-
-      sudo swupd autoupdate --enable
-
-.. _swupd-guide-example-install-bundle:
-
-Example 2: Find and install Kata Containers\*
-=============================================
-
-Kata Containers is a popular container implementation. Unlike other
-container implementations, each Kata Container has its own
-kernel instance and runs on its own :abbr:`VM (Virtual Machine)` for
-improved security.
-
-|CL| makes it very easy to install, since you only need to add
-one bundle to use `Kata Containers`_: `containers-virt`_, despite a
-number of dependencies.  Also, check out our tutorial: :ref:`kata`.
-
-#. Find the correct bundle.
-
-   To return all possible matches for the search string, enter
-   :command:`swupd search`, followed by 'kata':
-
-   .. code-block:: bash
-
-      sudo swupd search kata
-
-   The output should be similar to:
-
-   .. code-block:: console
-
-      Bundle with the best search result:
-
-      containers-virt - Run container applications from Dockerhub in
-      lightweight virtual machines
-
-      This bundle can be installed with:
-
-           swupd bundle-add  containers-virt
-
-      Alternative bundle options are
-
-           cloud-native-basic - Contains ClearLinux native software for Cloud
-
-   .. note::
-
-      If your search does not produce results with a specific term, shorten
-      the search term. For example, use *kube* instead of *kubernetes*.
-
-#. Add the bundle.
-
-   .. code-block:: bash
-
-      sudo swupd bundle-add containers-virt
-
-   .. note::
-
-      To add multiple bundles, add a space followed by the bundle name.
-
-   The output of a successful installation should be similar to:
-
-   .. code-block:: console
-
-      Downloading packs...
-
-      Extracting containers-virt pack for version 24430
-          ...50%
-      Extracting kernel-container pack for version 24430
-          ...100%
-      Starting download of remaining update content. This may take a while...
-          ...100%
-      Finishing download of update content...
-      Installing bundle(s) files...
-          ...100%
-      Calling post-update helper scripts.
-      Successfully installed 1 bundle
-
-Example 3: Verify and correct system file mismatch
-==================================================
-
-:command:`swupd` can determine whether system directories and files have
-been added to, overwritten, removed, or modified (e.g., permissions).
-
-.. code-block:: bash
-
-   sudo swupd diagnose
-
-All directories that are watched by :command:`swupd` are verified according
-to the manifest data. Hash mismatches are flagged as follows:
-
-.. code-block:: console
-
-   Verifying version 23300
-   Verifying files
-      ...0%
-   Hash mismatch for file: /usr/bin/chardetect
-   ...
-   ...
-   Hash mismatch for file: /usr/lib/python3.6/site-packages/urllib3/util/wait.py
-      ...100%
-   Inspected 237180 files
-      423 files did not match
-   Verify successful
-
-In this case, Python\* packages that were installed on top of the default
-install were flagged as mismatched. :command:`swupd` can be directed to
-ignore or fix issues based on command line options.
-
-:command:`swupd` can correct any issues it detects. Additional directives
-can be added including a white list of directories to be ignored.
-
-The following command repairs issues, removes unknown items, and
-ignores files or directories matching :file:`/usr/lib/python`:
-
-.. code-block:: bash
-
-   sudo swupd repair --picky --picky-whitelist=/usr/lib/python
-
-Quick reference
-***************
-
-swupd info
-   Returns the currently installed version and update servers.
-
-swupd update <version number>
-   Updates to a specific version or updates to latest version if no
-   arguments are used.
-
-swupd bundle-list [--all]
-   Lists installed bundles.
-
-swupd bundle-add [-b] <search term>
-   Finds a bundle that contains your search term.
-
-swupd bundle-add <bundle name>
-   Adds a bundle.
-
-swupd bundle-remove <bundle name>
-   Removes a bundle.
-
-swupd --help
-   Lists additional :command:`swupd` commands.
-
-man swupd
-   Opens the :command:`swupd` man page.
-
-Refer to `swupd source documentation`_ on GitHub for more details.
-
-Related topics
-**************
-
-* :ref:`autospec`
-* :ref:`mixer`
-* :ref:`bundles`
-
-.. _swupd source documentation: https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst
-
-.. _Kata Containers: https://clearlinux.org/downloads/containers
-
-.. _containers-virt: https://github.com/clearlinux/clr-bundles/blob/master/bundles/containers-virt
-
-.. _Bundle Definition Files: https://github.com/clearlinux/clr-bundles
-
-.. _bundles: https://github.com/clearlinux/clr-bundles/tree/master/bundles

_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/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/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/telemetrics/telem-guide.rst.txt

@@ -1,862 +0,0 @@
-.. _telem-guide:
-
-Telemetrics
-###########
-
-This guide describes the |CL-ATTR| telemetry solution.
-
-.. important::
-
-   Telemetry in |CL| is **opt-in**. The telemetry client is **not**  active
-   and sends **no** data until you explicitly enable it.
-
-.. note::
-
-   The telemetry functionality adheres to `Intel privacy policies`_ regarding
-   the collection and use of :abbr:`PII (Personally Identifiable Information)`
-   and is open source.
-
-   No intentionally identifiable information about the user or system owner is
-   collected.
-
-.. contents::
-   :local:
-   :depth: 1
-
-Overview
-********
-
-Telemetrics in |CL| is a client and server solution used to collect
-data from running |CL| systems to help quickly identify and fix bugs in the
-OS. Both client and server are customizable, and an API is available on the
-client side for instrumenting your code for debug and analysis.
-
-Telemetry, one of the key features of |CL|, enables developers to observe and
-proactively address issues in the OS 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 swupd, kernel oops, machine
-error checks, and the BIOS error report table for unhandled hardware
-failures. Telemetry enables real-time issue reporting to allow system
-developers to focus quickly 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 the libtelemetry library in
-your code to create custom telemetry records. You can also use the
-telem-record-gen utility in script files for light-touch record creation
-where instrumenting code files doesn't make sense.
-
-The |CL| telemetrics solution is an **opt-in** choice on the client side.
-By default, the telemetry client is disabled until you choose to enable it.
-Enabling the client is covered in this guide.
-
-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: receives records sent from the client and displays the cumulative
-  content through a specialized web interface.
-
-.. figure:: figures/telemetry-e2e.png
-   :alt: Figure 1, Telemetry Architecture
-
-   Figure 1: :guilabel:`|CL| Telemetry Architecture`
-
-The telemetry client provides the front end of the telemetrics solution and
-includes the following components:
-
-* telemprobd, which is a daemon that receives and prepares telemetry records
-  from probes and spools them to disk.
-* telempostd, which is a daemon that manages spooled telemetry records and
-  delivers these records according to configurable settings.
-* probes, which collect specific types of data from the operating system.
-* libtelemetry, which is the API that telemetrics probes use to create records.
-
-The telemetry backend provides the server-side component of the telemetrics
-solution and consists of:
-
-* Nginx web server.
-* Two Flask apps:
-
-  * Collector, which is an ingestion web app for records received from client
-    probes.
-  * TelemetryUI, which is a web app that exposes different views to visualize
-    the telemetry data.
-* PostgreSQL as the underlying database server.
-
-.. note::
-
-   The default telemetry backend server is hosted by the Intel |CL| development
-   team and is not viewable outside the Intel firewall. To collect your own
-   records, you must set up your own telemetry backend server.
-
-How to use
-**********
-
-From a workflow perspective, the |CL| telemetrics system is straightforward.
-On the client side, the main decisions after installation and enabling
-telemetry involve what to do with the record data generated by the probes.
-You can send the data to the default or a custom backend server, keep the data
-local to the system, or both. The backend server has a more complex setup, but
-once it's running, it is simple to use and configure.
-
-This section describes some of the possible scenarios for configuring
-the |CL| telemetrics system, and suggests which ones make sense according to
-your needs.
-
-Scenarios
-=========
-
-#. Enable telemetry:
-
-   Before probes can generate records, the telemetry client daemons must be
-   enabled. You can configure the client before enabling by creating a custom
-   :file:`telemetrics.conf` file that you place in the :file:`/etc/telemetrics`
-   directory. If you choose to use the default settings, records will be sent
-   to the telemetrics backend server managed by the |CL| development team at
-   Intel.
-
-#. Save record data locally:
-
-   You can configure the telemetry client to save records locally. This is
-   convenient when you want instant feedback during a development cycle, or to
-   track system issues if you believe there is a machine specific problem. The
-   client can be set not to send records at all, or to both keep the records
-   locally and send to the backend server.
-
-#. Set up a server to collect data:
-
-   Whether you are managing a network of |CL| systems or you don't want to
-   send records to the default telemetry server, you can set up a backend
-   server to collect your records. The backend server can be installed on any
-   Linux system and provides the same dashboard as the default server.
-
-
-#. Instrument your code with the libtelemetry API:
-
-   The :command:`telemetrics` bundle includes the libtelemetry C library, which
-   exposes an API used by the telemprobd and telempostd daemons. You can use
-   these in your applications as well. The API documentation is found in the
-   :file:`telemetry.h` file in `Telemetrics client`_ repository.
-
-
-Examples
-********
-
-.. contents::
-   :local:
-   :depth: 1
-
-Enable or disable telemetry
-===========================
-
-#. Enabling during installation:
-
-   During the initial installation of |CL|, you are requested to join the
-   stability enhancement program and allow |CL| to collect anonymous reports to
-   improve system stability. If you choose not to join this program, then the
-   telemetry software bundle is not added to your system. Choosing to join will
-   automatically enable telemetry on your system after installation is
-   complete.
-
-#. Enabling after install:
-
-   To start telemetry on your system, run the following command:
-
-   .. code-block:: bash
-
-      sudo telemctl start
-
-   This enables and starts the :command:`telemprobd` and :command:`telempostd`
-   daemons. Your system will begin to send telemetry data to the server defined
-   in the file :file:`/etc/telemetrics/telemetrics.conf`. If this file does not
-   exist, the :command:`telemprobd` and :command:`telempostd` daemons will use
-   the file :file:`/usr/share/defaults/telemetrics/telemetrics.conf`.
-
-#. Disabling after install:
-
-   To disable both of the telemetry daemons, run the following command:
-
-   .. code-block:: bash
-
-      sudo telemctl stop
-
-#. Opt in to telemetry:
-
-   To opt-in to the telemetry services, simply enter the opt-in command, which  
-   also starts the service:
-
-   .. code-block:: bash
-
-      sudo telemctl opt-in
-
-   This removes the :file:`/etc/telemetrics/opt-out` file, if it exists, and
-   starts the telemetry services.
-
-   .. note::
-
-      To opt-in but not immediately start telemetry services, you must
-      run the command :command:`sudo telemctl stop` after the :command:`opt-in`
-      command is entered. Once you are ready to start the service, enter the
-      command :command:`sudo telemctl start`.
-
-#. Opt out of telemetry:
-
-   To stop sending telemetrics data from your system, opt out of the telemetry
-   service:
-
-   .. code-block:: bash
-
-      sudo telemctl opt-out
-
-   This creates the file :file:`/etc/telemetrics/opt-out` and stops the
-   telemetry services.
-
-
-Saving data locally
-===================
-
-This example requires |CL| to be installed and telemetry to be enabled on the
-system.
-
-To change how records are managed, copy the default
-:file:`/usr/share/defaults/telemetrics/telemetrics.conf` file to
-:file:`/etc/telemetrics/telemetrics.conf` and edit it. The changes in the
-:file:`/etc/telemetrics/telemetrics.conf` file will override the defaults in
-the :file:`/usr/share/defaults/telemetrics/telemetrics.conf` file. You may need
-root permissions to create and edit files in :file:`/etc`. For each
-example, and for any time you make changes to the configuration file, you must
-restart the client daemons to pick up the changes:
-
-.. code-block:: bash
-
-  sudo telemctl restart
-
-
-The :command:`telemctl journal` command gives you access to features and
-options of the telemetry journal to assist with system analytics and debug.
-:command:`telemctl journal` has a number of options to help filter records.
-Use :command:`-h` or :command:`--help` to view usage options.
-
-
-#. Keep a local copy and send records to backend server:
-
-   To keep a local copy of the telemetry record and also send it on to the
-   backend server, we will need to change the
-   :guilabel:`record_retention_enabled` configuration key value to
-   :guilabel:`true`.
-
-#. Keep all records  -- don't send to backend server:
-
-   To keep records on the system without sending them to a backend server, set
-   the :guilabel:`record_server_delivery_enabled` key value to
-   :guilabel:`false`. Note that you will also need to ensure the
-   :guilabel:`record_retention_enabled` configuration key value is set to
-   :guilabel:`true` or the system will not keep local copies.
-
-#. Keep and send records to custom server:
-
-   This assumes you have set up a custom server according to the next example.
-
-   The server is identified by the :guilabel:`server` setting, and by default
-   records are sent to the |CL| server
-   :guilabel:`server=https://clr.telemetry.intel.com/v2/collector`. To change
-   this, you can use an IP address or fully qualified domain name.
-
-
-Set up a back-end server to collect telemetry records
-=====================================================
-
-For this example, start with a clean installation of |CL| on a new system
-using the :ref:`bare-metal-install-server` getting started guide and:
-
-#. Join the :guilabel:`Stability Enhancement Program` to install and
-   enable the telemetrics components.
-
-#. Select the manual installation method with the following settings:
-
-   * Set the hostname to :guilabel:`clr-telem-server`,
-   * Create an administrative user named :guilabel:`clear` and add this user
-     to sudoers
-
-#. Log in with your administrative user, from your :file:`$HOME` directory, 
-   run :command:`git` to clone the :guilabel:`telemetrics-backend` repository
-   into the :file:`$HOME/telemetrics-backend` directory:
-
-   .. code-block:: console
-
-      git clone https://github.com/clearlinux/telemetrics-backend
-
-   .. note::
-
-      You may need to set up the :envvar:`https_proxy` environment variable if
-      you have issues reaching github.com.
-
-#. Change your current working directory to :file:`telemetrics-backend/scripts`.
-#. Before you install the telemetrics backend with the :file:`deploy.sh` script
-   file in the next step, here is an explanation of the options to be specified:
-
-   * :command:`-a install` to perform an install
-   * :command:`-d clr` to install to a |CL| distro
-   * :command:`-H localhost` to set the domain to localhost
-
-   .. caution::
-      The :file:`deploy.sh` shell script has minimal error checking and makes
-      several changes to your system. Be sure that the options you define on
-      the cmdline are correct before proceeding.
-
-#. Run the shell script from the :file:`$HOME/telemetrics-backend/scripts`
-   directory:
-
-   .. code-block:: console
-
-      ./deploy.sh -H localhost -a install -d clr
-
-
-
-   The script starts and lists all the defined options and prompts you for
-   the :guilabel:`PostgreSQL` database password.
-
-   .. code-block:: console
-
-      Options:
-       host: localhost
-       distro: clr
-       action: install
-       repo: https://github.com/clearlinux/telemetrics-backend
-       source: master
-       type: git
-       DB password: (default: postgres):
-
-#. For the :guilabel:`DB password:`, press the :kbd:`Enter` key to accept the
-   default password `postgres`.
-
-   .. note::
-
-      The :file:`deploy.sh` script uses :command:`sudo` to run commands and you
-      may be prompted to enter your user password at any time while the script
-      is executing. If this occurs, enter your user password to execute the
-      :command:`sudo` command.
-
-
-#. After all the server components have been installed, you are prompted to
-   enter the :guilabel:`PostgreSQL` database password to change it as
-   illustrated below:
-
-   .. code-block:: console
-
-      Enter password for 'postgres' user:
-      New password:
-      Retype new password:
-      passwd: password updated successfully
-
-   Enter `postgres` for the current value of the password and then enter a new
-   password, retype it to verify the new password and the :guilabel:`PostgreSQL`
-   database password will be updated.
-
-#. After the installation is complete, you can use your web browser to view the
-   new server by opening the browser on the system and typing in localhost
-   in the address bar. You should see a web page similar to the one shown in
-   Figure 2 below.
-
-   .. figure:: figures/telemetry-backend-1.png
-      :alt: Telemetry UI
-
-      Figure 2: :guilabel:`Telemetry UI`
-
-Create records with telem-record-gen
-====================================
-
-The telemetrics bundle provides a record generator tool called
-`telem-record-gen`. This tool can be used to create records from shell
-scripts or the command line when writing a probe in C is not desirable.
-Records are sent to the backend server, and can also be echoed to stdout.
-
-There are three ways to supply the payload to the record.
-
-#. On the command line, use the :command:`-p <string>` option:
-
-   .. code-block:: bash
-
-      telem-record-gen -c a/b/c -n -o -p 'payload goes here'
-
-   .. code-block:: console
-
-      record_format_version: 4
-      classification: a/b/c
-      severity: 1
-      machine_id: FFFFFFFF
-      creation_timestamp: 1539023189
-      arch: x86_64
-      host_type: innotek GmbH|VirtualBox|1.2
-      build: 25180
-      kernel_version: 4.14.71-404.lts
-      payload_format_version: 1
-      system_name: clear-linux-os
-      board_name: VirtualBox|Oracle Corporation
-      cpu_model: Intel(R) Core(TM) i7-4650U CPU @ 1.70GHz
-      bios_version: VirtualBox
-      event_id: 2236710e4fc11e4a646ce956c7802788
-
-      payload goes here
-
-#. Specify a file that contains the payload with the option
-   :command:`-P path/to/file`.
-
-   .. code-block:: bash
-
-      telem-record-gen -c a/b/c -n -o -P ./payload_file.txt
-
-   .. code-block:: console
-
-      record_format_version: 4
-      classification: a/b/c
-      severity: 1
-      machine_id: FFFFFFFF
-      creation_timestamp: 1539023621
-      arch: x86_64
-      host_type: innotek GmbH|VirtualBox|1.2
-      build: 25180
-      kernel_version: 4.14.71-404.lts
-      payload_format_version: 1
-      system_name: clear-linux-os
-      board_name: VirtualBox|Oracle Corporation
-      cpu_model: Intel(R) Core(TM) i7-4650U CPU @ 1.70GHz
-      bios_version: VirtualBox
-      event_id: d73d6040afd7693cccdfece479df9795
-
-      payload read from file
-
-#. If the :command:`-p` or :command:`-P` options are absent, the tool reads
-   from stdin so you can use it in a :file:`heredoc` in scripts.
-
-   .. code-block:: bash
-
-      #telem-record-gen -c a/b/c -n -o << HEOF
-      payload read from stdin
-      HEOF
-
-   .. code-block:: console
-
-      record_format_version: 4
-      classification: a/b/c
-      severity: 1
-      machine_id: FFFFFFFF
-      creation_timestamp: 1539023621
-      arch: x86_64
-      host_type: innotek GmbH|VirtualBox|1.2
-      build: 25180
-      kernel_version: 4.14.71-404.lts
-      payload_format_version: 1
-      system_name: clear-linux-os
-      board_name: VirtualBox|Oracle Corporation
-      cpu_model: Intel(R) Core(TM) i7-4650U CPU @ 1.70GHz
-      bios_version: VirtualBox
-      event_id: 2f070e8e71679f2b1f28794e3a6c42ee
-
-      payload read from stdin
-
-Set a static machine id
-=======================
-
-The machine id reported by the telemetry client is rotated every three days
-for privacy reasons. If you wish to have a static machine id for testing
-purposes, you can opt in by creating a file named `opt-in-static-machine-id`
-in the directory  :file:`/etc/telemetrics/`.
-
-#. Create a directory `telemetrics`.
-
-   .. code-block:: bash
-
-      sudo mkdir -p /etc/telemetrics
-
-
-#. Create the file and replace the "unique machine ID" with your desired
-   static machine ID.
-
-   .. code-block:: bash
-
-      echo "unique machine ID" | sudo tee /etc/telemetrics/opt-in-static-machine-id
-
-.. note::
-
-   The machine ID is different than the system hostname.
-
-Instrument your code with the libtelemetry API
-==============================================
-
-Prerequisites
--------------
-
-Confirm that the telemetrics header file is located on the system at
-:file:`usr/include/telemetry.h`  The `latest version`_ of the file can also be
-found on github for reference, but installing the :command:`telemetry` bundle
-will install the header file that matches your |CL| version.
-
-#. Includes and variables:
-
-   You must include the following headers in your code to use the API:
-
-   .. code-block:: console
-
-      #define _GNU_SOURCE
-      #include <stdlib.h>
-      #include <stdio.h>
-      #include <string.h>
-      #include <telemetry.h>
-
-
-   Use the following code to create the variables needed to hold the data for
-   the record to be created:
-
-   .. code-block:: console
-
-      uint32_t severity = 1;
-      uint32_t payload_version = 1;
-      char classification[30] = "org.clearlinux/hello/world";
-      struct telem_ref *tm_handle = NULL;
-      char *payload;
-      int ret = 0;
-
-
-
-   Severity:
-    Type: uint32_t
-    Value:  Severity field value. Accepted values are in the range 1-4, with
-    1 being the lowest severity, and 4 being the highest severity. Values
-    provided outside of this range are clamped to 1 or 4. [low, med, high,
-    crit]
-
-   Payload_version:
-    Type: uint32_t
-    Value: Payload format version. The only supported value right now is 1,
-    which indicates that the payload is a freely-formatted (unstructured)
-    string. Values greater than 1 are reserved for future use.
-
-   Classification:
-     Type: char array
-     Value: It should have the form, DOMAIN/PROBENAME/REST: DOMAIN is the 
-     reverse domain to use as a namespace for the probe (e.g. org.clearlinux);
-     PROBENAME is the name of the probe; and REST is an arbitrary value that
-     the probe should use to classify the record. The maximum length for the
-     classification string is 122 bytes. Each sub-category may be no longer
-     than 40 bytes long. Two / delimiters are required.
-
-   Tm_handle:
-     Type: Telem_ref struct pointer
-     Value:  Struct pointer declared by the caller, The struct is initialized
-     if the function returns success.
-
-   Payload:
-     Type: char pointer
-     Value: The payload to set
-
-#. For this example, we'll set the payload to “hello” by using
-   :command:`asprintf()`:
-
-   .. code-block:: console
-
-         if (asprintf(&payload, "hello\n") < 0) {
-           exit(EXIT_FAILURE);
-            }
-
-   The functions :command:`asprintf()` and :command:`vasprintf()` are analogs of
-   :command:`sprintf(3)` and :command:`vsprintf(3)`, except that they allocate a
-   string large enough to hold the output including the terminating null byte
-   ('\0'), and return a pointer to it via the first argument. This pointer
-   should be passed to :command:`free(3)` to release the allocated storage when
-   it is no longer needed.
-
-#. Create the new telemetry record:
-
-   The  function  :command:`tm_create_record()` initializes a telemetry record and
-   sets the severity and classification of that record, as well as the payload
-   version number. The memory needed to store the telemetry record is allocated
-   and should be freed with :command:`tm_free_record()` when no longer needed.
-
-   .. code-block:: console
-
-      if ((ret = tm_create_record(&tm_handle, severity,    classification, payload_version)) < 0) {
-      printf("Failed to create record: %s\n", strerror(-ret));
-      ret = 1;
-      goto fail;
-      }
-
-#. Set the payload field of a telemetrics record:
-
-   The function :command:`tm_set_payload()` attaches the provided telemetry record
-   data to the telemetry record. The current maximum payload size is 8192b.
-
-   .. code-block:: console
-
-      if ((ret = tm_set_payload(tm_handle, payload)) < 0) {
-         printf("Failed to set record payload: %s\n", strerror(-ret));
-         ret = 1;
-         goto fail;
-      }
-      free(payload);
-
-   The :command:`free()` function frees the memory space pointed to by `ptr`, which
-   must have been returned by a previous call to :command:`malloc()`,
-   :command:`calloc()`, or :command:`realloc()`. Otherwise, or if
-   :command:`free(ptr)` has already been called before, undefined behavior
-   occurs. If `ptr` is NULL, no operation is performed.
-
-#. Send a record to the telemetrics daemon:
-
-   The function :command:`tm_send_record()` delivers the record to the local
-   :command:`telemprobd(1)` service. Since the telemetry record was allocated by
-   the program it should be freed with :command:`tm_free_record()` when it is no
-   longer needed.
-
-   .. code-block:: console
-
-      if ((ret = tm_send_record(tm_handle)) < 0) {
-         printf("Failed to send record to daemon: %s\n", strerror(-ret));
-         ret = 1;
-         goto fail;
-      } else {
-         printf("Successfully sent record to daemon.\n");
-         ret = 0;
-      }
-      fail:
-      tm_free_record(tm_handle);
-      tm_handle = NULL;
-
-      return ret;
-
-
-#. A full sample application with compiling flags:
-
-   Create a new file :file:`test.c` and add the following code:
-
-   .. code-block:: console
-
-        #define _GNU_SOURCE
-        #include <stdlib.h>
-        #include <stdio.h>
-        #include <string.h>
-        #include <telemetry.h>
-
-        int main(int argc, char **argv)
-        {
-              uint32_t severity = 1;
-              uint32_t payload_version = 1;
-              char classification[30] = "org.clearlinux/hello/world";
-              struct telem_ref *tm_handle = NULL;
-              char *payload;
-
-              int ret = 0;
-
-              if (asprintf(&payload, "hello\n") < 0) {
-                      exit(EXIT_FAILURE);
-              }
-
-              if ((ret = tm_create_record(&tm_handle, severity, classification, payload_version)) < 0) {
-                      printf("Failed to create record: %s\n", strerror(-ret));
-                      ret = 1;
-                      goto fail;
-              }
-
-              if ((ret = tm_set_payload(tm_handle, payload)) < 0) {
-                      printf("Failed to set record payload: %s\n", strerror(-ret));
-                      ret = 1;
-                      goto fail;
-              }
-
-              free(payload);
-
-              if ((ret = tm_send_record(tm_handle)) < 0) {
-                      printf("Failed to send record to daemon: %s\n", strerror(-ret));
-                      ret = 1;
-                      goto fail;
-              } else {
-                      printf("Successfully sent record to daemon.\n");
-                      ret = 0;
-              }
-        fail:
-              tm_free_record(tm_handle);
-              tm_handle = NULL;
-
-              return ret;
-         }
-
-
-
-   Compile with the gcc compiler, using this command:
-
-   .. code-block:: bash
-
-      gcc test.c -ltelemetry -o test_telem
-
-
-   Test to ensure the program is working:
-
-   .. code-block:: bash
-
-      ./test_telem
-      Successfully sent record to daemon.
-
-   .. note::
-
-      A full example of the `heartbeat probe`_ in C is documented in the
-      source code.
-
-Reference
-*********
-
-.. contents::
-   :local:
-   :depth: 1
-
-The telemetry API
-=================
-
-Installing the :command:`telemetrics` bundle includes the libtelemetry C library,
-which exposes an API used by the telemprobd and telempostd daemons. You can
-use these in your applications as well. The API documentation is found in the
-:file:`telemetry.h` file in `Telemetrics client`_ repository.
-
-Client configuration
-====================
-
-The telemetry client will look for the configuration file located at
-:file:`/etc/telemetrics/telemetrics.conf` and use it if it exists. If the
-file does not exist, the client will use the default configuration located
-at :file:`/usr/share/defaults telemetrics/telemetrics.conf`. To modify or
-customize the configuration, copy the file from
-:file:`/usr/share/defaults/telemetrics` to :file:`/etc/telemetrics` and edit it.
-
-Configuration options
----------------------
-
-The client uses the following configuration options from the config file:
-
-server
-   This specifies the web server to which telempostd sends the telemetry records.
-socket_path
-   This specifies the path of the unix domain socket on which the telemprobd
-   listens for connections from the probes.
-spool_dir
-   This configuration option is related to spooling. If the daemon is not able
-   to send the telemetry records to the backend server due to reasons such as
-   the network availability, then it stores the records in a spool directory.
-   This option specifies the path of the spool directory. This directory should
-   be owned by the same user as the daemon.
-record_expiry
-   This is the time, in minutes, after which the records in the spool directory
-   are deleted by the daemon.
-spool_process_time
-   This specifies the time interval, in seconds, that the daemon waits for
-   before checking the spool directory for records. The daemon picks up the
-   records in the order of modification date and tries to send the record to the
-   server. It sends a maximum of 10 records at a time. If it was able to send a
-   record successfully, it deletes the record from the spool. If the daemon
-   finds a record older than the "record_expiry" time, then it deletes that
-   record. The daemon looks at a maximum of 20 records in a single spool run loop.
-rate_limit_enabled
-   This determines whether rate-limiting is enabled or disabled. When enabled,
-   there is a threshold on both records sent within a window of time, and record
-   bytes sent within a window a time.
-record_burst_limit
-   This is the maximum amount of records allowed to be passed by the daemon
-   within the record_window_length of time. If set to -1, the rate-limiting for
-   record bursts is disabled.
-record_window_length
-   The time, in minutes (0-59), that establishes the window length for the
-   record_burst_limit. For example, if record_burst_window=1000 and
-   record_window_length=15, then no more than 1000 records can be passed within
-   any given fifteen-minute window.
-byte_burst_limit
-   This is the maximum amount of bytes that can be passed by the daemon within
-   the byte_window_length of time. If set to -1, the rate-limiting for byte
-   bursts is disabled.
-byte_window_length
-   This is the time, in minutes (0-59), that establishes the window length for
-   the byte_burst_limit.
-rate_limit_strategy
-   This is the strategy chosen once the rate-limiting threshold has been
-   reached. Currently the options are 'drop' or 'spool', with spool being the
-   default. If spool is chosen, records will be spooled and sent at a later time.
-record_retention_enabled
-   When this key is enabled (true) the daemon saves a copy of the payload on
-   disk from all valid records. To avoid the excessive use of disk space only
-   the latest 100 records are kept. The default value for this configuration key
-   is false.
-record_server_delivery_enabled
-   This key controls the delivery of records to server; when enabled (default
-   value), the record will be posted to the address in the configuration file.
-   If this configuration key is disabled (false), records will not be spooled or
-   posted to backend. This configuration key can be used in combination with
-   record_retention_enabled to keep copies of telemetry records locally only.
-
-  .. note::
-
-  	 Configuration options may change as the telemetry client evolves.
-  	 Please use the comments in the file itself as the most accurate
-  	 reference for configuration.
-
-
-Client run-time options
-=======================
-
-The |CL| telemetry client provides an admin tool called :guilabel:`telemctl`
-for managing the telemetry services and probes. The tool is located in
-:file:`/usr/bin`. Running it with no argument results in the following:
-
-.. code-block:: bash
-
-   sudo telemctl
-
-.. code-block:: console
-
-   /usr/bin/telemctl - Control actions for telemetry services
-     stop       Stops all running telemetry services
-     start      Starts all telemetry services
-     restart    Restarts all telemetry services
-     is-active  Checks if telemprobd and telempostd are active
-     opt-in     Opts in to telemetry, and starts telemetry services
-     opt-out    Opts out of telemetry, and stops telemetry services
-     journal    Prints telemetry journal contents. Use -h argument for more
-                options
-
-start/stop/restart
-------------------
-
-The commands to start, stop and restart the telemetry services manage all
-required services and probes on the system. There is no need to separately
-start/stop/restart the two client daemons telemprobd and telempostd.
-The :command:`restart` command option will call :command:`telemctl stop`
-followed by :command:`telemctl start` .
-
-is-active
----------
-
-The :command:`is-active` option reports whether the two client daemons are
-active. This is useful to verify that the :command:`opt-in` and
-:command:`opt-out` options have taken effect, or to ensure that telemetry is
-functioning on the system. Note that both daemons are verified.
-
-.. code-block:: bash
-
-   sudo telemctl is-active
-
-.. code-block:: console
-
-   telemprobd : active
-   telempostd : active
-
-
-.. _Telemetrics client: https://github.com/clearlinux/telemetrics-client/
-.. _latest version: https://github.com/clearlinux/telemetrics-client/tree/master/src
-.. _heartbeat probe: https://github.com/clearlinux/telemetrics-client/tree/master/src/probes/hello.c
-.. _Intel privacy policies: https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.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/bundles/openssh-server.rst.txt

@@ -1,169 +0,0 @@
-.. _openssh-server:
-
-openssh-server
-##############
-
-The **openssh-server** bundle provides the OpenSSH\* package needed to enable
-an SSH service in |CL-ATTR|. Remote users require an SSH service to be able
-to use an encrypted login shell.
-
-|CL| enables the `sshd.socket` unit, which will listen on port 22 by default
-and start the OpenSSH service as required. The first time OpenSSH starts, it
-generates the server SSH keys needed for the service.
-
-Prerequisites
-*************
-
-Assure the bundle :file:`openssh-server` is installed.
-
-To check it it's on your host, enter:
-
-.. code-block:: bash
-
-   sudo swupd bundle-list
-
-To add it, enter:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add openssh-server
-
-Change default port
-*******************
-
-Perform the following steps to change the default listening port for the
-OpenSSH service:
-
-#. Open the sshd.socket file:
-
-   .. code-block:: bash
-
-      sudo systemctl edit sshd.socket
-
-#. Add the `[Socket]` section and `ListenStream` option to the sshd.socket
-   file as shown below. The first `ListenStream` entry removes the |CL|
-   default listen port value. The second `ListenStream` entry sets the new
-   default listen port value. In this example, we set the new default port
-   to 4200:
-
-   .. code-block:: console
-
-      [Socket]
-      ListenStream=
-      ListenStream=4200
-
-
-   Make sure to include a new line after the last line of text in the sshd.socket file.
-
-#. Verify your changes:
-
-   .. code-block:: bash
-
-      cat /etc/systemd/system/sshd.socket.d/override.conf
-
-   You should see the following output:
-
-   .. code-block:: console
-
-      [Socket]
-      ListenStream=
-      ListenStream=4200
-
-#. Reload the systemd daemon configurations:
-
-   .. code-block:: bash
-
-      sudo systemctl daemon-reload
-
-#. Restart the sshd.socket unit:
-
-   .. code-block:: bash
-
-      sudo systemctl restart sshd.socket
-
-#. Confirm the the sshd.socket unit is listening on your new port:
-
-   .. code-block:: bash
-
-      sudo systemctl status sshd.socket
-
-   .. note::
-
-      Output should show :guilabel:`Active:` as `active(listening)`.
-
-Enable SFTP
-***********
-
-|CL| *disables* the :abbr:`SFTP (SSH File Transfer Protocol)` subsystem by
-default due to security considerations. To enable the SFTP subsystem, perform
-the following configuration of the :abbr:`SSHD (SSH Daemon)` service file:
-
-#. Create a systemd drop-in directory for the SSHD service:
-
-   .. code-block:: bash
-
-      sudo mkdir -p /etc/systemd/system/sshd@.service.d
-
-#. Create the following file:
-   :file:`/etc/systemd/system/sshd@.service.d/sftp.conf`
-
-#. Add the OPTIONS environment variable to the sftp.conf file.
-
-   .. code-block:: console
-
-      [Service]
-      Environment="OPTIONS=-o Subsystem=\"sftp /usr/libexec/sftp-server\""
-
-#. Reload systemd configuration:
-
-   .. code-block:: bash
-
-      sudo systemctl daemon-reload
-
-Congratulations! The SFTP subsystem is enabled.
-
-Enable root login
-*****************
-
-To enable root login via SSH, perform the following steps:
-
-#. Create a *ssh* directory in :file:`/etc`, if it does not already exist.
-
-   .. code-block:: bash
-
-      mkdir /etc/ssh
-
-#. Create the following file, if it does not already exist:
-   :file:`/etc/ssh/sshd_config`
-
-#. Set the configuration variable in /etc/ssh/sshd_config
-
-   .. code-block:: console
-
-      PermitRootLogin yes
-
-Enable X11-forwarding
-*********************
-
-X11 forwarding allows you to securely run graphical applications
-(i.e., X clients) over the ssh conection. This will alow for remote gui apps
-without the need for full VNC/remotedesktop. To enable X11-forwarding via
-SSH, perform the following steps:
-
-#. Create a *ssh* directory in :file:`/etc`, if it does not already exist.
-
-   .. code-block:: bash
-
-      mkdir /etc/ssh
-
-#. Create the following file, if it does not already exist:
-   :file:`/etc/ssh/sshd_config`
-
-#. Set the configuration variables.
-
-   .. code-block:: bash
-
-      AllowTcpForwarding yes
-      X11UseLocalhost yes
-      X11DisplayOffset 10
-      X11Forwarding yes

_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/aws-web/aws-web.rst.txt

@@ -1,276 +0,0 @@
-.. _aws-web:
-
-Create and launch |CL-ATTR| from Amazon Web Services
-######################################################
-
-This tutorial walks you through creating and launching a |CL|
-:abbr:`AMI (Amazon Machine Image)` instance from the
-:abbr:`AWS (Amazon Web Services)` console and complete the following tasks:
-
-#. Locate and select the |CL| OS Basic AMI in the AWS Marketplace.
-#. Create a new public and private key pair to allow you to connect to your
-   |CL| instance securely.
-#. Launch the new |CL| instance and connect to it.
-#. Update your instance of |CL| using the :command:`swupd` command.
-#. Stop the |CL| instance.
-
-Prerequisites
-*************
-
-This tutorial assumes the following statements are true:
-
-* You are using a linux-based system to access AWS and can run :command:`SSH`
-  to access the remote |CL| AWS image.
-* Your browser puts downloaded files in the :file:`$HOME/Downloads`
-  directory.
-* You have already set up an AWS user account and logged into the AWS
-  console.
-
-.. note::
-   This tutorial uses a |CL| AMI t2.micro instance that is eligible for the
-   AWS free tier. To learn more about AWS and setting up an account, visit the
-   AWS website at http://aws.amazon.com.
-
-Locate, select, and launch the |CL| Basic AMI
-*********************************************
-
-#. Start from your main AWS services console menu in your browser and select the
-   :guilabel:`EC2` text as shown in figure 1:
-
-   .. figure:: figures/aws-web-1.png
-      :scale: 50 %
-      :alt: AWS Console
-
-      Figure 1: :guilabel:`AWS Console`
-
-   This selection brings up your :guilabel:`EC2 Dashboard` menu.
-
-#. To create a new |CL| instance from the :guilabel:`EC2 Dashboard` menu,
-   select the :guilabel:`Launch Instance` button as shown in figure 2:
-
-   .. figure:: figures/aws-web-2.png
-      :scale: 50 %
-      :alt: EC2 Dashboard
-
-      Figure 2: :guilabel:`EC2 Dashboard`
-
-   This selection takes you to the
-   :guilabel:`Step 1: Choose an Amazon Machine Image (AMI)` menu.
-
-#. To find the :guilabel:`Clear Linux OS Basic` AMI in the
-   :guilabel:`Step 1: Choose an Amazon Machine Image (AMI)` menu, do the
-   following:
-
-   #. In the lefthand navigation window, select the
-      :guilabel:`AWS Marketplace` menu item to bring up the search bar to
-      :guilabel:`Search AWS Marketplace Products`.
-
-   #. In the search bar, type "clear linux os" and hit the :kbd:`Enter` key to
-      search for and locate the :guilabel:`Clear Linux OS Basic` AMI.
-
-   #. Select the :guilabel:`Clear Linux OS Basic` AMI by clicking on the
-      :guilabel:`Select` button as shown in figure 3:
-
-      .. figure:: figures/aws-web-3.png
-         :scale: 50 %
-         :alt: Step 1: Choose AMI
-
-         Figure 3: :guilabel:`Step 1: Choose AMI`
-
-   #. A pop-up dialog box appears showing you more information about the
-      :guilabel:`Clear Linux OS Basic` AMI along with the pricing details for running
-      |CL| on different platform configurations as shown in figure 4. Select
-      the :guilabel:`Continue` button.
-
-      .. figure:: figures/aws-web-4.png
-         :scale: 50 %
-         :alt: Clear Linux OS Basic
-
-         Figure 4: :guilabel:`Clear Linux OS Basic`
-
-#. The :guilabel:`Choose Instance Type` menu appears as shown in figure 5.
-
-   .. figure:: figures/aws-web-5.png
-      :scale: 50 %
-      :alt: Choose an Instance Type
-
-      Figure 5: :guilabel:`Choose an Instance Type`
-
-   Select the :guilabel:`t2.micro` type by clicking the box on the left side
-   of the instance and then select the :guilabel:`Review and Launch` button to
-   move to the :guilabel:`Step 7: Review the Instance Launch` menu.
-
-   .. note::
-
-      You can configure the instance details, add additional storage, add
-      tags, and configure the security group before selecting the
-      :guilabel:`Review and Launch` button if you want to further customize
-      this |CL| instance.
-
-#. The :guilabel:`Step 7: Review the Instance Launch` menu, shown in figure 6,
-   allows you to
-   :guilabel:`Cancel` the process, return to the :guilabel:`Previous` screen
-   to change the configuration or :guilabel:`Launch` the instance defined.
-
-   .. figure:: figures/aws-web-6.png
-      :scale: 50 %
-      :alt: Step 7: Review the Instance Launch
-
-      Figure 6: :guilabel:`Step 7: Review the Instance Launch`
-
-   #. Select the :guilabel:`Launch` button. A dialog box appears, as shown in
-      figure 7, asking you to
-      :guilabel:`Select an existing key pair or create a new pair`.
-
-      .. figure:: figures/aws-web-7.png
-         :scale: 50 %
-         :alt: Select an existing key pair or create a new pair
-
-         Figure 7: :guilabel:`Select an existing key pair or create a new pair`
-
-      #. Select the :guilabel:`Create a new key pair` option.
-
-      #. For the :guilabel:`Key pair name` field, enter `AWSClearTestKey`.
-
-      #. Select the :guilabel:`Download Key Pair` button to download the
-         :file:`AWSClearTestKey.pem` to your browser's defined
-         :file:`Downloads` directory.
-
-      #. When the file finishes downloading, select the
-         :guilabel:`Launch Instances` button to proceed to the
-         :guilabel:`Launch Status` menu shown in figure 8.
-
-         .. figure:: figures/aws-web-8.png
-            :scale: 50 %
-            :alt: Launch Status
-
-            Figure 8: :guilabel:`Launch Status`
-
-   #. Once the :guilabel:`Launch Status` page changes to what is shown in
-      figure 9, select the :guilabel:`View Instances` button to view your
-      :guilabel:`Instances` dashboard.
-
-      .. figure:: figures/aws-web-9.png
-         :scale: 50 %
-         :alt: View Instance
-
-         Figure 9: :guilabel:`View Instance`
-
-Connect to your Clear Linux OS Basic instance
-*********************************************
-
-Your :guilabel:`Instances` Dashboard is shown in figure 10 with the new |CL|
-OS basic instance already selected and in the running state. If there are
-other instances available, they are also listed but not selected.
-
-.. figure:: figures/aws-web-10.png
-   :scale: 50 %
-   :alt: Instance Dashboard
-
-   Figure 10: :guilabel:`Instance Dashboard`
-
-#. To connect to your running instance, click the :guilabel:`Connect` button
-   located at the top of your dashboard. AWS brings up the pop-up dialog
-   box shown in figure 11 describing how to connect to your running instance.
-
-.. _fig-aws-web-11:
-
-.. figure:: figures/aws-web-11.png
-   :scale: 50 %
-   :alt: Connect to Your Instance
-
-   Figure 11: :guilabel:`Connect to Your Instance`
-
-#. Open a terminal on your system. You should be in your :file:`$HOME`
-   directory.
-
-#. Copy the previously downloaded keyfile from the :file:`Downloads`
-   directory to the current directory.
-
-   .. code-block:: console
-
-      cp Downloads/AWSClearTestKey.pem .
-
-#. Change the attributes of the :file:`AWSClearTestKey.pem` using the
-   :command:`chmod` command as instructed in the dialog box shown in figure
-   11.
-
-   .. code-block:: console
-
-      chmod 400 AWSClearTestKey.pem
-
-#. Copy the text highlighted in the :guilabel:`Example:` section that is
-   shown in :ref:`figure 11<fig-aws-web-11>`. Paste the copied text into your
-   terminal, change the text before the `@` sign to the username `clear`, and
-   press the :kbd:`Enter` key to execute the command.
-
-   .. code-block:: console
-
-      ssh -i "AWSClearTestKey.pem" clear@ec2-34-209-39-184.us-west-2.compute.amazonaws.com
-
-#. A message appears on the terminal stating the authenticity of the host can't
-   be established and prompts you with the message:
-
-   .. code-block:: console
-
-      The authenticity of host 'ec2-34-209-39-184.us-west-2.compute.amazonaws.com (34.209.39.184)' can't be established.
-      ECDSA key fingerprint is SHA256:LrziT5Ar66iBTfia8qmiIsrfBUm/UGam76U8bDR6yJc.
-      Are you sure you want to continue connecting (yes/no)?
-
-#. Type `yes` and hit the :kbd:`Enter` key. Another warning is printed to the
-   terminal and you are now at the command prompt of your new |CL| instance.
-
-   .. code-block:: console
-
-      Warning: Permanently added 'ec2-34-209-39-184.us-west-2.compute.amazonaws.com,34.209.39.184' (ECDSA) to the list of known hosts.
-      clear@clr-96a8565d0ca54b0c80364a1e5e7b0f88 ~ $
-
-Update the |CL| instance
-************************
-
-Run the :command:`sudo swupd update` command to update the operating
-system as shown in figure 12:
-
-.. figure:: figures/aws-web-12.png
-   :scale: 50 %
-   :alt: sudo swupd update
-
-   Figure 12: :guilabel:`sudo swupd update`
-
-In this example we updated from version 18940 to 19100.
-
-Stop the |CL| instance
-**********************
-
-When you are finished using your AWS |CL| instance you need to stop it using
-the :guilabel:`Instances` dashboard to stop accruing charges. Complete the
-following steps from the :guilabel:`Instances` dashboard to stop your AWS |CL|
-instance from running.
-
-#. Select the :guilabel:`Actions` button to bring up a pull-down menu.
-
-#. Select the :guilabel:`Instance State` menu item to expand the options.
-
-#. Select :guilabel:`Stop` menu item to shut down the running instance.
-
-   Figure 13 illustrates these steps.
-
-   .. figure:: figures/aws-web-13.png
-      :scale: 50 %
-      :alt: Stop Instance
-
-      Figure 13: :guilabel:`Stop Instance`
-
-#. A pop-up dialog box appears warning you that any ephemeral storage of
-   your instance will be lost. Select the :guilabel:`Yes, Stop` button to stop
-   your |CL| instance.
-
-.. figure:: figures/aws-web-14.png
-   :scale: 50 %
-   :alt: Stop Instances
-
-   Figure 14: :guilabel:`Stop Instances`
-
-Congratulations! You are up and running with |CL| on AWS. To see what you
-can do with your |CL| instance, visit our :ref:`tutorials <tutorials>`
-section for examples on using your |CL| system.

_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/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/kubernetes/kubernetes.rst.txt

@@ -1,406 +0,0 @@
-.. _kubernetes:
-
-Run Kubernetes\*
-################
-
-This tutorial describes how to install, configure, and run the
-`Kubernetes container orchestration system`_ on |CL-ATTR| using CRI+O and
-kata-runtime.
-
-Kubernetes\* is an open source system for automating deployment, scaling, and
-management of containerized applications. It groups containers that make up
-an application into logical units for easy management and discovery.
-
-Kata Containers\* kata-runtime adheres to
-:abbr:`OCI (Open Container Initiative*)` guidelines and work seamlessly with
-Kubernetes. `Kata Containers`_ provide strong isolation for untrusted
-workloads or  multi-tenant scenarios. Kata Containers can be
-allocated on a per-pod basis so you can mix and match both on the same host
-to suit your needs.
-
-.. contents:: :local:
-   :depth: 1
-
-Prerequisites
-*************
-
-This tutorial assumes you have already installed |CL|. For detailed
-instructions on installing |CL| on a bare metal system, follow the
-:ref:`bare metal installation tutorial<bare-metal-install-desktop>`.
-Learn about the benefits of having an up-to-date system for cloud
-orchestration on the :ref:`swupd-about` page.
-
-Before you install any new packages, update |CL| with the following command:
-
-.. code-block:: bash
-
-   sudo swupd update
-
-Install Kubernetes and CRI runtimes
-***********************************
-
-Kubernetes, a set of supported :abbr:`CRI (Container Runtime Interface)`
-runtimes, and networking plugins, are included in the `cloud-native-basic`_
-bundle.
-
-To install this framework, enter the following command:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add cloud-native-basic
-
-.. note::
-
-   For more on networking plugins, see `Install pod network add-on`_.
-
-Configure Kubernetes
-********************
-
-This tutorial uses the basic default Kubernetes configuration for simplicity.
-You must define your Kubernetes configuration according to your specific
-deployment and your security needs.
-
-#. Enable IP forwarding to avoid kubeadm `preflight check`_ errors:
-
-   Create (or edit if it exists) the file :file:`/etc/sysctl.d/60-k8s.conf`
-   and include the following line:
-
-   .. code-block:: bash
-
-      net.ipv4.ip_forward = 1
-
-   Apply the change:
-
-   .. code-block:: bash
-
-      sudo systemctl restart systemd-sysctl
-
-#. Enable the kubelet service:
-
-   .. code-block:: bash
-
-      sudo systemctl enable kubelet.service
-
-#. Disable swap using one of the following methods, either:
-
-   a) Temporarily:
-
-      .. code-block:: bash
-
-         sudo swapoff -a
-
-      .. note::
-
-         Swap will be enabled at next reboot, causing failures in
-         your cluster.
-
-   or:
-
-   b) Permanently:
-
-      Mask the swap partition:
-
-      .. code-block:: bash
-
-         sudo systemctl mask $(sed -n -e 's#^/dev/\([0-9a-z]*\).*#dev-\1.swap#p' /proc/swaps) 2>/dev/null
-         sudo swapoff -a
-
-      .. note::
-
-         On systems with limited resources, some performance degradation may
-         be observed while swap is disabled.
-
-#. Switch to root to modify the `hosts` file:
-
-   .. code-block:: bash
-
-      sudo -s
-
-#.  Create (or edit if it exists) the hosts file that Kubernetes will read to
-    locate the master's host:
-
-    .. code-block:: bash
-
-       echo "127.0.0.1 localhost `hostname`" >> /etc/hosts
-
-#.  Exit root:
-
-    .. code-block:: bash
-
-       exit
-
-Configure and run Kubernetes
-****************************
-
-This section describes how to configure and run Kubernetes with CRI-O and
-kata-runtime.
-
-Configure and run CRI-O + kata-runtime
-======================================
-
-#.  Enable the CRI-O service:
-
-    .. code-block:: bash
-
-       sudo systemctl enable crio.service
-
-#.  Enter the commands:
-
-    .. code-block:: bash
-
-       sudo systemctl daemon-reload
-       sudo systemctl restart crio
-
-#.  Initialize the master control plane with the command below and follow the
-    displayed instructions to set up `kubectl`:
-
-    .. code-block:: bash
-
-       sudo kubeadm init --cri-socket=/run/crio/crio.sock
-
-#.  Register kata-runtime as a RuntimeClass handler:
-
-    .. code-block:: bash
-
-       cat << EOF | kubectl apply -f -
-       kind: RuntimeClass
-       apiVersion: node.k8s.io/v1beta1
-       metadata:
-           name: native
-       handler: runc
-       ---
-       kind: RuntimeClass
-       apiVersion: node.k8s.io/v1beta1
-       metadata:
-           name: kata-containers
-       handler: kata
-       EOF
-
-Install pod network add-on
-**************************
-
-You must choose and install a `pod network add-on`_ to allow your pods to
-communicate. Check whether or not your add-on requires special flags when you
-initialize the master control plane.
-
-**Notes about flannel add-on**
-
-If you choose the `flannel` add-on, then you must add the following to the
-`kubeadm init` command:
-
-.. code-block:: bash
-
-   --pod-network-cidr 10.244.0.0/16
-
-Furthermore, if you are using CRI-O and `flannel` and you want to use
-Kata Containers, edit the :file:`/etc/crio/crio.conf` file to add:
-
-..  code-block:: bash
-
-    [crio.runtime]
-    manage_network_ns_lifecycle = true
-
-Use your cluster
-****************
-
-Once your master control plane is successfully initialized, instructions on
-how to use your cluster and its *IP*, *token*, and *hash* values are
-displayed. It is important that you record the cluster values because they
-are needed when joining worker nodes to the cluster. Some values have a valid
-period. The values are presented in a format similar to:
-
-.. code-block:: bash
-
-   kubeadm join <master-ip>:<master-port> --token <token> --discovery-token-ca-cert-hash <hash>
-
-**Congratulations!**
-
-You've successfully installed and set up Kubernetes in |CL| using CRI-O and
-kata-runtime. You are now ready to follow on-screen instructions to deploy a
-pod network to the cluster and join worker nodes with the displayed token
-and IP information.
-
-Related topics
-**************
-
-Read the Kubernetes documentation to learn more about:
-
-* `Understanding basic Kubernetes architecture`_
-
-* `Deploying an application to your cluster`_
-
-* Installing a `pod network add-on`_
-
-* `Joining your nodes`_
-
-Cloud native setup automation (optional)
-****************************************
-
-Clone the `cloud-native-setup`_ repository on your system and follow the
-instructions. This repository includes helper scripts to automate configuration.
-
-Package configuration customization (optional)
-**********************************************
-
-|CL| is a stateless system that looks for user-defined package configuration
-files in the :file:`/etc/<package-name>` directory to be used as default. If
-user-defined files are not found, |CL| uses the distribution-provided
-configuration files for each package.
-
-If you customize any of the default package configuration files, you **must**
-store the customized files in the :file:`/etc/` directory. If you edit any of
-the distribution-provided default files, your changes will be lost in the
-next system update.
-
-For example, to customize CRI-O configuration in your system, run the
-following commands:
-
-.. code-block:: bash
-
-   sudo mkdir /etc/crio
-   sudo cp /usr/share/defaults/crio/crio.conf /etc/crio/
-   sudo $EDITOR /etc/crio/crio.conf
-
-Learn more about :ref:`stateless` in |CL| and view the |CL| `documentation`_.
-
-Proxy configuration (optional)
-******************************
-
-If you use a proxy server, you must set your proxy environment variables and
-create an appropriate proxy configuration file for both CRI-O services. Consult your IT department if you are behind a corporate proxy for
-the appropriate values. Ensure that your local IP is **explicitly included**
-in the environment variable *NO_PROXY*. (Setting *localhost* is not enough.)
-
-If you have already set your proxy environment variables, run the following
-commands as a shell script to configure all of these services in one step:
-
-.. code-block:: bash
-
-   services=('crio')
-   for s in "${services[@]}"; do
-   sudo mkdir -p "/etc/systemd/system/${s}.service.d/"
-   cat << EOF | sudo tee "/etc/systemd/system/${s}.service.d/proxy.conf"
-   [Service]
-   Environment="HTTP_PROXY=${http_proxy}"
-   Environment="HTTPS_PROXY=${https_proxy}"
-   Environment="SOCKS_PROXY=${socks_proxy}"
-   Environment="NO_PROXY=${no_proxy}"
-   EOF
-   done
-
-Next steps
-**********
-
-:ref:`kubernetes-bp`
-
-
-Troubleshooting
-***************
-
-* <HOSTNAME> not found in <IP> message.
-
-  Your DNS server may not be appropriately configured. Try adding an
-  entry to the :file:`/etc/hosts` file with your host's IP and Name.
-
-  For example: 100.200.50.20 myhost
-
-  Use the commands :command:`hostname` and :command:`hostname -I` to retrieve them.
-
-* Images cannot be pulled.
-
-  You may be behind a proxy server. Try configuring your proxy settings,
-  using the environment variables *HTTP_PROXY*, *HTTPS_PROXY*, and *NO_PROXY*
-  as required in your environment.
-
-* Connection refused error.
-
-  If you are behind a proxy server, you may need to add the master's IP to
-  the environment variable *NO_PROXY*.
-
-* Connection timed-out or Access Refused errors.
-
-  You must ensure that the appropriate proxy settings are available from the
-  same terminal where you will initialize the control plane. To verify the
-  proxy settings that Kubernetes will actually use, run the commands:
-
-  .. code-block:: bash
-
-    echo $HTTP_PROXY
-    echo $HTTPS_PROXY
-    echo $NO_PROXY
-
-  If the displayed proxy values are different from your assigned values, the
-  cluster initialization will fail. Contact your IT support team to learn how
-  to set the proxy variables permanently, and how to make them available for
-  all the types of access that you will use, such as remote SSH access.
-
-  If the result of the above commands is blank, you may need to add a
-  ``profile`` to the :file:`/etc` directory. To do so, follow these steps.
-
-  #. Create a `profile` in :file:`/etc`
-
-     .. code-block:: bash
-
-        sudo touch profile
-
-  #. With a preferred editor, open `profile`, and enter your proxy settings.
-     Example shown below.
-
-     .. code-block:: bash
-
-        export "HTTP_PROXY=http://proxy.example.com:443"
-        export "HTTPS_PROXY=http://proxy.example.com:445"
-        export "SOCKS_PROXY=http://proxy.example.com:1080"
-        export "NO_PROXY= site.com,.site.com,localhost,127.0.0.1,<master IP>
-
-     .. note::
-
-        <master IP> can be obtained by running :command:`ifconfig`.
-
-  #. Save and exit the `profile`.
-
-  #. Run:
-
-     .. code-block:: bash
-
-        sudo source profile
-
-  #. To ensure your system isn't running previous session variables, run:
-
-     .. code-block:: bash
-
-        sudo kubeadm reset --cri-socket=/run/crio/crio.sock
-
-  #. Continue below while passing `-E` in the command as shown.
-
-* Missing environment variables.
-
-  If you are behind a proxy server, pass environment variables by adding *-E*
-  to the command that initializes the master control plane.
-
-  .. code-block:: bash
-
-     /* Kubernetes with CRI-O + kata-runtime */
-     sudo -E kubeadm init --cri-socket=/run/crio/crio.sock
-
-.. _Kubernetes container orchestration system: https://kubernetes.io/
-
-.. _Kata Containers: https://katacontainers.io/
-
-.. _Software Update documentation: https://clearlinux.org/documentation/clear-linux/concepts/swupd-about#updating
-
-.. _cloud-native-basic: https://github.com/clearlinux/clr-bundles/blob/master/bundles/cloud-native-basic
-
-.. _preflight check: https://kubernetes.io/docs/reference/setup-tools/kubeadm/implementation-details/#preflight-checks
-
-.. _Understanding basic Kubernetes architecture: https://kubernetes.io/docs/user-journeys/users/application-developer/foundational/#section-3
-
-.. _Deploying an application to your cluster: https://kubernetes.io/docs/user-journeys/users/application-developer/foundational/#section-2
-
-.. _pod network add-on: https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/#pod-network
-
-.. _Joining your nodes: https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/#join-nodes
-
-.. _documentation: https://clearlinux.org/documentation/clear-linux
-
-.. _cloud-native-setup: https://github.com/clearlinux/cloud-native-setup

_sources/tutorials/machine-learning/machine-learning.rst.txt

@@ -1,242 +0,0 @@
-.. _machine-learning:
-
-TensorFlow\* machine learning on |CL-ATTR|
-##########################################
-
-This tutorial will demonstrate the installation and execusion of a TensorFlow\*
-machine learning example on |CL-ATTR|. It uses a Jupyter\* Notebook and MNIST
-data for handwriting recognition. 
-
-The initial steps will have you set up a Jupyter kernel and run a Notebook
-on a bare-metal |CL| system.
-
-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>`.
-
-Before you install any new packages, update |CL| with the following command:
-
-.. code-block:: bash
-
-   sudo swupd update
-
-Once your system is updated, add the following bundles to your system:
-
-* `machine-learning-web-ui`: This bundle contains the Jupyter application.
-
-* `machine-learning-basic`: This bundle contains TensorFlow and other useful
-  tools.
-
-To install the bundles, run the following commands in your :file:`$HOME`
-directory:
-
-.. code-block:: bash
-
-   sudo swupd bundle-add machine-learning-web-ui
-
-   sudo swupd bundle-add machine-learning-basic
-
-Set up a Jupyter notebook
-*************************
-
-With all required packages and libraries installed, set up the file structure
-for the Jupyter Notebook.
-
-#. In the :file:`$HOME` directory, create a directory for the Jupyter
-   Notebooks named :file:`Notebooks`.
-
-   .. code-block:: bash
-
-      mkdir Notebooks
-
-#. Within :file:`Notebooks`, create a directory named :file:`Handwriting`.
-
-   .. code-block:: bash
-
-      mkdir Notebooks/Handwriting
-
-#. Change to the new directory.
-
-   .. code-block:: bash
-
-      cd Notebooks/Handwriting
-
-#. Copy the :file:`MNIST_example.ipynb` file into the :file:`Handwriting`
-   directory.
-
-   .. note::
-      After installing the `machine-learning basic` bundle, you can find the
-      example code under
-      :file:`/usr/share/doc/tensorflow/MNIST_example.ipynb`.
-
-
-The example code downloads and decompresses the MNIST data directly into the
-:file:`./mnist` directory. Alternatively, download the four files directly
-from the Yann LeCun’s `MNIST Database website`_ and save them into a
-:file:`mnist` directory within the :file:`Handwriting` directory.
-
-The files needed are:
-
-* `train-images-idx3-ubyte.gz`_: Training set images (9912422 bytes)
-
-* `train-labels-idx1-ubyte.gz`_: Training set labels (28881 bytes)
-
-* `t10k-images-idx3-ubyte.gz`_: Test set images (1648877 bytes)
-
-* `t10k-labels-idx1-ubyte.gz`_: Test set labels (4542 bytes)
-
-Run the Jupyter machine learning example code
-*********************************************
-
-With |CL|, Jupyter, and TensorFlow installed and configured, we can
-run the example code.
-
-#. Go to the :file:`($HOME)/Notebooks` directory and start Jupyter with the
-   following commands:
-
-   .. code-block:: bash
-
-      cd ~/Notebooks
-
-      jupyter notebook
-
-   The Jupyter server starts and opens a web browser showing the Jupyter file
-   manager with a list of files in the current directory, see figure 1.
-
-   .. figure:: figures/machine-learning-1.png
-      :alt: Jupyter file manager
-
-      Figure 1: The Jupyter file manager shows the list of available files.
-
-#. Click on the :file:`Handwriting` directory. The :file:`MNIST_example.ipynb`
-   file created earlier should be listed there, see figure 2.
-
-   .. figure:: figures/machine-learning-2.png
-      :alt: Example file within the Jupyter file manager
-
-      Figure 2: The example file within the Jupyter file manager.
-
-#. To run the hand writing example, click on the :file:`MNIST_example.ipynb`
-   file to load the notebook, see figure 3.
-
-   .. figure:: figures/machine-learning-3.png
-      :alt: The loaded MNIST_example notebook
-
-      Figure 3: The loaded MNIST_example notebook within the Jupyter file
-      manager.
-
-#. Click the |run-cell| button to execute the code in the current cell and
-   move to the next.
-
-#. Select the :guilabel:`In [2]` cell and click the |run-cell| button to load
-   the MNIST data. The successful output is shown on figure 4.
-
-   .. figure:: figures/machine-learning-4.png
-      :alt: Successful import of MNIST data
-
-      Figure 4: Output after successfully importing the MNIST data.
-
-
-   After the MNIST data was successfully downloaded and extracted into the
-   :file:`mnist` directory within the :file:`($HOME)/Notebooks/Handwriting`
-   directory, four .gz files are present and the four data sets were created:
-   `trainX`, `trainY`, `testX` and `testY`.
-
-#. To inspect the imported data, the function in :guilabel:`In [3]` first
-   instructs Jupyter to reshape the data into an array of 28 x 28 images and to
-   plot the area in a 28 x 28 grid. Click the |run-cell| button twice to show
-   the first two digits in the `trainX` dataset, see figure 5.
-
-   .. figure:: figures/machine-learning-5.png
-      :alt: Function to reshape data.
-
-      Figure 5: A function reshapes the data and displays the first two
-      digits in the `trainX` dataset.
-
-#. The :guilabel:`In [4]` cell defines the neural network. It provides the
-   inputs, defines the hidden layers, runs the training model, and sets up
-   the output layer, see figure 6. Click the |run-cell| button four times to
-   perform these operations.
-
-   .. figure:: figures/machine-learning-6.png
-      :alt: Defining, building and training the neural network model
-
-      Figure 6: Defining, building and training the neural network model.
-
-#. To test the accuracy of the prediction the system makes, select the
-   :guilabel:`In [8]` cell and click the |run-cell| button. In this example,
-   the number 6 was predicted with a 99% accuracy, see figure 7.
-
-   .. figure:: figures/machine-learning-7.png
-      :alt: Prediction example
-
-      Figure 7: The system predicts a number providing the accuracy of the
-      prediction.
-
-   .. note::
-
-      To retest the accuracy of a random data point's prediction, run the
-      cell :guilabel:`In [8]` again. It will take another random data point
-      and predict its value.
-
-#. To check the accuracy for the whole dataset, select the :guilabel:`In [10]`
-   cell and click the |run-cell| button. Our example's accuracy is
-   calculated as 97.17%, see figure 8.
-
-   .. figure:: figures/machine-learning-8.png
-      :alt: System's accuracy
-
-      Figure 8: The system's accuracy for the entire data set.
-
-For more in-depth information on the model used and the mathematics it entails,
-visit the TensorFlow tutorials
-`TensorFlow MNIST beginners demo`_ and `TensorFlow MNIST pros demo`_.
-
-**Congratulations!**
-
-You have successfully installed a Jupyter kernel on |CL|. In addition, you
-trained a neural network to successfully predict the values contained in a
-data set of hand-written number images.
-
-Related topics
-**************
-
-* `MNIST Database website`_
-* `TensorFlow MNIST beginners demo`_
-* `TensorFlow MNIST pros demo`_
-* `Jupyter main website`_
-* `Jupyter documentation`_
-* `MNIST at Wikipedia`_
-
-.. _MNIST Database website:
-   http://yann.lecun.com/exdb/mnist/
-
-.. _train-images-idx3-ubyte.gz:
-   http://yann.lecun.com/exdb/mnist/train-images-idx3-ubyte.gz
-
-.. _train-labels-idx1-ubyte.gz:
-   http://yann.lecun.com/exdb/mnist/train-labels-idx1-ubyte.gz
-
-.. _t10k-images-idx3-ubyte.gz:
-   http://yann.lecun.com/exdb/mnist/t10k-images-idx3-ubyte.gz
-
-.. _t10k-labels-idx1-ubyte.gz:
-   http://yann.lecun.com/exdb/mnist/t10k-labels-idx1-ubyte.gz
-
-.. _Jupyter main website: http://jupyter.org/
-
-.. _Jupyter documentation:  https://jupyter.readthedocs.io/en/latest/index.html
-
-.. _TensorFlow MNIST beginners demo:
-   https://www.tensorflow.org/get_started/mnist/beginners
-
-.. _TensorFlow MNIST pros demo:
-   https://www.tensorflow.org/get_started/mnist/pros
-
-.. _MNIST at Wikipedia:
-   https://en.wikipedia.org/wiki/MNIST_database
-
-.. |run-cell| image::  ./figures/run-cell-button.png

_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/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

_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;
-}
-
-