archive repository

Merge pull request #1278 from clearlinux/bashtoni
Fix KVM instructions for zsh users
2026-09-06 05:41:44 +00:00 · 2025-08-07 13:27:57 -07:00 · 2024-11-04 10:47:21 -08:00 · 2024-11-04 10:45:13 -08:00 · 2024-11-04 10:39:49 -08:00 · 2024-11-04 10:39:09 -08:00
1439 changed files with 37392 additions and 310168 deletions
@@ -1,4 +0,0 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
 config: f8974e043de468370d3f73767671d8de
 tags: 645f666f9bcd5a90fca523b33c5a78b7
@@ -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.
@@ -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.
@@ -0,0 +1,24 @@
 name: Check
 on: [pull_request]
 jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Install dependencies
      run: |
        export PATH="$HOME/.local/bin:$PATH"
        sudo apt-get install -y python3-setuptools pandoc
        pip3 install --user -r requirements.txt
    - name: Build the docs
      run: |
        export PATH="$HOME/.local/bin:$PATH"
        make py
        make man
        make htmlall
@@ -0,0 +1,13 @@
 name: Greetings
 on: [pull_request, issues]
 jobs:
  greeting:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/first-interaction@v1
      with:
        repo-token: ${{ secrets.GITHUB_TOKEN }}
        issue-message: 'Welcome to Clear Linux* OS Docs. Thanks for submitting your first issue.'
        pr-message: 'Welcome to Clear Linux* OS Docs. Thanks for submitting your first PR.'
@@ -0,0 +1,22 @@
 name: Linkcheck
 on:
  schedule:
    - cron: '0 0 * * Mon,Wed,Fri'
 jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Install dependencies
      run: |
        export PATH="$HOME/.local/bin:$PATH"
        sudo apt-get install -y python3-setuptools
        pip3 install --user -r requirements.txt
    - name: CheckLinks
      run: |
        export PATH="$HOME/.local/bin:$PATH"
        make linkcheck
@@ -0,0 +1,40 @@
 name: CI
 on:
  push:
    branches:
        - master
 jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Install dependencies
      run: |
        export PATH="$HOME/.local/bin:$PATH"
        sudo apt-get install -y python3-setuptools pandoc
        pip3 install --user -r requirements.txt
    - name: Build the docs
      run: |
        export PATH="$HOME/.local/bin:$PATH"
        make py
        make man
        make htmlall
    - name: Pre-deploy
      run: |
        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
        mv source/_build/html $HOME/output
    - name: Deploy the docs
      run: |
        cd $HOME/output
        git init
        git config --global user.name "${GITHUB_ACTOR}"
        git config --global user.email "${GITHUB_ACTOR}@github.com"
        git add .
        git commit -m "latest html output"
        git push -f https://${GITHUB_ACTOR}:${{secrets.ACCESS_TOKEN}}@github.com/clearlinux/clear-linux-documentation.git HEAD:developmentHTML
@@ -0,0 +1,41 @@
 name: Publish
 on:
  push:
    branches:
        - publish
 jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Install dependencies
      run: |
        export PATH="$HOME/.local/bin:$PATH"
        sudo apt-get install -y python3-setuptools pandoc
        pip3 install --user -r requirements.txt
    - name: Build the docs
      run: |
        export PATH="$HOME/.local/bin:$PATH"
        make py
        make man
        make htmlall
    - name: Pre-deploy
      run: |
        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
        touch source/_build/html/.nojekyll
        mv source/_build/html $HOME/output
    - name: Deploy and publish docs
      run: |
        cd $HOME/output
        git init
        git config --global user.name "${GITHUB_ACTOR}"
        git config --global user.email "${GITHUB_ACTOR}@github.com"
        git add .
        git commit -m "latest html output"
        git push -f https://${GITHUB_ACTOR}:${{secrets.ACCESS_TOKEN}}@github.com/clearlinux/clear-linux-documentation.git HEAD:latestHTML
@@ -0,0 +1,29 @@
 #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
 #ignore for reDocs GUI
 .tox
 MANIFEST
 # ignore artifacts of man page generation
 source/_scripts/_python/manpages/*.rst
 source/reference/manpages
 source/_scripts/_python/manpages/*/
 source/reference/man-pages.rst
@@ -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
@@ -1,405 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>FAQ &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/FAQ/index.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Contribute" href="../collaboration/collaboration.html" />
    <link rel="prev" title="Tutorial difficulty ratings" href="../reference/tutorial-ratings.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../collaboration/collaboration.html" title="Contribute"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../reference/tutorial-ratings.html" title="Tutorial difficulty ratings"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">FAQ</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="faq">
 <span id="id1"></span><h1>FAQ<a class="headerlink" href="#faq" title="Link to this heading">¶</a></h1>
 <p>Below is a list of commonly asked questions with answers sourced from the
 Clear Linux* OS team and <a class="reference external" href="https://community.clearlinux.org">Clear Linux community forums</a>.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#general" id="id2">General</a></p>
 <ul>
 <li><p><a class="reference internal" href="#what-is-cl" id="id3">What is Clear Linux OS?</a></p></li>
 <li><p><a class="reference internal" href="#why-another-linux-distribution" id="id4">Why another Linux distribution?</a></p></li>
 <li><p><a class="reference internal" href="#is-it-a-derivative-of-another-linux-distribution" id="id5">Is it a derivative of another Linux distribution?</a></p></li>
 <li><p><a class="reference internal" href="#can-others-copy-improvements-from-cl" id="id6">Can others copy improvements from Clear Linux OS?</a></p></li>
 <li><p><a class="reference internal" href="#how-often-does-it-update" id="id7">How often does it update?</a></p></li>
 <li><p><a class="reference internal" href="#is-telemetry-required" id="id8">Is telemetry required?</a></p></li>
 <li><p><a class="reference internal" href="#what-is-the-default-firewall" id="id9">What is the default firewall?</a></p></li>
 <li><p><a class="reference internal" href="#where-are-the-files-that-i-usually-see-under-etc-like-fstab" id="id10">Where are the files that I usually see under /etc like fstab?</a></p></li>
 <li><p><a class="reference internal" href="#does-it-use-the-intel-compiler-icc" id="id11">Does it use the Intel Compiler (icc)?</a></p></li>
 </ul>
 </li>
 <li><p><a class="reference internal" href="#software" id="id12">Software</a></p>
 <ul>
 <li><p><a class="reference internal" href="#how-is-software-installed-and-updated" id="id13">How is software installed and updated?</a></p></li>
 <li><p><a class="reference internal" href="#does-it-use-rpms-or-debs-packages-like-other-distros" id="id14">Does it use RPMs or DEBs packages like other distros?</a></p></li>
 <li><p><a class="reference internal" href="#why-does-it-have-a-different-approach-to-software-management" id="id15">Why does it have a different approach to software management?</a></p></li>
 <li><p><a class="reference internal" href="#can-i-install-a-software-package-from-another-os-on-cl" id="id16">Can I install a software package from another OS on Clear Linux OS?</a></p></li>
 </ul>
 </li>
 <li><p><a class="reference internal" href="#software-availability" id="id17">Software availability</a></p>
 <ul>
 <li><p><a class="reference internal" href="#what-software-is-available-on-cl" id="id18">What software is available on Clear Linux OS?</a></p></li>
 <li><p><a class="reference internal" href="#is-google-chrome-available" id="id19">Is Google* Chrome* available?</a></p></li>
 <li><p><a class="reference internal" href="#is-microsoft-visual-studio-code-available" id="id20">Is Microsoft* Visual Studio Code* available?</a></p></li>
 <li><p><a class="reference internal" href="#is-ffmpeg-available" id="id21">Is FFmpeg available?</a></p></li>
 <li><p><a class="reference internal" href="#is-zfs-available" id="id22">Is ZFS* available?</a></p></li>
 <li><p><a class="reference internal" href="#can-you-add-a-driver-that-i-need" id="id23">Can you add a driver that I need?</a></p></li>
 </ul>
 </li>
 </ul>
 </nav>
 <section id="general">
 <h2><a class="toc-backref" href="#id2" role="doc-backlink">General</a><a class="headerlink" href="#general" title="Link to this heading">¶</a></h2>
 <section id="what-is-cl">
 <h3><a class="toc-backref" href="#id3" role="doc-backlink">What is Clear Linux OS?</a><a class="headerlink" href="#what-is-cl" title="Link to this heading">¶</a></h3>
 <p>Clear Linux OS is an open source, rolling release Linux distribution optimized for
 performance and security. See <a class="reference external" href="https://clearlinux.org/about">the about page</a>
 for more information.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="why-another-linux-distribution">
 <h3><a class="toc-backref" href="#id4" role="doc-backlink">Why another Linux distribution?</a><a class="headerlink" href="#why-another-linux-distribution" title="Link to this heading">¶</a></h3>
 <p>The Clear Linux OS team felt that performance was left on the table with Linux software.
 Clear Linux OS takes a holistic approach to improve performance across the stack. We
 also wanted to take more modern approaches with OS updates and tooling.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="is-it-a-derivative-of-another-linux-distribution">
 <h3><a class="toc-backref" href="#id5" role="doc-backlink">Is it a derivative of another Linux distribution?</a><a class="headerlink" href="#is-it-a-derivative-of-another-linux-distribution" title="Link to this heading">¶</a></h3>
 <p>No. Clear Linux OS is a new Linux distribution. It is not a fork and does not have a
 parent Linux distribution.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="can-others-copy-improvements-from-cl">
 <h3><a class="toc-backref" href="#id6" role="doc-backlink">Can others copy improvements from Clear Linux OS?</a><a class="headerlink" href="#can-others-copy-improvements-from-cl" title="Link to this heading">¶</a></h3>
 <p>Yes, we absolutely love open source reuse and upstreaming improvements.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="how-often-does-it-update">
 <h3><a class="toc-backref" href="#id7" role="doc-backlink">How often does it update?</a><a class="headerlink" href="#how-often-does-it-update" title="Link to this heading">¶</a></h3>
 <p>The Clear Linux OS team puts out multiple releases a week, often releasing two or more
 times a day. This rolling release approach allows Clear Linux OS to remain agile to
 upstream changes and security patches.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="is-telemetry-required">
 <h3><a class="toc-backref" href="#id8" role="doc-backlink">Is telemetry required?</a><a class="headerlink" href="#is-telemetry-required" title="Link to this heading">¶</a></h3>
 <p>The telemetry solution provided by Clear Linux OS is entirely optional and customizable.
 It is disabled by default. If you do choose to enable telemetry, the data
 helps the Clear Linux OS team proactively identify and resolve bugs. See the
 <a class="reference internal" href="../guides/clear/telemetrics.html#telem-guide"><span class="std std-ref">telemetry</span></a> guide for more information.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="what-is-the-default-firewall">
 <h3><a class="toc-backref" href="#id9" role="doc-backlink">What is the default firewall?</a><a class="headerlink" href="#what-is-the-default-firewall" title="Link to this heading">¶</a></h3>
 <p>Clear Linux OS packages <strong class="command">iptables</strong> and <strong class="command">firewalld</strong> as optional
 bundles, however, there are no default firewall rules. All network traffic is
 allowed by default.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="where-are-the-files-that-i-usually-see-under-etc-like-fstab">
 <h3><a class="toc-backref" href="#id10" role="doc-backlink">Where are the files that I usually see under /etc like fstab?</a><a class="headerlink" href="#where-are-the-files-that-i-usually-see-under-etc-like-fstab" title="Link to this heading">¶</a></h3>
 <p>Clear Linux OS has a stateless design that maintains a separation between system files
 and user files. Default values are stored under <code class="file docutils literal notranslate"><span class="pre">/usr/share/defaults/</span></code>.
 Clear Linux OS starts with a mostly empty <code class="file docutils literal notranslate"><span class="pre">/etc</span></code> directory to store user-defined
 configurations. See the <a class="reference internal" href="../guides/clear/stateless.html#stateless"><span class="std std-ref">stateless</span></a> page for more information.</p>
 <p>See <a class="reference external" href="https://clearlinux.org/news-blogs/where-etcfstab-clear-linux">this blog post</a> for an
 example explaining how this is accomplished with <code class="file docutils literal notranslate"><span class="pre">/etc/fstab/</span></code>
 specifically.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="does-it-use-the-intel-compiler-icc">
 <h3><a class="toc-backref" href="#id11" role="doc-backlink">Does it use the Intel Compiler (icc)?</a><a class="headerlink" href="#does-it-use-the-intel-compiler-icc" title="Link to this heading">¶</a></h3>
 <p>No. Clear Linux OS uses open source compilers: <strong class="command">gcc</strong> and <strong class="command">clang</strong>. Clear Linux OS
 does not compile any packages with <strong class="command">icc</strong>.</p>
 <p>For a more detailed explanation, see <a class="reference external" href="https://community.clearlinux.org/t/does-clear-linux-os-use-the-intel-compiler-icc-tl-nope/">this discussion on the community forum</a>.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 </section>
 <section id="software">
 <h2><a class="toc-backref" href="#id12" role="doc-backlink">Software</a><a class="headerlink" href="#software" title="Link to this heading">¶</a></h2>
 <section id="how-is-software-installed-and-updated">
 <h3><a class="toc-backref" href="#id13" role="doc-backlink">How is software installed and updated?</a><a class="headerlink" href="#how-is-software-installed-and-updated" title="Link to this heading">¶</a></h3>
 <p>Clear Linux OS provides software in the form of <a class="reference internal" href="../guides/clear/bundles.html#bundles-guide"><span class="std std-ref">bundles</span></a> and
 updates software with <a class="reference internal" href="../guides/clear/swupd.html#swupd-guide"><span class="std std-ref">swupd</span></a>.</p>
 <p><a class="reference internal" href="../tutorials/flatpak.html#flatpak-tutorial"><span class="std std-ref">Flatpak*</span></a> is an application virtualization solution
 that allows more software to be available to Clear Linux OS users by augmenting the
 software Clear Linux OS packages natively with software available through Flatpak.</p>
 <p>Our goal is to have software packaged natively and made available through
 bundles whenever possible.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="does-it-use-rpms-or-debs-packages-like-other-distros">
 <h3><a class="toc-backref" href="#id14" role="doc-backlink">Does it use RPMs or DEBs packages like other distros?</a><a class="headerlink" href="#does-it-use-rpms-or-debs-packages-like-other-distros" title="Link to this heading">¶</a></h3>
 <p>No. Clear Linux OS provides software to systems in the form of <a class="reference internal" href="../guides/clear/bundles.html#bundles-guide"><span class="std std-ref">Bundles</span></a>.
 Under the hood, Clear Linux OS developers use the RPM format as an intermediary step for
 packaging and determining software dependencies at OS build time.</p>
 <p>Individual RPMs and DEBs can sometimes be manually extracted and installed on
 a Clear Linux OS system with the right tools, but that is not the intended use case.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="why-does-it-have-a-different-approach-to-software-management">
 <h3><a class="toc-backref" href="#id15" role="doc-backlink">Why does it have a different approach to software management?</a><a class="headerlink" href="#why-does-it-have-a-different-approach-to-software-management" title="Link to this heading">¶</a></h3>
 <p>The Clear Linux OS team wants software <em>installation</em> and <em>updates</em> to be as efficient
 and error free as possible. Clear Linux OS packages software differently and uses a
 novel updater to solve some of the classic problems with how the software
 packages are on Linux.</p>
 <p>For a more detailed explanation, see <a class="reference external" href="https://community.clearlinux.org/t/why-does-clearlinux-use-swupd-and-not-apt-deb-rpm/">this discussion on our community forum</a>.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="can-i-install-a-software-package-from-another-os-on-cl">
 <h3><a class="toc-backref" href="#id16" role="doc-backlink">Can I install a software package from another OS on Clear Linux OS?</a><a class="headerlink" href="#can-i-install-a-software-package-from-another-os-on-cl" title="Link to this heading">¶</a></h3>
 <p>Software that is packaged in other formats for other Linux distributions is
 not guaranteed to work on Clear Linux OS and may be impacted by Clear Linux OS updates.</p>
 <p>If the software you’re seeking is open source, please submit a request to add
 it to Clear Linux OS. Submit requests on GitHub* here:
 <a class="reference external" href="https://github.com/clearlinux/distribution/issues">https://github.com/clearlinux/distribution/issues</a></p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 </section>
 <section id="software-availability">
 <h2><a class="toc-backref" href="#id17" role="doc-backlink">Software availability</a><a class="headerlink" href="#software-availability" title="Link to this heading">¶</a></h2>
 <section id="what-software-is-available-on-cl">
 <h3><a class="toc-backref" href="#id18" role="doc-backlink">What software is available on Clear Linux OS?</a><a class="headerlink" href="#what-software-is-available-on-cl" title="Link to this heading">¶</a></h3>
 <p>Available software can be found in the <a class="reference external" href="https://clearlinux.org/software">Software Store</a>, through the GNOME*
 Software application on the desktop, or by using <a class="reference internal" href="../guides/clear/swupd.html#swupd-quick-ref"><span class="std std-ref">swupd search</span></a>.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="is-google-chrome-available">
 <h3><a class="toc-backref" href="#id19" role="doc-backlink">Is Google* Chrome* available?</a><a class="headerlink" href="#is-google-chrome-available" title="Link to this heading">¶</a></h3>
 <p>The Google Chrome web browser is not distributed as a bundle in Clear Linux OS due to
 copyright and licensing complexities.</p>
 <p>A <a class="reference external" href="https://github.com/clearlinux/distribution/issues/422">discussion on manually installing and maintaining Google Chrome</a> can be found on
 GitHub.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="is-microsoft-visual-studio-code-available">
 <h3><a class="toc-backref" href="#id20" role="doc-backlink">Is Microsoft* Visual Studio Code* available?</a><a class="headerlink" href="#is-microsoft-visual-studio-code-available" title="Link to this heading">¶</a></h3>
 <p>Yes. Find the CLI command for installing <a class="reference external" href="https://clearlinux.org/software?search_api_fulltext=vscode">VS Code</a> and other Flatpak apps in
 the <a class="reference external" href="https://clearlinux.org/software">software store</a>. Installing Flatpak apps is also covered in our
 <a class="reference internal" href="../tutorials/flatpak.html#flatpak-tutorial"><span class="std std-ref">tutorial</span></a>.</p>
 <p>The Clear Linux OS team is working on a natively packaged version of Visual Studio Code
 for future release.</p>
 <p>Join a community <a class="reference external" href="https://community.clearlinux.org/t/need-native-support-for-vs-code-through-swupd/">forum discussion about manually installing and maintaining
 Visual Studio Code</a>.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="is-ffmpeg-available">
 <span id="licensing-restrict"></span><h3><a class="toc-backref" href="#id21" role="doc-backlink">Is FFmpeg available?</a><a class="headerlink" href="#is-ffmpeg-available" title="Link to this heading">¶</a></h3>
 <p><a class="reference external" href="https://ffmpeg.org/">FFmpeg</a> is a multimedia software suite, which is commonly used for
 various media encoding/decoding, streaming, and playback.</p>
 <p>Clear Linux OS does not distribute FFmpeg due to well-known licensing and legal
 complexities (See <a class="reference external" href="https://www.ffmpeg.org/legal.html">https://www.ffmpeg.org/legal.html</a> and
 <a class="reference external" href="http://blog.pkh.me/p/13-the-ffmpeg-libav-situation.html">http://blog.pkh.me/p/13-the-ffmpeg-libav-situation.html</a>).</p>
 <p>While Clear Linux OS cannot distribute FFmpeg, solutions for manually building and
 installing FFmpeg have been shared by users <a class="reference external" href="https://github.com/clearlinux/distribution/issues/429">on GitHub</a> and <a class="reference external" href="https://community.clearlinux.org/t/how-to-h264-etc-support-for-firefox-including-ffmpeg-install">the community
 forums</a>.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="is-zfs-available">
 <h3><a class="toc-backref" href="#id22" role="doc-backlink">Is ZFS* available?</a><a class="headerlink" href="#is-zfs-available" title="Link to this heading">¶</a></h3>
 <p>ZFS is not available with Clear Linux OS because of copyright and licensing
 complexities. BTRFS is an alternative filesystem that is available in Clear Linux OS
 natively.</p>
 <p>A community contributed tutorial has been shared on how to <a class="reference internal" href="../tutorials/zfs.html#zfs"><span class="std std-ref">manually
 install ZFS</span></a>.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 <section id="can-you-add-a-driver-that-i-need">
 <h3><a class="toc-backref" href="#id23" role="doc-backlink">Can you add a driver that I need?</a><a class="headerlink" href="#can-you-add-a-driver-that-i-need" title="Link to this heading">¶</a></h3>
 <p>If a kernel module is available as part of the Linux kernel source tree but
 not enabled in the Clear Linux OS kernels, in many cases the Clear Linux OS team will enable it
 upon request. Submit requests on GitHub here:
 <a class="reference external" href="https://github.com/clearlinux/distribution/issues">https://github.com/clearlinux/distribution/issues</a></p>
 <p>The Clear Linux OS team does not typically add out-of-tree kernel modules as a matter of
 practice because of the maintenance overhead. If the driver was unable to be
 merged upstream, there is a good chance we may be unable to merge it for
 similar reasons.</p>
 <p>Kernel modules can be individually built and installed on Clear Linux OS. See the
 <a class="reference internal" href="../guides/kernel/kernel-modules.html#kernel-modules"><span class="std std-ref">kernel modules</span></a> page for more information.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </section>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">FAQ</a><ul>
 <li><a class="reference internal" href="#general">General</a><ul>
 <li><a class="reference internal" href="#what-is-cl">What is Clear Linux OS?</a></li>
 <li><a class="reference internal" href="#why-another-linux-distribution">Why another Linux distribution?</a></li>
 <li><a class="reference internal" href="#is-it-a-derivative-of-another-linux-distribution">Is it a derivative of another Linux distribution?</a></li>
 <li><a class="reference internal" href="#can-others-copy-improvements-from-cl">Can others copy improvements from Clear Linux OS?</a></li>
 <li><a class="reference internal" href="#how-often-does-it-update">How often does it update?</a></li>
 <li><a class="reference internal" href="#is-telemetry-required">Is telemetry required?</a></li>
 <li><a class="reference internal" href="#what-is-the-default-firewall">What is the default firewall?</a></li>
 <li><a class="reference internal" href="#where-are-the-files-that-i-usually-see-under-etc-like-fstab">Where are the files that I usually see under /etc like fstab?</a></li>
 <li><a class="reference internal" href="#does-it-use-the-intel-compiler-icc">Does it use the Intel Compiler (icc)?</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#software">Software</a><ul>
 <li><a class="reference internal" href="#how-is-software-installed-and-updated">How is software installed and updated?</a></li>
 <li><a class="reference internal" href="#does-it-use-rpms-or-debs-packages-like-other-distros">Does it use RPMs or DEBs packages like other distros?</a></li>
 <li><a class="reference internal" href="#why-does-it-have-a-different-approach-to-software-management">Why does it have a different approach to software management?</a></li>
 <li><a class="reference internal" href="#can-i-install-a-software-package-from-another-os-on-cl">Can I install a software package from another OS on Clear Linux OS?</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#software-availability">Software availability</a><ul>
 <li><a class="reference internal" href="#what-software-is-available-on-cl">What software is available on Clear Linux OS?</a></li>
 <li><a class="reference internal" href="#is-google-chrome-available">Is Google* Chrome* available?</a></li>
 <li><a class="reference internal" href="#is-microsoft-visual-studio-code-available">Is Microsoft* Visual Studio Code* available?</a></li>
 <li><a class="reference internal" href="#is-ffmpeg-available">Is FFmpeg available?</a></li>
 <li><a class="reference internal" href="#is-zfs-available">Is ZFS* available?</a></li>
 <li><a class="reference internal" href="#can-you-add-a-driver-that-i-need">Can you add a driver that I need?</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="../reference/tutorial-ratings.html"
                          title="previous chapter">Tutorial difficulty ratings</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="../collaboration/collaboration.html"
                          title="next chapter">Contribute</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/FAQ/index.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../collaboration/collaboration.html" title="Contribute"
             >next</a> |</li>
        <li class="right" >
          <a href="../reference/tutorial-ratings.html" title="Tutorial difficulty ratings"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">FAQ</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -0,0 +1,45 @@
 # 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
 man:
 	$(MAKE) -C source man
 clean-man:
 	$(MAKE) -C source clean-man
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  html       to make standalone HTML files"
 clean:
 	$(MAKE) -C source clean
 	rm -rf venv
 venv:
 	virtualenv venv;\
 	source venv/bin/activate; \
 	pip3 install -r requirements.txt;
@@ -0,0 +1,7 @@
 ## DISCONTINUATION OF PROJECT. 
 This project will no longer be maintained by Intel. 
 Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.
 Contact: webadmin@linux.intel.com  
@@ -0,0 +1,192 @@
 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.
 This build will generate several warnings as there are two other optional make commands required to build the full documentation.
 1. ``make py`` to generate the bundle reference material.
 2. ``make man`` to generate man page reference material.
 To build the documentation exactly as seen on the website, use
 ``make man``, ``make py``, and ``make htmlall``. This builds both
 external dependencies and all supported languages.
 Use virtualenv 
 **************
 To develop documentation in a ``virtualenv``, use the ``venv`` target.
 The Clear Linux OS documentation make target ``venv`` provides a 
 simple development environment that ensures that you have the 
 latest packages and that you manage Python versions separately. Use of the 
 ``virtualenv`` requires **Python 3.6** or higher. For Windows examples below, use Powershell as an Administrator.
 The **virtual environment** uses the same version of Python that was used to **create the virtual environment**. 
 Verify ``pip`` is installed. A file path to pip should appear. 
 On Clear Linux OS and macOS\*:
 .. code-block:: bash
   which pip
 On Windows\* 10 OS: 
 .. code-block:: bash
   pip --version
 If ``pip`` is not installed, install it. 
 On Clear Linux OS and macOS:
 .. code-block:: bash
   python3 -m pip install --user --upgrade pip
 On Windows 10 OS: 
 .. code-block:: bash
   py -m pip install --upgrade pip
 .. note::
   This assumes Python was already added to your Windows path. 
 Install virtualenv 
 ==================
 Install ``virtualenv``. 
 On Clear Linux OS and macOS\*:
 .. code-block:: bash
   python3 -m pip install --user virtualenv
 On Windows 10 OS: 
 .. code-block:: bash
   py -m pip install --user virtualenv
 Create the ``virtualenv`` and install the required packages: 
 .. code-block:: bash
   make venv
 Activate the ``venv``. 
 .. code-block:: bash
   source venv/bin/activate
 Follow `Run the build`_ section to start developing documentation.
 Remove the ``venv`` when finished developing.  
 .. code-block:: bash
   deactivate
 Additional help
 ***************
 Cleaning up
 ===========
 When testing changes in the documentation, make sure to remove the previous
 build before building again by running ``make clean``:
 .. code-block:: bash
   make clean
 This will completely remove the previous build output, including artifacts 
 from the `make venv` target when done outside an active venv.
 Before running ``make man``, please run ``make clean-man`` to clear out any
 previous attempts.
 Convenience script
 ==================
 This bash script (Linux only) includes both ``make clean`` and
 ``make html``. It also starts a simple Python web server that
 displays a preview of the site at http://localhost:8000 on your local machine.
 .. code-block:: bash
   ./checkwork.sh
 To stop the web server simply use ``ctrl-c``.
 .. _Clear Linux\* OS documentation:  https://docs.01.org/clearlinux/
 .. _Sphinx: http://sphinx-doc.org/
 .. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
 .. _contribution guidelines: https://docs.01.org/clearlinux/latest/collaboration/collaboration.html
 .. _instructions for installing Sphinx: https://www.sphinx-doc.org/en/master/usage/installation.html
@@ -1,95 +0,0 @@
 .. _man-pages:
 Man pages
 #########
 These pages are generated from `Clear Linux\* tool
 repositories <https://github.com/clearlinux>`__. Updated |today|.
 `clr-man-pages <https://github.com/clearlinux/clr-man-pages>`__
 ===============================================================
 .. toctree::
   :maxdepth: 1
   manpages/stateless.7.rst
   manpages/os-core.7.rst
   manpages/os-format.7.rst
 `clr-power-tweaks <https://github.com/clearlinux/clr-power-tweaks>`__
 =====================================================================
 .. toctree::
   :maxdepth: 1
   manpages/clr-power-tweaks.conf.5.rst
   manpages/clr_power.1.rst
 `clrtrust <https://github.com/clearlinux/clrtrust>`__
 =====================================================
 .. toctree::
   :maxdepth: 1
   manpages/clrtrust.1.rst
 `micro-config-drive <https://github.com/clearlinux/micro-config-drive>`__
 =========================================================================
 .. toctree::
   :maxdepth: 1
   manpages/ucd.1.rst
   manpages/cloud-config.5.rst
   manpages/ucd-data-fetch.1.rst
 `mixer-tools <https://github.com/clearlinux/mixer-tools>`__
 ===========================================================
 .. toctree::
   :maxdepth: 1
   manpages/mixer.bundle.1.rst
   manpages/mixer.build.1.rst
   manpages/mixer.add-rpms.1.rst
   manpages/mixer.1.rst
   manpages/mixer.repo.1.rst
   manpages/mixer.versions.1.rst
   manpages/mixer.init.1.rst
   manpages/mixer.config.1.rst
 `swupd-client <https://github.com/clearlinux/swupd-client>`__
 =============================================================
 .. toctree::
   :maxdepth: 1
   manpages/swupd-update.service.4.rst
   manpages/update-triggers.target.4.rst
   manpages/swupd.1.rst
   manpages/swupd-update.timer.4.rst
 `tallow <https://github.com/clearlinux/tallow>`__
 =================================================
 .. toctree::
   :maxdepth: 1
   manpages/tallow.1.rst
   manpages/tallow.conf.5.rst
   manpages/tallow.patterns.5.rst
 `telemetrics-client <https://github.com/clearlinux/telemetrics-client>`__
 =========================================================================
 .. toctree::
   :maxdepth: 1
   manpages/telemetrics.conf.5.rst
   manpages/telem-record-gen.1.rst
   manpages/telempostd.1.rst
   manpages/telemprobd.1.rst
   manpages/telemctl.1.rst
   manpages/telemetry.3.rst
@@ -1,273 +0,0 @@
 cloud-config
 ============
 `cloud-config(5) <cloud-config.5.html>`__ – User data format used by `ucd(1) <ucd.1.html>`__
 SYNOPSIS
 --------
 ``user-data``
 ``#cloud-config``
 cloud-config data is provided by the cloud infrastructure to a cloud
 instance. This data is parsed by ``cloud-init(1)`` which then configures
 the cloud instance based on the information in the cloud-config.
 DESCRIPTION
 -----------
 The user-data as provided can be of several formats. ``cloud-init(1)``
 supports the ``cloud-config`` format, but also supports generic shell
 scripts. If the user-data starts with ``#!``, it is assumed that the
 user-data is a generic shell script, and ``cloud-init`` will attempt to
 execute the data as a script. If the user-data starts with the
 ``#cloud-config`` stanza, it is assumed the user-data is in the
 ``cloud-config`` format, described below.
 The ``cloud-config`` format is used to structure configuration data
 provided to the cloud instance. This data is structured in the YAML
 format (``http://yaml.org``). Note that ``cloud-init``\ (1) uses the
 libyaml library, which supports YAML version 1.1.
 In the YAML content, the root node (the document) contains a sequence of
 directives. These directives inform cloud-init that the content of the
 directive are processed by a directive-specific handler, or “module”.
 cloud-init includes many modules, each expecting a specifically
 constructed content. This document lists the correct format and
 organization of each data section for the supported modules, describes
 their effect, and states various parameters for each option.
 Table of implemented directives. Column 3 (“Ref”) and column 4
 (“CoreOS”) list whether the reference specification or the CoreOS
 implementation support these directives. Note that implementation
 details may differ, due to the underlying differences in Operating
 Systems.
 ::
   Directive           |Description                          |Ref. |CoreOS.
   --------------------|-------------------------------------|-----|-------
   groups              |Configure user account groups        |yes  |no
   package_upgrade     |Perform a software update            |yes  |no
   packages            |Install additional software          |yes  |no
   runcmd              |Execute system commands              |yes  |no
   service             |Perform system service configuration |no   |no
   ssh_authorized_keys |Provision SSH public keys            |yes  |yes
   users               |Configure user accounts              |yes  |yes
   write_files         |Write content to arbitrary files     |yes  |yes
   hostname            |Define the system's hostname         |yes  |yes
   envar               |Set environment variables            |no   |no
   bootcmd             |Execute system commands on first boot|no   |no
   wait_for_network    |Halt execution until network is up   |no   |no
 OPTIONS
 -------
 For each of the directives listed in the table above, zero or more
 options may be provided. The list below documents the implemented
 options per directive. The “Type” field values are:
 TYPES
 ~~~~~
 ::
   Type       |Description
   -----------|-------------------------------------------------------------------
   boolean    |Either true, false, yes, no, 0 or 1 (upper case and initial capitol
              |letter versions treated identical)
   string     |A generic string encoded value. Can be multiline or YAML encoded
              |content
   integer    |A string encoded decimal integer value
   octal      |A string encoded octal integer value
   hex        |A string encoded hexadecimal integer value
   []         |if a type is listed with [] appended, it means there may be zero or
              |more values, lists of values or any arbitrary depth of these nested
   *          |Indicates this value isn't a separate key, but directly the
              |associated value of the root node. This is applicable for directives
              |that only have a single configuration parameter,
              |e.g. "package_upgrade"
 groups
 ~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   name      |string[] |no          |Create a new user account group and
             |         |            |place listed user account names in
             |         |            |that group
 package_upgrade
 ~~~~~~~~~~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   *         |boolean  |yes         |Enables or disables whether software
             |         |            |update is performed
 This option implies the ``wait_for_network`` option.
 packages
 ~~~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   name      |string[] |no          |Enables installation of software bundles
 This option implies the ``wait_for_network`` option.
 runcmd
 ~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   *         |string[] |no          |Executes a command, if the item is a list,
             |         |            |the list will be converted to a string
             |         |            |and executed as a command line.
 hostname
 ~~~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   *         |string   |yes         |Defines the system's hostname
 service
 ~~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   start     |string[] |no          |Start units
   stop      |string[] |no          |Stop units
   restart   |string[] |no          |Restart units
   enable    |string[] |no          |Enable units to start automatically
   disable   |string[] |no          |Disable units from starting automatically
   reload    |string[] |no          |Reload service units
   isolate   |string[] |no          |Change target to a new unit
   mask      |string[] |no          |Prevent units from starting
   unmask    |string[] |no          |Remove unit start prevention mask
 ssh_authorized_keys
 ~~~~~~~~~~~~~~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   *         |string[] |no          |Specifies an SSH public key value, as
             |         |            |string. This will be added to the default
             |         |            |user account's SSH configuration
 users
 ~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   *         |[]       |no          |This directive expects a list of user
             |         |            |definitions. Each definition can
             |         |            |additionally specify the following
             |         |            |sub-options:
   name      |string   |yes         |A user account name to be created
   gecos     |string   |no          |A real user name, can be left empty
   homedir   |string   |no          |A home directory path. Default under "/home"
   primary-group|string|no          |A group name.
   groups    |string   |no          |Comma-separated list of group names or
             |         |            |single group name. Specifies additional
             |         |            |groups to put this user account into
   lock-passwd|boolean |no          |Lock the user account
   inactive  |boolean  |no          |Mark the user account as inactive
   passwd    |string   |no          |Password hash for the user account
   no-create-home|boolean|no        |Omits creating a home directory
   no-user-group|boolean|no         |Omits group creating for the account
   no-log-init|boolean |no          |Omits this account from lastlog/faillog
   expiredate|string   |no          |A date at which to expire the password
   ssh-authorized-keys|string[]|no  |Add SSH public keys to ssh configuration
   sudo      |string[] |no          |Add sudoers lines for this account, the account
             |         |            |name is automatically prepended
   system    |boolean  |no          |Make the account a system account
 write_files
 ~~~~~~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   *         |[]       |no          |This directive expects a list of write_files
             |         |            |definitions. Each definition itself contains the
             |         |            |following options:
   content   |string   |yes         |The content to write to a file
   path      |string   |yes         |The full path and filename of the file to
             |         |            |be written out
   owner     |string   |no          |Username and optionally group name, separated
             |         |            |by ":" or ".". Defaults to "root.root"
   permissions|octal   |no          |Octal value describing the file permissions
             |         |            |default value is influenced according to
             |         |            |`umask`
 envar
 ~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   *         |string   |yes         |Add environment variables to /etc/profile.d/cloud-init.sh
             |         |            |and to current cloud-init process
 bootcmd
 ~~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   *         |string[] |no          |Similar to runcmd but bootcmd will run only on first boot
 wait_for_network
 ~~~~~~~~~~~~~~~~
 ::
   Option    |Type     |Required    |Function
   ----------|---------|------------|-----------------------------------
   *         |boolean  |no          |Enable to force waiting for a functional network.
 This option makes the program wait until an active network is detected.
 To prevent waiting, ensure that this option is disabled explicitly
 disabled, before other options are used. This may be needed when using
 the ``packages`` or ``package_upgrade`` options, which imply that this
 option is used.
 COPYRIGHT
 ---------
 -  Copyright (C) 2017 Intel Corporation, License: CC-BY-SA-3.0
 SEE ALSO
 --------
 ``cloud-init``\ (1)
 NOTES
 -----
 Creative Commons Attribution-ShareAlike 3.0 Unported
 -  http://creativecommons.org/licenses/by-sa/3.0/
@@ -1,93 +0,0 @@
 clr-power-tweaks.conf
 =====================
 :Manual section: 5
 SYNOPSIS
 --------
 ``clr-power-tweaks.conf`` is an optional configuration file for the
 `clr_power(1) <clr_power.1.html>`__ utility.
 ``/etc/clr-power-tweaks.conf``
 DESCRIPTION
 -----------
 ``clr-power-tweaks.conf`` is an optional configuration file for the
 `clr_power(1) <clr_power.1.html>`__ utility. The configuration file contains kernel and device
 parameter values used by the `clr_power(1) <clr_power.1.html>`__ utility.
 Configuration parameter values placed in ``clr-power-tweaks.conf`` will
 supersede the built-in defaults configured by `clr_power(1) <clr_power.1.html>`__. New
 parameters can be added to the configuration to supplement the built-in
 values. Built-in parameters can be changed by defining them in
 ``clr-power-tweaks.conf`` with a different value. Parameters can be
 excluded from being modified by `clr_power(1) <clr_power.1.html>`__ by adding them in
 ``clr-power-tweaks.conf`` without a value.
 FILE FORMAT
 -----------
 ``clr-power-tweaks.conf`` uses a key-value pairs to define parameter
 values.
 Each line contains one parameter-value pair, delimited by a space
 character.
 Parameters are paths from the proc(5) filesystem. Parameters paths can
 include glob(n) wildcards to match multiple paths.
 Acceptable values are determined by the parameter being set. Any
 parameter listed in the configuration file without a value will be
 excluded by `clr_power(1) <clr_power.1.html>`__ and the parameter will inherit the kernel’s
 built-in default parameter value.
 EXAMPLES
 --------
 1. ``clr-power-tweaks.conf`` entry to override the default value in
   `clr_power(1) <clr_power.1.html>`__ for CPU governor with **powersave**. All other values
   built-in to `clr_power(1) <clr_power.1.html>`__ would still get applied.
   Note the globbing used with ``*`` to target all CPU cores.
   ::
      /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor powersave
 2. ``clr-power-tweaks.conf`` entry to exclude a parameter causing it to
   use the kernel’s built-in default value (60). All other values
   built-in to `clr_power(1) <clr_power.1.html>`__ would still get applied.
   Note the omission of a value.
   ::
      /proc/sys/vm/swappiness
 3. ``clr-power-tweaks.conf`` entry to add two new parameters to increase
   UDP buffers All other values built-in to `clr_power(1) <clr_power.1.html>`__ would still get
   applied.
   ::
      /proc/sys/net/ipv4/udp_rmem_min 8192
      /proc/sys/net/ipv4/udp_wmem_min 8192
 BUGS
 ----
 The default `clr-power-tweaks.conf(5) <clr-power-tweaks.conf.5.html>`__ aims to have reasonable defaults
 for achieving power and performance efficiency. Default values may not
 be optimal for all systems and environments.
 See GitHub Issues: https://github.com/clearlinux/clr-power-tweaks/issues
 SEE ALSO
 --------
 **clr_power.conf(5)**, **proc(5)**, **sysctl(2)**
 For parameters understood by the kernel, please see
 https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html
@@ -1,73 +0,0 @@
 clr_power
 =========
 :Manual section: 1
 SYNOPSIS
 --------
 ``clr_power`` is a utility to adjust power and performance settings in
 the operating system. It is configurable and can enforce power and
 performance policies.
 **clr_power** [**-d**\ \|\ **–debug**]
 DESCRIPTION
 -----------
 ``clr_power`` adjusts power and performance in the operating system by
 setting runtime kernel and device parameters in the proc(5) filesystem.
 ``clr_power`` operates with built-in default values. Values can be added
 or changed in user-defined `clr-power-tweaks.conf(5) <clr-power-tweaks.conf.5.html>`__ file.
 ``clr_power`` applies settings and immediately exits after it is
 started. It can act as a daemon that enforces settings with the included
 systemd files.
 The program handles server and desktop-like systems differently and will
 set values based on whether a system is a server platform or a desktop
 platform. Most systems will be assumed a server, and if it can’t be
 determined what type of platform the system is, treated as a server
 platform. By default, systems with CPU’s that identify as ``Core(TM)``,
 ``Celeron`` and ``Pentium`` are treated as desktop systems, and systems
 with CPU’s that identify as ``Xeon`` are treated as server systems.
 Tunings applied will vary per system. To see what tunings are applied,
 run the program with the ``--debug`` option.
 OPTIONS
 -------
 ``-d``, ``--debug`` Display debug/verbose output including built-in
 values.
 ``-S``, ``--server`` Treat the system as a server, and apply server
 specific tunings.
 ``-D``, ``--desktop`` Treat the system as a desktop, and apply desktop
 specific tunings
 FILES
 -----
 -  *clr-power.service* systemd service unit that executes **clr_power**.
 -  *clr-power.timer* systemd timer that periodically executes the
   *clr-power.service* to enforce settings.
 -  *clr-power-rfkill.service* systemd service that stops bluetooth
   devices at boot to prevent power drain.
 -  */etc/clr-power-tweaks.conf* Optional user-defined configuration file
   to override or att values. See `clr-power-tweaks.conf(5) <clr-power-tweaks.conf.5.html>`__ for more
   information.
 BUGS
 ----
 See GitHub Issues: https://github.com/clearlinux/clr-power-tweaks/issues
 SEE ALSO
 --------
 `clr-power-tweaks.conf(5) <clr-power-tweaks.conf.5.html>`__, **proc(5)**
@@ -1,185 +0,0 @@
 clrtrust
 ========
 :Manual section: 1
 SYNOPSIS
 --------
 **clrtrust** is a tool for generating and managing a centralized trusted
 certificate store.
 ``clrtrust [-v|--verbose] [-h|--help] [-c|--internal-rehash] <command> [options]``
 DESCRIPTION
 -----------
 A trust store contains a set of X.509 certificates which the operating
 system and applications should consider trustworthy.
 The ``clrtrust`` tool provides a frontend for centralized trust store
 management. It allows for adding (trusting) and removing (distrusting)
 certificate authorities (CAs). It also provides maintenance commands for
 viewing and re-generating the trust store.
 Certificates can be provided by the operating system for out-of-box
 functionality. Certificates can also be provided and modified by
 privileged users.
 It is up to each application to make use of the trust store generated by
 ``clrtrust``.
 OPTIONS
 -------
 ::
   Usage: clrtrust [-v|--verbose] [-h|--help] [-c|--internal-rehash] <command> [options]
       -v | --verbose          Shows more details about execution
       -c | --internal-rehash  Forces use of internal implementation of c_rehash
       -h | --help             Prints this message
       Commands
           generate    generates the trust store
           list        list CAs
           add         add trust to a CA
           remove      remove trust to a CA
           restore     restore trust to previously removed CA
           check       sanity/consistency check of the trust store
   clrtrust <command> --help to get help on specific command.
 **Commands that modify the trust store require root privileges.**
 -  ``clrtrust generate [-f|--force]``
   The ``generate`` command has no arguments and generates a unified
   trust store composed of system-provided and user-provided
   certificates, if any. The optional ``--force`` parameter will
   forcibly generate the trust store, even if it results in an empty
   store. See the FILES section for paths used for trust store
   generation.
 -  ``clrtrust list``
   The ``list`` command has no arguments and outputs a list of trusted
   certificates with the following fields:
   ``id`` uniquely identifies the certificate. It can be used as input
   to other ``clrtrust`` commands such as ``remove`` or ``restore``.
   ``File`` contains the file path of the certificate in the trust
   store.
   ``Authority`` shows the name of the organization that issued the
   certificate. This field is extracted from the certificate file.
   ``Expires`` shows the expiration date of the certificate. This field
   is extracted from the certificate file.
 -  ``clrtust add [<certificateFile> ...] [-f|--force]``
   The ``add`` command takes one or more certificates as required
   argument(s). The certificate is identified by a file path. The
   certificate file(s) must be PEM-encoded with only one certificate per
   file. The optional ``--force`` parameter will forcibly add the
   certificate to the trust store, even if it is not a root CA.
   Adding a root CA to the trust store allows applications using the
   trust store to trust the root CA certificate, trust certificate
   chains issued by the authority, verify the authenticity of peer’s
   certificate, and establish a connection.
 -  ``clrtrust remove [<certificateFile|id> ...]``
   The ``remove`` command takes one or more certificates as required
   argument(s). The certificate is identified by a file path or ``id``.
   The argument can be an ``id`` of the certificate (see the ``list``
   command) or the file path of the certificate.
   Removing a root CA from the trust store distrusts the certificate for
   applications using the trust store. Certificate chains issued by the
   authority will no longer be trusted, authenticity of the peer’s
   certificate will no longer be verified, and a connection will not be
   established.
 -  ``clrtrust check``
   The ``check`` command has no arguments and validate the consistency
   of a previously generated unified trust store.
 EXAMPLES
 --------
 View the list of trusted CAs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ``clrtrust list``
 The command above outputs a list of trusted certificates in the format
 below:
 ::
   id: FA:B7:EE:36:97:26:62:FB:2D:B0:2A:F6:BF:03:FD:E8:7C:4B:2F:9B
   File: /var/cache/ca-certs/anchors/certSIGN_ROOT_CA.crt
   Authority: /C=RO/O=certSIGN/OU=certSIGN ROOT CA
   Expires: Jul  4 17:20:04 2031 GMT
 The certificate can be further inspected using the ``openssl x509``
 command. For example:
 ::
   openssl x509 -in /var/cache/ca-certs/anchors/certSIGN_ROOT_CA.crt -noout -text
 Add (trust) a root CA
 ~~~~~~~~~~~~~~~~~~~~~
 ``clrtrust add ~/PrivateCA.pem``
 The command above will add a root CA certificate located in the
 ``~/PrivateCA.pem`` file. If the certificate file is not in the PEM
 format, use ``openssl x509`` command to convert to PEM first. For
 example:
 ::
   openssl x509 -in PrivateCA.cer -inform der -out PrivateCA.pem -outform pem
 Remove (distrust) a root CA
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ``clrtrust remove ~/PrivateCA.pem``
 The command above will remove a root CA certificate located in the
 ``~/PrivateCA.pem`` file from the trust store and distrust it.
 FILES
 -----
 */var/cache/ca-certs*
 Generated directory of certificates and verification keys. Do not modify
 contents outside of ``clrtrust``.
 */usr/share/ca-certs/*
 Operating-system provided certificates and keys. Do not modify contents
 outside of ``clrtrust``.
 */etc/ca-certs/*
 Generated directory of user-supplied certificates and verification keys.
 Do not modify contents outside of ``clrtrust``.
 BUGS
 ----
 See GitHub Issues: https://github.com/clearlinux/clrtrust/issues
 SEE ALSO
 --------
 **openssl(1)**
@@ -1,149 +0,0 @@
 =====
 mixer
 =====
 ------------------------
 OS software update mixer
 ------------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``mixer [subcommand] <flags>``
 DESCRIPTION
 ===========
 `mixer(1) <mixer.1.html>`__ is a software update generator that uses input RPMs and bundle
 definition files to create update metadata consumable by `swupd(1) <swupd.1.html>`__.
 ``mixer`` operates in a mix workspace using configuration files existing in the
 workspace. The tool allows users to use RPMs from an upstream URL (default
 download.clearlinux.org), provide their own RPMs, and use RPMs from other remote
 repositories to build updates. Users can also define their own local bundle
 definitions as well as use the default bundle definitions from the upstream URL.
 ``mixer`` provides commands to manage local RPMs and bundle definitions and
 configure remote RPM repositories.
 The output of ``mixer`` is a set of manifests readable by ``swupd`` as well as
 all the OS content ``swupd`` needs to perform its update operations. The OS
 content includes all the files in an update as well as zero- and delta-packs for
 improved update performance. The content that ``mixer`` produces is tied to a
 specific format so that ``swupd`` is guaranteed to understand it if the client
 is using the right version of ``swupd``. See `swupd(1) <swupd.1.html>`__ and `os-format(7) <os-format.7.html>`__
 for more details.
 OPTIONS
 =======
 The following options are applicable to most subcommands, and can be
 used to modify the core behavior and resources that ``mixer`` uses.
 -  ``-h, --help``
   Display general help information. If put after a subcommand, it will
   display help specific to that subcommand.
 -  ``--check``
   Check all external dependencies needed by mixer.
 -  ``-v, --version``
   Displays the version information of the ``mixer`` program and exit.
 -  ``--offline``
   Skip caching upstream bundles and work entirely with local bundles.
   Do not reach out over network to perform operations.
 SUBCOMMANDS
 ===========
 ``add-rpms``
    Add RPMs from the configured LOCAL_RPM_DIR to the local dnf repository.
    See `mixer.add-rpms(1) <mixer.add-rpms.1.html>`__ for more details.
 ``build``
    Build various pieces of OS content, including all metadata needed by
    ``swupd`` to perform updates. ``mixer build`` is a complicated tool in
    itself. See `mixer.build(1) <mixer.build.1.html>`__ for more details.
 ``bundle``
    Perform various configuration actions on local and upstream bundles. The
    user can add or remove bundles from their mix, create new bundle definitions,
    or validate local bundle definition files. See `mixer.bundle(1) <mixer.bundle.1.html>`__ for more details.
 ``config``
    Perform configuration related actions, including configuration file
    validation and conversion from deprecated formats. See `mixer.config(1) <mixer.config.1.html>`__
    for more details.
 ``help``
    Print help text for any ``mixer`` subcommand.
 ``init``
    Initialize ``mixer`` configuration and workspace. See `mixer.init(1) <mixer.init.1.html>`__ for
    more details.
 ``repo``
    Add, list, remove, or edit RPM repositories to be used by mixer. This
    subcommand allows users to configure which remote or local repositories
    mixer should use to look for RPMs. See `mixer.repo(1) <mixer.repo.1.html>`__ for more
    information.
 ``versions``
    Manage mix and upstream versions. By itself the command will print the
    current version of mix and upstream, and also report the latest version of
    upstream available. Also allows the user to update mix and upstream
    versions. See `mixer.versions(1) <mixer.versions.1.html>`__ for more details.
 FILES
 =====
 `<mixer/workspace>/builder.conf`
    The mixer configuration file.
 `<mixer/workspace>/.yum-mix.conf`
    The default location for the DNF configuration file.
 EXIT STATUS
 ===========
 On success, 0 is returned. A non-zero return code indicates a failure.
 SEE ALSO
 --------
 * `mixer.add-rpms(1) <mixer.add-rpms.1.html>`__
 * `mixer.build(1) <mixer.build.1.html>`__
 * `mixer.bundle(1) <mixer.bundle.1.html>`__
 * `mixer.config(1) <mixer.config.1.html>`__
 * `mixer.init(1) <mixer.init.1.html>`__
 * `mixer.repo(1) <mixer.repo.1.html>`__
 * `mixer.versions(1) <mixer.versions.1.html>`__
 * `swupd(1) <swupd.1.html>`__
 * `os-format(7) <os-format.7.html>`__
 * https://github.com/clearlinux/mixer-tools
 * https://github.com/clearlinux/swupd-client
 * https://clearlinux.org/documentation/
@@ -1,50 +0,0 @@
 ==============
 mixer.add-rpms
 ==============
 ---------------------
 Add local RPMs to mix
 ---------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``mixer add-rpms [flags]``
 DESCRIPTION
 ===========
 Adds RPMs from the `LOCAL_RPM_DIR` (configured in the `builder.conf`) to the
 local RPM repository to be used in creating a mix.
 OPTIONS
 =======
 In addition to the globally recognized ``mixer`` flags (see `mixer(1) <mixer.1.html>`__ for
 more details), the following options are recognized.
 -  ``-c, --config {path}``
   Optionally tell ``mixer`` to use the configuration file at `path`. Uses the
   default `builder.conf` in the mixer workspace if this option is not provided.
 -  ``-h, --help``
   Display ``add-rpm`` help information and exit.
 EXIT STATUS
 ===========
 On success, 0 is returned. A non-zero return code indicates a failure.
 SEE ALSO
 --------
 * `mixer(1) <mixer.1.html>`__
@@ -1,298 +0,0 @@
 ===========
 mixer.build
 ===========
 -----------------------------------
 Build varioius pieces of OS content
 -----------------------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``mixer build [command] [flags]``
 DESCRIPTION
 ===========
 Builds various pieces of OS content and output update metadata to
 `<mixer/workspace>/update/www/<version>/`. This metadata can be published
 directly to a web-server and consumed by client update systems via the
 `swupd(1) <swupd.1.html>`__ update tool. All steps can be run at once using ``build all`` or
 the steps can be run individually using the subcommands.
 OPTIONS
 =======
 In addition to the globally recognized ``mixer`` flags (see `mixer(1) <mixer.1.html>`__ for
 more details), the following options are recognized across all ``build``
 subcommands.
 -  ``--bundle-workers``
   Number of parallel workers when building bundles, passing 0 or omitting this
   flag defaults the number of workers to the number of CPUs on the system.
 -  ``--delta-workers``
   Number of parallel workers when creating deltas, passing 0 or omitting this
   flag defaults the number of workers to the number of CPUs on the system.
 -  ``--fullfile-workers``
   Number of parallel workers when creating fullfiles, passing 0 or omitting this
   flag defaults the number of workers to the number of CPUs on the system.
 -  ``--skip-format-check``
   Skip check for compatible upstream format when building on top of a new
   upstream.
 -  ``-h, --help``
   Display ``build`` help information and exit.
 SUBCOMMANDS
 ===========
 ``all``
    Build all content for the mix. Implicitly runs ``build bundles`` followed by
    ``build update``. In addition to the global options ``mixer build all``
    takes the following options.
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``--format {number}``
      Supply the format number to use for the build.
    - ``-h, --help``
      Display ``build all`` help information and exit.
    - ``--increment``
      Automatically increment the mix version post build.
    - ``--min-version {version}``
      Supply minimum version for ``mixer`` to use old content from. This option
      tells ``mixer`` to regenerate all mix content starting from a certain
      version. ``mixer`` will not use any OS content from a version older than
      the min-version passed here.
   - ``--no-signing``
     Do not generate a certificate and do not sign the Manifest.MoM
   - ``--prefix {path}``
     Supply the `path` to the file system where the ``swupd`` binaries live.
 ``bundles``
    Build the bundles for your mix. This is done by extracting dependency
    information and file lists for each package in each bundle definition for the
    mix. In addition to the global options ``mixer build bundles`` takes the
    following options.
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``-h, --help``
      Display ``build bundles`` help information and exit.
   - ``--no-signing``
     Do not generate a certificate and do not sign the Manifest.MoM
 ``delta-packs``
    Build packs to optimize ``swupd update``\s between versions. When a
    ``swupd`` client updates a bundle it looks for a pack file from its current
    version to the new version. If available ``swupd`` will download and apply
    the pack content to the file system. Delta packs contain binary diff files
    that describe changes between updates whenever possible and full files only
    when necessary. Because of this delta packs are a significant performance
    optimization for client updates. Because the client can fall back to full
    files if a pack is not available, delta packs are not necessary for a
    functional update. In addition to the global options ``mixer build
    delta-packs`` takes the following options.
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``--from {version}``
      Generate packs from the specified `version`.
    - ``-h, --help``
      Display ``build delta-packs`` help information and exit.
    - ``--previous-versions {number}``
      Generate packs for `number` of previous versions.
    - ``--report``
      Report reason each file in the `to` manifest was packed in the delta pack
      or not.
    - ``--to {version}``
      Generate packs targeting a specific `to` `version`.
 ``delta-manifests``
    Build manifest deltas to optimize ``swupd update``\s between versions. When a
    ``swupd`` client update runs, it will first try to get a delta manifest file
    if it exists and apply that on the bundle manifest file for the version
    installed on their system (if it exists). This can save a large amount of
    content being downloaded in the case of few files changing in a manifest.
    Because the client can fall back to the full manifest file if a delta is not
    available, delta manifests are not necessary for a functional update. In
    addition to the global options ``mixer build delta-manifests`` takes the
    following options.
    - ``--from {version}``
      Generate packs from the specified `version`.
    - ``-h, --help``
      Display ``build delta-manifests`` help information and exit.
    - ``--previous-versions {number}``
      Generate packs for `number` of previous versions.
    - ``--to {version}``
      Generate packs targeting a specific `to` `version`.
 ``image``
    Build an image from the mix content. In addition to the global options
    ``mixer build image`` takes the following options.
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``--format {number}``
      Supply the format `number` used for the mix.
    - ``-h, --help``
      Display ``build image`` help information and exit.
    - ``--template {path}``
      Provide the `path` to the image template file to use.
 ``update``
    Build the update content for the mix. This command builds the actual update
    metadata (manifests) and content (full files and zero packs) necessary for
    ``swupd`` to perform updates on client systems. ``update`` relies on the
    output of ``build bundles`` as the input for this step and expects the
    output of ``build bundles`` to exist in the
    `<mixer/workspace>/update/image/<version>` directory. In addition to the
    global options ``mixer build update`` takes the following options.
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``--format {number}``
      Supply the format `number` used for the mix.
    - ``-h, --help``
      Display ``build update`` help information and exit.
    - ``--increment``
      Automatically increment the mix version post build.
    - ``--min-version {version}``
      Supply minimum version for ``mixer`` to use old content from. This option
      tells ``mixer`` to regenerate all mix content starting from a certain
      version. ``mixer`` will not use any OS content from a version older than
      the min-version passed here.
   - ``--no-signing``
     Do not generate a certificate and do not sign the Manifest.MoM
   - ``--prefix {path}``
     Supply the `path` to the file system where the ``swupd`` binaries live.
 ``validate``
    Compare two versions to validate that manifest file changes align with corresponding
    package changes. Inconsistencies between manifest entries and package contents are
    reported as errors. When no errors occur, package update statistics are displayed.
    - ``--from {version}``
      Compare manifests ``from`` a specific version
    - ``--to {version}``
      Compare manifests ``to`` a specific version
    - ``--from-repo-url {repo}={URL}``
      Overrides the baseurl value for the provided repo in the DNF config file for the ``from`` version
    - ``--to-repo-url {repo}={URL}``
      Overrides the baseurl value for the provided repo in the DNF config file for the ``to`` version
    - ``--table-width {width}``
      Max width of package statistics table, defaults to terminal width and disabled by negative numbers
    - ``-h, --help``
      Display ``build validate`` help information and exit.
 EXIT STATUS
 ===========
 On success, 0 is returned. A non-zero return code indicates a failure.
 SEE ALSO
 --------
 * `mixer(1) <mixer.1.html>`__
 * `swupd(1) <swupd.1.html>`__
@@ -1,207 +0,0 @@
 ============
 mixer.bundle
 ============
 ------------------------------------------------
 Perform various configuration actions on bundles
 ------------------------------------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``mixer bundle [command] [flags]``
 DESCRIPTION
 ===========
 Performs various configuration actions on upstream and local bundle definition
 files. List and validate mix bundles. Validate local bundle definition files.
 SUBCOMMANDS
 ===========
 ``add {bundle} [{bundle}...] [flags]``
    Add local or upstream bundles to your mix by modifying the mix bundles list
    at `<mixer/workspace>/mixbundles`. In addition to the global options ``mixer
    bundle add`` takes the following options.
    - ``--all-local``
      Add all local bundles defined in `<mixer/workspace>/local-bundles` to the
      mix. This command takes precedence over bundle list.
    - ``--all-upstream``
      Add all upstream bundles (cached in `<mixer/workspace>/upstream-bundles`
      to the mix. This command takes precedence over bundle list.
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``--git``
      Automatically apply a new git commit after modifying the mix bundles list
      or bundle definitions. This is useful if your local bundles are kept under
      version control.
    - ``-h, --help``
      Display ``bundle add`` help information and exit.
 ``create``
    Create new bundles or copy existing bundles.
    This command will locate the bundle by first looking in local-bundles,
    and then in upstream-bundles. If the bundle is only found upstream,
    the bundle file will be copied to your local-bundles directory. If the bundle is
    not found anywhere, a blank template will be created with the correct name.
    Passing '--add' will also add the bundle(s) to your mix. Please note that
    bundles are added after all bundles are created, and thus will not be added
    if any errors are encountered earlier on.
    In addition to the global options ``mixer bundle create`` takes the following
    options.
    - ``--add``
      Add the bundle(s) to your mix after editing.
    - ``--local``
      Skip upstream check and create empty local bundle(s).
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``--git``
      Automatically apply a new git commit after modifying the mix bundles list
      or bundle definitions. This is useful if your local bundles are kept under
      version control.
    - ``-h, --help``
      Display ``bundle create`` help information and exit.
 ``list [mix|local|upstream] [flags]``
    List the bundles in the mix, the available local bundles, or the available
    upstream bundles. In addition to the global options ``mixer bundle list``
    takes the following options.
    - ``mix``
      List the bundles in the mix.
    - ``local``
      List available locally-defined bundles.
    - ``upstream``
      List available upstream bundles.
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``-h, --help``
      Display ``bundle list`` help information and exit.
    - ``--tree``
      Pretty-print the bundle list as a tree showing include information.
 ``remove``
    Removes bundles from your mix by modifying the mix bundle list (stored in
    the `<mixer/workspace>/mixbundles` file). The mix bundle list is parsed, the
    bundles are removed, and the resultant list is written back out in sorted
    order. If bundles do not exist in the mix, they are skipped. In addition to
    the global options ``mixer bundle remove`` takes the following options.
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``--git``
      Automatically apply a new git commit after modifying the mix bundles list
      or bundle definitions. This is useful if your local bundles are kept under
      version control.
    - ``-h, --help``
      Display ``bundle remove`` help information and exit.
    - ``--local``
      Also remove the bundle file from local-bundles. This action is
      irrevocable.
    - ``--mix={bool}``
      Remove bundle from the mix bundle list. This defaults to true.
 ``validate``
    Checks bundle definition files for validity. Only local bundle files are
    checked; upstream bundles are trusted as valid. Valid bundles yield no
    output. Any invalid bundles will yield a non-zero return code.
    Basic validation includes checking syntax and structure, and that the bundle
    has a valid name. Commands like ``mixer bundle add`` run basic validation
    automatically.
    In addition to the global options ``mixer bundle remove`` takes the
    following options.
    - ``--all-local``
      Run validation against all local bundles.
    - ``-c, --config {path}``
      Optionally tell ``mixer`` to use the configuration file at `path`. Uses
      the default `builder.conf` in the mixer workspace if this option is not
      provided.
    - ``-h, --help``
      Display ``bundle validate`` help information and exit.
    - ``--strict``
      Perform strict validation to additionally check that the bundle header
      fields are parse-able and non-empty, and that the header 'Title' is itself
      valid and matches the bundle filename.
 EXIT STATUS
 ===========
 On success, 0 is returned. A non-zero return code indicates a failure.
 SEE ALSO
 --------
 * `mixer(1) <mixer.1.html>`__
@@ -1,79 +0,0 @@
 ============
 mixer.config
 ============
 ------------------------------------------
 Perform configuration manipulation actions
 ------------------------------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``mixer config [command]``
 DESCRIPTION
 ===========
 Perform various configuration manipulation actions on the mixer configuration
 files.
 OPTIONS
 =======
 In addition to the globally recognized ``mixer`` flags (see `mixer(1) <mixer.1.html>`__ for
 more details), the following options are recognized.
 -  ``-h, --help``
   Display ``config`` help information and exit.
 SUBCOMMANDS
 ===========
 ``convert``
    Convert an old config file to the new TOML format. The command will generate
    a backup file of the old config and will replace it with the converted one.
    Environment variables will not be expanded and the values will not be
    validated. In addition to the global options ``mixer config convert`` takes
    the following options.
    - ``-c, --config {path}``
      The `path` to the configuration file to convert.
    - ``-h, --help``
      Display ``config convert`` help and exit.
 ``validate``
    Parse a builder config file and display its properties. Properties
    containing environment variables will be expanded.  In addition to the
    global options ``mixer config validate`` takes the following options.
    - ``-c, --config {path}``
      The `path` to the configuration file to validate.
    - ``-h, --help``
      Display ``config validate`` help and exit.
 EXIT STATUS
 ===========
 On success, 0 is returned. A non-zero return code indicates a failure.
 SEE ALSO
 --------
 * `mixer(1) <mixer.1.html>`__
@@ -1,89 +0,0 @@
 ==========
 mixer.init
 ==========
 ------------------------------
 Initialize mixer and workspace
 ------------------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``mixer init [flags]``
 DESCRIPTION
 ===========
 Initialize the mixer configuration and mixer workspace by writing default
 configuration files if necessary and building the proper directory structure.
 OPTIONS
 =======
 In addition to the globally recognized ``mixer`` flags (see `mixer(1) <mixer.1.html>`__ for
 more details), the following options are recognized.
 -  ``--all-local``
   Initialize mix with all local bundles automatically included.
 -  ``--all-upstream``
   Initialize the mix with all upstream bundles automatically included.
 -  ``--clear-version {version}``
   Upstream version used to compose the mix. It must be either an integer or 'latest' (default "latest")
 -  ``--config {path}``
   Supply a specific configuration file at `path` to use for mixing.
 -  ``--format {format}``
   Supply the format version for the mix.
 -  ``--git``
   Track mixer's internal work directory with git.
 -  ``-h, --help``
   Display ``init`` help information and exit.
 -  ``--local-rpms``
   Create and configure local RPM directories.
 -  ``--mix-version {version}``
   Supply the mix version to build (default is 10)
 -  ``--no-default-bundles``
   Skip adding default bundles to the mix
 -  ``--upstream-url {url}``
   Supply an upstream URL to use for mixing (default is
   "https://download.clearlinux.org")
 -  ``--upstream-version {version}``
   Alias to `--clear-version` (default is "latest")
 EXIT STATUS
 ===========
 On success, 0 is returned. A non-zero return code indicates a failure.
 SEE ALSO
 --------
 * `mixer(1) <mixer.1.html>`__
@@ -1,85 +0,0 @@
 ==========
 mixer.repo
 ==========
 ---------------------------------------------------------------
 Perform various configuration actions on mixer RPM repositories
 ---------------------------------------------------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``mixer repo [command]``
 DESCRIPTION
 ===========
 Perform various configuration actions on mixer RPM repositories. These RPM
 repositories are used as content sources for mixer to build updates from.
 OPTIONS
 =======
 In addition to the globally recognized ``mixer`` flags (see `mixer(1) <mixer.1.html>`__ for
 more details), the following options are recognized.
 -  ``-c, --config {path}``
   The `path` to the configuration file to use.
 -  ``-h, --help``
   Display subcommand help information and exit.
 SUBCOMMANDS
 ===========
 ``add {name} {url}``
    Add the repo named `name` at the `url` url. In addition to the global
    options ``mixer repo add`` takes the following options.
    - ``--priority``
      Repo priority between 1 and 99, where 1 is highest. This flag defaults to 1.
 ``init``
    Initialize the DNF configuration file with the default `Clear` repository
    enabled.
 ``list``
    List all RPM repositories configured in the DNF configuration file used by
    mixer.
 ``remove {name}``
    Remove the repo `name` from the DNF configuration file used by mixer.
 ``set-priority {name} {priority}``
    Sets the priority for repo `name` to the provided `priority`.
 ``set-url {name} {url}``
    Sets the URL for repo `name` to the provided `url`. If `name` does not exist
    the repo will be added to the configuration.
 EXIT STATUS
 ===========
 On success, 0 is returned. A non-zero return code indicates a failure.
 SEE ALSO
 --------
 * `mixer(1) <mixer.1.html>`__
@@ -1,92 +0,0 @@
 ==============
 mixer.versions
 ==============
 --------------------------------
 Manage mix and upstream versions
 --------------------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``mixer versions``
 ``mixer versions [command]``
 DESCRIPTION
 ===========
 Manage mix and upstream versions. By itself the command will print the current
 version of mix and upstream, and also report on the latest version of upstream
 available. This command also allows the user to increment the mix version and
 optionally the upstream version.
 OPTIONS
 =======
 In addition to the globally recognized ``mixer`` flags (see `mixer(1) <mixer.1.html>`__ for
 more details), the following options are recognized.
 -  ``-h, --help``
   Display subcommand help information and exit.
 SUBCOMMANDS
 ===========
 ``update``
    Increment the mix version to generate a new release. By default the mix
    version is incremented by 10, following Clear Linux conventions to leave
    room for intermediate versions if necessary. The increment can be configured
    with the `--increment` flag. The ``update`` command also allows the user to
    update the upstream version.
    In addition to the global options ``mixer versions update`` takes the
    following options.
    - ``--clear-version {version}``
      Alias to `--upstream-version`
    - ``-c, --config {path}``
      Supply the `path` to the configuration file to use.
    - ``--increment {number}``
      Amount to increment the current mix version (default is 10).
    - ``--mix-version {version}``
      Set a specific mix `version`.
    - ``--upstream-version {version}``
      Set a specific next upstream version (either version number or the default
      "latest" string).
    - ``--skip-format-check``
      Skip check for compatible upstream format when changing upstream version.
      This command will not update to an upstream version of a different format
      ("format bumps"). At the moment this needs to be handled manually.
 EXIT STATUS
 ===========
 On success, 0 is returned. A non-zero return code indicates a failure.
 SEE ALSO
 --------
 * `mixer(1) <mixer.1.html>`__
@@ -1,37 +0,0 @@
 =======
 os-core
 =======
 ----------------------------------------------------
 Base files for Clear Linux OS for Intel Architecture
 ----------------------------------------------------
 :Copyright: \(C\) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 7
 SYNOPSIS
 ========
 * ``init``
 * ``root filesystem``
 * ``shell``
 DESCRIPTION
 ===========
 os-core provides a minimal base for the Clear Linux OS for Intel
 Architecture. It contains required utilities for running the init
 program systemd, letting users log in and run bash shell commands. The
 core also contains pieces of packages that are required to run any
 other package in the distribution.
 This is the only required bundle for Clear Linux OS and can not be
 removed as all other bundles depend upon it.
 SEE ALSO
 ========
 `<https://clearlinux.org/documentation/>`_
@@ -1,55 +0,0 @@
 =========
 OS Format
 =========
 --------------------------------------
 A summary of OS formats in Clear Linux
 --------------------------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 7
 SYNOPSIS
 ========
 ``/usr/share/defaults/swupd/format``
 DESCRIPTION
 ===========
 A format defines a range of OS versions that have compatible update metadata and
 content. An update client can update a system from the oldest version in the
 format to the latest version in the format without worrying about compatibility
 issues in the update content for the version it is updating to.
 A format bump occurs when the update metadata or content is changed in such a
 way that will cause client updates to break. In this case the format number must
 be incremented so clients will not attempt to update to the new versions in the
 new format without crossing the format boundary. Update clients update only to
 the latest build in their format. Once that update is complete the update client
 may then update forward again because the last version in the current format has
 identical content to the first version in the new format, including the new
 update client needed to understand the new format.
 Because the update system in Clear Linux (``swupd``) has auto-update turned on
 by default most users will never be aware of their system changing to a new
 format. Those users who have disabled auto-update may occasionally see ``swupd``
 perform two updates in a row when they only invoked ``swupd update`` once. This
 is because ``swupd`` detects when it crossed a format boundary and immediately
 re-executes an update to carry it to the latest version in the new format. This
 re-execution will actually invoke the new version of ``swupd`` that was
 delivered in the first update.
 Format bumps are simply a way for Clear Linux to introduce breaking changes to
 the OS without breaking user's update stream or workflow.
 SEE ALSO
 ========
 * `mixer(1) <mixer.1.html>`__
 * `swupd(1) <swupd.1.html>`__
 * https://clearlinux.org/documentation/
 * https://github.com/clearlinux/swupd-client/
 * https://github.com/clearlinux/mixer-tools/
@@ -1,309 +0,0 @@
 =========
 stateless
 =========
 ---------------------------------------------------------------------------
 A guide to stateless configuration in Clear Linux OS for Intel Architecture
 ---------------------------------------------------------------------------
 :Copyright: \(C) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 7
 SYNOPSIS
 ========
 ``/etc/``
 ``/usr/share/defaults/``
 ``/usr/share/defaults/etc/``
 ``/var/``
 ``/var/cache/``
 ``/usr/local/``
 ``/usr/src/``
 ``/usr/lib/kernel/``
 ``/usr/lib/modules/``
 DESCRIPTION
 ===========
 The Clear Linux OS for Intel Architecture has a unique way of
 providing customization and configuration to system administrators and
 users. This man page aims to provide both an explanation of what this
 method is and how users of Clear Linux can use it and benefit from it.
 The goal of "stateless" is to provide a system OS that functions
 without user configuration. A system should not require editing of
 configuration files by the end user before it is functional, nor should
 it place lengthy and confusing configuration files automatically in
 user-maintained file system areas (``/etc/``) by default. And
 additionally, any configuration placed in user-maintained configuration
 should be removable without breaking functionality.
 This is achieved by several methods, each of which implements a part
 of the stateless goal.
 * Removal of configuration files
 The first step taken to achieve stateless configuration is to embed
 proper default configuration values in the software. Any missing
 critical configuration value should have a built-in default value.
 * Providing of default configuration files outside of ``/etc/``
 Software is adjusted to use a distribution provided default
 configuration file in ``/usr/share/defaults``. If no configuration
 file exists in ``/etc/`` for the software, the software must use the
 distribution default configuration file.
 * Allowing the end user to provide configuration in ``/etc/``
 If the user provides a properly formatted configuration file in
 the ``/etc/`` filesystem area (or, wherever it is relevant for the
 software), the software is instructed to use this configuration
 file instead of any other.
 Consequences for the system administrator (user)
 ------------------------------------------------
 The user should create configuration files as needed and avoid
 modifying distribution provided defaults. The filesystem folders and
 all content under ``/etc/`` and ``/var/`` may be modified as needed, but
 the content under ``/usr/``, ``/lib/``, ``/lib64/``, ``/bin/``, ``/sbin/`` should
 never be modified, and will be overwritten by `swupd(1) <swupd.1.html>`__ as needed.
 Some default configuration structure and data is automatically created
 under ``/etc/`` and ``/var/``. The user may remove these file system
 structures entirely - a reboot of the OS should properly restore the
 system to its factory default. This may also provide the user with
 a way to repair a defective system configuration.
 The user should, if user configuration of a service is needed,
 attempt to place the configuration file in the ``/etc/`` structure as
 the service requests. Often, template files for the configuration
 format can be found under the ``/usr/share/defaults/`` file structure,
 and these files can be copied to the ``/etc/`` file structure.
 To modify system service configuration (``systemd``\(1) service units),
 the user should not touch or modify unit files under the ``/usr/``
 file structure directly, as changes in those files will be lost after
 a system software update with `swupd(1) <swupd.1.html>`__.
 A list of package specific hints and best practices is listed below. In 
 many cases, the man pages for the respective packages also provides 
 detailed information as to how to configure the software. Please 
 consult the relevant manual pages for the software to find information
 on the specific syntax and options for each software.
 Where can I install system-wide files then?
 -------------------------------------------
 `swupd(1) <swupd.1.html>`__ has a list of exempted locations where the system
 administrator can place files that will not get overwritten or removed
 at all. The default whitelisted directories are:
    ``/usr/lib/modules``
    ``/usr/lib/kernel``
    ``/usr/local``
    ``/usr/src``
 Using these locations for your own software is highly recommended. Not
 only do these locations provide a standard FHS compliant way of adding
 local software, they are sufficiently separated from OS software that
 maintaining them will be much more simple.
 ldconfig
 --------
    ``ldconfig``\(8)
 The default paths that the linker searches includes only ``/usr/lib64``
 and paths below that. This explicitly omits ``/usr/local/``. If you
 compile libraries manually and install them in other paths, you may
 need to configure the ``ld.so``\(8) linker to find these before you run
 ``ldconfig``. For example:
    ``echo "/usr/local/lib" | sudo tee -a /etc/ld.so.conf``
    ``sudo ldconfig``
 systemd
 -------
    ``systemd``\(1)
 Unit files can be created under ``/etc/systemd/system`` as needed and 
 function normally. To override unit file options, the simplest method 
 is to have ``systemctl``\(1) copy it for you by invoking it as:
    ``systemctl edit --full foo.service``
 This creates an exact copy of the default unit file and invokes the
 editor for the user, allowing the user to override any part of the unit.
 Unit files can be started as normal with ``systemctl start <unit>``.
 To enable services to start at boot time, use ``systemctl enable <unit>``.
 sshd
 ----
    ``sshd``\(8)
    ``sshd_config``\(5)
 The SSH daemon has all of its configuration built in and no template
 configuration file is present on the file system. The man page for
 ``sshd_config``\(5) explains the format, and it suffices to put only a
 single option in the file
   ``/etc/ssh/sshd_config``
 For example, to enable X11 forwarding through sshd all one has to do is
 add one line containing ``X11Forwarding yes``. Other often used options
 include ``PermitRootLogin yes`` to allow root ssh login access, and the
 following 3 lines to disable password authentication entirely:
    ``ChallengeResponseAuthentication no``
    ``PasswordAuthentication no``
    ``UsePAM no``
 To modify the listening port of sshd, one needs to determine whether
 ``sshd.socket`` or ``sshd.service`` is enabled first, since the methods
 for changing the port number depend on whether ``sshd``\(8) is controlling
 the port number, or whether ``systemd``\(1) is:
    ``systemctl is-enabled sshd.socket``
 If enabled, the ``sshd.socket`` unit should be edited to modify the port:
    ``systemctl edit --full sshd.socket``
 And, the user should modify the port number at ``ListenStream=`` to the
 desired new port number.
 If ``sshd.service`` is enabled, the user should create, and edit a new
 ``/etc/ssh/sshd_config`` file:
    ``mkdir -p /etc/ssh/``
    ``vi /etc/ssh/sshd_config``
 And add a line in that file that reads:
    ``Port 10022``
 to, for instance, change the port number sshd.service will listen on
 to port 10022.
 Root login over SSH is disabled by default and should remain disabled
 for most systemd. However, in some cases this is acceptable and it can
 be easily enabled by adding the following line to ``/etc/ssh/sshd_config``
 that reads:
    ``PermitRootLogin yes``
 nginx
 -----
 Nginx ships by default in a non-functional configuration. However,
 an example configuration file is present that can be used to enable
 a simple server. To use this template configuration, create:
    ``mkdir -p /etc/nginx/conf.d``
 And then copy configuration templates over to this folder:
    ``cp /usr/share/nginx/conf/nginx.conf.example /etc/nginx/nginx.conf``
    ``cp /usr/share/nginx/conf/server.conf.example /etc/nginx/conf.d/server.conf``
 Edit the file to assure options such as SSL and PHP are enabled in
 the preferred method. In the default configuration, PHP is enabled
 to run listening to ``/run/php-fpm.sock``. The template file has PHP
 by default disabled, but the listed example lines can be uncommented
 to make the nginx service process php documents.
 php-fpm
 -------
    ``php-fpm``\(8)
 Php's default configuration file doesn't allow us to provide an 
 alternative as it is programmed to only read the builtin file. If you 
 wish to have php-fpm use a different configuration, you must pass it a 
 startup option to tell it where it is. This can be done by ``systemctl 
 edit --full php-fpm.service``. That command copies the default php-fpm 
 service unit to ``/etc/systemd/system/`` and allows the user to override 
 any option. It spawns an editor with the copy.
 Then, the user should change the line:
    ``ExecStart=/usr/sbin/php-fpm --nodaemonize``
 to:
    ``ExecStart=/usr/sbin/php-fpm --nodaemonize --fpm-config /etc/php-fpm.conf``
 The template php-fpm.conf can be found at ``/usr/share/defaults/php/php-fpm.conf``.
 One should copy this to a place in ``/etc/``:
    ``cp /usr/share/defaults/php/php-fpm.conf /etc/php-fpm.conf``
 Then, the user should edit ``/etc/php-fpm.conf`` and assure that 
 configuration options are all properly set as needed.
 Care must be taken using the default ``pool`` configuration. If needed, 
 the user should also create ``/etc/php-fpm.d/`` and include pool 
 configuration files from either ``/usr/share/defaults/php/php-fpm.d/`` or 
 copy them and modify them as needed as well, as well as adjust the 
 ``include`` configuration option in ``php-fpm.conf`` to point to a new 
 location for pool configuration files.
 Network interface management
 ----------------------------
 Clear Linux has switched the network interface management model to be fully
 managed by NetworkManager when installed on real hardware. Previously, Ethernet
 interfaces were managed by systemd-networkd whereas Wi-Fi and others were
 managed by NetworkManager. Clear Linux cloud images continue to use
 systemd-networkd.
 When updating from previous versions of Clear Linux, the installation will be
 reconfigured to continue with systemd-networkd managing the Ethernet interfaces.
 Since the connectivity could be lost during the procedure, physical access to the
 system is required. To switch to NetworkManager for all the interfaces, the
 user should disable and stop systemd-networkd:
    ``sudo systemctl disable systemd-networkd``
    ``sudo systemctl stop systemd-networkd``
 Then, remove the file ``/etc/NetworkManager/conf.d/systemd-networkd-unmanaged.conf``
 Finally, restart NetworkManager
    ``sudo systemctl restart NetworkManager``
 SEE ALSO
 ========
 * `swupd(1) <swupd.1.html>`__
 * ``systemd``\(1)
 * https://clearlinux.org/documentation/
 * https://clearlinux.org/features/stateless
 * https://github.com/clearlinux/swupd-client/
@@ -1,46 +0,0 @@
 ====================
 swupd-update.service
 ====================
 ---------------------
 Performs an OS update
 ---------------------
 :Copyright: \(C) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 4
 SYNOPSIS
 ========
 ``swupd-update.service``
 ``/usr/lib/systemd/system/swupd-update.service``
 DESCRIPTION
 ===========
 Instructs the ``systemd``\(1) system daemon how to start and control the
 ``swupd`` service to perform an update.
 When this unit runs, the output will be sent to the systemd journal, and
 it can be inspected with the ``journalctl``\(1) command.
 The user can disable all background updates (either started through
 timers or not) by executing the following command:
 ``systemctl mask swupd-update.service``
 ENVIRONMENT
 ===========
 This unit is a ``systemd``\(1) unit file.
 SEE ALSO
 ========
 `swupd(1) <swupd.1.html>`__,  `swupd-update.timer(4) <swupd-update.timer.4.html>`__
@@ -1,40 +0,0 @@
 ==================
 swupd-update.timer
 ==================
 ----------------------------
 Schedules periodical updates
 ----------------------------
 :Copyright: \(C) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 4
 SYNOPSIS
 ========
 ``swupd-update.timer``
 ``/usr/lib/systemd/system/swupd-update.timer``
 DESCRIPTION
 ===========
 Instructs the ``systemd``\(1) system daemon when to periodically start a
 system software update. The update itself may not execute if the
 `swupd-update.service(4) <swupd-update.service.4.html>`__ is disabled. See that manual page for
 information on how to disable that unit.
 ENVIRONMENT
 ===========
 This unit is a ``systemd``\(1) unit file.
 SEE ALSO
 ========
 `swupd(1) <swupd.1.html>`__, `swupd-update.service(4) <swupd-update.service.4.html>`__
@@ -1,771 +0,0 @@
 =====
 swupd
 =====
 --------------------------
 OS software update program
 --------------------------
 :Copyright: \(C) 2020 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``swupd [subcommand] <flags>``
 DESCRIPTION
 ===========
 `swupd(1) <swupd.1.html>`__ is an OS-level software update program that applies updates
 to system software.
 The updates are fetched from a central software update server. If a
 valid update is found on the server, it can be downloaded and applied.
 The ``swupd`` tool can also install and remove bundles, check for
 updates without applying them, perform system-level diagnose of
 the system software, and install an OS.
 A *version url* server provides version information. This server
 notifies the program of available updates.
 A *content url* server (can be the same as *version url* server)
 provides the file and metadata content for all versions. The content url
 server provides metadata in the form of manifests. These Manifest files
 list and describe file contents, symlinks, directories. Additionally,
 the actual content is provided to clients in the form of archive files.
 ``swupd`` consumes update artifacts generated by ``mixer`` in the specific
 format the installed version of ``swupd`` understands. For more information
 about how these artifacts are generated see `mixer(1) <mixer.1.html>`__ and `os-format(7) <os-format.7.html>`__.
 The ``swupd`` tool can also manage 3rd-party content, this allows users to
 install, remove, and update bundles from 3rd-party repositories.
 OPTIONS
 =======
 The following options are applicable to most subcommands, and can be
 used to modify the core behavior and resources that swupd uses.
 -h, --help    Display general help information. If put after a subcommand, it
        will display help specific to that subcommand.
 -v, --version   Displays the version information of the swupd program, and exit.
        It also displays compile options and copyright information.
 -p <path>, --path=<path>   Optionally set the top-level directory for the
        swupd-managed system. This can be used to point to a chroot installation
        of the OS or a custom mount. If not specified this will default to ``/``.
 -u <url>, --url=<url>   Specify an RFC-3986 encoded url. The url will be used to
        download version information and file content downloads.
 -P <port>, --port=<port>    Specify the port number of the server to connect to.
        Applies to both version and file content url server connections.
 -c <url>, --contenturl=<url>    Specify an RFC-3986 encoded url. The url will be
        used for file content downloads only.
 -v <url>, --versionurl=<url>    Specify an RFC-3986 encoded url. The url will be
        used to download version information.
 -F <formatstring>, --format=<formatstring>  Specify the format suffix for
        version file downloads. Is usually one of ``1``, ``2``, ``3``, etc. or
        ``staging``. Software update formats may change regularly and normally
        you should consult the swupd server data for the appropriate latest
        version available. If that version is not supported by your version of
        ``swupd``, you should subtract ``1`` from the number and try again until
        it succeeds.
 -S <path>, --statedir=<path>    Specify an alternate path for swupd cache and data directory.
        Normally ``swupd`` uses ``/var/lib/swupd``.
 -K <path>, --cachedir=<path>    Specify an alternate swupd cache directory.
        Normally ``swupd`` uses ``/var/lib/swupd``.
 -Z <path>, --datadir=<path>    Specify an alternate swupd data directory.
        Normally ``swupd`` uses ``/var/lib/swupd``.
 -C <path>, --certpath=<cert>  Specify alternate path to swupd certificate store (pem file).
        Default is /usr/share/clear/update-ca/Swupd_Root.pem
 -W <n>, --max-parallel-downloads=<n>    Set the maximum number of parallel downloads.
 -r <n>, --max-retries=<n>   Maximum number of retries for download failures.
 -d <n>, --retry-delay=<n>  Initial delay in seconds between download retries, this will
        be doubled for each retry until the download succeeds or the maximum
        number of retries has been reached.
 -n, --nosigcheck    Do not attempt to enforce certificate or signature checking.
 -n, --nosigcheck-latest     Do not attempt to enforce signature checking when
        retrieving the latest version number.
 -I, --ignore-time   Ignore system/certificate time when validating signature.
 -t, --time  Show verbose time output for swupd operations.
 -N, --no-scripts    Do not run the post-update scripts and boot update tool.
 -b, --no-boot-update    Do not update the boot files using clr-boot-manager.
 -j, --json-output   Prints the swupd output as a machine readable JSON stream.
 -y, --yes   Assume yes as answer to all prompts and run non-interactively.
 --allow-insecure-http   For security reasons, swupd only allows system updates
        using secure https connections by default. This option forces swupd
        to allow updates over insecure http connections.
        ``Warning``: although it is not recommended, if an http server is
        set up as the upstream server, the `allow_insecure_http=true` option will
        need to be setup in the swupd configuration file for the autoupdate
        command to continue to work.
 --quiet    Sets `swupd` to print a minimal and more stable output that is easier
        to parse for its commands. Only the most relevant information and errors
        are printed out.
        Output displayed when using this option is rarely going to change, so
        this is a good option to use when writing scripts that use `swupd`.
 --verbose   Enable verbosity for commands.
 --debug     Print extra information to help debugging problems.
 --no-progress   Don't print progress report on commands that informs the
        percentage left in current operation.
 --wait-for-scripts  Wait for the post-update scripts to complete.
 --assume=<yes|no>   Sets an automatic response to all prompts and run
        non-interactively.
 SUBCOMMANDS
 ===========
 info
 ----
    Shows the current OS version and the URLs used for updates.
 autoupdate
 ----------
    Enables or disables automatic updates, or reports current
    status. Enabling updates does not cause an immediate update -
    use ``swupd update`` to force one if desired.
 --enable    Enable autoupdates
 --disable   Disable autoupdates
 check-update
 ------------
    Checks whether an update is available and prints out the information
    if so. Does not download update content.
 update
 ------
    Performs a system software update.
    The program will contact the version server at the version url, and
    check to see if a system software update is available. If an update
    is available, the update content will be downloaded from the content
    url and stored in the `/var/lib/swupd` state path. Once all content
    is downloaded and verified, the update is applied to the system.
    In case any problem arises during a software update, the program
    attempts to correct the issue, possibly by performing a ``swupd repair``
    operation, which corrects broken or missing files and other issues.
    After the update is applied, the system performs an array of
    post-update actions. These actions are triggered through `systemd(1)`
    and reside in the `update-triggers.target(4) <update-triggers.target.4.html>`__ system target.
 -V <version>, --version=<version>   Update to a specific version, also accepts 'latest' (default).
 -s, --status    Do not perform an update, instead display whether an update is
        available on the version url server, and what version number is
        available. This is the same as running ``swupd check-update``.
 -k, --keepcache     Do not delete the swupd state directory content after
        updating the system.
 --download      Do not perform an update, instead download all resources needed
        to perform the update, and exit.
 --update-search-file-index  Update the index used by search-file to speed up
        searches. Don't enable this if you have download or space restrictions.
 --3rd-party     If update is successfull, also update content from 3rd-party
        repositories.
 bundle-add <bundles>
 --------------------
    Installs new software bundles. Any bundle name listed after ``bundle-add``
    will be installed in the system. A list of all existing bundles can be
    displayed with the ``bundle-list --all`` command.
    The names can also be aliases that are not actual bundles names but instead
    are names in an alias configuration file. See ``swupd-alias``\(7)
 --skip-optional     Do not install optional bundles (`also-add` flag in
        Manifests).
        A bundle may include other bundles that will also get installed
        when installing the bundle that includes them. This included bundles
        can be either optional, or mandatory. Optional bundles can be skipped
        at install time by using this option.
 --skip-diskspace-check  Skip checking for available disk space before installing
        a bundle.
        By default, swupd attempts to determine if there is enough free
        disk space to add the passed in bundle before attempting to install.
        The current implementation will check free space in ``/usr/`` by default,
        or it will check the passed in --path option with ``/usr/`` appended.
 bundle-remove <bundles>
 -----------------------
    Removes software bundles. Any bundle name listed after ``bundle-remove``
    will be removed from the system. If the bundle is required by another
    bundle(s) on the system, a tree will be displayed to indicate which bundles
    are blocking removal.
 -x, --force     Removes a bundle along with all the bundles that depend on it.
        ``Warning``: This operation is dangerous and must be used with care since
        it can remove many unexpected bundles.
 -R, --recursive Removes a bundle and its dependencies recursively, except for
        bundle os-core.
        ``Warning``: This operation is dangerous and must be used with care since
        it can remove many unexpected bundles.
 --orphans       Removes all orphaned bundles. Orphan bundles are those that are no
        longer required by any of the tracked bundles.
        ``Warning``: This operation is dangerous and must be used with care since
        it can remove many unexpected bundles.
 bundle-list
 -----------
    List all installed software bundles in the local system. Available bundles
    can be listed with the ``--all`` option.
 -a, --all   Lists all available software bundles, either installed or not, that
        are available.
 -D <bundle>, --has-dep=<bundle>     Displays a list of all bundles which include
        the passed BUNDLE as a dependency. Combine with ``--all`` to report all
        bundles including those not installed on the system. Combine with
        ``--verbose`` to show a tree of those bundles.
 --status    Show the installation status of the listed bundles. Bundles
        installation status can be; "explicitly installed", meaning that they
        were specifically requested to be installed by the user, or they can be
        "implicitly installed", meaning they were installed as a dependency of
        another explicitly installed bundle.
 --deps=<bundle>     Lists all bundle dependencies of the passed BUNDLE,
        including recursively included bundles.
 --orphans    List orphaned bundles. Orphan bundles are those that are installed
         but no longer required by any tracked bundle.
 bundle-info
 -----------
    Display detailed information about a bundle.
 -V <version>, --version=<version>   Show the bundle info for the specified
        version, it also accepts 'latest'.i It defaults to the current version
        if no version is specified.
 --dependencies  Show the bundle's direct and indirect dependencies as well as if
        they are optional or mandatory dependencies. Direct dependencies are
        those that are specifically included by the bundle in question, while
        indirect dependencies are those that are included by the bundles that
        are a direct dependency of the bundle in question.
 --files     Show the files directly included in this bundle, in other words it
        shows the files included in the bundle's manifest. If this option is used
        along with the ``--dependencies`` option, all files installed by the
        bundle are listed, including those files installed by the dependencies
        of the bundle.
 search
 ------
    Swupd search functionality is provided by the swupd-search binary, available
    on os-core-search bundle.
    For more information run:
    ``$ swupd search --help``
 search-file <string>
 --------------------
    Search for matching paths in manifest data. The specified `{string}`
    is matched in any part of the path listed in manifests, and all
    matches are printed, including the name of the bundle in which the
    match was found.
    If manifest data is not present in the state folder, it is
    downloaded from the `content url`.
    Because this search consults all manifests, it normally requires to
    download all manifests for bundles that are not installed, and may
    result in the download of several mega bytes of manifest data.
 -V <version>, --version=<version>   Search for a match of the given file in the
        specified version version.
 -l, --library   Restrict search to designated dynamic shared library paths.
 -B, --binary    Restrict search to designated program binary paths.
 -T <num_results>, --top=<num_results>   Only display the top specified number of
        results for each bundle.
 -m, --csv   Output the search results in a machine readable CSV format.
 -i, --init  Just perform the collection and download of all required manifest
        resources needed to perform the search, then exit.
 -o <order>, --order=<order>     Sort the output in one of two ways:
        -  Use 'alpha' to order alphabetically (default)
        -  Use 'size' to order by bundle size (smaller to larger)
 diagnose
 --------
    Perform system software installation verification. The program will
    obtain all the manifests needed from version url and content url to
    establish whether the system software is correctly installed and not
    overwritten, modified, missing or otherwise incorrect (permissions, etc.).
    After obtaining the proper resources, all files that are under
    control of the software update program are verified according to the
    manifest data
 -V <version>, --version=<version>   Diagnose against the specified manifest VERSION.
 -x, --force     Attempt to proceed even if non-critical errors found.
 -q, --quick     Omit checking hash values. Instead only looks for missing files
        and directories and/or symlinks.
 -B <bundles>, --bundles=<bundles>     Forces swupd to only diagnose the (comma separated) list of bundles provided.
        Examples:
            - ``--bundles xterm,vim``
                Diagnoses only bundles `xterm` and `vim`.
 -Y, --picky     Also list files which should not exist. Only files listed in the
         manifests should exist. By default swupd only looks for these
         files at ``/usr``, this path can be changed using ``--picky-tree``.
         Some paths at ``/usr`` are skipped by default:
         ``/usr/lib/modules``, ``/usr/lib/kernel``, ``/usr/local``
         and ``/usr/src``. These paths can be changed using
         ``--picky-whitelist``.
 -X <path>, --picky-tree=<path>  Changes the path where ``--picky`` and
        ``--extra-files-only`` looks for extra files. To be specified as
        absolute PATH.
        The default path is ``/usr``.
 -w <regex>, --picky-whitelist=<regex>   Any path matching the POSIX extended regular expression regex is ignored by ``--picky``. The given expression is always
        wrapped in ``^(`` and ``)$`` and thus has to match the entire path.
        Matched directories get skipped completely.
        The default is to ignore ``/usr/lib/kernel``,
        ``/usr/lib/modules``, ``/usr/src`` and ``/usr/local``.
        Examples:
            - ``/var|/etc/machine-id``
                Ignores ``/var`` or ``/etc/machine-id``, regardless of
                whether they are directories or something else. In the
                usual case that ``/var`` is a directory, also everything
                inside it is ignored because the directory gets skipped
                while scanning the directory tree.
            -  empty string or ``^$``
                Matches nothing, because `paths` are never empty.
 --extra-files-only      Like ``--picky``, but it only looks for extra files.
        It omits checking hash values, and for missing files, directories and/or
        symlinks.
 --file  Forces swupd to only diagnose the specified file or directory
        (recursively).
 repair
 ------
    Correct any issues found. This will overwrite incorrect file content,
    add missing files and do additional corrections, permissions, etc.
 -V <version>, --version=<version>   Repair against the specified manifest
        version.
 -x, --force     Attempt to proceed even if non-critical errors found.
 -q, --quick     Omit repairing corrupt files. Instead only add missing files
        and directories and/or symlinks.
 -B <bundles>, --bundles=<bundles>     Forces swupd to only repair the (comma separated) list
        of bundles provided.
        Examples:
            - ``--bundles xterm,vim``
                Repairs only bundles `xterm` and `vim`.
 -Y, --picky     Also removes files which should not exist. Only files listed
        in the manifests should exist. By default swupd only looks for these
        files at ``/usr``, this path can be changed using ``--picky-tree``.
        Some paths at ``/usr`` are skipped by default:
        ``/usr/lib/modules``, ``/usr/lib/kernel``, ``/usr/local``
        and ``/usr/src``. These paths can be changed using
        ``--picky-whitelist``.
 -X <path>, --picky-tree=<path>  Changes the path where ``--picky`` and
        ``--extra-files-only`` looks for extra files. To be specified as
        absolute PATH. The default path is ``/usr``.
 -w <regex>, --picky-whitelist=<regex>   Any path matching the POSIX extended regular
        expression regex is ignored by ``--picky``. The given expression is
        always wrapped in ``^(`` and ``)$`` and thus has to match the entire
        path. Matched directories get skipped completely.
        The default is to ignore ``/usr/lib/kernel``,
        ``/usr/lib/modules``, ``/usr/src`` and ``/usr/local``.
        Examples:
            - ``/var|/etc/machine-id``
               Ignores ``/var`` or ``/etc/machine-id``, regardless of
               whether they are directories or something else. In the
               usual case that ``/var`` is a directory, also everything
               inside it is ignored because the directory gets skipped
               while scanning the directory tree.
            -  empty string or ``^$``
                Matches nothing, because paths are never empty.
 --extra-files-only  Like ``--picky``, but it only removes extra files. It omits
        repairing corrupt files, and adding missing files, directories and/or
        symlinks.
 --file  Forces swupd to only repair the specified file or directory
        (recursively).
 os-install
 ----------
    Perform system software installation in the specified location. Install
    all files into `{path}` as specified by the ``swupd os-install {path}``
    option. Useful to generate a new system root. The only bundle that will
    be installed by default is ``os-core`` unless more bundles are specified
    with the ``--bundles`` option.
 -V <version>, --version=<version>   Install the specified version of the OS.
 -x, --force     Attempt to proceed even if non-critical errors found.
 -B <bundles>, --bundles=<bundles>   Include the (comma separated) list of
        bundles with the base OS install.
        Examples:
            - ``--bundles xterm,vim``
                Installs bundles `xterm` and `vim`, along with `os-core`
                (installed by default).
 -s <path>, --statedir-cache=<path>  After checking for content in the
        `statedir`, check the `statedir-cache` before downloading it over the
        network.
 --download      Do not perform an install, instead download all resources
        needed to perform the install, and exit.
 --skip-optional     Do not install optional bundles (`also-add` flag in
        Manifests).
        A bundle may include other bundles that will also get installed
        when installing the bundle that includes them. This included bundles
        can be either optional, or mandatory. Optional bundles can be skipped
        at install time by using this option.
 mirror
 ------
    Configure a `mirror URL` for swupd to use instead of the defaults on the
    system or compiled into the swupd binary.
 -s <url>, --set=<url>     Set the `content` and `version URLs` to URL by adding
        configuration files to ``<path>/etc/swupd/mirror_contenturl`` and
        ``<path>/etc/swupd/mirror_versionurl``
 -U, --unset     Remove the `content` and `version URL` configuration by removing
        ``<path>/etc/swupd``
 clean
 -----
    Removes files cached by swupd.
    Note that removing these files may cause swupd to perform slower the next time
    it is used since it may need to download some files from the update server
    again.
 --all   | Removes all the content including recent metadata.
 --dry-run       Just prints files that would be removed.
 hashdump
 --------
    Calculates and print the Manifest hash for a specific file on disk.
 -n, --no-xattrs      Ignore extended attributes when calculating hash.
 -p <path>, --path=<path>    Specify the PATH to use for operations. This can be
        used to point to a chroot installation of the OS or a custom mount.
 3rd-party
 ---------
    Manages 3rd-party repositories and content installed from them. A 3rd-party
    repository enables the distribution of user produced content.
    The following subcommands are available to manage `3rd-party repositories`:
    -  ``add``
       Adds a 3rd-party repository.
         -  ``force``
         Attempt to proceed with the removal of the repo even if non-critical
         errors found.
    -  ``remove``
       Removes a 3rd-party repository along with all the content installed
       from it from the system.
         -  ``force``
         Attempt to proceed with the removal of the repo even if non-critical
         errors found.
    -  ``list``
       Lists the 3rd-party repositories available to the system. These
       repositories must have been previously added using ``swupd 3rd-party add``.
    Most of the swupd subcommands used for managing `upstream` content are
    supported to manage `3rd-party` content along with most of their options.
    To use these subcommands for 3rd-party content, it is necessary to use the
    ``3rd-party`` subcommand followed by the desired operation to be performed.
    This is the syntax for 3rd-party operations to manage content:
    ``$ swupd 3rd-party <subcommand> [option(s)]``
    Example:
         -  ``swupd 3rd-party bundle-add my_bundle``
            Looks for the 3rd-party bundle `my_bundle` among all the available
            3rd-party repositories, and installs it in the system as long as
            it is found in one, and only one, repository. If the bundle exists
            in more than one 3rd-party repository, users are required to specify
            the repository to install it from by using the ``--repo`` option.
            There is no need to specify the 3rd-party repository if the bundle
            name is unique among 3rd-party repositories, even if a bundle with
            the same name exists in the upstream update server. Bundles from
            3rd-party repositories are installed in a different location so they
            don't clash with upstream bundles.
         -  ``swupd 3rd-party update --repo my_repo``
            Performs a software update for content installed from the 3rd-party
            repository `my_repo`. If no repository is specified, content from
            all 3rd-party repositories is updated.
    All 3rd-party content is installed in the following location:
    ``/opt/3rd-party/<bundle_name>/``
    The following subcommands are available to manage `3rd-party content`:
    -  ``update``
       Update to latest version of a 3rd-party repository.
       For information about the options for this command please refer to
       the ``swupd update`` section.
    -  ``bundle-add``
       Installs a bundle from a 3rd-party repository.
       For information about the options for this command please refer to
       the ``swupd bundle-add`` section.
    -  ``bundle-remove``
       Remove a bundle from a 3rd-party repository.
       For information about the options for this command please refer to
       the ``swupd bundle-remove`` section.
    -  ``bundle-list``
       List bundles from a 3rd-party repository.
       For information about the options for this command please refer to
       the ``swupd bundle-list`` section.
    -  ``bundle-info``
       Display information about a bundle in a 3rd-party repository.
       For information about the options for this command please refer to
       the ``swupd bundle-info`` section.
    -  ``diagnose``
       Verify content from a 3rd-party repository.
       For information about the options for this command please refer to
       the ``swupd diagnose`` section.
    -  ``repair``
       Repair local issues relative to a 3rd-party repository.
       For information about the options for this command please refer to
       the ``swupd repair`` section.
    -  ``check-update``
       Check if a new version of a 3rd-party repository is available.
       For information about the options for this command please refer to
       the ``swupd check-update`` section.
    -  ``clean``
       Clean cached files of a 3rd-party repository.
       For information about the options for this command please refer to
       the ``swupd clean`` section.
 FILES
 =====
 /usr/share/defaults/swupd
    Sometimes a set of flags is always used for one, or many swupd commands. The
    ``swupd configuration file`` provides a convenient way of persistently define
    these flags so they don't need to be specified every time a command is run.
    The configuration file is an INI type of file that consists of sections, each led
    by a [section] header, followed by key/value entries separated by a '=' character.
    Note that there should be no whitespace between key=value. The configuration
    file may include comments, prefixed by either the '#' or the ';' characters.
    There can be one section for each swupd command (e.g. [bundle-add], [update], etc.)
    and one for global options (e.g. [GLOBAL]). Global options can be specified in the
    either in the GLOBAL section, in a command section, or in both. Global options
    specified in the command section have higher precedence than those specified in the
    GLOBAL section, so it is possible to define a GLOBAL option that will apply to all
    swupd command except for that one overwritten in the command section.
    A sample swupd configuration file can be found at this location (this file should not
    be modified):
    `/usr/share/defaults/swupd`
    To use it, copy it to `/etc/swupd` where swupd reads the configuration from.
 EXIT STATUS
 ===========
 On success, ``0`` is returned. A ``non-zero`` return code signals a failure.
 If the subcommand ``check-update`` was specified, the program returns
 ``0`` if an update is available, ``1`` if no update available, and a
 return value higher than ``1`` signals a failure.
 If the subcommand was ``autoupdate`` without options, then the program
 returns ``0`` if automatic updating is enabled.
 If the subcommand was ``diagnose``, then the program returns ``0`` if the system
 is consistent at the end of the process or ``1`` if there are invalid/missing
 files in the system.
 The non-zero return codes for other operations are listed here:
 **2**     A required bundle was removed or was attempted to be removed
 | **3**     The specified bundle is invalid
 | **4**     Unable to download or read MoM manifest
 | **5**     Unable to delete a file
 | **6**     Unable to rename a directory
 | **7**     Unable to create a file
 | **8**     Unable to recursively load included manifests
 | **9**     Unable to obtain lock on state directory
 | **10**    Unable to rename a file
 | **11**    Unable to initialize curl agent
 | **12**    Initialization error
 | **13**    Bundle not tracked on system
 | **14**    Unable to load manifest into memory
 | **15**    Invalid command-line option
 | **16**    Unable to connect to update server
 | **17**    File download issue
 | **18**    Unable to untar a file
 | **19**    Unable to create required directory
 | **20**    Unable to determine current version of the OS
 | **21**    Unable to initialize signature verification
 | **22**    System time is off by a large margin
 | **23**    Pack download issue
 | **24**    Unable to verify server SSL certificate
 | **25**    There is not enough disk space left (or it cannot be determined)
 | **26**    The required path was not found in any manifest
 | **27**    Unexpected condition found
 | **28**    Unable to execute another program in a subprocess
 | **29**    Unable to list the content of a directory
 | **30**    An error occurred computing the hash of a file
 | **31**    Unable to get current system time
 | **32**    Unable to write a file
 | **34**    swupd ran out of memory
 | **35**    Unable to fix/replace/delete one or more files
 | **36**    Unable to execute binary, is either missing or invalid
 | **37**    Invalid 3rd-party repository (not found)
 | **38**    File is missing or invalid
 SEE ALSO
 ========
 | `swupd-update.service(4) <swupd-update.service.4.html>`__,  `swupd-update.timer(4) <swupd-update.timer.4.html>`__,  `update-triggers.target(4) <update-triggers.target.4.html>`__,  `mixer(1) <mixer.1.html>`__,  `os-format(7) <os-format.7.html>`__
 | Official repository     https://github.com/clearlinux/swupd-client/
 | Official documentation  https://clearlinux.org/documentation/
@@ -1,63 +0,0 @@
 tallow
 ======
 Reduce log clutter due to ssh login attempts.
 SYNOPSIS
 --------
 ``/usr/sbin/tallow``
 DESCRIPTION
 -----------
 ``tallow`` is a daemon that watches the systemd journal for messages
 from the ``sshd`` service. It parses the messages and looks for
 attempted random logins such as failed logins to the root account and
 failed logins to invalid user accounts, and various other obviously
 malicious login attempts that try things as forcing old protocols, or
 weak key systems.
 If such logins were detected, the offending IP address is stored in a
 list. Items from this list are regularly purged, but if the amount of
 times that a specific IP address is seen exceeds a threshold, an
 ipset(1) entry is inserted in the ``tallow`` or ``tallow6`` ipset, and
 further packets from that ip address will be blocked by an
 ``iptables(1)`` or ``ip6tables(1)`` rule that tallow creates at startup.
 Additionally, certain types of login failure will trigger a short term
 ban of further packets from the offending IP address immediately.
 The system administrator needs to assure that the tallow and tallow6
 ipsets are left alone and that the inserted iptables rules are properly
 matching on packets.
 Care should be taken to assure that legitimate users are not blocked
 inadvertently. You may wish to list any valid IP address with the
 whitelist option in `tallow.conf(5) <tallow.conf.5.html>`__. Multiple addresses can be
 whitelisted.
 OPTIONS
 -------
 The ``tallow`` daemon itself has no runtime configuration. All
 configuration is done through the `tallow.conf(5) <tallow.conf.5.html>`__ config file.
 SIGNALS
 -------
 The ``USR1`` signal causes ``tallow`` to print out it’s internal
 tracking table of IP addresses. This requires that tallow is compiled
 with the ``-DDEBUG=1`` symbol passed to the compiler.
 SEE ALSO
 --------
 systemd-journald(1), iptables(1), ipset(1), `tallow.conf(5) <tallow.conf.5.html>`__,
 `tallow.patterns(5) <tallow.patterns.5.html>`__
 BUGS
 ----
 ``tallow`` is ``NOT A SECURITY SOLUTION``, nor does it protect against
 random password logins. A attacker may still be able to logon to your
 systems if you allow password logins.
@@ -1,92 +0,0 @@
 tallow.conf
 ===========
 The tallow configuration file
 NAME
 ----
 tallow.conf - Tallow daemon configuration file
 SYNOPSIS
 --------
 ``/etc/tallow.conf``
 DESCRIPTION
 -----------
 This file is read on startup by the `tallow(1) <tallow.1.html>`__ daemon, and can be used to
 provide options to the tallow daemon. If not present, tallow will
 operate with built-in defaults.
 OPTIONS
 -------
 ``fwcmd_path``\ =\ ``<string>`` Specifies the location of the ipset(1)
 firewall-cmd(1) programs. By default, tallow will look in “/usr/sbin”
 for them.
 ``ipt_path``\ =\ ``<string>`` Specifies the location of the ipset(1)
 program and iptables(1) or ip6tables(1) programs. By default, tallow
 will look in “/usr/sbin” for them.
 ``expires``\ =\ ``<int>`` The number of seconds that IP addresses are
 blocked for. Note that due to the implementation, IP addresses may be
 blocked for much longer than this period. If IP addresses are seen, but
 not blocked within this period, they are also removed from the watch
 list. Defaults to 3600s.
 ``whitelist``\ =\ ``<ip address|pattern>`` Specify an IP address or
 ``pattern`` that should never be blocked. Multiple IP addresses can be
 included by repeating the ``whitelist`` option several times. By
 default, 127.0.0.1, 192.168., and 10. are whitelisted. If you create a
 manual whitelist, you must include these entries if you want to continue
 them to be whitelisted as well, otherwise they will be omitted from the
 whitelist.
 If the last character of the listed ip adress is a ``.`` or a ``:``,
 then the matching is only performed on the leftmost characters of an IP
 address against the whitelist entry. For instance, if you whitelist
 ``10.`` then all IP addresses in the ``10/8`` subnet mask will match
 this whitelist entry and never be blocked.
 ``ipv6``\ =\ ``<0|1>`` Enable or disable ipv6 (ip6tables) support. Ipv6
 is disabled automatically on systems that do not appear to have ipv6
 support and enabled when ipv6 is present. Use this option to explicitly
 disable ipv6 support if your system does not have ipv6 or is missing
 ip6tables. Even with ipv6 disabled, tallow will track and log ipv6
 addresses.
 ``nocreate``\ =\ ``<0|1>`` Disable the creation of firewall rules and
 ipset sets. By default, tallow will create new firewall-cmd(1) or
 iptables(1) and ip6tables(1) rules when needed automatically. If set to
 ``1``, `tallow(1) <tallow.1.html>`__ will not create any new firewall DROP rules or
 ipset sets that are needed work. You should create them manually before
 tallow starts up and remove them afterwards using the sets of commands
 below.
 Use the following commands if you’re using iptables(1):
 ::
   ipset create tallow hash:ip family inet timeout 3600
   iptables -t filter -I INPUT 1 -m set --match-set tallow src -j DROP
   ipset create tallow6 hash:ip family inet6 timeout 3600
   ip6tables -t filter -I INPUT 1 -m set --match-set tallow6 src -j DROP
 Use the following commands if you’re using firewalld(1):
 ::
     firewall-cmd --permanent --new-ipset=tallow --type=hash:ip --family=inet --option=timeout=3600
     firewall-cmd --permanent --direct --add-rule ipv4 filter INPUT 1 -m set --match-set tallow src -j DROP
     firewall-cmd --permanent --new-ipset=tallow6 --type=hash:ip --family=inet6 --option=timeout=3600
     firewall-cmd --permanent --direct --add-rule ipv6 filter INPUT 1 -m set --match-set tallow6 src -j DROP
 SEE ALSO
 --------
 `tallow(1) <tallow.1.html>`__, `tallow.patterns(5) <tallow.patterns.5.html>`__
@@ -1,136 +0,0 @@
 tallow.patterns
 ===============
 Tallow pattern matching configuration files.
 SYNOPSIS
 --------
 `tallow(1) <tallow.1.html>`__ uses regular expressions to match journal entries and extract
 an IP address from them. JSON files are used to configure the patterns
 and banning thresholds used by `tallow(1) <tallow.1.html>`__.
 ``/etc/tallow/*.json`` ``/usr/share/tallow/*.json``
 DESCRIPTION
 -----------
 `tallow(1) <tallow.1.html>`__ uses regular expressions to match journal entries and extract
 an IP address from them. JSON files are used to configure the patterns
 and banning thresholds used by `tallow(1) <tallow.1.html>`__. This adds the ability to
 extend the patterns `tallow(1) <tallow.1.html>`__ will recognize. Many JSON files can exist
 for logical grouping. The `tallow(1) <tallow.1.html>`__ daemon will read all JSON files in
 the configuration directories at startup.
 `tallow(1) <tallow.1.html>`__ operates with default pattern definitions
 in\ ``/usr/share/tallow/*.json``. Users can add more patterns with their
 own JSON files under ``/etc/tallow``. The default JSON files can be
 overridden by creating the same file under ``/etc/tallow``.
 FILE FORMAT
 -----------
 Pattern configuration files use the JavaScript Object Notation (JSON)
 format.
 The JSON must be two levels deep and all properties are required. The
 root object is an array containing objects with a ``filter`` key and an
 ``items`` key.
 -  ``filter`` is a string that defines a field for filtering the journal
   file. This helps make sure patterns are only matched to a subset of
   journal entries. See systemd.journal-fields(7) for valid journal
   fields.
 -  ``items`` is an array of objects that contains three elements:
   ``ban``, ``score``, and ``pattern``.
   -  ``ban`` is an integer that defines the number of seconds to ban
      originating IP for. If this value is > 0, the IP address get
      banned immediately when a journal entry matches ``pattern``.
   -  ``score`` is a double that defines a value to add to the
      accumulated “score” of an originating IP address each time a
      journal entry matches the ``pattern``. If the combined score is >
      1.0, tallow bans the originating IP for the default time of 1
      hour. The ``ban`` element value above is not used for bans made
      due to ``score``.
   -  ``pattern`` is a string that defines a Perl Compatible Regular
      Expressions (PCRE) to match against the filtered journal entries.
      The PCRE should extract exactly one substring: the originating IP
      address for `tallow(1) <tallow.1.html>`__. See systemd.journal-fields(7) for valid
      journal fields.
 EXAMPLES
 --------
 1. The JSON below is a snippet from one of the default pattern
   configuration files for blocking certain failed ``sshd`` connections.
   The first pattern will ban an IP address after it fails to login 6
   times causing it to reach a total score > 1.0.
   The second pattern will ban an IP address for 10 seconds every time a
   login is attempted with an invalid user. Additionally, it will ban
   the IP address for 1 hour if it attempts to login with an invalid
   user 6 times causing it to reach a total score > 1.0.
   See the ``/usr/share/tallow/sshd.json`` file for more ``sshd``
   examples.
   ::
      [
        {
          "filter": "SYSLOG_IDENTIFIER=sshd",
          "items": [
            {
              "ban": 0,
              "score": 0.2,
              "pattern": "MESSAGE=Failed .* for .* from ([0-9a-z:.]+) port \\d+ ssh2"
            },
            {
              "ban": 10,
              "score": 0.2,
              "pattern": "MESSAGE=Invalid user .* from ([0-9a-z:.]+) port \\d+"
            }
          ]
        }
      ]
 2. The JSON below defines a pattern for blocking connections based on
   error logs from ``nginx-mainline`` if placed in a
   ``/etc/tallow/nginx-mainline.json`` file.
   The pattern will ban an IP address for 15 seconds every time it
   attempts to access a script that does not exist. Additionally, it
   will ban the IP address for 1 hour if it attempts to access invalid
   scripts 4 times causing it to reach a total score > 1.0.
   ::
      [
        {
          "filter": "SYSLOG_IDENTIFIER=nginx-mainline",
          "items": [
            {
              "ban": 15,
              "score": 0.3,
              "pattern": ".Primary script unknown. while reading response header from upstream, client: ([0-9a-z:.]+),"
            }
          ]
        }
      ]
 SEE ALSO
 --------
 `tallow(1) <tallow.1.html>`__, `tallow.conf(5) <tallow.conf.5.html>`__
 BUGS
 ----
 ``tallow`` is ``NOT A SECURITY SOLUTION``, nor does it protect against
 random password logins. An attacker may still be able to logon to your
 systems if you allow password logins.
@@ -1,81 +0,0 @@
 ================
 telem-record-gen
 ================
 ------------------------------
 Create custom telemetry record
 ------------------------------
 :Copyright: \(C) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``telem-record-gen`` <options>
 DESCRIPTION
 ===========
 Generate and attempt to send a telemetry record to `telemprobd(1) <telemprobd.1.html>`__. This
 program can be used to create a telemetry record from a shell script
 or from another program using e.g. ``system()``. The program connects
 to a local `telemprobd(1) <telemprobd.1.html>`__ daemon to spool the record for delivery to
 the actual collection service.
 The payload can be provided as standard input, as a file with the
 ``--payload-file`` option, or as a string argument with the ``--payload``
 option. If neither the ``--payload`` or ``--payload-file`` is provided,
 the payload is assumed to be on <stdin>.
 Each record is expected to have a class identifier, a record version
 number, and a severity level. A class identifier is required to be
 provided.
 OPTIONS
 =======
 * ``-h``, ``--help``:
   Show help options.
 * ``-V``, ``--version``:
   Print the program version.
 * ``-f``, ``--config-file`` <file>:
   Path to configuration file (not implemented yet).
 * ``-s``, ``--severity``:
   Severity level (1-4) - (default 1).
 * ``-c``, ``--class``:
   Classification ``level_1``/``level_2``/``level_3``.
 * ``-p``, ``--payload`` <payload>:
   Record body (max size = 8k).
 * ``-P``, ``--payload-file`` <file>:
   File to read payload from.
 * ``-R``, ``--record-version`` <version>:
   Version number for format of payload (default 1).
 * ``-e``, ``--event-id`` <version>:
   Event id to use in the record. If not provided a randomly generated id will be assigned to record.
 RETURN VALUES
 =============
 0 on success. A non-zero exit code indicates a failure occurred.
 SEE ALSO
 ========
 * `telemprobd(1) <telemprobd.1.html>`__
 * https://github.com/clearlinux/telemetrics-client
 * https://clearlinux.org/documentation/
@@ -1,58 +0,0 @@
 ========
 telemctl
 ========
 -------------------------------------
 Telemetry service administration tool
 -------------------------------------
 :Copyright: \(C) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``telemctl``
 ``/etc/telemetrics/opt-in``
 DESCRIPTION
 ===========
 Control actions for telemetry services. The command can be used to start,
 restart, or stop `telemprobd(1) <telemprobd.1.html>`__ and `telempostd(1) <telempostd.1.html>`__, or to opt-in or opt-out of telemetry delivery of records to a central telemetry service.
 OPTIONS
 =======
 * ``start``|``stop``|``restart``:
   Starts, stops or restarts all running telemetry services.
 * ``opt-in``:
   Opts in to telemetry and the opt-in file ``/etc/telemetrics/opt-in``
   is created. Note: this is a one time required operation before
   telemetry can be used the first time.
 * ``opt-out``:
   Opts out of telemetry, and stops telemetry services. The opt-in file
   ``/etc/telemetrics/opt-in`` is deleted.
 * ``is-active``:
   Checks if telemetry client daemons are active (telemprobd and telempostd).
 RETURN VALUES
 =============
 0 on success. A non-zero exit code indicates a failure occurred.
 SEE ALSO
 ========
 * `telemprobd(1) <telemprobd.1.html>`__
 * https://github.com/clearlinux/telemetrics-client
 * https://clearlinux.org/documentation/
@@ -1,109 +0,0 @@
 ================
 telemetrics.conf
 ================
 ------------------------------------
 Telemetry service configuration file
 ------------------------------------
 :Copyright: \(C) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 5
 SYNOPSIS
 ========
 ``/etc/telemetrics/telemetrics.conf``
 ``/usr/share/defaults/telemetrics/telemetrics.conf``
 DESCRIPTION
 ===========
 This file contains configuration parameters for the `telemprobd(1) <telemprobd.1.html>`__ and `telempostd(1) <telempostd.1.html>`__ telemetry service daemons. The daemon reads this file at startup if it exists.
 SYNTAX
 ======
 The configuration file contains ``key=value`` pairs, formatted as plain
 text, one option per line. Comments can be added by preceding them with the
 ``#`` character. All configuration options should be in a section marked
 with ``[settings]``.
 OPTIONS
 =======
 -  ``server=<url>``
   Server URL including protocol designator.
 -  ``socket_path=<path>``
   Path to the socket that `telemprobd` will listen on.
 -  ``cainfo=<path>``
   Certificate file to use for validation of SSL endpoint.
 -  ``tidheader=<header>``
   Telemetry ID in header format, usually ``tidheader=X-Telemetry-TID:<uuid>``
   post header used to group records in ingestion service, which may be
   ingesting for more than one set of clients. Can be set to any string.
 -  ``record_expiry=<minutes>``
   Record expiry time in minutes.
 -  ``spool_dir=<dir>``
   Local spool directory used to store records being processed.
 -  ``spool_max_size=<kB>``
   maximum size of the spool directory in kB. A value of ``-1`` indicates
   no limit. The block size of the files in this directory is considered,
   and not the actual size of the record itself.
 -  ``spool_process_time=<seconds>``
   Time in seconds for processing spool. Valid range: 120..300. Values
   outside this range are clamped.
 -  ``rate_limit_enabled=<true|false>``
   Enable rate limiting. If this is set to false then all rate-limiting
   disabled. It is possible to disable each rate-limit individually below.
 -  ``record_burst_limit=<limit>``
   Rate limiting record burst limit. Valid Range:  0..``INT_MAX``, -1 = disabled.
 -  ``record_window_length=<minutes>``
   Rate limiting record window length in minutes. Valid Range: 0..59.
 -  ``byte_burst_limit=<limit>``
   Rate limiting byte burst limit. Valid Range:  0..`INT_MAX`, -1 = disabled.
 -  ``byte_window_length=<minutes>``
   Rate limiting byte window length in minutes. Valid Range: 0..59.
 -  ``rate_limit_strategy=<strategy>``
   Rate limit strategy - what to do with record if rate-limiting prevents
   delivery over network. Valid stategies: ``spool``, ``drop``.
 SEE ALSO
 ========
 * `telemprobd(1) <telemprobd.1.html>`__
 * `telempostd(1) <telempostd.1.html>`__
 * https://github.com/clearlinux/telemetrics-client
 * https://clearlinux.org/documentation/
@@ -1,71 +0,0 @@
 =========
 telemetry
 =========
 ----------------------------------------------
 C programming interface for telemetrics-client
 ----------------------------------------------
 :Copyright: \(C) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 3
 SYNOPSIS
 ========
 ``#include "telemetry.h"``
 ``struct telem_ref { struct telem_record *record; };``
 ``int tm_create_record(struct telem_ref **t_ref, uint32_t severity, char *classification, uint32_t payload_version)``
 ``int tm_set_payload(struct telem_ref *t_ref, char *payload)``
 ``int tm_send_record(struct telem_ref *t_ref)``
 ``void tm_free_record(struct telem_ref *t_ref)``
 ``int tm_set_config_file(const char *c_file)``
 ``int tm_is_opted_in(void)``
 DESCRIPTION
 ===========
 The functions in the telemetry library facilitate the delivery of
 telemetry data to the `telemprobd(1) <telemprobd.1.html>`__ service.
 The function ``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 ``tm_free_record()`` when no longer
 needed.
 The function ``tm_set_payload()`` attaches the provided telemetry record
 data to the telemetry record. The current maximum payload size is 8192b.
 The function ``tm_send_record()`` delivers the record to the local
 `telemprobd(1) <telemprobd.1.html>`__ service.
 The function ``tm_set_config_file()`` can be used to provide an alternate
 configuration path to the telemetry library.
 ``tm_is_opted_in`` is a utility provided to check if the one time opt-in
 has been performed.
 RETURN VALUES
 =============
 All these functions return ``0`` on success, or a non-zero return value
 if an error occurred. The function ``tm_free_record()`` does not return
 any value. ``tm_is_opted_in`` returns ``1`` when telemetry is opted-in
 otherwise ``0``.
 SEE ALSO
 ========
 * `telemprobd(1) <telemprobd.1.html>`__
 * https://github.com/clearlinux/telemetrics-client
 * https://clearlinux.org/documentation/
@@ -1,71 +0,0 @@
 ==========
 telempostd
 ==========
 ------------------------
 Telemetry client service
 ------------------------
 :Copyright: \(C) 2018 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``telempostd`` \<flags\>
 ``/etc/telemetrics/telemetrics.conf``
 ``/usr/share/defaults/telemetrics/telemetrics.conf``
 ``/etc/telemetrics/opt-in-static-machine-id``
 DESCRIPTION
 ===========
 The ``telempostd`` program delivers locally generated telemetry records to a remote
 telemetry service. Telemetry data can be in any format, and is relayed as-is.
 OPTIONS
 =======
  * ``-f``, ``--config_file`` \[\<file\>\]:
    Configuration file. This overrides the other parameters.
  * ``-h``, ``--help``:
    Display this help message.
  * ``-V``, ``--version``:
    Print the program version.
 FILES
 =====
 * ``/usr/share/defaults/telemetrics/telemetrics.conf``
    If no custom configuration file is found, ``telempostd`` uses the
    settings in this file.
 * ``/etc/telemetrics/telemetrics.conf``
    Custom configuration file that ``telempostd`` reads. See `telemetrics.conf(5) <telemetrics.conf.5.html>`__.
 EXIT STATUS
 ===========
 0 when no errors occurred. A non-zero exit status indicates a failure occurred.
 SEE ALSO
 ========
 * `telemetry(3) <telemetry.3.html>`__
 * `telemetrics.conf(5) <telemetrics.conf.5.html>`__
 * https://github.com/clearlinux/telemetrics-client
 * https://clearlinux.org/documentation/
@@ -1,78 +0,0 @@
 ==========
 telemprobd
 ==========
 ------------------------
 Telemetry probes service
 ------------------------
 :Copyright: \(C) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 1
 SYNOPSIS
 ========
 ``telemprobd`` \<flags\>
 ``/etc/telemetrics/telemetrics.conf``
 ``/usr/share/defaults/telemetrics/telemetrics.conf``
 ``/etc/telemetrics/opt-in-static-machine-id``
 DESCRIPTION
 ===========
 The ``telemprobd`` program handles communication between telemetry client and telemetry
 probes.
 OPTIONS
 =======
  * ``-f``, ``--config_file`` \[\<file\>\]:
    Configuration file. This overides the other parameters.
  * ``-h``, ``--help``:
    Display this help message.
  * ``-V``, ``--version``:
    Print the program version.
 FILES
 =====
 * ``/usr/share/defaults/telemetrics/telemetrics.conf``
    If no custom configuration file is found, ``telemprobd`` uses the
    settings in this file.
 * ``/etc/telemetrics/telemetrics.conf``
    Custom configuration file that ``telemprobd`` reads. See `telemetrics.conf(5) <telemetrics.conf.5.html>`__.
 * ``/etc/telemetrics/opt-in-static-machine-id``
    If this file exists, the first line of this file will be sent to
    the server as the machine ID. Otherwise, the machine ID will be
    random and changed regularly.
 EXIT STATUS
 ===========
 0 when no errors occurred. A non-zero exit status indicates a failure occurred.
 SEE ALSO
 ========
 * `telemetry(3) <telemetry.3.html>`__
 * `telemetrics.conf(5) <telemetrics.conf.5.html>`__
 * https://github.com/clearlinux/telemetrics-client
 * https://clearlinux.org/documentation/
@@ -1,53 +0,0 @@
 ucd-data-fetch
 ==============
 `ucd-data-fetch(1) <ucd-data-fetch.1.html>`__ – Fetch user-data and ssh keys from cloud services
 SYNOPSIS
 --------
 ``/usr/bin/ucd-data-fetch <aws|oci|tencent>``
 DESCRIPTION
 -----------
 ``ucd-data-fetch`` is a helper agent program that fetches openstack
 user-data from the http://169.254.*/ service, as well as the SSH pubkey
 provided to the cloud instance. After fetching the two pieces of data,
 ucd-data-fetch combines them into a valid ``#cloud-config`` user-data
 text block and passes the output to `ucd(1) <ucd.1.html>`__ for
 processing/execution.
 The user-data file is currently only fetched for aws instances.
 OPTIONS
 -------
 The only parameter supported is the name of the cloud service provider,
 and can be ``aws``, ``oci`` or ``tencent``. It is required, and if not
 passed as argument 1, will cause the program to terminate with an error
 message.
 EXIT STATUS
 -----------
 On success, 0 is returned, a non-zero failure code otherwise. The exit
 code returned may be the exit code of the subsequent ``ucd`` program
 execution.
 COPYRIGHT
 ---------
 -  Copyright (C) 2017-2019 Intel Corporation, License: CC-BY-SA-3.0
 SEE ALSO
 --------
 `ucd(1) <ucd.1.html>`__
 NOTES
 -----
 Creative Commons Attribution-ShareAlike 3.0 Unported
 -  http://creativecommons.org/licenses/by-sa/3.0/
@@ -1,164 +0,0 @@
 ucd
 ===
 micro-config-drive(1) – Configure a cloud instance using config-drive
 data
 SYNOPSIS
 --------
 ``/usr/bin/ucd``
 ``ucd`` [OPTIONS…]
 DESCRIPTION
 -----------
 ``ucd`` runs at boot time with the purpose of configuring a cloud
 instance for use of the end user.
 ucd can perform any of the following (optional) tasks:
 -  create a default account with sudo privileges
 -  lock root and default account, the only way to login is using ssh
   keys (security feature)
 -  maintain the cloud instance in a right state (resize/fix partitions
   and filesystem)
 -  get and process userdata and metadata from an attached config-drive
   block device
 Userdata formats supported:
 -  ``cloud-config``: begins with ``#cloud-config`` and is used to
   execute certain tasks in a human friendly format
 -  ``shell-script``: begins with ``#!`` and is used to execute a shell
   script
 Metadata formats supported:
 -  ``openstack``
 OPENSTACK DATASOURCES
 ---------------------
 Datasources are used to retrive instance-specific data in order to
 configure a new cloud instance. Openstack attaches two datasources to
 the cloud instance when it boots.
 -  ``config-drive``: is a disk formatted with vfat or iso9660 and have a
   label of config-2
 -  ``metadata service``: instances can access to it at
   http://169.254.169.254 ``[NOT SUPPORTED]``
 more information about openstack datasources can be found in:
 -  http://docs.openstack.org/user-guide/cli_config_drive.html
 -  http://docs.openstack.org/admin-guide/compute-networking-nova.html#metadata-service
 WORKFLOW
 --------
 ::
   `|` Parse options
   `|` Init openstack datasource
   `|->` if config-drive is found then define it as datasource otherwise exit
   `|` Start openstack datasource
   `|->` Get userdata and metadata from datasource
   `|` Run async tasks
   `|->` resize disk
   `|->` resize filesystem
   `|` If a datasource was found
   `|->` if VM first boot was detected
   `|   |->` Run async tasks
   `|   |   |->` lock root account
   `|   |   |->` Create sudoers file for default user account
   `|   |->` Create default user account
   `|->` Process openstack metadata
   `|->` Process openstack userdata
   `|` Join async tasks
   `|` Finish openstack datasource (free resources)
 OPTIONS
 -------
 The following options are understood:
 -  ``-h``, ``--help``:
   Prints a help message.
 -  ``-u`` FILE, ``--user-data-file`` FILE:
   Path to a cloud-config user data file&. If omitted, ``ucd`` will
   attempt to fetch user-data from the openstack link-local connected
   data service URL.
 -  ``--openstack-metadata-file`` FILE:
   Path to an openstack metadata file. more information:
   http://docs.openstack.org/user-guide/cli_config_drive.html#openstack-metadata-format
 -  ``--openstack-config-drive`` PATH:
   Path to openstack config drive (iso9660 or vfat filesystem), it will
   be used to process metadata and userdata. more information:
   http://docs.openstack.org/user-guide/cli_config_drive.html#configuration-drive-contents
 -  ``--user-data``:
   Get and process user data from data sources.
 -  ``--user-data-once``:
   Only on first boot get and process user data from data sources. Note
   this option is ignored if ``--user-data`` is enabled.
 -  ``--metadata``:
   Get and process metadata from data sources.
 -  ``--fix-disk``:
   Fix disk and filesystem if it is needed.
 -  ``-v``, ``--version``:
   Prints version information.
 -  ``--first-boot-setup``:
   Setup the instance in its first boot. When first boot of the instance
   is detected, ``ucd`` will perform the following tasks: create a
   default user account, create sudoers file for default user account,
   lock the root account.
 EXIT STATUS
 -----------
 On success, 0 is returned, a non-zero failure code otherwise.
 COPYRIGHT
 ---------
 -  Copyright (C) 2017 Intel Corporation, License: CC-BY-SA-3.0
 SEE ALSO
 --------
 This project is a limited-functionality implementation of the cloud-init
 specification. The full documentation of the generic implementation is
 available online and can be referenced here:
 ``https://cloudinit.readthedocs.org/en/latest/``
 The cloud-config format that `ucd(1) <ucd.1.html>`__ supports is documented in
 `cloud-config(5) <cloud-config.5.html>`__. This lists the options that are supported, their
 structure and function.
 NOTES
 -----
 Creative Commons Attribution-ShareAlike 3.0 Unported
 -  http://creativecommons.org/licenses/by-sa/3.0/
@@ -1,55 +0,0 @@
 ======================
 update-triggers.target
 ======================
 ----------------------------------------
 Provides post OS software-update actions
 ----------------------------------------
 :Copyright: \(C) 2017 Intel Corporation, CC-BY-SA-3.0
 :Manual section: 4
 SYNOPSIS
 ========
 ``update-triggers.target``
 ``/usr/lib/systemd/system/update-triggers.target``
 DESCRIPTION
 ===========
 Instructs the ``systemd``\(1) system daemon what units needed to be
 started as part of the software update process. After the main software
 update content is applied to the OS, the `swupd(1) <swupd.1.html>`__ program starts
 this *systemd* target.
 The main function of this target is to allow optional corrections and
 adjustments to be made after installation that can not easily be made
 through static file installation methods. This usually applies to things
 like cached lists, dynamic configuration files and similar volatile
 databases that are regularly altered and may contain user data.
 One example is the dynamic loader cache which needs to be updated when
 ever there are modifications to the system installed dynamic libraries.
 The user is not intended to execute these scripts and plugin units
 directly. If however so this is desired, one can execute the following
 command to re-execute all the actions:
 ``systemctl start update-triggers.target``
 ENVIRONMENT
 ===========
 This unit is a ``systemd``\(1) target file.
 SEE ALSO
 ========
 `swupd(1) <swupd.1.html>`__
@@ -1,914 +0,0 @@
 /*
 * Sphinx stylesheet -- basic theme.
 */
 /* -- main layout ----------------------------------------------------------- */
 div.clearer {
    clear: both;
 }
 div.section::after {
    display: block;
    content: '';
    clear: left;
 }
 /* -- 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: 210px;
    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-top: 10px;
 }
 ul.search li {
    padding: 5px 0;
 }
 ul.search li a {
    font-weight: bold;
 }
 ul.search li p.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: 360px;
    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;
 }
 a:visited {
    color: #551A8B;
 }
 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, .figure.align-left, object.align-left {
    clear: left;
    float: left;
    margin-right: 1em;
 }
 img.align-right, figure.align-right, .figure.align-right, object.align-right {
    clear: right;
    float: right;
    margin-left: 1em;
 }
 img.align-center, figure.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
 }
 img.align-default, figure.align-default, .figure.align-default {
  display: block;
  margin-left: auto;
  margin-right: auto;
 }
 .align-left {
    text-align: left;
 }
 .align-center {
    text-align: center;
 }
 .align-default {
    text-align: center;
 }
 .align-right {
    text-align: right;
 }
 /* -- sidebars -------------------------------------------------------------- */
 div.sidebar,
 aside.sidebar {
    margin: 0 0 0.5em 1em;
    border: 1px solid #ddb;
    padding: 7px;
    background-color: #ffe;
    width: 40%;
    float: right;
    clear: right;
    overflow-x: auto;
 }
 p.sidebar-title {
    font-weight: bold;
 }
 nav.contents,
 aside.topic,
 div.admonition, div.topic, blockquote {
    clear: left;
 }
 /* -- topics ---------------------------------------------------------------- */
 nav.contents,
 aside.topic,
 div.topic {
    border: 1px solid #ccc;
    padding: 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;
 }
 p.admonition-title {
    margin: 0px 10px 5px 0px;
    font-weight: bold;
 }
 div.body p.centered {
    text-align: center;
    margin-top: 25px;
 }
 /* -- content of sidebars/topics/admonitions -------------------------------- */
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
 nav.contents > :last-child,
 aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
    margin-bottom: 0;
 }
 div.sidebar::after,
 aside.sidebar::after,
 nav.contents::after,
 aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
    display: block;
    content: '';
    clear: both;
 }
 /* -- tables ---------------------------------------------------------------- */
 table.docutils {
    margin-top: 10px;
    margin-bottom: 10px;
    border: 0;
    border-collapse: collapse;
 }
 table.align-center {
    margin-left: auto;
    margin-right: auto;
 }
 table.align-default {
    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;
 }
 th {
    text-align: left;
    padding-right: 5px;
 }
 table.citation {
    border-left: solid 1px gray;
    margin-left: 1px;
 }
 table.citation td {
    border-bottom: none;
 }
 th > :first-child,
 td > :first-child {
    margin-top: 0px;
 }
 th > :last-child,
 td > :last-child {
    margin-bottom: 0px;
 }
 /* -- figures --------------------------------------------------------------- */
 div.figure, figure {
    margin: 0.5em;
    padding: 0.5em;
 }
 div.figure p.caption, figcaption {
    padding: 0.3em;
 }
 div.figure p.caption span.caption-number,
 figcaption span.caption-number {
    font-style: italic;
 }
 div.figure p.caption span.caption-text,
 figcaption 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 {
    margin: 1em 0;
 }
 table.hlist td {
    vertical-align: top;
 }
 /* -- object description styles --------------------------------------------- */
 .sig {
 	font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
 }
 .sig-name, code.descname {
    background-color: transparent;
    font-weight: bold;
 }
 .sig-name {
 	font-size: 1.1em;
 }
 code.descname {
    font-size: 1.2em;
 }
 .sig-prename, code.descclassname {
    background-color: transparent;
 }
 .optional {
    font-size: 1.3em;
 }
 .sig-paren {
    font-size: larger;
 }
 .sig-param.n {
 	font-style: italic;
 }
 /* C++ specific styling */
 .sig-inline.c-texpr,
 .sig-inline.cpp-texpr {
 	font-family: unset;
 }
 .sig.c   .k, .sig.c   .kt,
 .sig.cpp .k, .sig.cpp .kt {
 	color: #0033B3;
 }
 .sig.c   .m,
 .sig.cpp .m {
 	color: #1750EB;
 }
 .sig.c   .s, .sig.c   .sc,
 .sig.cpp .s, .sig.cpp .sc {
 	color: #067D17;
 }
 /* -- 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;
 }
 :not(li) > ol > li:first-child > :first-child,
 :not(li) > ul > li:first-child > :first-child {
    margin-top: 0px;
 }
 :not(li) > ol > li:last-child > :last-child,
 :not(li) > ul > li:last-child > :last-child {
    margin-bottom: 0px;
 }
 ol.simple ol p,
 ol.simple ul p,
 ul.simple ol p,
 ul.simple ul p {
    margin-top: 0;
 }
 ol.simple > li:not(:first-child) > p,
 ul.simple > li:not(:first-child) > p {
    margin-top: 0;
 }
 ol.simple p,
 ul.simple p {
    margin-bottom: 0;
 }
 aside.footnote > span,
 div.citation > span {
    float: left;
 }
 aside.footnote > span:last-of-type,
 div.citation > span:last-of-type {
  padding-right: 0.5em;
 }
 aside.footnote > p {
  margin-left: 2em;
 }
 div.citation > p {
  margin-left: 4em;
 }
 aside.footnote > p:last-of-type,
 div.citation > p:last-of-type {
    margin-bottom: 0em;
 }
 aside.footnote > p:last-of-type:after,
 div.citation > p:last-of-type:after {
    content: "";
    clear: both;
 }
 dl.field-list {
    display: grid;
    grid-template-columns: fit-content(30%) auto;
 }
 dl.field-list > dt {
    font-weight: bold;
    word-break: break-word;
    padding-left: 0.5em;
    padding-right: 5px;
 }
 dl.field-list > dd {
    padding-left: 0.5em;
    margin-top: 0em;
    margin-left: 0em;
    margin-bottom: 0em;
 }
 dl {
    margin-bottom: 15px;
 }
 dd > :first-child {
    margin-top: 0px;
 }
 dd ul, dd table {
    margin-bottom: 10px;
 }
 dd {
    margin-top: 3px;
    margin-bottom: 10px;
    margin-left: 30px;
 }
 .sig dd {
    margin-top: 0px;
    margin-bottom: 0px;
 }
 .sig dl {
    margin-top: 0px;
    margin-bottom: 0px;
 }
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
    margin-bottom: 0;
 }
 dt:target, span.highlighted {
    background-color: #fbe54e;
 }
 rect.highlighted {
    fill: #fbe54e;
 }
 dl.glossary dt {
    font-weight: bold;
    font-size: 1.1em;
 }
 .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;
 }
 .classifier:before {
    font-style: normal;
    margin: 0 0.5em;
    content: ":";
    display: inline-block;
 }
 abbr, acronym {
    border-bottom: dotted 1px;
    cursor: help;
 }
 .translated {
    background-color: rgba(207, 255, 207, 0.2)
 }
 .untranslated {
    background-color: rgba(255, 207, 207, 0.2)
 }
 /* -- code displays --------------------------------------------------------- */
 pre {
    overflow: auto;
    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
 }
 pre, div[class*="highlight-"] {
    clear: both;
 }
 span.pre {
    -moz-hyphens: none;
    -ms-hyphens: none;
    -webkit-hyphens: none;
    hyphens: none;
    white-space: nowrap;
 }
 div[class*="highlight-"] {
    margin: 1em 0;
 }
 td.linenos pre {
    border: 0;
    background-color: transparent;
    color: #aaa;
 }
 table.highlighttable {
    display: block;
 }
 table.highlighttable tbody {
    display: block;
 }
 table.highlighttable tr {
    display: flex;
 }
 table.highlighttable td {
    margin: 0;
    padding: 0;
 }
 table.highlighttable td.linenos {
    padding-right: 0.5em;
 }
 table.highlighttable td.code {
    flex: 1;
    overflow: hidden;
 }
 .highlight .hll {
    display: block;
 }
 div.highlight pre,
 table.highlighttable pre {
    margin: 0;
 }
 div.code-block-caption + div {
    margin-top: 0;
 }
 div.code-block-caption {
    margin-top: 1em;
    padding: 2px 5px;
    font-size: small;
 }
 div.code-block-caption code {
    background-color: transparent;
 }
 table.highlighttable td.linenos,
 span.linenos,
 div.highlight span.gp {  /* gp: Generic.Prompt */
  user-select: none;
  -webkit-user-select: text; /* Safari fallback only */
  -webkit-user-select: none; /* Chrome/Safari */
  -moz-user-select: none; /* Firefox */
  -ms-user-select: none; /* IE10+ */
 }
 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 {
    margin: 1em 0;
 }
 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: absolute;
    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;
    }
 }
@@ -1,505 +0,0 @@
 /*
 * Sphinx stylesheet -- business style theme.
 */
@import url("basic.css");
 /* -- page layout ----------------------------------------------------------- */
 body {
    font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
                 'Verdana', sans-serif;
    font-size: 14px;
    letter-spacing: -0.01em;
    line-height: 150%;
    text-align: center;
    background-color: white;
    background-image: url(background_b01.png);
    color: black;
    padding: 0;
    border-right: 1px solid #336699;
    border-left: 1px solid #336699;
    margin: 0px 40px 0px 40px;
 }
 div.document {
    background-color: white;
    text-align: left;
    background-repeat: repeat-x;
    -moz-box-shadow: 2px 2px 5px #000;
    -webkit-box-shadow: 2px 2px 5px #000;
 }
 div.documentwrapper {
    float: left;
    width: 100%;
 }
 div.bodywrapper {
    margin: 0 0 0 240px;
    border-left: 1px solid #ccc;
 }
 div.body {
    margin: 0;
    padding: 0.5em 20px 20px 20px;
 }
 div.bodywrapper {
    margin: 0 0 0 calc(210px + 30px);
 }
 div.related {
    font-size: 1em;
    -moz-box-shadow: 2px 2px 5px #000;
    -webkit-box-shadow: 2px 2px 5px #000;
 }
 div.related ul {
    background-color: #336699;
    height: 100%;
    overflow: hidden;
    border-top: 1px solid #ddd;
    border-bottom: 1px solid #ddd;
 }
 div.related ul li {
    color: white;
    margin: 0;
    padding: 0;
    height: 2em;
    float: left;
 }
 div.related ul li.right {
    float: right;
    margin-right: 5px;
 }
 div.related ul li a {
    margin: 0;
    padding: 0 5px 0 5px;
    line-height: 1.75em;
    color: #fff;
 }
 div.related ul li a:hover {
    color: #fff;
    text-decoration: underline;
 }
 div.sphinxsidebarwrapper {
    padding: 0;
 }
 div.sphinxsidebar {
    padding: 0.5em 12px 12px 12px;
    width: 210px;
    font-size: 1em;
    text-align: left;
 }
 div.sphinxsidebar h3, div.sphinxsidebar h4 {
    margin: 1em 0 0.5em 0;
    font-size: 1em;
    padding: 0.1em 0 0.1em 0.5em;
    color: white;
    border: 1px solid #336699;
    background-color: #336699;
 }
 div.sphinxsidebar h3 a {
    color: white;
 }
 div.sphinxsidebar ul {
    padding-left: 1.5em;
    margin-top: 7px;
    padding: 0;
    line-height: 130%;
 }
 div.sphinxsidebar ul ul {
    margin-left: 20px;
 }
 div.sphinxsidebar input {
    border: 1px solid #336699;
 }
 div.footer {
    background-color: white;
    color: #336699;
    padding: 3px 8px 3px 0;
    clear: both;
    font-size: 0.8em;
    text-align: right;
    border-bottom: 1px solid #336699;
    -moz-box-shadow: 2px 2px 5px #000;
    -webkit-box-shadow: 2px 2px 5px #000;
 }
 div.footer a {
    color: #336699;
    text-decoration: underline;
 }
 /* -- body styles ----------------------------------------------------------- */
 p {
    margin: 0.8em 0 0.5em 0;
 }
 a {
    color: #336699;
    text-decoration: none;
 }
 a:hover {
    color: #336699;
    text-decoration: underline;
 }
 a:visited {
    color: #551a8b;
 }
 div.body a {
    text-decoration: underline;
 }
 h1, h2, h3 {
    color: #336699;
 }
 h1 {
    margin: 0;
    padding: 0.7em 0 0.3em 0;
    font-size: 1.5em;
 }
 h2 {
    margin: 1.3em 0 0.2em 0;
    font-size: 1.35em;
    padding-bottom: .5em;
    border-bottom: 1px solid #336699;
 }
 h3 {
    margin: 1em 0 -0.3em 0;
    font-size: 1.2em;
    padding-bottom: .3em;
    border-bottom: 1px solid #CCCCCC;
 }
 div.body h1 a, div.body h2 a, div.body h3 a,
 div.body h4 a, div.body h5 a, div.body h6 a {
    color: black!important;
 }
 h1 a.anchor, h2 a.anchor, h3 a.anchor,
 h4 a.anchor, h5 a.anchor, h6 a.anchor {
    display: none;
    margin: 0 0 0 0.3em;
    padding: 0 0.2em 0 0.2em;
    color: #aaa!important;
 }
 h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor,
 h5:hover a.anchor, h6:hover a.anchor {
    display: inline;
 }
 h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover,
 h5 a.anchor:hover, h6 a.anchor:hover {
    color: #777;
    background-color: #eee;
 }
 a.headerlink {
    color: #c60f0f!important;
    font-size: 1em;
    margin-left: 6px;
    padding: 0 4px 0 4px;
    text-decoration: none!important;
 }
 a.headerlink:hover {
    background-color: #ccc;
    color: white!important;
 }
 cite, code, tt {
    font-family: 'Consolas', 'Deja Vu Sans Mono',
                 'Bitstream Vera Sans Mono', monospace;
    font-size: 0.95em;
    letter-spacing: 0.01em;
 }
 code {
    background-color: #F2F2F2;
    border-bottom: 1px solid #ddd;
    color: #333;
 }
 code.descname, code.descclassname, code.xref {
    border: 0;
 }
 hr {
    border: 1px solid #abc;
    margin: 2em;
 }
 a code {
    border: 0;
    color: #CA7900;
 }
 a code:hover {
    color: #2491CF;
 }
 pre {
    background-color: transparent !important;
    font-family: 'Consolas', 'Deja Vu Sans Mono',
                 'Bitstream Vera Sans Mono', monospace;
    font-size: 0.95em;
    letter-spacing: 0.015em;
    line-height: 120%;
    padding: 0.5em;
    border-right: 5px solid #ccc;
    border-left: 5px solid #ccc;
 }
 pre a {
    color: inherit;
    text-decoration: underline;
 }
 td.linenos pre {
    padding: 0.5em 0;
 }
 div.quotebar {
    background-color: #f8f8f8;
    max-width: 250px;
    float: right;
    padding: 2px 7px;
    border: 1px solid #ccc;
 }
 nav.contents,
 aside.topic,
 div.topic {
    background-color: #f8f8f8;
 }
 table {
    border-collapse: collapse;
    margin: 0 -0.5em 0 -0.5em;
 }
 table td, table th {
    padding: 0.2em 0.5em 0.2em 0.5em;
 }
 div.admonition {
    font-size: 0.9em;
    margin: 1em 0 1em 0;
    border: 3px solid #cccccc;
    background-color: #f7f7f7;
    padding: 0;
 }
 div.admonition p {
    margin: 0.5em 1em 0.5em 1em;
    padding: 0;
 }
 div.admonition li p {
    margin-left: 0;
 }
 div.admonition pre, div.warning pre {
    margin: 0;
 }
 div.highlight {
    margin: 0.4em 1em;
 }
 div.admonition p.admonition-title {
    margin: 0;
    padding: 0.1em 0 0.1em 0.5em;
    color: white;
    border-bottom: 3px solid #cccccc;
    font-weight: bold;
    background-color: #165e83;
 }
 div.danger    { border: 3px solid #f0908d; background-color: #f0cfa0; }
 div.error     { border: 3px solid #f0908d; background-color: #ede4cd; }
 div.warning   { border: 3px solid #f8b862; background-color: #f0cfa0; }
 div.caution   { border: 3px solid #f8b862; background-color: #ede4cd; }
 div.attention { border: 3px solid #f8b862; background-color: #f3f3f3; }
 div.important { border: 3px solid #f0cfa0; background-color: #ede4cd; }
 div.note      { border: 3px solid #f0cfa0; background-color: #f3f3f3; }
 div.hint      { border: 3px solid #bed2c3; background-color: #f3f3f3; }
 div.tip       { border: 3px solid #bed2c3; background-color: #f3f3f3; }
 div.danger p.admonition-title, div.error p.admonition-title {
    background-color: #b7282e;
    border-bottom: 3px solid #f0908d;
 }
 div.caution p.admonition-title,
 div.warning p.admonition-title,
 div.attention p.admonition-title {
    background-color: #f19072;
    border-bottom: 3px solid #f8b862;
 }
 div.note p.admonition-title, div.important p.admonition-title {
    background-color: #f8b862;
    border-bottom: 3px solid #f0cfa0;
 }
 div.hint p.admonition-title, div.tip p.admonition-title {
    background-color: #7ebea5;
    border-bottom: 3px solid #bed2c3;
 }
 div.admonition ul, div.admonition ol,
 div.warning ul, div.warning ol {
    margin: 0.1em 0.5em 0.5em 3em;
    padding: 0;
 }
 div.versioninfo {
    margin: 1em 0 0 0;
    border: 1px solid #ccc;
    background-color: #DDEAF0;
    padding: 8px;
    line-height: 1.3em;
    font-size: 0.9em;
 }
 .viewcode-back {
    font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
                 'Verdana', sans-serif;
 }
 div.viewcode-block:target {
    background-color: #f4debf;
    border-top: 1px solid #ac9;
    border-bottom: 1px solid #ac9;
 }
 p.versionchanged span.versionmodified {
    font-size: 0.9em;
    margin-right: 0.2em;
    padding: 0.1em;
    background-color: #DCE6A0;
 }
 dl.field-list > dt {
    color: white;
    background-color: #82A0BE;
 }
 dl.field-list > dd {
    background-color: #f7f7f7;
 }
 /* -- table styles ---------------------------------------------------------- */
 table.docutils {
    margin: 1em 0;
    padding: 0;
    border: 1px solid white;
    background-color: #f7f7f7;
 }
 table.docutils td, table.docutils th {
    padding: 1px 8px 1px 5px;
    border-top: 0;
    border-left: 0;
    border-right: 1px solid white;
    border-bottom: 1px solid white;
 }
 table.docutils td p {
    margin-top: 0;
    margin-bottom: 0.3em;
 }
 table.field-list td, table.field-list th {
    border: 0 !important;
    word-break: break-word;
 }
 table.footnote td, table.footnote th {
    border: 0 !important;
 }
 th {
    color: white;
    text-align: left;
    padding-right: 5px;
    background-color: #82A0BE;
 }
 div.literal-block-wrapper div.code-block-caption {
    background-color: #EEE;
    border-style: solid;
    border-color: #CCC;
    border-width: 1px 5px;
 }
 /* WIDE DESKTOP STYLE */
@media only screen and (min-width: 1176px) {
 body {
    margin: 0 40px 0 40px;
 }
 }
 /* TABLET STYLE */
@media only screen and (min-width: 768px) and (max-width: 991px) {
 body {
    margin: 0 40px 0 40px;
 }
 }
 /* MOBILE LAYOUT (PORTRAIT/320px) */
@media only screen and (max-width: 767px) {
 body {
    margin: 0;
 }
 div.bodywrapper {
    margin: 0;
    width: 100%;
    border: none;
 }
 div.sphinxsidebar {
    display: none;
 }
 }
 /* MOBILE LAYOUT (LANDSCAPE/480px) */
@media only screen and (min-width: 480px) and (max-width: 767px) {
 body {
    margin: 0 20px 0 20px;
 }
 }
 /* RETINA OVERRIDES */
@media
 only screen and (-webkit-min-device-pixel-ratio: 2),
 only screen and (min-device-pixel-ratio: 2) {
 }
 /* -- end ------------------------------------------------------------------- */
@@ -1,24 +0,0 @@
 /*
 * Sphinx javascript -- for bizstyle theme.
 *
 * This theme was created by referring to 'sphinxdoc'
 */
 const initialiseBizStyle = () => {
    if (navigator.userAgent.indexOf("iPhone") > 0 || navigator.userAgent.indexOf("Android") > 0) {
        document.querySelector("li.nav-item-0 a").innerText = "Top"
    }
    const truncator = item => {if (item.textContent.length > 20) {
        item.title = item.innerText
        item.innerText = item.innerText.substr(0, 17) + "..."
      }
    }
    document.querySelectorAll("div.related:first ul li:not(.right) a").slice(1).forEach(truncator);
    document.querySelectorAll("div.related:last ul li:not(.right) a").slice(1).forEach(truncator);
 }
 window.addEventListener("resize",
  () => (document.querySelector("li.nav-item-0 a").innerText = (window.innerWidth <= 776) ? "Top" : "Documentation for Clear Linux* project")
 )
 if (document.readyState !== "loading") initialiseBizStyle()
 else document.addEventListener("DOMContentLoaded", initialiseBizStyle)
@@ -1,4 +0,0 @@
 <svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-check" width="44" height="44" viewBox="0 0 24 24" stroke-width="2" stroke="#22863a" fill="none" stroke-linecap="round" stroke-linejoin="round">
  <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
  <path d="M5 12l5 5l10 -10" />
 </svg>
@@ -1,5 +0,0 @@
 <svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-copy" width="44" height="44" viewBox="0 0 24 24" stroke-width="1.5" stroke="#000000" fill="none" stroke-linecap="round" stroke-linejoin="round">
  <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
  <rect x="8" y="8" width="12" height="12" rx="2" />
  <path d="M16 8v-2a2 2 0 0 0 -2 -2h-8a2 2 0 0 0 -2 2v8a2 2 0 0 0 2 2h2" />
 </svg>
@@ -1,94 +0,0 @@
 /* Copy buttons */
 button.copybtn {
    position: absolute;
    display: flex;
    top: .3em;
    right: .3em;
    width: 1.7em;
    height: 1.7em;
 	opacity: 0;
    transition: opacity 0.3s, border .3s, background-color .3s;
    user-select: none;
    padding: 0;
    border: none;
    outline: none;
    border-radius: 0.4em;
    /* The colors that GitHub uses */
    border: #1b1f2426 1px solid;
    background-color: #f6f8fa;
    color: #57606a;
 }
 button.copybtn.success {
    border-color: #22863a;
    color: #22863a;
 }
 button.copybtn svg {
    stroke: currentColor;
    width: 1.5em;
    height: 1.5em;
    padding: 0.1em;
 }
 div.highlight  {
    position: relative;
 }
 /* Show the copybutton */
 .highlight:hover button.copybtn, button.copybtn.success {
 	opacity: 1;
 }
 .highlight button.copybtn:hover {
    background-color: rgb(235, 235, 235);
 }
 .highlight button.copybtn:active {
    background-color: rgb(187, 187, 187);
 }
 /**
 * A minimal CSS-only tooltip copied from:
 *   https://codepen.io/mildrenben/pen/rVBrpK
 *
 * To use, write HTML like the following:
 *
 * <p class="o-tooltip--left" data-tooltip="Hey">Short</p>
 */
 .o-tooltip--left {
  position: relative;
 }
 .o-tooltip--left:after {
    opacity: 0;
    visibility: hidden;
    position: absolute;
    content: attr(data-tooltip);
    padding: .2em;
    font-size: .8em;
    left: -.2em;
    background: grey;
    color: white;
    white-space: nowrap;
    z-index: 2;
    border-radius: 2px;
    transform: translateX(-102%) translateY(0);
    transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1);
 }
 .o-tooltip--left:hover:after {
    display: block;
    opacity: 1;
    visibility: visible;
    transform: translateX(-100%) translateY(0);
    transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1);
    transition-delay: .5s;
 }
 /* By default the copy button shouldn't show up when printing a page */
@media print {
    button.copybtn {
        display: none;
    }
 }
@@ -1,248 +0,0 @@
 // Localization support
 const messages = {
  'en': {
    'copy': 'Copy',
    'copy_to_clipboard': 'Copy to clipboard',
    'copy_success': 'Copied!',
    'copy_failure': 'Failed to copy',
  },
  'es' : {
    'copy': 'Copiar',
    'copy_to_clipboard': 'Copiar al portapapeles',
    'copy_success': '¡Copiado!',
    'copy_failure': 'Error al copiar',
  },
  'de' : {
    'copy': 'Kopieren',
    'copy_to_clipboard': 'In die Zwischenablage kopieren',
    'copy_success': 'Kopiert!',
    'copy_failure': 'Fehler beim Kopieren',
  },
  'fr' : {
    'copy': 'Copier',
    'copy_to_clipboard': 'Copier dans le presse-papier',
    'copy_success': 'Copié !',
    'copy_failure': 'Échec de la copie',
  },
  'ru': {
    'copy': 'Скопировать',
    'copy_to_clipboard': 'Скопировать в буфер',
    'copy_success': 'Скопировано!',
    'copy_failure': 'Не удалось скопировать',
  },
  'zh-CN': {
    'copy': '复制',
    'copy_to_clipboard': '复制到剪贴板',
    'copy_success': '复制成功!',
    'copy_failure': '复制失败',
  },
  'it' : {
    'copy': 'Copiare',
    'copy_to_clipboard': 'Copiato negli appunti',
    'copy_success': 'Copiato!',
    'copy_failure': 'Errore durante la copia',
  }
 }
 let locale = 'en'
 if( document.documentElement.lang !== undefined
    && messages[document.documentElement.lang] !== undefined ) {
  locale = document.documentElement.lang
 }
 let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT;
 if (doc_url_root == '#') {
    doc_url_root = '';
 }
 /**
 * SVG files for our copy buttons
 */
 let iconCheck = `<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-check" width="44" height="44" viewBox="0 0 24 24" stroke-width="2" stroke="#22863a" fill="none" stroke-linecap="round" stroke-linejoin="round">
  <title>${messages[locale]['copy_success']}</title>
  <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
  <path d="M5 12l5 5l10 -10" />
 </svg>`
 // If the user specified their own SVG use that, otherwise use the default
 let iconCopy = ``;
 if (!iconCopy) {
  iconCopy = `<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-copy" width="44" height="44" viewBox="0 0 24 24" stroke-width="1.5" stroke="#000000" fill="none" stroke-linecap="round" stroke-linejoin="round">
  <title>${messages[locale]['copy_to_clipboard']}</title>
  <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
  <rect x="8" y="8" width="12" height="12" rx="2" />
  <path d="M16 8v-2a2 2 0 0 0 -2 -2h-8a2 2 0 0 0 -2 2v8a2 2 0 0 0 2 2h2" />
 </svg>`
 }
 /**
 * Set up copy/paste for code blocks
 */
 const runWhenDOMLoaded = cb => {
  if (document.readyState != 'loading') {
    cb()
  } else if (document.addEventListener) {
    document.addEventListener('DOMContentLoaded', cb)
  } else {
    document.attachEvent('onreadystatechange', function() {
      if (document.readyState == 'complete') cb()
    })
  }
 }
 const codeCellId = index => `codecell${index}`
 // Clears selected text since ClipboardJS will select the text when copying
 const clearSelection = () => {
  if (window.getSelection) {
    window.getSelection().removeAllRanges()
  } else if (document.selection) {
    document.selection.empty()
  }
 }
 // Changes tooltip text for a moment, then changes it back
 // We want the timeout of our `success` class to be a bit shorter than the
 // tooltip and icon change, so that we can hide the icon before changing back.
 var timeoutIcon = 2000;
 var timeoutSuccessClass = 1500;
 const temporarilyChangeTooltip = (el, oldText, newText) => {
  el.setAttribute('data-tooltip', newText)
  el.classList.add('success')
  // Remove success a little bit sooner than we change the tooltip
  // So that we can use CSS to hide the copybutton first
  setTimeout(() => el.classList.remove('success'), timeoutSuccessClass)
  setTimeout(() => el.setAttribute('data-tooltip', oldText), timeoutIcon)
 }
 // Changes the copy button icon for two seconds, then changes it back
 const temporarilyChangeIcon = (el) => {
  el.innerHTML = iconCheck;
  setTimeout(() => {el.innerHTML = iconCopy}, timeoutIcon)
 }
 const addCopyButtonToCodeCells = () => {
  // If ClipboardJS hasn't loaded, wait a bit and try again. This
  // happens because we load ClipboardJS asynchronously.
  if (window.ClipboardJS === undefined) {
    setTimeout(addCopyButtonToCodeCells, 250)
    return
  }
  // Add copybuttons to all of our code cells
  const COPYBUTTON_SELECTOR = 'div.highlight pre';
  const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR)
  codeCells.forEach((codeCell, index) => {
    const id = codeCellId(index)
    codeCell.setAttribute('id', id)
    const clipboardButton = id =>
    `<button class="copybtn o-tooltip--left" data-tooltip="${messages[locale]['copy']}" data-clipboard-target="#${id}">
      ${iconCopy}
    </button>`
    codeCell.insertAdjacentHTML('afterend', clipboardButton(id))
  })
 function escapeRegExp(string) {
    return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
 }
 /**
 * Removes excluded text from a Node.
 *
 * @param {Node} target Node to filter.
 * @param {string} exclude CSS selector of nodes to exclude.
 * @returns {DOMString} Text from `target` with text removed.
 */
 function filterText(target, exclude) {
    const clone = target.cloneNode(true);  // clone as to not modify the live DOM
    if (exclude) {
        // remove excluded nodes
        clone.querySelectorAll(exclude).forEach(node => node.remove());
    }
    return clone.innerText;
 }
 // Callback when a copy button is clicked. Will be passed the node that was clicked
 // should then grab the text and replace pieces of text that shouldn't be used in output
 function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") {
    var regexp;
    var match;
    // Do we check for line continuation characters and "HERE-documents"?
    var useLineCont = !!lineContinuationChar
    var useHereDoc = !!hereDocDelim
    // create regexp to capture prompt and remaining line
    if (isRegexp) {
        regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)')
    } else {
        regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)')
    }
    const outputLines = [];
    var promptFound = false;
    var gotLineCont = false;
    var gotHereDoc = false;
    const lineGotPrompt = [];
    for (const line of textContent.split('\n')) {
        match = line.match(regexp)
        if (match || gotLineCont || gotHereDoc) {
            promptFound = regexp.test(line)
            lineGotPrompt.push(promptFound)
            if (removePrompts && promptFound) {
                outputLines.push(match[2])
            } else {
                outputLines.push(line)
            }
            gotLineCont = line.endsWith(lineContinuationChar) & useLineCont
            if (line.includes(hereDocDelim) & useHereDoc)
                gotHereDoc = !gotHereDoc
        } else if (!onlyCopyPromptLines) {
            outputLines.push(line)
        } else if (copyEmptyLines && line.trim() === '') {
            outputLines.push(line)
        }
    }
    // If no lines with the prompt were found then just use original lines
    if (lineGotPrompt.some(v => v === true)) {
        textContent = outputLines.join('\n');
    }
    // Remove a trailing newline to avoid auto-running when pasting
    if (textContent.endsWith("\n")) {
        textContent = textContent.slice(0, -1)
    }
    return textContent
 }
 var copyTargetText = (trigger) => {
  var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);
  // get filtered text
  let exclude = '.linenos';
  let text = filterText(target, exclude);
  return formatCopyText(text, '$ ', false, true, true, true, '', '')
 }
  // Initialize with a callback so we can modify the text before copy
  const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText})
  // Update UI with error/success messages
  clipboard.on('success', event => {
    clearSelection()
    temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success'])
    temporarilyChangeIcon(event.trigger)
  })
  clipboard.on('error', event => {
    temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure'])
  })
 }
 runWhenDOMLoaded(addCopyButtonToCodeCells)
@@ -1,73 +0,0 @@
 function escapeRegExp(string) {
    return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
 }
 /**
 * Removes excluded text from a Node.
 *
 * @param {Node} target Node to filter.
 * @param {string} exclude CSS selector of nodes to exclude.
 * @returns {DOMString} Text from `target` with text removed.
 */
 export function filterText(target, exclude) {
    const clone = target.cloneNode(true);  // clone as to not modify the live DOM
    if (exclude) {
        // remove excluded nodes
        clone.querySelectorAll(exclude).forEach(node => node.remove());
    }
    return clone.innerText;
 }
 // Callback when a copy button is clicked. Will be passed the node that was clicked
 // should then grab the text and replace pieces of text that shouldn't be used in output
 export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") {
    var regexp;
    var match;
    // Do we check for line continuation characters and "HERE-documents"?
    var useLineCont = !!lineContinuationChar
    var useHereDoc = !!hereDocDelim
    // create regexp to capture prompt and remaining line
    if (isRegexp) {
        regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)')
    } else {
        regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)')
    }
    const outputLines = [];
    var promptFound = false;
    var gotLineCont = false;
    var gotHereDoc = false;
    const lineGotPrompt = [];
    for (const line of textContent.split('\n')) {
        match = line.match(regexp)
        if (match || gotLineCont || gotHereDoc) {
            promptFound = regexp.test(line)
            lineGotPrompt.push(promptFound)
            if (removePrompts && promptFound) {
                outputLines.push(match[2])
            } else {
                outputLines.push(line)
            }
            gotLineCont = line.endsWith(lineContinuationChar) & useLineCont
            if (line.includes(hereDocDelim) & useHereDoc)
                gotHereDoc = !gotHereDoc
        } else if (!onlyCopyPromptLines) {
            outputLines.push(line)
        } else if (copyEmptyLines && line.trim() === '') {
            outputLines.push(line)
        }
    }
    // If no lines with the prompt were found then just use original lines
    if (lineGotPrompt.some(v => v === true)) {
        textContent = outputLines.join('\n');
    }
    // Remove a trailing newline to avoid auto-running when pasting
    if (textContent.endsWith("\n")) {
        textContent = textContent.slice(0, -1)
    }
    return textContent
 }
@@ -1,149 +0,0 @@
 /*
 * Base JavaScript utilities for all Sphinx HTML documentation.
 */
 "use strict";
 const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
  "TEXTAREA",
  "INPUT",
  "SELECT",
  "BUTTON",
 ]);
 const _ready = (callback) => {
  if (document.readyState !== "loading") {
    callback();
  } else {
    document.addEventListener("DOMContentLoaded", callback);
  }
 };
 /**
 * Small JavaScript module for the documentation.
 */
 const Documentation = {
  init: () => {
    Documentation.initDomainIndexTable();
    Documentation.initOnKeyListeners();
  },
  /**
   * i18n support
   */
  TRANSLATIONS: {},
  PLURAL_EXPR: (n) => (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: (string) => {
    const translated = Documentation.TRANSLATIONS[string];
    switch (typeof translated) {
      case "undefined":
        return string; // no translation
      case "string":
        return translated; // translation exists
      default:
        return translated[0]; // (singular, plural) translation tuple exists
    }
  },
  ngettext: (singular, plural, n) => {
    const translated = Documentation.TRANSLATIONS[singular];
    if (typeof translated !== "undefined")
      return translated[Documentation.PLURAL_EXPR(n)];
    return n === 1 ? singular : plural;
  },
  addTranslations: (catalog) => {
    Object.assign(Documentation.TRANSLATIONS, catalog.messages);
    Documentation.PLURAL_EXPR = new Function(
      "n",
      `return (${catalog.plural_expr})`
    );
    Documentation.LOCALE = catalog.locale;
  },
  /**
   * helper function to focus on search bar
   */
  focusSearchBar: () => {
    document.querySelectorAll("input[name=q]")[0]?.focus();
  },
  /**
   * Initialise the domain index toggle buttons
   */
  initDomainIndexTable: () => {
    const toggler = (el) => {
      const idNumber = el.id.substr(7);
      const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
      if (el.src.substr(-9) === "minus.png") {
        el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
        toggledRows.forEach((el) => (el.style.display = "none"));
      } else {
        el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
        toggledRows.forEach((el) => (el.style.display = ""));
      }
    };
    const togglerElements = document.querySelectorAll("img.toggler");
    togglerElements.forEach((el) =>
      el.addEventListener("click", (event) => toggler(event.currentTarget))
    );
    togglerElements.forEach((el) => (el.style.display = ""));
    if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
  },
  initOnKeyListeners: () => {
    // only install a listener if it is really needed
    if (
      !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
      !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
    )
      return;
    document.addEventListener("keydown", (event) => {
      // bail for input elements
      if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
      // bail with special keys
      if (event.altKey || event.ctrlKey || event.metaKey) return;
      if (!event.shiftKey) {
        switch (event.key) {
          case "ArrowLeft":
            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
            const prevLink = document.querySelector('link[rel="prev"]');
            if (prevLink && prevLink.href) {
              window.location.href = prevLink.href;
              event.preventDefault();
            }
            break;
          case "ArrowRight":
            if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
            const nextLink = document.querySelector('link[rel="next"]');
            if (nextLink && nextLink.href) {
              window.location.href = nextLink.href;
              event.preventDefault();
            }
            break;
        }
      }
      // some keyboard layouts may need Shift to get /
      switch (event.key) {
        case "/":
          if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
          Documentation.focusSearchBar();
          event.preventDefault();
      }
    });
  },
 };
 // quick alias for translations
 const _ = Documentation.gettext;
 _ready(Documentation.init);
@@ -1,13 +0,0 @@
 const DOCUMENTATION_OPTIONS = {
    VERSION: '',
    LANGUAGE: 'en',
    COLLAPSE_INDEX: false,
    BUILDER: 'html',
    FILE_SUFFIX: '.html',
    LINK_SUFFIX: '.html',
    HAS_SOURCE: true,
    SOURCELINK_SUFFIX: '.txt',
    NAVIGATION_WITH_KEYS: false,
    SHOW_SEARCH_SUMMARY: true,
    ENABLE_SEARCH_SHORTCUTS: true,
 };
@@ -1,192 +0,0 @@
 /*
 * This script contains the language-specific data used by searchtools.js,
 * namely the list of stopwords, stemmer, scorer and splitter.
 */
 var stopwords = ["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 is copied as a separate JS file, if available */
 /**
 * 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;
  }
 }
@@ -1,75 +0,0 @@
 pre { line-height: 125%; }
 td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
 td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .highlight .hll { background-color: #ffffcc }
 .highlight { background: #eeffcc; }
 .highlight .c { color: #408090; font-style: italic } /* Comment */
 .highlight .err { border: 1px solid #FF0000 } /* Error */
 .highlight .k { color: #007020; font-weight: bold } /* Keyword */
 .highlight .o { color: #666666 } /* Operator */
 .highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
 .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
 .highlight .cp { color: #007020 } /* Comment.Preproc */
 .highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
 .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
 .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
 .highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #FF0000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #00A000 } /* Generic.Inserted */
 .highlight .go { color: #333333 } /* Generic.Output */
 .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
 .highlight .gs { font-weight: bold } /* Generic.Strong */
 .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
 .highlight .gt { color: #0044DD } /* Generic.Traceback */
 .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
 .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
 .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
 .highlight .kp { color: #007020 } /* Keyword.Pseudo */
 .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
 .highlight .kt { color: #902000 } /* Keyword.Type */
 .highlight .m { color: #208050 } /* Literal.Number */
 .highlight .s { color: #4070a0 } /* Literal.String */
 .highlight .na { color: #4070a0 } /* Name.Attribute */
 .highlight .nb { color: #007020 } /* Name.Builtin */
 .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
 .highlight .no { color: #60add5 } /* Name.Constant */
 .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
 .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
 .highlight .ne { color: #007020 } /* Name.Exception */
 .highlight .nf { color: #06287e } /* Name.Function */
 .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
 .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
 .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
 .highlight .nv { color: #bb60d5 } /* Name.Variable */
 .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
 .highlight .w { color: #bbbbbb } /* Text.Whitespace */
 .highlight .mb { color: #208050 } /* Literal.Number.Bin */
 .highlight .mf { color: #208050 } /* Literal.Number.Float */
 .highlight .mh { color: #208050 } /* Literal.Number.Hex */
 .highlight .mi { color: #208050 } /* Literal.Number.Integer */
 .highlight .mo { color: #208050 } /* Literal.Number.Oct */
 .highlight .sa { color: #4070a0 } /* Literal.String.Affix */
 .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
 .highlight .sc { color: #4070a0 } /* Literal.String.Char */
 .highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
 .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
 .highlight .s2 { color: #4070a0 } /* Literal.String.Double */
 .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
 .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
 .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
 .highlight .sx { color: #c65d09 } /* Literal.String.Other */
 .highlight .sr { color: #235388 } /* Literal.String.Regex */
 .highlight .s1 { color: #4070a0 } /* Literal.String.Single */
 .highlight .ss { color: #517918 } /* Literal.String.Symbol */
 .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
 .highlight .fm { color: #06287e } /* Name.Function.Magic */
 .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
 .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
 .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
 .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
 .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
@@ -1,632 +0,0 @@
 /*
 * Sphinx JavaScript utilities for the full-text search.
 */
 "use strict";
 /**
 * Simple result scoring code.
 */
 if (typeof Scorer === "undefined") {
  var Scorer = {
    // Implement the following function to further tweak the score for each result
    // The function takes a result array [docname, title, anchor, descr, score, filename]
    // and returns the new score.
    /*
    score: result => {
      const [docname, title, anchor, descr, score, filename, kind] = result
      return score
    },
    */
    // query matches the full name of an object
    objNameMatch: 11,
    // or matches in the last dotted part of the object name
    objPartialMatch: 6,
    // Additive scores depending on the priority of the object
    objPrio: {
      0: 15, // used to be importantResults
      1: 5, // used to be objectResults
      2: -5, // used to be unimportantResults
    },
    //  Used when the priority is not in the mapping.
    objPrioDefault: 0,
    // query found in title
    title: 15,
    partialTitle: 7,
    // query found in terms
    term: 5,
    partialTerm: 2,
  };
 }
 // Global search result kind enum, used by themes to style search results.
 class SearchResultKind {
    static get index() { return  "index"; }
    static get object() { return "object"; }
    static get text() { return "text"; }
    static get title() { return "title"; }
 }
 const _removeChildren = (element) => {
  while (element && element.lastChild) element.removeChild(element.lastChild);
 };
 /**
 * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
 */
 const _escapeRegExp = (string) =>
  string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
 const _displayItem = (item, searchTerms, highlightTerms) => {
  const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
  const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
  const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
  const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
  const contentRoot = document.documentElement.dataset.content_root;
  const [docName, title, anchor, descr, score, _filename, kind] = item;
  let listItem = document.createElement("li");
  // Add a class representing the item's type:
  // can be used by a theme's CSS selector for styling
  // See SearchResultKind for the class names.
  listItem.classList.add(`kind-${kind}`);
  let requestUrl;
  let linkUrl;
  if (docBuilder === "dirhtml") {
    // dirhtml builder
    let dirname = docName + "/";
    if (dirname.match(/\/index\/$/))
      dirname = dirname.substring(0, dirname.length - 6);
    else if (dirname === "index/") dirname = "";
    requestUrl = contentRoot + dirname;
    linkUrl = requestUrl;
  } else {
    // normal html builders
    requestUrl = contentRoot + docName + docFileSuffix;
    linkUrl = docName + docLinkSuffix;
  }
  let linkEl = listItem.appendChild(document.createElement("a"));
  linkEl.href = linkUrl + anchor;
  linkEl.dataset.score = score;
  linkEl.innerHTML = title;
  if (descr) {
    listItem.appendChild(document.createElement("span")).innerHTML =
      " (" + descr + ")";
    // highlight search terms in the description
    if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
      highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
  }
  else if (showSearchSummary)
    fetch(requestUrl)
      .then((responseData) => responseData.text())
      .then((data) => {
        if (data)
          listItem.appendChild(
            Search.makeSearchSummary(data, searchTerms, anchor)
          );
        // highlight search terms in the summary
        if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
          highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
      });
  Search.output.appendChild(listItem);
 };
 const _finishSearch = (resultCount) => {
  Search.stopPulse();
  Search.title.innerText = _("Search Results");
  if (!resultCount)
    Search.status.innerText = Documentation.gettext(
      "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
    );
  else
    Search.status.innerText = Documentation.ngettext(
      "Search finished, found one page matching the search query.",
      "Search finished, found ${resultCount} pages matching the search query.",
      resultCount,
    ).replace('${resultCount}', resultCount);
 };
 const _displayNextItem = (
  results,
  resultCount,
  searchTerms,
  highlightTerms,
 ) => {
  // results left, load the summary and display it
  // this is intended to be dynamic (don't sub resultsCount)
  if (results.length) {
    _displayItem(results.pop(), searchTerms, highlightTerms);
    setTimeout(
      () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
      5
    );
  }
  // search finished, update title and status message
  else _finishSearch(resultCount);
 };
 // Helper function used by query() to order search results.
 // Each input is an array of [docname, title, anchor, descr, score, filename, kind].
 // Order the results by score (in opposite order of appearance, since the
 // `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
 const _orderResultsByScoreThenName = (a, b) => {
  const leftScore = a[4];
  const rightScore = b[4];
  if (leftScore === rightScore) {
    // same score: sort alphabetically
    const leftTitle = a[1].toLowerCase();
    const rightTitle = b[1].toLowerCase();
    if (leftTitle === rightTitle) return 0;
    return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
  }
  return leftScore > rightScore ? 1 : -1;
 };
 /**
 * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
 * custom function per language.
 *
 * The regular expression works by splitting the string on consecutive characters
 * that are not Unicode letters, numbers, underscores, or emoji characters.
 * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
 */
 if (typeof splitQuery === "undefined") {
  var splitQuery = (query) => query
      .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
      .filter(term => term)  // remove remaining empty strings
 }
 /**
 * Search Module
 */
 const Search = {
  _index: null,
  _queued_query: null,
  _pulse_status: -1,
  htmlToText: (htmlString, anchor) => {
    const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
    for (const removalQuery of [".headerlink", "script", "style"]) {
      htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
    }
    if (anchor) {
      const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
      if (anchorContent) return anchorContent.textContent;
      console.warn(
        `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
      );
    }
    // if anchor not specified or not found, fall back to main content
    const docContent = htmlElement.querySelector('[role="main"]');
    if (docContent) return docContent.textContent;
    console.warn(
      "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
    );
    return "";
  },
  init: () => {
    const query = new URLSearchParams(window.location.search).get("q");
    document
      .querySelectorAll('input[name="q"]')
      .forEach((el) => (el.value = query));
    if (query) Search.performSearch(query);
  },
  loadIndex: (url) =>
    (document.body.appendChild(document.createElement("script")).src = url),
  setIndex: (index) => {
    Search._index = index;
    if (Search._queued_query !== null) {
      const query = Search._queued_query;
      Search._queued_query = null;
      Search.query(query);
    }
  },
  hasIndex: () => Search._index !== null,
  deferQuery: (query) => (Search._queued_query = query),
  stopPulse: () => (Search._pulse_status = -1),
  startPulse: () => {
    if (Search._pulse_status >= 0) return;
    const pulse = () => {
      Search._pulse_status = (Search._pulse_status + 1) % 4;
      Search.dots.innerText = ".".repeat(Search._pulse_status);
      if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
    };
    pulse();
  },
  /**
   * perform a search for something (or wait until index is loaded)
   */
  performSearch: (query) => {
    // create the required interface elements
    const searchText = document.createElement("h2");
    searchText.textContent = _("Searching");
    const searchSummary = document.createElement("p");
    searchSummary.classList.add("search-summary");
    searchSummary.innerText = "";
    const searchList = document.createElement("ul");
    searchList.setAttribute("role", "list");
    searchList.classList.add("search");
    const out = document.getElementById("search-results");
    Search.title = out.appendChild(searchText);
    Search.dots = Search.title.appendChild(document.createElement("span"));
    Search.status = out.appendChild(searchSummary);
    Search.output = out.appendChild(searchList);
    const searchProgress = document.getElementById("search-progress");
    // Some themes don't use the search progress node
    if (searchProgress) {
      searchProgress.innerText = _("Preparing search...");
    }
    Search.startPulse();
    // index already loaded, the browser was quick!
    if (Search.hasIndex()) Search.query(query);
    else Search.deferQuery(query);
  },
  _parseQuery: (query) => {
    // stem the search terms and add them to the correct list
    const stemmer = new Stemmer();
    const searchTerms = new Set();
    const excludedTerms = new Set();
    const highlightTerms = new Set();
    const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
    splitQuery(query.trim()).forEach((queryTerm) => {
      const queryTermLower = queryTerm.toLowerCase();
      // maybe skip this "word"
      // stopwords array is from language_data.js
      if (
        stopwords.indexOf(queryTermLower) !== -1 ||
        queryTerm.match(/^\d+$/)
      )
        return;
      // stem the word
      let word = stemmer.stemWord(queryTermLower);
      // select the correct list
      if (word[0] === "-") excludedTerms.add(word.substr(1));
      else {
        searchTerms.add(word);
        highlightTerms.add(queryTermLower);
      }
    });
    if (SPHINX_HIGHLIGHT_ENABLED) {  // set in sphinx_highlight.js
      localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
    }
    // console.debug("SEARCH: searching for:");
    // console.info("required: ", [...searchTerms]);
    // console.info("excluded: ", [...excludedTerms]);
    return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
  },
  /**
   * execute search (requires search index to be loaded)
   */
  _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
    const filenames = Search._index.filenames;
    const docNames = Search._index.docnames;
    const titles = Search._index.titles;
    const allTitles = Search._index.alltitles;
    const indexEntries = Search._index.indexentries;
    // Collect multiple result groups to be sorted separately and then ordered.
    // Each is an array of [docname, title, anchor, descr, score, filename, kind].
    const normalResults = [];
    const nonMainIndexResults = [];
    _removeChildren(document.getElementById("search-progress"));
    const queryLower = query.toLowerCase().trim();
    for (const [title, foundTitles] of Object.entries(allTitles)) {
      if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
        for (const [file, id] of foundTitles) {
          const score = Math.round(Scorer.title * queryLower.length / title.length);
          const boost = titles[file] === title ? 1 : 0;  // add a boost for document titles
          normalResults.push([
            docNames[file],
            titles[file] !== title ? `${titles[file]} > ${title}` : title,
            id !== null ? "#" + id : "",
            null,
            score + boost,
            filenames[file],
            SearchResultKind.title,
          ]);
        }
      }
    }
    // search for explicit entries in index directives
    for (const [entry, foundEntries] of Object.entries(indexEntries)) {
      if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
        for (const [file, id, isMain] of foundEntries) {
          const score = Math.round(100 * queryLower.length / entry.length);
          const result = [
            docNames[file],
            titles[file],
            id ? "#" + id : "",
            null,
            score,
            filenames[file],
            SearchResultKind.index,
          ];
          if (isMain) {
            normalResults.push(result);
          } else {
            nonMainIndexResults.push(result);
          }
        }
      }
    }
    // lookup as object
    objectTerms.forEach((term) =>
      normalResults.push(...Search.performObjectSearch(term, objectTerms))
    );
    // lookup as search terms in fulltext
    normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
    // let the scorer override scores with a custom scoring function
    if (Scorer.score) {
      normalResults.forEach((item) => (item[4] = Scorer.score(item)));
      nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
    }
    // Sort each group of results by score and then alphabetically by name.
    normalResults.sort(_orderResultsByScoreThenName);
    nonMainIndexResults.sort(_orderResultsByScoreThenName);
    // Combine the result groups in (reverse) order.
    // Non-main index entries are typically arbitrary cross-references,
    // so display them after other results.
    let results = [...nonMainIndexResults, ...normalResults];
    // remove duplicate search results
    // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
    let seen = new Set();
    results = results.reverse().reduce((acc, result) => {
      let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
      if (!seen.has(resultStr)) {
        acc.push(result);
        seen.add(resultStr);
      }
      return acc;
    }, []);
    return results.reverse();
  },
  query: (query) => {
    const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
    const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
    // for debugging
    //Search.lastresults = results.slice();  // a copy
    // console.info("search results:", Search.lastresults);
    // print the results
    _displayNextItem(results, results.length, searchTerms, highlightTerms);
  },
  /**
   * search for object names
   */
  performObjectSearch: (object, objectTerms) => {
    const filenames = Search._index.filenames;
    const docNames = Search._index.docnames;
    const objects = Search._index.objects;
    const objNames = Search._index.objnames;
    const titles = Search._index.titles;
    const results = [];
    const objectSearchCallback = (prefix, match) => {
      const name = match[4]
      const fullname = (prefix ? prefix + "." : "") + name;
      const fullnameLower = fullname.toLowerCase();
      if (fullnameLower.indexOf(object) < 0) return;
      let score = 0;
      const parts = fullnameLower.split(".");
      // check for different match types: exact matches of full name or
      // "last name" (i.e. last dotted part)
      if (fullnameLower === object || parts.slice(-1)[0] === object)
        score += Scorer.objNameMatch;
      else if (parts.slice(-1)[0].indexOf(object) > -1)
        score += Scorer.objPartialMatch; // matches in last name
      const objName = objNames[match[1]][2];
      const title = titles[match[0]];
      // If more than one term searched for, we require other words to be
      // found in the name/title/description
      const otherTerms = new Set(objectTerms);
      otherTerms.delete(object);
      if (otherTerms.size > 0) {
        const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
        if (
          [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
        )
          return;
      }
      let anchor = match[3];
      if (anchor === "") anchor = fullname;
      else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
      const descr = objName + _(", in ") + title;
      // add custom score for some objects according to scorer
      if (Scorer.objPrio.hasOwnProperty(match[2]))
        score += Scorer.objPrio[match[2]];
      else score += Scorer.objPrioDefault;
      results.push([
        docNames[match[0]],
        fullname,
        "#" + anchor,
        descr,
        score,
        filenames[match[0]],
        SearchResultKind.object,
      ]);
    };
    Object.keys(objects).forEach((prefix) =>
      objects[prefix].forEach((array) =>
        objectSearchCallback(prefix, array)
      )
    );
    return results;
  },
  /**
   * search for full-text terms in the index
   */
  performTermsSearch: (searchTerms, excludedTerms) => {
    // prepare search
    const terms = Search._index.terms;
    const titleTerms = Search._index.titleterms;
    const filenames = Search._index.filenames;
    const docNames = Search._index.docnames;
    const titles = Search._index.titles;
    const scoreMap = new Map();
    const fileMap = new Map();
    // perform the search on the required terms
    searchTerms.forEach((word) => {
      const files = [];
      const arr = [
        { files: terms[word], score: Scorer.term },
        { files: titleTerms[word], score: Scorer.title },
      ];
      // add support for partial matches
      if (word.length > 2) {
        const escapedWord = _escapeRegExp(word);
        if (!terms.hasOwnProperty(word)) {
          Object.keys(terms).forEach((term) => {
            if (term.match(escapedWord))
              arr.push({ files: terms[term], score: Scorer.partialTerm });
          });
        }
        if (!titleTerms.hasOwnProperty(word)) {
          Object.keys(titleTerms).forEach((term) => {
            if (term.match(escapedWord))
              arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
          });
        }
      }
      // no match but word was a required one
      if (arr.every((record) => record.files === undefined)) return;
      // found search word in contents
      arr.forEach((record) => {
        if (record.files === undefined) return;
        let recordFiles = record.files;
        if (recordFiles.length === undefined) recordFiles = [recordFiles];
        files.push(...recordFiles);
        // set score for the word in each file
        recordFiles.forEach((file) => {
          if (!scoreMap.has(file)) scoreMap.set(file, {});
          scoreMap.get(file)[word] = record.score;
        });
      });
      // create the mapping
      files.forEach((file) => {
        if (!fileMap.has(file)) fileMap.set(file, [word]);
        else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
      });
    });
    // now check if the files don't contain excluded terms
    const results = [];
    for (const [file, wordList] of fileMap) {
      // check if all requirements are matched
      // as search terms with length < 3 are discarded
      const filteredTermCount = [...searchTerms].filter(
        (term) => term.length > 2
      ).length;
      if (
        wordList.length !== searchTerms.size &&
        wordList.length !== filteredTermCount
      )
        continue;
      // ensure that none of the excluded terms is in the search result
      if (
        [...excludedTerms].some(
          (term) =>
            terms[term] === file ||
            titleTerms[term] === file ||
            (terms[term] || []).includes(file) ||
            (titleTerms[term] || []).includes(file)
        )
      )
        break;
      // select one (max) score for the file.
      const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
      // add result to the result list
      results.push([
        docNames[file],
        titles[file],
        "",
        null,
        score,
        filenames[file],
        SearchResultKind.text,
      ]);
    }
    return results;
  },
  /**
   * helper function to return a node containing the
   * search summary for a given text. keywords is a list
   * of stemmed words.
   */
  makeSearchSummary: (htmlText, keywords, anchor) => {
    const text = Search.htmlToText(htmlText, anchor);
    if (text === "") return null;
    const textLower = text.toLowerCase();
    const actualStartPosition = [...keywords]
      .map((k) => textLower.indexOf(k.toLowerCase()))
      .filter((i) => i > -1)
      .slice(-1)[0];
    const startWithContext = Math.max(actualStartPosition - 120, 0);
    const top = startWithContext === 0 ? "" : "...";
    const tail = startWithContext + 240 < text.length ? "..." : "";
    let summary = document.createElement("p");
    summary.classList.add("context");
    summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
    return summary;
  },
 };
 _ready(Search.init);
@@ -1,154 +0,0 @@
 /* Highlighting utilities for Sphinx HTML documentation. */
 "use strict";
 const SPHINX_HIGHLIGHT_ENABLED = true
 /**
 * highlight a given string on a node by wrapping it in
 * span elements with the given class name.
 */
 const _highlight = (node, addItems, text, className) => {
  if (node.nodeType === Node.TEXT_NODE) {
    const val = node.nodeValue;
    const parent = node.parentNode;
    const pos = val.toLowerCase().indexOf(text);
    if (
      pos >= 0 &&
      !parent.classList.contains(className) &&
      !parent.classList.contains("nohighlight")
    ) {
      let span;
      const closestNode = parent.closest("body, svg, foreignObject");
      const isInSVG = closestNode && closestNode.matches("svg");
      if (isInSVG) {
        span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
      } else {
        span = document.createElement("span");
        span.classList.add(className);
      }
      span.appendChild(document.createTextNode(val.substr(pos, text.length)));
      const rest = document.createTextNode(val.substr(pos + text.length));
      parent.insertBefore(
        span,
        parent.insertBefore(
          rest,
          node.nextSibling
        )
      );
      node.nodeValue = val.substr(0, pos);
      /* There may be more occurrences of search term in this node. So call this
       * function recursively on the remaining fragment.
       */
      _highlight(rest, addItems, text, className);
      if (isInSVG) {
        const rect = document.createElementNS(
          "http://www.w3.org/2000/svg",
          "rect"
        );
        const bbox = parent.getBBox();
        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);
        addItems.push({ parent: parent, target: rect });
      }
    }
  } else if (node.matches && !node.matches("button, select, textarea")) {
    node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
  }
 };
 const _highlightText = (thisNode, text, className) => {
  let addItems = [];
  _highlight(thisNode, addItems, text, className);
  addItems.forEach((obj) =>
    obj.parent.insertAdjacentElement("beforebegin", obj.target)
  );
 };
 /**
 * Small JavaScript module for the documentation.
 */
 const SphinxHighlight = {
  /**
   * highlight the search words provided in localstorage in the text
   */
  highlightSearchWords: () => {
    if (!SPHINX_HIGHLIGHT_ENABLED) return;  // bail if no highlight
    // get and clear terms from localstorage
    const url = new URL(window.location);
    const highlight =
        localStorage.getItem("sphinx_highlight_terms")
        || url.searchParams.get("highlight")
        || "";
    localStorage.removeItem("sphinx_highlight_terms")
    url.searchParams.delete("highlight");
    window.history.replaceState({}, "", url);
    // get individual terms from highlight string
    const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
    if (terms.length === 0) return; // nothing to do
    // There should never be more than one element matching "div.body"
    const divBody = document.querySelectorAll("div.body");
    const body = divBody.length ? divBody[0] : document.querySelector("body");
    window.setTimeout(() => {
      terms.forEach((term) => _highlightText(body, term, "highlighted"));
    }, 10);
    const searchBox = document.getElementById("searchbox");
    if (searchBox === null) return;
    searchBox.appendChild(
      document
        .createRange()
        .createContextualFragment(
          '<p class="highlight-link">' +
            '<a href="javascript:SphinxHighlight.hideSearchWords()">' +
            _("Hide Search Matches") +
            "</a></p>"
        )
    );
  },
  /**
   * helper function to hide the search marks again
   */
  hideSearchWords: () => {
    document
      .querySelectorAll("#searchbox .highlight-link")
      .forEach((el) => el.remove());
    document
      .querySelectorAll("span.highlighted")
      .forEach((el) => el.classList.remove("highlighted"));
    localStorage.removeItem("sphinx_highlight_terms")
  },
  initEscapeListener: () => {
    // only install a listener if it is really needed
    if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
    document.addEventListener("keydown", (event) => {
      // bail for input elements
      if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
      // bail with special keys
      if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
      if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
        SphinxHighlight.hideSearchWords();
        event.preventDefault();
      }
    });
  },
 };
 _ready(() => {
  /* Do not call highlightSearchWords() when we are on the search page.
   * It will highlight words from the *previous* search query.
   */
  if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
  SphinxHighlight.initEscapeListener();
 });
@@ -1,89 +0,0 @@
 .sphinx-tabs {
  margin-bottom: 1rem;
 }
 [role="tablist"] {
  border-bottom: 1px solid #a0b3bf;
 }
 .sphinx-tabs-tab {
  position: relative;
  font-family: Lato,'Helvetica Neue',Arial,Helvetica,sans-serif;
  color: #1D5C87;
  line-height: 24px;
  margin: 0;
  font-size: 16px;
  font-weight: 400;
  background-color: rgba(255, 255, 255, 0);
  border-radius: 5px 5px 0 0;
  border: 0;
  padding: 1rem 1.5rem;
  margin-bottom: 0;
 }
 .sphinx-tabs-tab[aria-selected="true"] {
  font-weight: 700;
  border: 1px solid #a0b3bf;
  border-bottom: 1px solid white;
  margin: -1px;
  background-color: white;
 }
 .sphinx-tabs-tab:focus {
  z-index: 1;
  outline-offset: 1px;
 }
 .sphinx-tabs-panel {
  position: relative;
  padding: 1rem;
  border: 1px solid #a0b3bf;
  margin: 0px -1px -1px -1px;
  border-radius: 0 0 5px 5px;
  border-top: 0;
  background: white;
 }
 .sphinx-tabs-panel.code-tab {
  padding: 0.4rem;
 }
 .sphinx-tab img {
 	margin-bottom: 24 px;
 }
 /* Dark theme preference styling */
@media (prefers-color-scheme: dark) {
  body[data-theme="auto"] .sphinx-tabs-panel {
    color: white;
    background-color: rgb(50, 50, 50);
  }
  body[data-theme="auto"] .sphinx-tabs-tab {
    color: white;
    background-color: rgba(255, 255, 255, 0.05);
  }
  body[data-theme="auto"] .sphinx-tabs-tab[aria-selected="true"] {
    border-bottom: 1px solid rgb(50, 50, 50);
    background-color: rgb(50, 50, 50);
  }
 }
 /* Explicit dark theme styling */
 body[data-theme="dark"] .sphinx-tabs-panel {
  color: white;
  background-color: rgb(50, 50, 50);
 }
 body[data-theme="dark"] .sphinx-tabs-tab {
  color: white;
  background-color: rgba(255, 255, 255, 0.05);
 }
 body[data-theme="dark"] .sphinx-tabs-tab[aria-selected="true"] {
  border-bottom: 2px solid rgb(50, 50, 50);
  background-color: rgb(50, 50, 50);
 }
@@ -1,145 +0,0 @@
 try {
  var session = window.sessionStorage || {};
 } catch (e) {
  var session = {};
 }
 window.addEventListener("DOMContentLoaded", () => {
  const allTabs = document.querySelectorAll('.sphinx-tabs-tab');
  const tabLists = document.querySelectorAll('[role="tablist"]');
  allTabs.forEach(tab => {
    tab.addEventListener("click", changeTabs);
  });
  tabLists.forEach(tabList => {
    tabList.addEventListener("keydown", keyTabs);
  });
  // Restore group tab selection from session
  const lastSelected = session.getItem('sphinx-tabs-last-selected');
  if (lastSelected != null) selectNamedTabs(lastSelected);
 });
 /**
 * Key focus left and right between sibling elements using arrows
 * @param  {Node} e the element in focus when key was pressed
 */
 function keyTabs(e) {
    const tab = e.target;
    let nextTab = null;
    if (e.keyCode === 39 || e.keyCode === 37) {
      tab.setAttribute("tabindex", -1);
      // Move right
      if (e.keyCode === 39) {
        nextTab = tab.nextElementSibling;
        if (nextTab === null) {
          nextTab = tab.parentNode.firstElementChild;
        }
      // Move left
      } else if (e.keyCode === 37) {
        nextTab = tab.previousElementSibling;
        if (nextTab === null) {
          nextTab = tab.parentNode.lastElementChild;
        }
      }
    }
    if (nextTab !== null) {
      nextTab.setAttribute("tabindex", 0);
      nextTab.focus();
    }
 }
 /**
 * Select or deselect clicked tab. If a group tab
 * is selected, also select tab in other tabLists.
 * @param  {Node} e the element that was clicked
 */
 function changeTabs(e) {
  // Use this instead of the element that was clicked, in case it's a child
  const notSelected = this.getAttribute("aria-selected") === "false";
  const positionBefore = this.parentNode.getBoundingClientRect().top;
  const notClosable = !this.parentNode.classList.contains("closeable");
  deselectTabList(this);
  if (notSelected || notClosable) {
    selectTab(this);
    const name = this.getAttribute("name");
    selectNamedTabs(name, this.id);
    if (this.classList.contains("group-tab")) {
      // Persist during session
      session.setItem('sphinx-tabs-last-selected', name);
    }
  }
  const positionAfter = this.parentNode.getBoundingClientRect().top;
  const positionDelta = positionAfter - positionBefore;
  // Scroll to offset content resizing
  window.scrollTo(0, window.scrollY + positionDelta);
 }
 /**
 * Select tab and show associated panel.
 * @param  {Node} tab tab to select
 */
 function selectTab(tab) {
  tab.setAttribute("aria-selected", true);
  // Show the associated panel
  document
    .getElementById(tab.getAttribute("aria-controls"))
    .removeAttribute("hidden");
 }
 /**
 * Hide the panels associated with all tabs within the
 * tablist containing this tab.
 * @param  {Node} tab a tab within the tablist to deselect
 */
 function deselectTabList(tab) {
  const parent = tab.parentNode;
  const grandparent = parent.parentNode;
  Array.from(parent.children)
  .forEach(t => t.setAttribute("aria-selected", false));
  Array.from(grandparent.children)
    .slice(1)  // Skip tablist
    .forEach(panel => panel.setAttribute("hidden", true));
 }
 /**
 * Select grouped tabs with the same name, but no the tab
 * with the given id.
 * @param  {Node} name name of grouped tab to be selected
 * @param  {Node} clickedId id of clicked tab
 */
 function selectNamedTabs(name, clickedId=null) {
  const groupedTabs = document.querySelectorAll(`.sphinx-tabs-tab[name="${name}"]`);
  const tabLists = Array.from(groupedTabs).map(tab => tab.parentNode);
  tabLists
    .forEach(tabList => {
      // Don't want to change the tabList containing the clicked tab
      const clickedTab = tabList.querySelector(`[id="${clickedId}"]`);
      if (clickedTab === null ) {
        // Select first tab with matching name
        const tab = tabList.querySelector(`.sphinx-tabs-tab[name="${name}"]`);
        deselectTabList(tab);
        selectTab(tab);
      }
    })
 }
 if (typeof exports === 'undefined') {
  exports = {};
 }
 exports.keyTabs = keyTabs;
 exports.changeTabs = changeTabs;
 exports.selectTab = selectTab;
 exports.deselectTabList = deselectTabList;
 exports.selectNamedTabs = selectNamedTabs;
@@ -1,407 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>About &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/about.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="#" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Guides" href="guides/index.html" />
    <link rel="prev" title="Clear Linux* OS container images" href="get-started/containers/container-images.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="guides/index.html" title="Guides"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="get-started/containers/container-images.html" title="Clear Linux* OS container images"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">About</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="about">
 <span id="id1"></span><h1>About<a class="headerlink" href="#about" title="Link to this heading">¶</a></h1>
 <p>Clear Linux* OS does things differently. Our software architecture provides a
 unique and innovative platform for Linux* developers focused on
 performance and security for compute, server, and the cloud.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#what-is-cl" id="id4">What is Clear Linux OS?</a></p></li>
 <li><p><a class="reference internal" href="#what-cl-isn-t" id="id5">What Clear Linux OS isn’t?</a></p></li>
 <li><p><a class="reference internal" href="#is-cl-completely-open-source" id="id6">Is Clear Linux OS completely Open Source?</a></p></li>
 <li><p><a class="reference internal" href="#who-is-the-target-audience" id="id7">Who is the target audience?</a></p></li>
 <li><p><a class="reference internal" href="#how-does-cl-address-security" id="id8">How does Clear Linux OS address security?</a></p></li>
 <li><p><a class="reference internal" href="#whats-the-thinking-around-server-vs-desktop" id="id9">What’s the thinking around Server vs. Desktop?</a></p></li>
 <li><p><a class="reference internal" href="#what-makes-cl-different" id="id10">What makes Clear Linux OS different?</a></p></li>
 <li><p><a class="reference internal" href="#why-create-new-components-rather-than-modifying-existing-projects" id="id11">Why create new components rather than modifying existing projects?</a></p></li>
 <li><p><a class="reference internal" href="#which-components-are-used-in-clear-linux" id="id12">Which Components are used in Clear Linux?</a></p></li>
 </ul>
 </nav>
 <section id="what-is-cl">
 <h2><a class="toc-backref" href="#id4" role="doc-backlink">What is Clear Linux OS?</a><a class="headerlink" href="#what-is-cl" title="Link to this heading">¶</a></h2>
 <p>Clear Linux OS is an open source, rolling-release Linux distribution, optimized for
 performance and security from the cloud to the Edge. Designed from the ground up,
 Clear Linux OS provides an industry blueprint on how to incorporate Intel® architecture
 features for a modern, modular Linux OS. Clear Linux OS is not based on any other Linux
 distro.</p>
 </section>
 <section id="what-cl-isn-t">
 <h2><a class="toc-backref" href="#id5" role="doc-backlink">What Clear Linux OS isn’t?</a><a class="headerlink" href="#what-cl-isn-t" title="Link to this heading">¶</a></h2>
 <p>Clear Linux OS is not intended to be a general-purpose Linux distribution, suitable
 for novice end-users. While we ship common applications, our purpose isn’t
 to make an OS for routine desktop tasks and provide immunity from all
 security threats in all situations. Our unique focus means that what we consider <em>essential</em> use cases, <em>optional</em> use cases, or even <em>unsupported</em> use cases, differs from other Linux distros. See our <a class="reference internal" href="#target-audience"><span class="std std-ref">target audience</span></a> below.</p>
 </section>
 <section id="is-cl-completely-open-source">
 <h2><a class="toc-backref" href="#id6" role="doc-backlink">Is Clear Linux OS completely Open Source?</a><a class="headerlink" href="#is-cl-completely-open-source" title="Link to this heading">¶</a></h2>
 <p>Clear Linux OS aims to be completely open source. Our project <a class="reference external" href="https://github.com/clearlinux">source code</a> and
 <a class="reference external" href="https://github.com/clearlinux-pkgs/">packages source code</a> are available on GitHub*. When considering projects
 for inclusion, we check that they are in active development and are well
 maintained. We have a very strict requirement for not accepting proprietary
 packages and non-open source components.  For example, many Linux distros
 may not be able to include certain media codecs due to
 <a class="reference internal" href="FAQ/index.html#licensing-restrict"><span class="std std-ref">licensing restrictions</span></a>, but manual installation and <a class="reference external" href="https://community.clearlinux.org/t/about-the-3rd-party-sw-category/4072">third party alternatives</a> are available.</p>
 </section>
 <section id="who-is-the-target-audience">
 <span id="target-audience"></span><h2><a class="toc-backref" href="#id7" role="doc-backlink">Who is the target audience?</a><a class="headerlink" href="#who-is-the-target-audience" title="Link to this heading">¶</a></h2>
 <p>Clear Linux OS mainly targets professionals in IT, DevOps, Cloud/Container deployments, and <abbr title="Artificial Intelligence">AI</abbr>.</p>
 <p>Rather than making a standard Linux distribution, the Clear Linux OS team decided to
 build a unique Linux distro. Developing a distro in house allows us to experiment and iterate faster, which means we continually optimize performance and deliver security patches, <a class="reference internal" href="#release-cadence"><span class="std std-ref">several times per week</span></a>. Yet our experiments are only valuable if our software architecture gives you the freedom to innovate, too. To improve manageability, Clear Linux OS employs a <a class="reference internal" href="guides/clear/stateless.html#stateless"><span class="std std-ref">Stateless</span></a> design, separating user and system management.</p>
 <p>We leverage the pool of knowledge and skills at Intel to drive improvements to Clear Linux OS.</p>
 <p>Intel has worked with the Linux community and other distros for many years.
 Understanding what it takes to integrate features in our own Linux distro
 helps us collaborate with other distro owners and submit enhancements to
 upstream. We demonstrate the value of our distro by offering users the same
 tools we use. For example, <a class="reference internal" href="guides/clear/mixer.html#mixer"><span class="std std-ref">mixer</span></a>, a tool unique to Clear Linux OS, allows users
 to build custom derivatives and act as their own <abbr title="Operating System Vendor">OSV</abbr>.</p>
 <p>For more details on Clear Linux OS features, visit our <a class="reference internal" href="guides/index.html#cl-guides"><span class="std std-ref">Clear Linux</span></a> guides.</p>
 </section>
 <section id="how-does-cl-address-security">
 <h2><a class="toc-backref" href="#id8" role="doc-backlink">How does Clear Linux OS address security?</a><a class="headerlink" href="#how-does-cl-address-security" title="Link to this heading">¶</a></h2>
 <p>Several <a class="reference internal" href="guides/clear/security.html#security"><span class="std std-ref">security features</span></a> are designed to work
 out-of-the-box, yet they’re not intended to be intrusive. We focus on
 <em>essential</em> use cases and ignore <em>unwanted</em> or <em>unsupported</em> use cases.
 For example, while Clear Linux OS does not enable antivirus by default, we provide a
 bundle for it (<code class="docutils literal notranslate"><span class="pre">clamav</span></code>). We leave antivirus configuration to our users.
 In addition, firewalls are less important if the OS doesn’t expose services
 to the outside by default. In Clear Linux OS, we enforce this strategy by disabling
 network services by default - e.g. <code class="docutils literal notranslate"><span class="pre">mariadb</span></code> listens on a UNIX socket;
 <code class="docutils literal notranslate"><span class="pre">nginx</span></code> won’t listen at all; and other services similarly are restricted
 from being accessed over the network. This strategy alone makes firewall
 software much less urgent–there simply isn’t anything that a firewall could
 easily block.</p>
 </section>
 <section id="whats-the-thinking-around-server-vs-desktop">
 <h2><a class="toc-backref" href="#id9" role="doc-backlink">What’s the thinking around Server vs. Desktop?</a><a class="headerlink" href="#whats-the-thinking-around-server-vs-desktop" title="Link to this heading">¶</a></h2>
 <p>Clear Linux OS focuses on performance for server and cloud use-cases first because
 many design decisions associated with them are applicable to other
 use-cases, such as IoT and the desktop client. While our initial focus was
 on the command line, we realized that many people valued the ease-of-use of
 a desktop environment.  Whereas in the past we tried to accommodate those
 interested in a desktop version, we were forced to confront clear limits as
 to how we could meet this need. Clear Linux OS minimizes the customizations and patches in support of the desktop and provides a generic GNOME implementation. Other window managers or desktops are available; however, testing in Clear Linux OS is focused on GNOME.</p>
 </section>
 <section id="what-makes-cl-different">
 <h2><a class="toc-backref" href="#id10" role="doc-backlink">What makes Clear Linux OS different?</a><a class="headerlink" href="#what-makes-cl-different" title="Link to this heading">¶</a></h2>
 <section id="release-cadence">
 <span id="id2"></span><h3>Release Cadence<a class="headerlink" href="#release-cadence" title="Link to this heading">¶</a></h3>
 <p>Clear Linux OS updates are based on a rolling release that can occur daily, up to a few
 times per week. Each release has a unique version number that identifies
 every component in the OS from kernel, to driver, to tool, to GUI
 application. Most components are included in entities called <a class="reference internal" href="reference/bundles/bundles.html#bundles"><span class="std std-ref">bundles</span></a>.</p>
 </section>
 <section id="updates">
 <h3>Updates<a class="headerlink" href="#updates" title="Link to this heading">¶</a></h3>
 <p>By default, Clear Linux OS automatically checks for updates, ensuring the latest
 performance and security fixes are installed as soon as they are available.
 Clear Linux OS stays in lockstep with upstream for current security upgrades and is
 designed to rapidly deliver security mitigations to customers.
 <a class="reference internal" href="guides/clear/swupd.html#swupd-guide"><span class="std std-ref">swupd</span></a> is designed to manage updates and bundles.</p>
 </section>
 <section id="ease-of-use">
 <h3>Ease of Use<a class="headerlink" href="#ease-of-use" title="Link to this heading">¶</a></h3>
 <p>Clear Linux OS makes it easier to manage a number of difficult problems.</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="guides/clear/autoproxy.html#autoproxy"><span class="std std-ref">Autoproxy</span></a> makes it possible for Clear Linux OS tools to operate in some proxy
 environments without needing to be configured.</p></li>
 <li><p><a class="reference internal" href="guides/clear/stateless.html#stateless"><span class="std std-ref">Stateless</span></a> means that configuration settings are easier to manage
 and remain untouched when system software is updated.</p></li>
 <li><p><a class="reference internal" href="guides/clear/swupd.html#swupd-guide"><span class="std std-ref">swupd</span></a> simplifies managing software and maintaining
 compatibility.</p></li>
 </ul>
 </section>
 <section id="custom-derivatives">
 <h3>Custom Derivatives<a class="headerlink" href="#custom-derivatives" title="Link to this heading">¶</a></h3>
 <p>The same tools used to build the Clear Linux OS are available <em>in</em> the OS. These tools can be used to create a custom distribution that continues to benefit from upstream rolling releases.</p>
 <figure class="align-center" id="id3">
 <a class="reference internal image-reference" href="_images/clear-lifecycle.png"><img alt="Creating and managing a Clear Linux* OS  version (or derivative)" src="_images/clear-lifecycle.png" style="width: 600.0px; height: 337.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: Creating and managing a Clear Linux* OS version (or derivative)</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </section>
 <section id="create">
 <h3>Create<a class="headerlink" href="#create" title="Link to this heading">¶</a></h3>
 <p>To create a custom distribution you need to understand how to use the
 <a class="reference internal" href="guides/clear/autospec.html#autospec"><span class="std std-ref">autospec</span></a> and <a class="reference internal" href="guides/clear/mixer.html#mixer"><span class="std std-ref">mixer</span></a> tools. Additional training materials are available in the <a class="reference external" href="https://github.com/clearlinux/how-to-clear">how-to-clear</a> GitHub project to help you get started with Clear Linux OS tools.</p>
 </section>
 <section id="deploy">
 <h3>Deploy<a class="headerlink" href="#deploy" title="Link to this heading">¶</a></h3>
 <p>We also provide training on how to <a class="reference internal" href="guides/maintenance/deploy-at-scale.html#deploy-at-scale"><span class="std std-ref">Deploy at Scale</span></a>.</p>
 </section>
 <section id="administrate">
 <h3>Administrate<a class="headerlink" href="#administrate" title="Link to this heading">¶</a></h3>
 <p>Clear Linux OS provides a <a class="reference internal" href="guides/clear/telemetrics.html#telem-guide"><span class="std std-ref">Telemetrics</span></a> solution for collecting useful information
 about a deployment, as well as <a class="reference internal" href="guides/clear/debug.html#debug"><span class="std std-ref">Debug system</span></a> capabilities.</p>
 </section>
 </section>
 <section id="why-create-new-components-rather-than-modifying-existing-projects">
 <h2><a class="toc-backref" href="#id11" role="doc-backlink">Why create new components rather than modifying existing projects?</a><a class="headerlink" href="#why-create-new-components-rather-than-modifying-existing-projects" title="Link to this heading">¶</a></h2>
 <p>One question that’s often asked: “Why did you develop your own solution
 instead of using &lt;XYZ&gt;?” (e.g. <a class="reference external" href="https://community.clearlinux.org/t/why-does-clearlinux-use-swupd-and-not-apt-deb-rpm/">swupd post</a>).  We do evaluate existing
 projects for inclusion in Clear Linux OS, yet there are cases where our unique
 architecture and components would require too much customization to use
 off-the-shelf projects.  In other situations, we may feel that using a new
 language to develop the component would give us a performance advantage,
 ease code development and maintenance, and grow the skills of our engineers
 on new and upcoming programming languages.  And yes, sometimes there are
 personal biases for and against some projects by the architects and
 engineers.  We tend to move fast, and sometimes it’s easier to live with
 suboptimal choices until we have the time or incentive to re-architect them
 properly.</p>
 </section>
 <section id="which-components-are-used-in-clear-linux">
 <h2><a class="toc-backref" href="#id12" role="doc-backlink">Which Components are used in Clear Linux?</a><a class="headerlink" href="#which-components-are-used-in-clear-linux" title="Link to this heading">¶</a></h2>
 <table class="docutils align-default">
 <colgroup>
 <col style="width: 33.3%" />
 <col style="width: 33.3%" />
 <col style="width: 33.3%" />
 </colgroup>
 <thead>
 <tr class="row-odd"><th class="head"><p>Component</p></th>
 <th class="head"><p>Enabled in OS/Bundle</p></th>
 <th class="head"><p>Optional</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><p>OS Installer</p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/clr-installer/">Clear Linux installer</a></p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p>Bootloader</p></td>
 <td><p><a class="reference external" href="https://www.freedesktop.org/software/systemd/man/systemd-boot.html">systemd-boot</a> (UEFI) / <a class="reference external" href="https://wiki.syslinux.org/wiki/index.php?title=The_Syslinux_Project">syslinux</a> (Legacy)</p></td>
 <td></td>
 </tr>
 <tr class="row-even"><td><p>Boot Manager</p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/clr-boot-manager">Clear Linux Boot Manager</a></p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p>Configuration initialization and management</p></td>
 <td><p><em>NA</em></p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/micro-config-drive">micro-config-drive</a> (minimal cloud-init), Ansible</p></td>
 </tr>
 <tr class="row-even"><td><p>Software component installer, manager, updater</p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/swupd-client">swupd</a></p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p>Software bundle generator -</p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/mixer-tools">mixer</a> and <a class="reference external" href="https://github.com/clearlinux/clr-distro-factory">Clear Linux Distro Factory</a></p></td>
 <td></td>
 </tr>
 <tr class="row-even"><td><p>Software package builder</p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/common">autospec</a></p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p>Software debugging</p></td>
 <td><p><em>NA</em></p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/clr-debug-info">clr-debug-info</a></p></td>
 </tr>
 <tr class="row-even"><td><p>Unified TLS Trust Store Management</p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/clrtrust">clrtrust</a></p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p>System and software telemetry</p></td>
 <td><p><em>NA</em></p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/telemetrics-backend">Telemetrics</a> (disabled by default)</p></td>
 </tr>
 <tr class="row-even"><td><p>File system</p></td>
 <td><p><a class="reference external" href="https://ext4.wiki.kernel.org/index.php/Main_Page">EXT4</a> (default for rootfs), <a class="reference external" href="https://www.kernel.org/doc/html/latest/filesystems/vfat.html">VFAT</a>, <a class="reference external" href="https://ext4.wiki.kernel.org/index.php/Main_Page">EXT2 and EXT3</a>, <a class="reference external" href="https://www.kernel.org/doc/Documentation/filesystems/f2fs.txt">F2FS</a></p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p>Disk encryption</p></td>
 <td><p><em>NA</em></p></td>
 <td><p><a class="reference external" href="https://gitlab.com/cryptsetup/cryptsetup/">LUKS</a></p></td>
 </tr>
 <tr class="row-even"><td><p>System /Service manager</p></td>
 <td><p><a class="reference external" href="https://www.freedesktop.org/wiki/Software/systemd/">systemd</a></p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p>Display manager</p></td>
 <td><p><a class="reference external" href="https://www.gnome.org/">GNOME</a></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">KDE</span></code>, <code class="docutils literal notranslate"><span class="pre">Xfce</span></code>, <code class="docutils literal notranslate"><span class="pre">lightdm</span></code>, <code class="docutils literal notranslate"><span class="pre">sddm</span></code>  (see <a class="reference external" href="https://clearlinux.org/software">Clear Linux store</a>)</p></td>
 </tr>
 <tr class="row-even"><td><p>Display services (Desktop installed)</p></td>
 <td><p><a class="reference external" href="https://www.x.org/">X.Org</a></p></td>
 <td><p><a class="reference external" href="https://wayland.freedesktop.org/">Wayland</a> compositor</p></td>
 </tr>
 <tr class="row-odd"><td><p>Network services</p></td>
 <td><p><a class="reference external" href="https://wiki.gnome.org/Projects/NetworkManager">NetworkManager</a> by default, <a class="reference external" href="https://www.freedesktop.org/software/systemd/man/systemd.network.html">systemd-networkd</a> See Note below.</p></td>
 <td></td>
 </tr>
 <tr class="row-even"><td><p>SSH Port scanning blocker</p></td>
 <td><p><a class="reference external" href="https://github.com/clearlinux/tallow">Tallow</a></p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p>Firewall</p></td>
 <td><p><em>NA</em></p></td>
 <td><p>iptables and <a class="reference external" href="https://docs.01.org/clearlinux/latest/guides/network/firewall.html#firewalld">firewalld</a></p></td>
 </tr>
 <tr class="row-even"><td><p>Antivirus</p></td>
 <td><p><em>NA</em></p></td>
 <td><p><a class="reference external" href="https://www.clamav.net/">ClamAV*</a></p></td>
 </tr>
 <tr class="row-odd"><td><p>Web browser</p></td>
 <td><p><a class="reference external" href="https://lynx.invisible-island.net/">Lynx</a> or <a class="reference external" href="http://links.twibright.com/">links</a> for text environments, <a class="reference external" href="https://www.mozilla.org/en-US/firefox/">Firefox*</a> for GUI</p></td>
 <td></td>
 </tr>
 <tr class="row-even"><td><p>Additional Software</p></td>
 <td><p><a class="reference external" href="https://clearlinux.org/software">Supplied Bundles</a></p></td>
 <td><p>Flatpak, 3rd-party software bundles</p></td>
 </tr>
 </tbody>
 </table>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The Clear Linux OS OS images targeted for cloud deployments continue to use
 <code class="docutils literal notranslate"><span class="pre">systemd-networkd</span></code> to manage network connections.  In earlier Clear Linux OS,
 <code class="docutils literal notranslate"><span class="pre">systemd-networkd</span></code> was used to manage Ethernet interfaces and NetworkManager was used for wireless interfaces.</p>
 </div>
 <p><em>Intel and the Intel logo are trademarks of Intel Corporation or its subsidiaries.</em></p>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">About</a><ul>
 <li><a class="reference internal" href="#what-is-cl">What is Clear Linux OS?</a></li>
 <li><a class="reference internal" href="#what-cl-isn-t">What Clear Linux OS isn’t?</a></li>
 <li><a class="reference internal" href="#is-cl-completely-open-source">Is Clear Linux OS completely Open Source?</a></li>
 <li><a class="reference internal" href="#who-is-the-target-audience">Who is the target audience?</a></li>
 <li><a class="reference internal" href="#how-does-cl-address-security">How does Clear Linux OS address security?</a></li>
 <li><a class="reference internal" href="#whats-the-thinking-around-server-vs-desktop">What’s the thinking around Server vs. Desktop?</a></li>
 <li><a class="reference internal" href="#what-makes-cl-different">What makes Clear Linux OS different?</a><ul>
 <li><a class="reference internal" href="#release-cadence">Release Cadence</a></li>
 <li><a class="reference internal" href="#updates">Updates</a></li>
 <li><a class="reference internal" href="#ease-of-use">Ease of Use</a></li>
 <li><a class="reference internal" href="#custom-derivatives">Custom Derivatives</a></li>
 <li><a class="reference internal" href="#create">Create</a></li>
 <li><a class="reference internal" href="#deploy">Deploy</a></li>
 <li><a class="reference internal" href="#administrate">Administrate</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#why-create-new-components-rather-than-modifying-existing-projects">Why create new components rather than modifying existing projects?</a></li>
 <li><a class="reference internal" href="#which-components-are-used-in-clear-linux">Which Components are used in Clear Linux?</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="get-started/containers/container-images.html"
                          title="previous chapter">Clear Linux* OS container images</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="guides/index.html"
                          title="next chapter">Guides</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/about.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="guides/index.html" title="Guides"
             >next</a> |</li>
        <li class="right" >
          <a href="get-started/containers/container-images.html" title="Clear Linux* OS container images"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">About</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -0,0 +1,14 @@
 #! /bin/bash
 # run with no arguments
 # 1. deletes previous build output
 # 2. builds default language version of docs only (English)
 # 3. changes directory to html output
 # 4. runs http server for local review of docs
 #
 # Requires python 3 
 make clean
 make html
 cd source/_build/html
 python3 -m http.server
@@ -1,181 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Contribute &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/collaboration/collaboration.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Writing guide" href="writing-guide.html" />
    <link rel="prev" title="FAQ" href="../FAQ/index.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="writing-guide.html" title="Writing guide"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../FAQ/index.html" title="FAQ"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Contribute</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="contribute">
 <span id="collaboration"></span><h1>Contribute<a class="headerlink" href="#contribute" title="Link to this heading">¶</a></h1>
 <p>There are multiple ways to help improve our documentation:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation">Contribute via GitHub</a>: Submit pull requests in the GitHub* documentation
 repository.</p></li>
 <li><p><a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation/issues">Log an issue</a>: Enter an issue in the documentation repository for
 minor issues such as typos.</p></li>
 <li><p><a class="reference external" href="mailto:dev&#37;&#52;&#48;clearlinux&#46;discoursemail&#46;com">Make a suggestion</a>: Send your documentation suggestion to the dev email inbox.</p></li>
 <li><p>Test documentation: Step through our guides and tutorials to verify the
 instructions. <a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation/issues">Log an issue</a> or <a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation">submit a pull request</a> with your findings.</p></li>
 </ul>
 <p>All contributions must follow our <a class="reference external" href="https://clearlinux.org/community/code-of-conduct">code of conduct</a>.</p>
 <section id="contribute-via-github">
 <h2>Contribute via GitHub<a class="headerlink" href="#contribute-via-github" title="Link to this heading">¶</a></h2>
 <p>Our documentation is hosted in GitHub and we follow the standard <a class="reference external" href="https://guides.github.com/introduction/flow/">GitHub flow</a>.
 Here are the basic steps for contributing:</p>
 <ol class="arabic simple">
 <li><p>Clone the <a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation">documentation repository</a>.</p></li>
 <li><p>Create your own fork of the repository.</p></li>
 <li><p>Create a branch for your contribution.</p></li>
 <li><p>Add your commits.</p></li>
 <li><p>Open a pull request.</p></li>
 <li><p>Discuss, review, and update your contributions.</p></li>
 <li><p>Once the maintainer approves, your contribution is merged and published as
 part of the documentation.</p></li>
 </ol>
 </section>
 <section id="contribution-guidelines">
 <h2>Contribution guidelines<a class="headerlink" href="#contribution-guidelines" title="Link to this heading">¶</a></h2>
 <p>The Clear Linux OS documentation is written using reStructuredText. Use our guidelines
 and best practices to write consistent, readable documentation. If you’re writing a tutorial, review our skill levels to better target a user group.</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="writing-guide.html">Writing guide</a></li>
 <li class="toctree-l1"><a class="reference internal" href="structure-formatting.html">Structure and formatting guide</a></li>
 </ul>
 </div>
 </section>
 <section id="references">
 <span id="id1"></span><h2>References<a class="headerlink" href="#references" title="Link to this heading">¶</a></h2>
 <p>We use the following references for grammar, style, and formatting:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="https://docs.microsoft.com/en-us/style-guide/welcome/">Microsoft Writing Style Guide</a></p></li>
 <li><p><a class="reference external" href="https://www.merriam-webster.com/">Merriam-Webster Dictionary</a></p></li>
 <li><p>The Chicago Manual of Style (15th edition), The University of Chicago Press</p></li>
 <li><p>Microsoft Press Computer Dictionary, Microsoft Press</p></li>
 <li><p>Read Me First!, Oracle Technical Publications</p></li>
 </ul>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Contribute</a><ul>
 <li><a class="reference internal" href="#contribute-via-github">Contribute via GitHub</a></li>
 <li><a class="reference internal" href="#contribution-guidelines">Contribution guidelines</a></li>
 <li><a class="reference internal" href="#references">References</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="../FAQ/index.html"
                          title="previous chapter">FAQ</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="writing-guide.html"
                          title="next chapter">Writing guide</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/collaboration/collaboration.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="writing-guide.html" title="Writing guide"
             >next</a> |</li>
        <li class="right" >
          <a href="../FAQ/index.html" title="FAQ"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Contribute</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,621 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Structure and formatting &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/collaboration/structure-formatting.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="prev" title="Writing guide" href="writing-guide.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="writing-guide.html" title="Writing guide"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="collaboration.html" accesskey="U">Contribute</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Structure and formatting</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="structure-and-formatting">
 <span id="structure-formatting"></span><h1>Structure and formatting<a class="headerlink" href="#structure-and-formatting" title="Link to this heading">¶</a></h1>
 <p>Content should be organized to support scanning. Consistent organization,
 formatting, and writing style helps readers quickly find what they need and to
 understand the content more effectively. This document describes our
 organization and formatting guidelines.</p>
 <p>Refer to <a class="reference internal" href="writing-guide.html#writing-guide"><span class="std std-ref">Writing guide</span></a> to learn how we keep our documents clear and
 concise.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#markup" id="id1">Markup</a></p></li>
 <li><p><a class="reference internal" href="#documentation-organization" id="id2">Documentation organization</a></p></li>
 <li><p><a class="reference internal" href="#inline-text-formatting" id="id3">Inline text formatting</a></p></li>
 <li><p><a class="reference internal" href="#code-blocks-and-examples" id="id4">Code blocks and examples</a></p></li>
 <li><p><a class="reference internal" href="#lists-and-instructions" id="id5">Lists and instructions</a></p></li>
 <li><p><a class="reference internal" href="#notices" id="id6">Notices</a></p></li>
 <li><p><a class="reference internal" href="#links" id="id7">Links</a></p></li>
 <li><p><a class="reference internal" href="#images" id="id8">Images</a></p></li>
 </ul>
 </nav>
 <section id="markup">
 <h2><a class="toc-backref" href="#id1" role="doc-backlink">Markup</a><a class="headerlink" href="#markup" title="Link to this heading">¶</a></h2>
 <p>Our documentation is written in the reStructuredText markup language, using
 Sphinx roles and directives. We use Sphinx to generate the final documentation.
 You can read more about reStructuredText and Sphinx on their respective
 websites:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">Sphinx documentation</a></p></li>
 <li><p><a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html">reStructuredText Primer</a></p></li>
 </ul>
 <p>You can view the content directly in the .rst markup files, or generate the HTML
 content by installing and building the documentation locally. To run the
 documentation locally, follow the instructions found in the
 <a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation">documentation repository</a> README.</p>
 <section id="new-pages">
 <h3>New pages<a class="headerlink" href="#new-pages" title="Link to this heading">¶</a></h3>
 <p>There are a few additional steps to consider when adding a new page to the
 documentation. First, identify where your new page should be located within the
 existing <a class="reference internal" href="#documentation-organization">Documentation organization</a>. Second, make sure the new page is picked
 up in the Sphinx build and easily linkable from other content.</p>
 <p>Each page must be included in a <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/quickstart.html?highlight=toctree#defining-document-structure">Sphinx toctree</a> in order to be included in the
 documentation content tree. Typically, pages are added to the section landing
 page toctree.</p>
 <p>For example, the <a class="reference internal" href="collaboration.html#collaboration"><span class="std std-ref">Contribute</span></a> page toctree looks like:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">toctree</span><span class="p">::</span>
   <span class="nc">:maxdepth:</span> 1
   writing-guide
   structure-formatting
 </pre></div>
 </div>
 <p>Additionally, each page must include a uniquely named reST label directly before
 the page title, to enable the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref">Sphinx ref role</a> for linking to a page.</p>
 <p>For example, this page “Structure and formatting” has the label
 <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">_structure-formatting</span></code>:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">_structure-formatting:</span>
 <span class="gh">Structure and formatting</span>
 <span class="gh">########################</span>
 </pre></div>
 </div>
 <p>This page can then be referenced from other pages in the documentation using the
 <cite>:ref:</cite> role:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="na">:ref:</span><span class="nv">`structure-formatting`</span>
 </pre></div>
 </div>
 </section>
 </section>
 <section id="documentation-organization">
 <h2><a class="toc-backref" href="#id2" role="doc-backlink">Documentation organization</a><a class="headerlink" href="#documentation-organization" title="Link to this heading">¶</a></h2>
 <p>The documentation is organized into five general sections:</p>
 <ol class="arabic simple">
 <li><p><strong>Concepts</strong>: Introduction and overview of Clear Linux OS specific concepts or
 features.</p></li>
 <li><p><strong>Get started</strong>: Information about getting started with Clear Linux OS.</p></li>
 <li><p><strong>Guides</strong>: Detailed information and instruction on using Clear Linux OS features.</p></li>
 <li><p><strong>Tutorials</strong>: Step-by-step instruction for using Clear Linux OS in specific use cases.</p></li>
 <li><p><strong>Reference</strong>: Supplementary and reference information for Clear Linux OS.</p></li>
 </ol>
 <section id="page-structure">
 <h3>Page structure<a class="headerlink" href="#page-structure" title="Link to this heading">¶</a></h3>
 <p>Each page in the documentation should follow the basic format of:</p>
 <ul class="simple">
 <li><p>Overview: 1-2 sentences describing what this page shows and why it matters</p></li>
 <li><p>Prerequisites: Describe any pre-work necessary to the content (if appropriate)</p></li>
 <li><p>Content</p></li>
 <li><p>Next steps: List links to next steps (if appropriate)</p></li>
 <li><p>Related topics: List links to related content (if appropriate)</p></li>
 </ul>
 </section>
 <section id="headings">
 <h3>Headings<a class="headerlink" href="#headings" title="Link to this heading">¶</a></h3>
 <p>Use headings to section and organize your content for better readability and
 clarity.</p>
 <ul class="simple">
 <li><p>All files must have a top level heading, which is the title for the page.</p></li>
 <li><p>Up to three additional levels of headings are allowed under the title heading.</p></li>
 <li><p>Each heading should be followed by at least one paragraph of content. Avoid
 two or more consecutive headings.</p></li>
 </ul>
 <p>Refer to the <a class="reference internal" href="writing-guide.html#writing-guide"><span class="std std-ref">Writing guide</span></a> for tips on using headings to create
 <a class="reference internal" href="writing-guide.html#scannable-content"><span class="std std-ref">scannable content</span></a>.</p>
 <p>To mark up headings in the .rst file:</p>
 <ul>
 <li><p>Use hash-tags to underline the file’s main title:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="gh">Main title</span>
 <span class="gh">##########</span>
 </pre></div>
 </div>
 </li>
 <li><p>Use asterisks to underline the file’s first level headings:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="gh">First level heading</span>
 <span class="gh">*******************</span>
 </pre></div>
 </div>
 </li>
 <li><p>Use equal signs to underline the file’s second level of headings:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="gh">Second level heading</span>
 <span class="gh">====================</span>
 </pre></div>
 </div>
 </li>
 <li><p>Use dashes to underline the file’s third level of headings:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="gh">Third level heading</span>
 <span class="gh">-------------------</span>
 </pre></div>
 </div>
 </li>
 </ul>
 </section>
 <section id="in-page-navigation">
 <h3>In-page navigation<a class="headerlink" href="#in-page-navigation" title="Link to this heading">¶</a></h3>
 <p>If a page has three or more sections, provide quick links to each section. Place
 the quick links after the overview section.</p>
 <p>Use the standard <a class="reference external" href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents">reST contents directive</a> with depth: 1 for quick links.</p>
 </section>
 </section>
 <section id="inline-text-formatting">
 <h2><a class="toc-backref" href="#id3" role="doc-backlink">Inline text formatting</a><a class="headerlink" href="#inline-text-formatting" title="Link to this heading">¶</a></h2>
 <p>We use the <a class="reference external" href="https://docs.microsoft.com/en-us/style-guide/welcome/">Microsoft Writing Style Guide</a> as our starting point for text
 formatting. We apply the formatting using reST and Sphinx markup.</p>
 <p>Use our quick reference for the most commonly used inline text elements:</p>
 <table class="docutils align-default">
 <tbody>
 <tr class="row-odd"><td><p><strong>Element</strong></p></td>
 <td><p><strong>Convention</strong></p></td>
 <td><p><strong>reST/Sphinx</strong></p></td>
 </tr>
 <tr class="row-even"><td><p>Acronyms</p></td>
 <td><p>Define acronym when first used. After
 first use and definition, use the
 acronym only.</p></td>
 <td><p>Use the <code class="docutils literal notranslate"><span class="pre">:abbr:</span></code> role, in
 the following format:</p>
 <p><code class="docutils literal notranslate"><span class="pre">:abbr:`Acronym</span> <span class="pre">(Def)`</span></code></p>
 </td>
 </tr>
 <tr class="row-odd"><td><p>Bundle names</p></td>
 <td><p>Bold</p></td>
 <td><p>Use the <code class="docutils literal notranslate"><span class="pre">:command:</span></code> role.</p></td>
 </tr>
 <tr class="row-even"><td><p>Callouts</p></td>
 <td></td>
 <td><p>Use <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">note::</span></code></p></td>
 </tr>
 <tr class="row-odd"><td><p>Code/command examples</p></td>
 <td><p>Monospace, visually distinct
 from rest of text. Use an
 indented call-out box.</p></td>
 <td><p>Use <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">code-block::</span></code>
 with the correct language
 setting.</p></td>
 </tr>
 <tr class="row-even"><td><p>Commands</p></td>
 <td><p>Bold</p></td>
 <td><p>Use the <code class="docutils literal notranslate"><span class="pre">:command:</span></code> role.</p></td>
 </tr>
 <tr class="row-odd"><td><p>Command flags</p></td>
 <td><p>Bold</p></td>
 <td><p>Use the <code class="docutils literal notranslate"><span class="pre">:command:</span></code> role.</p></td>
 </tr>
 <tr class="row-even"><td><p>Console output</p></td>
 <td><p>Monospace, visual distinction
 from rest of text. Use an
 indented call-out box.</p></td>
 <td><p>Use <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">code-block::</span></code>
 with console as the
 language setting.</p></td>
 </tr>
 <tr class="row-odd"><td><p>Emphasis</p></td>
 <td><p>Italic</p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">*strong*</span></code></p></td>
 </tr>
 <tr class="row-even"><td><p>Environment variables</p></td>
 <td><p>Use the case format of the
 environment variable.</p></td>
 <td><p>Use <code class="docutils literal notranslate"><span class="pre">:envvar:</span></code></p></td>
 </tr>
 <tr class="row-odd"><td><p>Example commands with
 optional or replaceable
 parts</p></td>
 <td><p>Use angle brackets for swapping
 in the specific name,
 e.g. &lt;package-name&gt;.</p>
 <p>Use square brackets for optional
 parts,
 e.g. [–build].</p>
 </td>
 <td></td>
 </tr>
 <tr class="row-even"><td><p>Example URLs (not linked)</p></td>
 <td><p>Plain text</p></td>
 <td></td>
 </tr>
 <tr class="row-odd"><td><p>File extensions</p></td>
 <td><p>Lowercase</p></td>
 <td></td>
 </tr>
 <tr class="row-even"><td><p>File names, directories, paths</p></td>
 <td><p>Title style capitalization</p></td>
 <td><p>Use the <code class="docutils literal notranslate"><span class="pre">:file:</span></code> role.</p></td>
 </tr>
 <tr class="row-odd"><td><p>GUI labels</p></td>
 <td></td>
 <td><p>Use <code class="docutils literal notranslate"><span class="pre">:guilabel:</span></code></p></td>
 </tr>
 <tr class="row-even"><td><p>Inline comments</p></td>
 <td></td>
 <td><p>Use <code class="docutils literal notranslate"><span class="pre">..</span></code></p></td>
 </tr>
 <tr class="row-odd"><td><p>Keystrokes</p></td>
 <td></td>
 <td><p>Use <code class="docutils literal notranslate"><span class="pre">:kbd:</span></code></p></td>
 </tr>
 <tr class="row-even"><td><p>Local navigation</p></td>
 <td></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">contents::</span> <span class="pre">:local:</span></code>
 with a depth of 1</p></td>
 </tr>
 <tr class="row-odd"><td><p>Menu selection</p></td>
 <td></td>
 <td><p>Use <code class="docutils literal notranslate"><span class="pre">:menuselection:</span></code></p></td>
 </tr>
 <tr class="row-even"><td><p>New terms</p></td>
 <td><p>Italic for first use, normal for all
 subsequent uses.</p>
 <p>If it is used outside of the source
 of definition, link the term.</p>
 </td>
 <td><p><code class="docutils literal notranslate"><span class="pre">*term*</span></code></p></td>
 </tr>
 <tr class="row-odd"><td><p>Product name</p></td>
 <td><p>Follow correct trademark and
 attribution guidelines.</p></td>
 <td></td>
 </tr>
 <tr class="row-even"><td><p>Tool names</p></td>
 <td><p>Correctly capitalized, no quotes,
 bold, or italics as the basic rule.</p>
 <p>If the tool name is the command, like
 most Linux tools, treat it like a
 command.</p>
 <p>If the tool name is lowercase and
 used at the start of a sentence, use
 bold.</p>
 </td>
 <td></td>
 </tr>
 </tbody>
 </table>
 <section id="white-space-and-line-length">
 <h3>White space and line length<a class="headerlink" href="#white-space-and-line-length" title="Link to this heading">¶</a></h3>
 <p>Limit line length to 78 characters. The GitHub web interface forces this
 limitation for readability.</p>
 <p>Remove trailing whitespace from your documents.</p>
 </section>
 </section>
 <section id="code-blocks-and-examples">
 <h2><a class="toc-backref" href="#id4" role="doc-backlink">Code blocks and examples</a><a class="headerlink" href="#code-blocks-and-examples" title="Link to this heading">¶</a></h2>
 <p>When providing example code or commands use the <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block">Sphinx code-block directive</a>.
 Select the appropriate syntax highlighting for the example command or code.</p>
 <p>For example, if showing console output, use console highlighting:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">code-block</span><span class="p">::</span> console
 </pre></div>
 </div>
 <p>Sphinx provides other ways of <a class="reference external" href="http://www.sphinx-doc.org/en/1.6/markup/code.html">marking up example code</a> if needed.</p>
 </section>
 <section id="lists-and-instructions">
 <h2><a class="toc-backref" href="#id5" role="doc-backlink">Lists and instructions</a><a class="headerlink" href="#lists-and-instructions" title="Link to this heading">¶</a></h2>
 <p>Use a numbered list when the order or priority of the items is important, such
 as step-by-step instructions.</p>
 <p>Use a bulleted list when the order of the items is not important.</p>
 <p>For both list types, keep all items in the list parallel. See
 <a class="reference internal" href="writing-guide.html#parallelism"><span class="std std-ref">Parallelism</span></a>.</p>
 <p>Use standard <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks">reST list markup</a>.</p>
 <section id="numbered-lists">
 <h3>Numbered lists<a class="headerlink" href="#numbered-lists" title="Link to this heading">¶</a></h3>
 <p>Numbered lists are most frequently used for procedures. Use numbered lists to
 show sequence for the items. Follow our guidelines for numbered lists:</p>
 <ul class="simple">
 <li><p>Make sure the list is sequential and not just a collection of items.</p></li>
 <li><p>Introduce a numbered list with a sentence. End the setup text with a
 colon. Example: “To configure the unit, perform the following steps:”</p></li>
 <li><p>Each item in the list should be parallel.</p></li>
 <li><p>Treat numbered list items as full sentences with correct ending
 punctuation.</p></li>
 <li><p>You may interrupt numbered lists with other content, if relevant,
 e.g. explanatory text, commands, or code.</p></li>
 <li><p>Second-level steps are acceptable; avoid third-level steps.</p></li>
 <li><p>Avoid single-step procedures; the minimum number of steps in a procedure
 is two.</p></li>
 <li><p>Do not create numbered lists that emulate flowcharts. The reader should be
 able to execute the list of steps from first to last without branching or
 looping.</p></li>
 <li><p>Avoid over-using numbered lists, except in procedural documents such as
 tutorials and step-by-step guides.</p></li>
 </ul>
 </section>
 <section id="bulleted-lists">
 <h3>Bulleted lists<a class="headerlink" href="#bulleted-lists" title="Link to this heading">¶</a></h3>
 <p>Use bulleted lists to reduce wordiness and paragraph density, especially when
 a sequence is not required. Here are some guidelines for bulleted lists:</p>
 <ul class="simple">
 <li><p>Introduce a bulleted list with a sentence. End the setup text with a
 colon. Example: “To repair the unit, you will need the following items:”</p></li>
 <li><p>Each item in the list should be parallel.</p></li>
 <li><p>Avoid interrupting bulleted lists with other paragraph styles.</p></li>
 <li><p>Second-level bullets are acceptable; avoid third-level bullets.</p></li>
 </ul>
 <p>Use the correct ending punctuation for sentence style bullet lists. For example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">When</span> <span class="n">setting</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span><span class="p">,</span> <span class="n">remember</span><span class="p">:</span>
 <span class="o">*</span> <span class="n">Use</span> <span class="n">a</span> <span class="n">number</span> <span class="n">that</span> <span class="n">has</span> <span class="n">a</span> <span class="n">meaning</span> <span class="k">for</span> <span class="n">you</span><span class="o">.</span>
 <span class="o">*</span> <span class="n">Change</span> <span class="n">the</span> <span class="n">code</span> <span class="n">once</span> <span class="n">a</span> <span class="n">month</span><span class="o">.</span>
 <span class="o">*</span> <span class="n">Do</span> <span class="ow">not</span> <span class="n">disclose</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span> <span class="n">to</span> <span class="n">anyone</span><span class="p">,</span> <span class="n">including</span> <span class="n">the</span> <span class="n">security</span> <span class="n">company</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">When</span> <span class="n">setting</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span> <span class="n">remember</span><span class="p">:</span>
 <span class="o">*</span> <span class="n">make</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span> <span class="n">easy</span> <span class="n">to</span> <span class="n">remember</span><span class="o">.</span> <span class="n">Use</span> <span class="n">a</span> <span class="n">number</span> <span class="n">that</span> <span class="n">has</span> <span class="n">a</span> <span class="n">meaning</span> <span class="k">for</span> <span class="n">you</span>
 <span class="o">*</span> <span class="n">change</span> <span class="n">the</span> <span class="n">code</span> <span class="n">once</span> <span class="n">a</span> <span class="n">month</span>
 <span class="o">*</span> <span class="n">do</span> <span class="ow">not</span> <span class="n">disclose</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span> <span class="n">to</span> <span class="n">anyone</span> <span class="k">else</span><span class="o">.</span> <span class="n">This</span> <span class="n">includes</span> <span class="n">the</span> <span class="n">security</span>
  <span class="n">company</span>
 </pre></div>
 </div>
 </section>
 <section id="instructions">
 <h3>Instructions<a class="headerlink" href="#instructions" title="Link to this heading">¶</a></h3>
 <p>When presenting instructions, such as in a tutorial, present them in a numbered
 list according to these guidelines:</p>
 <ul>
 <li><p>Each step (list item) should describe one action.</p></li>
 <li><p>If the same steps are repeated, refer to the earlier steps rather than
 repeating them.</p></li>
 <li><p>When a step includes a command or code block as an example, put the command
 or code block after the step that includes them.</p></li>
 <li><p>Use supporting images where appropriate. If the series of steps is supported
 by one figure, refer to the figure in the introductory text.</p>
 <p>For example: “See Figure 15 and do the following:”</p>
 <p>When a series of steps is supported by two or more figures, refer to the
 specific figure in the relevant step and show the figure immediately after
 the reference. <strong>Do not write</strong>: “See figures 15 through 22 and do the
 following:”</p>
 </li>
 </ul>
 </section>
 </section>
 <section id="notices">
 <h2><a class="toc-backref" href="#id6" role="doc-backlink">Notices</a><a class="headerlink" href="#notices" title="Link to this heading">¶</a></h2>
 <p>We use four special types of notices: notes, cautions, warnings, and dangers.
 Here are some specific rules and tips regarding use of these notices:</p>
 <ul class="simple">
 <li><p>Do not use a notice directly after a heading. Notices must follow a variant of
 body text.</p></li>
 <li><p>Do not include more than one notice in a single notice block.</p></li>
 <li><p>Avoid back-to-back notices.</p></li>
 <li><p>If back-to-back notices are not avoidable, make sure each distinct notice in
 the notice block is clearly defined.</p></li>
 </ul>
 <p>Use the standard <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives">reST admonition directive</a>.</p>
 <section id="notes-cautions-and-warnings">
 <h3>Notes, cautions, and warnings<a class="headerlink" href="#notes-cautions-and-warnings" title="Link to this heading">¶</a></h3>
 <p>Use notes sparingly. Avoid having more than one note per section. If you exceed
 this number consistently, consider rewriting the notes as main body text.</p>
 <p>Use cautions and warnings to alert readers of potential problems or pitfalls.
 Use conditional phrases in cautions and warnings, such as “If you do X, then Y
 will occur.”</p>
 <p>These are examples of typical notices and the conditions for their usage:</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Notes are extra bits of information that supplement the main content. Notes
 should be relatively short.</p>
 </div>
 <div class="admonition caution">
 <p class="admonition-title">Caution</p>
 <p>Cautions are low-level hazard messages that alert the user of possible
 equipment, product, and software damage, including loss of data.</p>
 </div>
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
 <p>Warnings are mid-level hazards that are likely to cause product damage.</p>
 </div>
 </section>
 </section>
 <section id="links">
 <h2><a class="toc-backref" href="#id7" role="doc-backlink">Links</a><a class="headerlink" href="#links" title="Link to this heading">¶</a></h2>
 <p>Use the standard <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks">reST markup for links</a>.</p>
 <p>To add a cross-reference to another documentation page, use the <cite>:ref:</cite> role:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="na">:ref:</span><span class="nv">`structure-formatting`</span>
 </pre></div>
 </div>
 <p>To add an external link, we use named references that refer to a defined
 link/label at the bottom of the page.</p>
 <p>For example, an external link is defined at the bottom of the page like this:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">_wiki about dogs:</span> https://en.wikipedia.org/wiki/Dog
 </pre></div>
 </div>
 <p>The defined link is then used in the content like this:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span>Check out the great <span class="s">`wiki about dogs`_</span>.
 </pre></div>
 </div>
 </section>
 <section id="images">
 <h2><a class="toc-backref" href="#id8" role="doc-backlink">Images</a><a class="headerlink" href="#images" title="Link to this heading">¶</a></h2>
 <p>Use images or figures to convey information that may be difficult to explain
 using words alone. Well-planned graphics reduce the amount of text required to
 explain a topic or example.</p>
 <p>Follow these guidelines when using graphics in support of your documentation:</p>
 <ul>
 <li><p>Keep it simple. Use images that serve a specific purpose in your document,
 and contain only the information the reader needs.</p></li>
 <li><p>Avoid graphics that will need frequent updating. Don’t include information in
 a graphic that might change with each release, such as product versions.</p></li>
 <li><p>Use either PNG or JPEG bitmap files for screenshots and SVG files for vector
 graphics.</p></li>
 <li><p>Place the image immediately after the text it helps clarify, or as close as
 possible.</p></li>
 <li><p>Use the <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives">Sphinx figure directive</a> to insert images and figures into the
 document. Include both alt text, a figure name, and caption.</p>
 <p>For example:</p>
 <div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">figure</span><span class="p">::</span> figures/topic-1.png
   <span class="nc">:alt:</span> An image supporting the topic.
   Figure 1: This is the figure 1 caption.
 </pre></div>
 </div>
 </li>
 <li><p>Include at least one direct reference to an image from the main text, using
 the figure number. For example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Figure</span> <span class="mi">1</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">The</span> <span class="n">figure</span> <span class="n">above</span> <span class="ow">or</span> <span class="n">below</span>
 </pre></div>
 </div>
 </li>
 </ul>
 <p>Images should follow these naming and location conventions:</p>
 <ul class="simple">
 <li><p>Save the image files in a <code class="file docutils literal notranslate"><span class="pre">figures</span></code> folder at the same level as the file
 that will reference the image.</p></li>
 <li><p>Name image files according to the following rules:</p>
 <ul>
 <li><p>Use only lower case letters.</p></li>
 <li><p>Separate multiple words in filenames using dashes.</p></li>
 <li><p>Name images using the filename of the file they appear on and add a number
 to indicate their place in the file. For example, the third figure added to
 the <code class="file docutils literal notranslate"><span class="pre">welcome.rst</span></code> file must be named <code class="file docutils literal notranslate"><span class="pre">welcome-3.png</span></code>.</p></li>
 </ul>
 </li>
 </ul>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Structure and formatting</a><ul>
 <li><a class="reference internal" href="#markup">Markup</a><ul>
 <li><a class="reference internal" href="#new-pages">New pages</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#documentation-organization">Documentation organization</a><ul>
 <li><a class="reference internal" href="#page-structure">Page structure</a></li>
 <li><a class="reference internal" href="#headings">Headings</a></li>
 <li><a class="reference internal" href="#in-page-navigation">In-page navigation</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#inline-text-formatting">Inline text formatting</a><ul>
 <li><a class="reference internal" href="#white-space-and-line-length">White space and line length</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#code-blocks-and-examples">Code blocks and examples</a></li>
 <li><a class="reference internal" href="#lists-and-instructions">Lists and instructions</a><ul>
 <li><a class="reference internal" href="#numbered-lists">Numbered lists</a></li>
 <li><a class="reference internal" href="#bulleted-lists">Bulleted lists</a></li>
 <li><a class="reference internal" href="#instructions">Instructions</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#notices">Notices</a><ul>
 <li><a class="reference internal" href="#notes-cautions-and-warnings">Notes, cautions, and warnings</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#links">Links</a></li>
 <li><a class="reference internal" href="#images">Images</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="writing-guide.html"
                          title="previous chapter">Writing guide</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/collaboration/structure-formatting.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="writing-guide.html" title="Writing guide"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="collaboration.html" >Contribute</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Structure and formatting</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,597 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Writing guide &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/collaboration/writing-guide.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Structure and formatting" href="structure-formatting.html" />
    <link rel="prev" title="Contribute" href="collaboration.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="structure-formatting.html" title="Structure and formatting"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="collaboration.html" title="Contribute"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="collaboration.html" accesskey="U">Contribute</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Writing guide</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="writing-guide">
 <span id="id1"></span><h1>Writing guide<a class="headerlink" href="#writing-guide" title="Link to this heading">¶</a></h1>
 <p>We want our documentation to be easy to read and understand. This document
 describes guidelines for writing documentation that is clear, concise,
 confident, and courteous.</p>
 <p>Refer to <a class="reference internal" href="structure-formatting.html#structure-formatting"><span class="std std-ref">Structure and formatting</span></a> for details on organizing content and how
 we use reStructuredText and Sphinx.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#use-simple-english" id="id3">Use simple English</a></p></li>
 <li><p><a class="reference internal" href="#make-content-scannable" id="id4">Make content scannable</a></p></li>
 <li><p><a class="reference internal" href="#use-strong-verbs" id="id5">Use strong verbs</a></p></li>
 <li><p><a class="reference internal" href="#avoid-long-noun-phrases" id="id6">Avoid long noun phrases</a></p></li>
 <li><p><a class="reference internal" href="#parallelism" id="id7">Parallelism</a></p></li>
 <li><p><a class="reference internal" href="#grammar-and-punctuation" id="id8">Grammar and punctuation</a></p></li>
 </ul>
 </nav>
 <section id="use-simple-english">
 <h2><a class="toc-backref" href="#id3" role="doc-backlink">Use simple English</a><a class="headerlink" href="#use-simple-english" title="Link to this heading">¶</a></h2>
 <p>Write using simple English: Be brief and communicate only the information that
 is needed. Be friendly and informative. Emphasize clarity and avoid
 unnecessary complicated or technical terms. Make the content accessible to
 non-native speakers.</p>
 <section id="be-brief">
 <h3>Be brief<a class="headerlink" href="#be-brief" title="Link to this heading">¶</a></h3>
 <p>Use short sentences and paragraphs. Stick to the principle of one main
 idea per sentence, plus one additional point if needed. Each paragraph
 should address one main idea. Remember the basic structure of a paragraph:
 Introduction, body, and conclusion.</p>
 </section>
 <section id="be-friendly">
 <h3>Be friendly<a class="headerlink" href="#be-friendly" title="Link to this heading">¶</a></h3>
 <p>We write for our peers and want to be familiar. Take a personal tone as if you
 were speaking directly to the reader. Use “you” to address the reader and “we”
 to refer to our view. Be professional, respectful, and cooperative.</p>
 <p>Assume your audience has the same level of technical understanding and expertise
 as you did when you first started collaborating. Do not talk down to our
 readers, but also do not assume they know everything about the subject. Offer
 brief explanations or summaries of common knowledge if a significant portion of
 readers might benefit.</p>
 </section>
 <section id="use-simple-words">
 <h3>Use simple words<a class="headerlink" href="#use-simple-words" title="Link to this heading">¶</a></h3>
 <p>Use simple words to increase reader comprehension and reduce ambiguity. Follow
 our tips for making good word choices:</p>
 <ul>
 <li><p><strong>Avoid jargon</strong>: Write for your audience, using everyday language where
 possible, and technical terms where appropriate. Avoid clichés, idioms, and
 metaphors.</p></li>
 <li><p><strong>Be consistent</strong>: Use one term for each concept or action and use it
 consistently.</p></li>
 <li><p><strong>Avoid “fancy” words and phrases</strong>: If there is a simpler word or phrase,
 use it.</p>
 <p>For example:</p>
 <table class="docutils align-default">
 <thead>
 <tr class="row-odd"><th class="head"><p>Use this</p></th>
 <th class="head"><p>Not this</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><p>start, begin</p></td>
 <td><p>commence</p></td>
 </tr>
 <tr class="row-odd"><td><p>so</p></td>
 <td><p>consequently</p></td>
 </tr>
 <tr class="row-even"><td><p>more than</p></td>
 <td><p>in excess of</p></td>
 </tr>
 <tr class="row-odd"><td><p>if</p></td>
 <td><p>in the event of</p></td>
 </tr>
 <tr class="row-even"><td><p>before</p></td>
 <td><p>prior to</p></td>
 </tr>
 <tr class="row-odd"><td><p>if you want</p></td>
 <td><p>should one wish</p></td>
 </tr>
 <tr class="row-even"><td><p>use</p></td>
 <td><p>utilize</p></td>
 </tr>
 <tr class="row-odd"><td><p>example</p></td>
 <td><p>instance</p></td>
 </tr>
 </tbody>
 </table>
 </li>
 </ul>
 </section>
 <section id="avoid-overuse-of-product-name">
 <h3>Avoid overuse of product name<a class="headerlink" href="#avoid-overuse-of-product-name" title="Link to this heading">¶</a></h3>
 <p>Use product names only when necessary. Typically, you can rewrite sentences to
 remove the product name with no change in meaning, which keeps the content
 concise and scannable.</p>
 <p>Avoid using the product name in page titles and headings.</p>
 </section>
 </section>
 <section id="make-content-scannable">
 <span id="scannable-content"></span><h2><a class="toc-backref" href="#id4" role="doc-backlink">Make content scannable</a><a class="headerlink" href="#make-content-scannable" title="Link to this heading">¶</a></h2>
 <p>Organize your content to make it scannable for the reader, which helps them find
 what they need quickly, and to understand the information more efficiently.</p>
 <ul class="simple">
 <li><p><strong>Put the most important content first.</strong> Make sure your introduction clearly
 communicates what the reader can find on the page. Present the point of the
 document first, and organize supporting information towards the end of the
 page.</p></li>
 <li><p><strong>Write scannable headings.</strong> Expect readers of documentation to skim and scan
 the content, and to leave if they don’t find what they need quickly. Good
 headings add organization to your content and help the reader to find and
 understand content more effectively. Follow our guidelines for writing
 effective <a class="reference internal" href="#headings">Headings</a>.</p></li>
 <li><p><strong>Write great link text.</strong> Great link text tells the reader what they can
 expect when they click on a link. It also helps make the page more scannable.
 Follow our guidelines for writing <a class="reference internal" href="#link-text">Link text</a>.</p></li>
 </ul>
 <section id="headings">
 <h3>Headings<a class="headerlink" href="#headings" title="Link to this heading">¶</a></h3>
 <p>Use these guidelines to write effective headings:</p>
 <ul class="simple">
 <li><p><strong>Be concise and descriptive.</strong> Use only the words necessary to describe the
 section.</p></li>
 <li><p><strong>Use sentence case.</strong> Capitalize only the first word and proper nouns in a
 heading.</p></li>
 <li><p><strong>Avoid punctuation.</strong> Unless your heading is a question, don’t use sentence
 punctuation in headings.</p></li>
 <li><p><strong>Use parallel structure.</strong> Headings at the same level should use the same
 grammatical pattern. This provides structure to the document and helps users
 find information more easily. See <a class="reference internal" href="#parallelism"><span class="std std-ref">Parallelism</span></a>.</p></li>
 <li><p><strong>Use strong verbs.</strong> Strong, active verbs get to the point. Avoid -ing verbs,
 such as <em>Running</em>, <em>Testing</em>, etc.</p></li>
 </ul>
 <p>For example, two headings at the same level:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Install</span> <span class="n">software</span>
 <span class="n">Configure</span> <span class="n">software</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Installing</span> <span class="n">the</span> <span class="n">Software</span> <span class="n">on</span> <span class="n">the</span> <span class="n">Platform</span>
 <span class="n">Software</span> <span class="n">Configuration</span><span class="o">.</span>
 </pre></div>
 </div>
 </section>
 <section id="link-text">
 <h3>Link text<a class="headerlink" href="#link-text" title="Link to this heading">¶</a></h3>
 <p>All links in content should follow these guidelines:</p>
 <ul class="simple">
 <li><p><strong>Write descriptive link text</strong>: Link text should describe where the link
 goes, without having to read the surrounding text.</p></li>
 <li><p><strong>Keep link text concise</strong>: Use only the words needed to accurately describe
 the destination.</p></li>
 <li><p><strong>Use unique link text</strong>: Each link on a page should be unique. If users see
 the same link text twice on a page, they’ll assume it goes to the same place.</p></li>
 <li><p><strong>Start link text with keywords</strong>: Frontload the link text with the most
 important words to help users scan the text.</p></li>
 <li><p><strong>Avoid generic text</strong>: Don’t use generic, uninformative link text such as
 “click here” or “read more”.</p></li>
 </ul>
 <p>For example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>For more information about dogs, read the `dog wiki article`_.
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>For more information about dogs, `click here`_.
 </pre></div>
 </div>
 </section>
 </section>
 <section id="use-strong-verbs">
 <h2><a class="toc-backref" href="#id5" role="doc-backlink">Use strong verbs</a><a class="headerlink" href="#use-strong-verbs" title="Link to this heading">¶</a></h2>
 <p>Passive verbs make writing stuffy and formal. Use strong verbs to get to the
 point and avoid unnecessary words and phrases.</p>
 <section id="use-imperatives">
 <h3>Use imperatives<a class="headerlink" href="#use-imperatives" title="Link to this heading">¶</a></h3>
 <p>Commands, also called imperatives, are the fastest and most direct way of giving
 someone instructions. For example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Send</span> <span class="n">it</span> <span class="n">to</span> <span class="n">me</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">I</span> <span class="n">would</span> <span class="n">appreciate</span> <span class="n">it</span> <span class="k">if</span> <span class="n">you</span> <span class="n">would</span> <span class="n">send</span> <span class="n">it</span> <span class="n">to</span> <span class="n">me</span><span class="o">.</span>
 </pre></div>
 </div>
 </section>
 <section id="use-present-tense">
 <h3>Use present tense<a class="headerlink" href="#use-present-tense" title="Link to this heading">¶</a></h3>
 <p>Use simple present tense instead of future tense for most text. Search for the
 words “will” or “shall” to find future tense instances. Future tense is
 acceptable for conditional statements, such as in a caution or a warning. For
 example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">The</span> <span class="n">system</span> <span class="n">operates</span> <span class="n">at</span> <span class="n">a</span> <span class="n">nominal</span> <span class="n">temperature</span> <span class="n">of</span> <span class="mi">180</span> <span class="n">degrees</span> <span class="n">Fahrenheit</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">The</span> <span class="n">system</span> <span class="n">will</span> <span class="n">operate</span> <span class="n">at</span> <span class="n">a</span> <span class="n">nominal</span> <span class="n">temperature</span> <span class="n">of</span> <span class="mi">180</span> <span class="n">degrees</span> <span class="n">Fahrenheit</span><span class="o">.</span>
 </pre></div>
 </div>
 </section>
 <section id="avoid-nominalizations">
 <h3>Avoid nominalizations<a class="headerlink" href="#avoid-nominalizations" title="Link to this heading">¶</a></h3>
 <p>Avoid nominalizations, which are nouns formed from verbs.</p>
 <p>For example:</p>
 <table class="docutils align-default">
 <thead>
 <tr class="row-odd"><th class="head"><p>Verb</p></th>
 <th class="head"><p>Nominalization</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><p>complete</p></td>
 <td><p>completion</p></td>
 </tr>
 <tr class="row-odd"><td><p>provide</p></td>
 <td><p>provision</p></td>
 </tr>
 <tr class="row-even"><td><p>fail</p></td>
 <td><p>failure</p></td>
 </tr>
 <tr class="row-odd"><td><p>install</p></td>
 <td><p>installation</p></td>
 </tr>
 </tbody>
 </table>
 <p>For example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">We</span> <span class="n">discussed</span> <span class="n">the</span> <span class="n">matter</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">We</span> <span class="n">had</span> <span class="n">a</span> <span class="n">discussion</span> <span class="n">about</span> <span class="n">the</span> <span class="n">matter</span><span class="o">.</span>
 </pre></div>
 </div>
 <p>Or:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">IT</span> <span class="n">has</span> <span class="n">installed</span> <span class="n">the</span> <span class="n">software</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">IT</span> <span class="n">has</span> <span class="n">completed</span> <span class="n">the</span> <span class="n">installation</span> <span class="n">of</span> <span class="n">the</span> <span class="n">software</span><span class="o">.</span>
 </pre></div>
 </div>
 </section>
 <section id="avoid-words-ending-in-ing">
 <h3>Avoid words ending in -ing<a class="headerlink" href="#avoid-words-ending-in-ing" title="Link to this heading">¶</a></h3>
 <p>Avoid using words ending in -ing unless they are part of a technical name. For
 example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">There</span> <span class="ow">is</span> <span class="n">no</span> <span class="n">way</span> <span class="n">to</span> <span class="n">verify</span> <span class="n">this</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">There</span> <span class="ow">is</span> <span class="n">no</span> <span class="n">way</span> <span class="n">of</span> <span class="n">verifying</span> <span class="n">this</span><span class="o">.</span>
 </pre></div>
 </div>
 </section>
 <section id="use-the-active-voice">
 <h3>Use the active voice<a class="headerlink" href="#use-the-active-voice" title="Link to this heading">¶</a></h3>
 <p>Use active voice whenever possible to show who or what is performing an
 action.</p>
 <ul class="simple">
 <li><p>Active voice follows standard English word order: SUBJECT–VERB–OBJECT
 (where the OBJECT is optional).</p></li>
 <li><p>Passive voice reverses the order and weakens the verb: OBJECT–be VERB–by
 SUBJECT (where the OBJECT is optional).</p></li>
 </ul>
 <p>For example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">I</span> <span class="n">made</span> <span class="n">a</span> <span class="n">mistake</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>A mistake was made. *(By whom?)*
 </pre></div>
 </div>
 <p>Or:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">We</span> <span class="n">released</span> <span class="n">version</span> <span class="mf">2.0</span> <span class="ow">in</span> <span class="n">June</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Version</span> <span class="mf">2.0</span> <span class="n">was</span> <span class="n">released</span> <span class="ow">in</span> <span class="n">June</span><span class="o">.</span>
 </pre></div>
 </div>
 </section>
 </section>
 <section id="avoid-long-noun-phrases">
 <h2><a class="toc-backref" href="#id6" role="doc-backlink">Avoid long noun phrases</a><a class="headerlink" href="#avoid-long-noun-phrases" title="Link to this heading">¶</a></h2>
 <p>Noun phrases (a noun and other words that describe or modify it) can be
 difficult to understand. Try to limit the number of modifiers in a noun phrase
 to two. For example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Integration</span> <span class="n">policies</span> <span class="k">for</span> <span class="n">power</span> <span class="n">management</span> <span class="n">mechanisms</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Power</span> <span class="n">management</span> <span class="n">mechanism</span> <span class="n">integration</span> <span class="n">policies</span><span class="o">.</span>
 </pre></div>
 </div>
 </section>
 <section id="parallelism">
 <span id="id2"></span><h2><a class="toc-backref" href="#id7" role="doc-backlink">Parallelism</a><a class="headerlink" href="#parallelism" title="Link to this heading">¶</a></h2>
 <p>Parallelism refers to the practice of using similar patterns of grammar, and
 sometimes length, to coordinate words, phrases, and clauses.</p>
 <p>Use parallel construction in lists. The table below shows some unparallel
 structures and how they can be made parallel with a little rewording.</p>
 <table class="docutils align-default">
 <thead>
 <tr class="row-odd"><th class="head"><p>Parallel (do)</p></th>
 <th class="head"><p>Unparallel (don’t)</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><ol class="arabic simple">
 <li><p>Mount the panel.</p></li>
 <li><p>Install the battery.</p></li>
 <li><p>Wire the keypad.</p></li>
 </ol>
 </td>
 <td><ol class="arabic simple">
 <li><p>Mount the panel.</p></li>
 <li><p>Battery installation.</p></li>
 <li><p>Wiring the keypad.</p></li>
 </ol>
 </td>
 </tr>
 <tr class="row-odd"><td><p>I like practicing my accordion,
 reading sci-fi, and eating
 peanut butter and pickle
 sandwiches.</p></td>
 <td><p>I like practicing my accordion,
 reading sci-fi, and to eat
 peanut butter and pickle
 sandwiches.</p></td>
 </tr>
 <tr class="row-even"><td><p>For breakfast he likes coffee
 and bacon.</p></td>
 <td><p>For breakfast he likes coffee
 and to fry bacon.</p></td>
 </tr>
 <tr class="row-odd"><td><p>Apples or bananas are a good
 snack.</p></td>
 <td><p>Apples or a banana are a good
 snack.</p></td>
 </tr>
 </tbody>
 </table>
 </section>
 <section id="grammar-and-punctuation">
 <h2><a class="toc-backref" href="#id8" role="doc-backlink">Grammar and punctuation</a><a class="headerlink" href="#grammar-and-punctuation" title="Link to this heading">¶</a></h2>
 <p>This section covers common grammatical topics relevant to our
 documentation. For detailed explanations of correct grammar and punctuation,
 use one of our <a class="reference internal" href="collaboration.html#references"><span class="std std-ref">preferred references</span></a>.</p>
 <section id="capitalization">
 <h3>Capitalization<a class="headerlink" href="#capitalization" title="Link to this heading">¶</a></h3>
 <p>The capitalization style for all documentation is sentence case. Words should
 only be capitalized when they are proper nouns or refer to trademarked product
 names.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Do not capitalize a word to indicate it is more important than other
 words. Never change the case of variable, function or file names - always
 keep the original case.</p>
 </div>
 <section id="menu-capitalization">
 <h4>Menu capitalization<a class="headerlink" href="#menu-capitalization" title="Link to this heading">¶</a></h4>
 <p>When referring to software menu items by name, use the same capitalization as
 seen in the actual menu.</p>
 <p>A few other tips when referring to menu items:</p>
 <ul>
 <li><p>Reference the specific menu item using “Select <span class="menuselection">File ‣ New</span>.”</p></li>
 <li><p>Put the option to be selected last. “Select
 <span class="menuselection">View ‣ Side Bar ‣ Hide Side Bar</span>”</p></li>
 <li><p>Do not include more than 3 navigation steps in a menu selection. If
 more than three steps are needed, divide the steps using
 <code class="docutils literal notranslate"><span class="pre">:guilabel:</span></code> or <code class="docutils literal notranslate"><span class="pre">:menuselection:</span></code>.</p>
 <p>For example: “Go to <span class="guilabel">File</span> and select
 <span class="menuselection">Print ‣ Print Preview ‣ Set Up</span>.”</p>
 </li>
 </ul>
 </section>
 <section id="software-version-capitalization">
 <h4>Software version capitalization<a class="headerlink" href="#software-version-capitalization" title="Link to this heading">¶</a></h4>
 <p>When listing software or hardware version numbers, the word “version” or letter
 “v” are lowercase. The v is closed with the number (no period).</p>
 <p>For example:</p>
 <ul class="simple">
 <li><p>Widget Pro version 5.0</p></li>
 <li><p>Widget Master v2.1.12</p></li>
 </ul>
 </section>
 </section>
 <section id="contractions">
 <h3>Contractions<a class="headerlink" href="#contractions" title="Link to this heading">¶</a></h3>
 <p>Avoid using contractions, such as it’s, they’re, and you’re, because they may be
 unclear to non-native English-speaking audiences.</p>
 </section>
 <section id="quotation-marks">
 <h3>Quotation marks<a class="headerlink" href="#quotation-marks" title="Link to this heading">¶</a></h3>
 <p>Follow these guidelines for quotation marks:</p>
 <ul class="simple">
 <li><p>Restrict use of quotation marks to terms as terms.</p></li>
 <li><p>Do not use quotation marks for emphasis; use <em>italics</em> for emphasis.</p></li>
 <li><p>Avoid using single-quote marks.</p></li>
 </ul>
 </section>
 <section id="commas-and-colons">
 <h3>Commas and colons<a class="headerlink" href="#commas-and-colons" title="Link to this heading">¶</a></h3>
 <p>This section addresses common use of commas, semicolons, and colons in our
 documentation. Refer to one of our <a class="reference internal" href="collaboration.html#references"><span class="std std-ref">preferred references</span></a>
 for further details.</p>
 <section id="use-the-serial-comma">
 <h4>Use the serial comma<a class="headerlink" href="#use-the-serial-comma" title="Link to this heading">¶</a></h4>
 <p>When writing a series of items, use the serial comma before the final <em>and</em> and
 <em>or</em> to avoid confusion and ambiguity. For example:</p>
 <p><strong>Use this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Mom</span><span class="p">,</span> <span class="n">Dad</span><span class="p">,</span> <span class="ow">and</span> <span class="n">I</span> <span class="n">are</span> <span class="n">going</span> <span class="n">to</span> <span class="n">the</span> <span class="n">game</span><span class="o">.</span>
 </pre></div>
 </div>
 <p><strong>Not this:</strong></p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Mom</span><span class="p">,</span> <span class="n">Dad</span> <span class="ow">and</span> <span class="n">I</span> <span class="n">are</span> <span class="n">going</span> <span class="n">to</span> <span class="n">the</span> <span class="n">game</span><span class="o">.</span>
 </pre></div>
 </div>
 </section>
 </section>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Writing guide</a><ul>
 <li><a class="reference internal" href="#use-simple-english">Use simple English</a><ul>
 <li><a class="reference internal" href="#be-brief">Be brief</a></li>
 <li><a class="reference internal" href="#be-friendly">Be friendly</a></li>
 <li><a class="reference internal" href="#use-simple-words">Use simple words</a></li>
 <li><a class="reference internal" href="#avoid-overuse-of-product-name">Avoid overuse of product name</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#make-content-scannable">Make content scannable</a><ul>
 <li><a class="reference internal" href="#headings">Headings</a></li>
 <li><a class="reference internal" href="#link-text">Link text</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#use-strong-verbs">Use strong verbs</a><ul>
 <li><a class="reference internal" href="#use-imperatives">Use imperatives</a></li>
 <li><a class="reference internal" href="#use-present-tense">Use present tense</a></li>
 <li><a class="reference internal" href="#avoid-nominalizations">Avoid nominalizations</a></li>
 <li><a class="reference internal" href="#avoid-words-ending-in-ing">Avoid words ending in -ing</a></li>
 <li><a class="reference internal" href="#use-the-active-voice">Use the active voice</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#avoid-long-noun-phrases">Avoid long noun phrases</a></li>
 <li><a class="reference internal" href="#parallelism">Parallelism</a></li>
 <li><a class="reference internal" href="#grammar-and-punctuation">Grammar and punctuation</a><ul>
 <li><a class="reference internal" href="#capitalization">Capitalization</a><ul>
 <li><a class="reference internal" href="#menu-capitalization">Menu capitalization</a></li>
 <li><a class="reference internal" href="#software-version-capitalization">Software version capitalization</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#contractions">Contractions</a></li>
 <li><a class="reference internal" href="#quotation-marks">Quotation marks</a></li>
 <li><a class="reference internal" href="#commas-and-colons">Commas and colons</a><ul>
 <li><a class="reference internal" href="#use-the-serial-comma">Use the serial comma</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="collaboration.html"
                          title="previous chapter">Contribute</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="structure-formatting.html"
                          title="next chapter">Structure and formatting</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/collaboration/writing-guide.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="structure-formatting.html" title="Structure and formatting"
             >next</a> |</li>
        <li class="right" >
          <a href="collaboration.html" title="Contribute"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="collaboration.html" >Contribute</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Writing guide</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,102 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>&lt;no title&gt; &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/disclaimers.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">&lt;no title&gt;</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <p class="rubric" id="disclaimers">Disclaimer</p>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
 <p>This documentation is a work in progress and is being provided for
 informative purposes only. Because it is a work in progress, there are
 parts that are either missing or will be revised as code development
 continues.</p>
 </div>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/disclaimers.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">&lt;no title&gt;</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,100 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>&lt;no title&gt; &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/documentation_license.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">&lt;no title&gt;</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <a rel="license"
 href="http://creativecommons.org/licenses/by/4.0/"><img
 alt="Creative Commons License" style="border-width:0"
 src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br
 />This work is licensed under a <a rel="license"
 href="http://creativecommons.org/licenses/by/4.0/">Creative Commons
 Attribution 4.0 International License</a>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/documentation_license.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">&lt;no title&gt;</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,110 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Index &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/genindex-E.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
 <h1 id="index">Index &#x2013; E</h1>
 <table style="width: 100%" class="indextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    environment variable
      <ul>
        <li><a href="tutorials/smb-server.html#index-0">[SharedDrive]</a>
 </li>
        <li><a href="guides/clear/telemetrics.html#index-0">https_proxy</a>
 </li>
        <li><a href="guides/network/dpdk.html#index-0">RTE_SDK</a>, <a href="guides/network/dpdk.html#index-2">[1]</a>
 </li>
        <li><a href="guides/network/dpdk.html#index-1">RTE_TARGET</a>, <a href="guides/network/dpdk.html#index-3">[1]</a>
 </li>
        <li><a href="tutorials/smb-server.html#index-1">valid users</a>
 </li>
      </ul></li>
  </ul></td>
 </tr></table>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,97 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Index &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/genindex-H.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
 <h1 id="index">Index &#x2013; H</h1>
 <table style="width: 100%" class="indextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="guides/clear/telemetrics.html#index-0">https_proxy</a>
 </li>
  </ul></td>
 </tr></table>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,101 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Index &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/genindex-R.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
 <h1 id="index">Index &#x2013; R</h1>
 <table style="width: 100%" class="indextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="guides/network/dpdk.html#index-0">RTE_SDK</a>, <a href="guides/network/dpdk.html#index-2">[1]</a>
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="guides/network/dpdk.html#index-1">RTE_TARGET</a>, <a href="guides/network/dpdk.html#index-3">[1]</a>
 </li>
  </ul></td>
 </tr></table>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,97 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Index &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/genindex-Symbols.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
 <h1 id="index">Index &#x2013; Symbols</h1>
 <table style="width: 100%" class="indextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="tutorials/smb-server.html#index-0">[SharedDrive]</a>
 </li>
  </ul></td>
 </tr></table>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,97 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Index &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/genindex-V.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
 <h1 id="index">Index &#x2013; V</h1>
 <table style="width: 100%" class="indextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="tutorials/smb-server.html#index-1">valid users</a>
 </li>
  </ul></td>
 </tr></table>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,154 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Index &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/genindex-all.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
 <h1 id="index">Index</h1>
 <div class="genindex-jumpbox">
 <a href="#Symbols"><strong>Symbols</strong></a>
 | <a href="#E"><strong>E</strong></a>
 | <a href="#H"><strong>H</strong></a>
 | <a href="#R"><strong>R</strong></a>
 | <a href="#V"><strong>V</strong></a>
 </div>
 <h2 id="Symbols">Symbols</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="tutorials/smb-server.html#index-0">[SharedDrive]</a>
 </li>
  </ul></td>
 </tr></table>
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    environment variable
      <ul>
        <li><a href="tutorials/smb-server.html#index-0">[SharedDrive]</a>
 </li>
        <li><a href="guides/clear/telemetrics.html#index-0">https_proxy</a>
 </li>
        <li><a href="guides/network/dpdk.html#index-0">RTE_SDK</a>, <a href="guides/network/dpdk.html#index-2">[1]</a>
 </li>
        <li><a href="guides/network/dpdk.html#index-1">RTE_TARGET</a>, <a href="guides/network/dpdk.html#index-3">[1]</a>
 </li>
        <li><a href="tutorials/smb-server.html#index-1">valid users</a>
 </li>
      </ul></li>
  </ul></td>
 </tr></table>
 <h2 id="H">H</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="guides/clear/telemetrics.html#index-0">https_proxy</a>
 </li>
  </ul></td>
 </tr></table>
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="guides/network/dpdk.html#index-0">RTE_SDK</a>, <a href="guides/network/dpdk.html#index-2">[1]</a>
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="guides/network/dpdk.html#index-1">RTE_TARGET</a>, <a href="guides/network/dpdk.html#index-3">[1]</a>
 </li>
  </ul></td>
 </tr></table>
 <h2 id="V">V</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="tutorials/smb-server.html#index-1">valid users</a>
 </li>
  </ul></td>
 </tr></table>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,102 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="./">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Index &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <script src="_static/documentation_options.js?v=5929fcd5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=a56c686a"></script>
    <script src="_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/genindex.html" />
    <link rel="icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="index" title="Index" href="#" />
    <link rel="search" title="Search" href="search.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             accesskey="I">index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
   <h1 id="index">Index</h1>
   <p>Index pages by letter:</p>
   <div class="genindex-jumpbox">
   <p><a href="genindex-Symbols.html"><strong>Symbols</strong></a>
     | <a href="genindex-E.html"><strong>E</strong></a>
     | <a href="genindex-H.html"><strong>H</strong></a>
     | <a href="genindex-R.html"><strong>R</strong></a>
     | <a href="genindex-V.html"><strong>V</strong></a>
     </p>
   <p><a href="genindex-all.html"><strong>Full index on one page</strong>
                                               (can be huge)</a></p>
   </div>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             >index</a></li>
        <li class="nav-item nav-item-0"><a href="index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,854 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Install Clear Linux* OS from the live desktop &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/bare-metal-install-desktop.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Install Clear Linux* OS from the live server" href="bare-metal-install-server.html" />
    <link rel="prev" title="Create a bootable USB drive using Etcher*" href="bootable-usb.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="bare-metal-install-server.html" title="Install Clear Linux* OS from the live server"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="bootable-usb.html" title="Create a bootable USB drive using Etcher*"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Install Clear Linux* OS from the live desktop</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="install-cl-attr-from-the-live-desktop">
 <span id="bare-metal-install-desktop"></span><h1>Install Clear Linux* OS from the live desktop<a class="headerlink" href="#install-cl-attr-from-the-live-desktop" title="Link to this heading">¶</a></h1>
 <p>This page explains how to boot the Clear Linux* OS live desktop image, from which
 you can install Clear Linux OS or explore without modifying the host system.
 Alternatively, use a <a class="reference internal" href="install-configfile.html#install-configfile"><span class="std std-ref">YAML configuration file</span></a>
 to install Clear Linux OS.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#system-requirements" id="id26">System requirements</a></p></li>
 <li><p><a class="reference internal" href="#preliminary-steps" id="id27">Preliminary steps</a></p></li>
 <li><p><a class="reference internal" href="#install-from-live-image" id="id28">Install from live image</a></p></li>
 <li><p><a class="reference internal" href="#minimum-installation-requirements" id="id29">Minimum installation requirements</a></p></li>
 <li><p><a class="reference internal" href="#cl-desktop-installer" id="id30">Clear Linux OS Desktop Installer</a></p></li>
 <li><p><a class="reference internal" href="#navigation" id="id31">Navigation</a></p></li>
 <li><p><a class="reference internal" href="#required-options" id="id32">Required options</a></p></li>
 <li><p><a class="reference internal" href="#advanced-options" id="id33">Advanced options</a></p></li>
 <li><p><a class="reference internal" href="#finish-installation" id="id34">Finish installation</a></p></li>
 <li><p><a class="reference internal" href="#troubleshooting" id="id35">Troubleshooting</a></p></li>
 <li><p><a class="reference internal" href="#related-topics" id="id36">Related topics</a></p></li>
 </ul>
 </nav>
 <section id="system-requirements">
 <h2><a class="toc-backref" href="#id26" role="doc-backlink">System requirements</a><a class="headerlink" href="#system-requirements" title="Link to this heading">¶</a></h2>
 <p>Before installing Clear Linux OS, verify that the host system supports the
 installation:</p>
 <ul class="simple">
 <li><p>Requires 20 GB or more disk space</p></li>
 <li><p><a class="reference internal" href="../reference/system-requirements.html#system-requirements"><span class="std std-ref">Recommended minimum system requirements</span></a></p></li>
 <li><p><a class="reference internal" href="compatibility-check.html#compatibility-check"><span class="std std-ref">Check Processor Compatibility</span></a></p></li>
 </ul>
 </section>
 <section id="preliminary-steps">
 <span id="preliminary-steps-install-desktop"></span><h2><a class="toc-backref" href="#id27" role="doc-backlink">Preliminary steps</a><a class="headerlink" href="#preliminary-steps" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Visit our <a class="reference external" href="https://clearlinux.org/downloads">Downloads</a> page.</p></li>
 <li><p>Download the file <code class="file docutils literal notranslate"><span class="pre">clear-&lt;release</span> <span class="pre">number&gt;-live-desktop.iso</span></code>,
 also called the Clear Linux OS Desktop.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>&lt;release-number&gt; is the latest Clear Linux OS auto-numbered release.</p>
 </div>
 </li>
 <li><p>Follow your OS instructions to
 <a class="reference internal" href="bootable-usb.html#bootable-usb"><span class="std std-ref">create a bootable usb drive</span></a>.</p></li>
 </ol>
 </section>
 <section id="install-from-live-image">
 <span id="install-on-target-start"></span><h2><a class="toc-backref" href="#id28" role="doc-backlink">Install from live image</a><a class="headerlink" href="#install-from-live-image" title="Link to this heading">¶</a></h2>
 <p>After you download and burn the live desktop image on a USB drive, follow
 these steps.</p>
 <ol class="arabic simple">
 <li><p>Insert the USB drive into an available USB slot.</p></li>
 <li><p>Power on the system.</p></li>
 <li><p>Open the system BIOS setup menu by pressing the <kbd class="kbd docutils literal notranslate">F2</kbd> key.
 Your BIOS setup menu entry point may vary.</p></li>
 <li><p>In the setup menu, enable the UEFI boot and set the USB drive as the
 first option in the device boot order.</p></li>
 <li><p>Save these settings, e.g. <kbd class="kbd docutils literal notranslate">F10</kbd>, and exit.</p></li>
 <li><p>Reboot the target system.</p></li>
 </ol>
 <section id="choose-boot-menu-option">
 <span id="preliminary-steps-install-desktop-end"></span><h3>Choose boot menu option<a class="headerlink" href="#choose-boot-menu-option" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>Choose one of the options shown in Figure 1.</p>
 <ol class="loweralpha">
 <li><p>Follow <a class="reference internal" href="#verify-integrity-of-installer-media-optional">Verify integrity of installer media (optional)</a>.</p></li>
 <li><p>Select <span class="guilabel">Clear Linux OS</span> in the boot menu.</p>
 <figure class="align-default" id="id1">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-01.png"><img alt="Clear Linux OS in boot menu" src="../_images/bare-metal-install-desktop-01.png" style="width: 660.0px; height: 415.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: Clear Linux OS in boot menu</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>If no action is taken, the live image starts by default.</p>
 </div>
 </li>
 </ol>
 </li>
 </ol>
 </section>
 <section id="verify-integrity-of-installer-media-optional">
 <span id="install-on-target-end"></span><h3>Verify integrity of installer media (optional)<a class="headerlink" href="#verify-integrity-of-installer-media-optional" title="Link to this heading">¶</a></h3>
 <p>Use <span class="guilabel">Verify ISO Integrity</span> to verify the checksum of
 the image burned to the installer media. The checksum ensures that the ISO
 is uncorrupted (see Figure 1). For every ISO generated, the
 <span class="guilabel">clr-installer</span> implants checksums, which are verified during
 early boot stage as part of <strong class="command">initrd</strong>.</p>
 <ol class="arabic simple">
 <li><p>Select <span class="guilabel">Verify ISO Integrity</span>. The media will be validated.</p></li>
 <li><p>If the check passes, it will boot into the live image. Continue in
 the next section.</p></li>
 <li><p>If the check fails, a failure message appears.</p>
 <ul class="simple">
 <li><p>Restart the process at <a class="reference internal" href="#preliminary-steps">Preliminary Steps</a>.</p></li>
 </ul>
 </li>
 </ol>
 </section>
 <section id="launch-the-cl-installer">
 <span id="install-clr-desktop-start"></span><h3>Launch the Clear Linux OS installer<a class="headerlink" href="#launch-the-cl-installer" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>After the live desktop image boots, scroll over the vertical
 <span class="guilabel">Activities</span> menu at left.</p></li>
 <li><p>Click the Clear Linux OS penguin icon to launch the installer, shown in Figure 2.</p>
 <figure class="align-default" id="id2">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-02.png"><img alt="Install Clear Linux OS icon" src="../_images/bare-metal-install-desktop-02.png" style="width: 660.0px; height: 370.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 2: Clear Linux OS installer icon</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>After the installer is launched, it will appear as shown in Figure 3.</p>
 <figure class="align-default" id="id3">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-03.png"><img alt="|CL| Desktop Installer" src="../_images/bare-metal-install-desktop-03.png" style="width: 660.0px; height: 360.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 3: Clear Linux OS OS Desktop Installer</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In <span class="guilabel">Select Language</span>, select a language from the options, or
 type your preferred language in the search bar.</p></li>
 <li><p>Select <span class="guilabel">Next</span>.</p></li>
 </ol>
 <section id="network-proxy-optional">
 <h4>Network Proxy (optional)<a class="headerlink" href="#network-proxy-optional" title="Link to this heading">¶</a></h4>
 <ol class="arabic simple">
 <li><p>Configure <span class="guilabel">Network Proxy</span> settings.</p></li>
 <li><p>In the top right menu bar, select the <span class="guilabel">Power button</span>.</p></li>
 <li><p>Select <span class="guilabel">Wired Connected</span> and then <span class="guilabel">Wired Settings</span>.</p>
 <ol class="arabic simple">
 <li><p>In <span class="guilabel">Network Proxy</span>, select the <span class="guilabel">Gear</span> icon to view
 options.</p></li>
 <li><p>Select an option from <cite>Automatic</cite>, <cite>Manual</cite> or <cite>Disabled</cite>.</p></li>
 <li><p>Close <span class="guilabel">Network Proxy</span>.</p></li>
 </ol>
 </li>
 <li><p>Close <span class="guilabel">Settings</span>.</p></li>
 </ol>
 </section>
 </section>
 </section>
 <section id="minimum-installation-requirements">
 <span id="incl-bare-metal-beta-start"></span><h2><a class="toc-backref" href="#id29" role="doc-backlink">Minimum installation requirements</a><a class="headerlink" href="#minimum-installation-requirements" title="Link to this heading">¶</a></h2>
 <p>To fulfill minimum installation requirements, complete the
 <a class="reference internal" href="#required-options">Required options</a>. We also recommend completing <a class="reference internal" href="#advanced-options">Advanced options</a>.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <ul class="simple">
 <li><p>The <kbd class="kbd docutils literal notranslate">Install</kbd> button is only highlighted <strong>after</strong> you complete
 <a class="reference internal" href="#required-options">Required options</a>.</p></li>
 <li><p>Check marks indicate a selection has been made.</p></li>
 <li><p>The installer image contains the default bundles required for
 installation. An Internet connection is only required if you install
 additional bundles from <a class="reference internal" href="#advanced-options">Advanced options</a>.</p></li>
 </ul>
 </div>
 </section>
 <section id="cl-desktop-installer">
 <h2><a class="toc-backref" href="#id30" role="doc-backlink">Clear Linux OS Desktop Installer</a><a class="headerlink" href="#cl-desktop-installer" title="Link to this heading">¶</a></h2>
 <p>The Clear Linux OS Desktop Installer Main Menu appears as shown in Figure 4. To meet
 the minimum requirements, enter values in all submenus for the
 <span class="guilabel">Required options</span>. After you complete them, your selections appear
 below submenus and a check mark appears at right.</p>
 <figure class="align-default" id="id4">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-04.png"><img alt="Clear Linux OS Desktop Installer - Main Menu" src="../_images/bare-metal-install-desktop-04.png" style="width: 660.0px; height: 349.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 4: Clear Linux OS Desktop Installer - Main Menu</span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </section>
 <section id="navigation">
 <h2><a class="toc-backref" href="#id31" role="doc-backlink">Navigation</a><a class="headerlink" href="#navigation" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Use the <kbd class="kbd docutils literal notranslate">mouse</kbd> to navigate or select options.</p></li>
 <li><p>Use <kbd class="kbd docutils literal notranslate">Tab</kbd> key to navigate between <span class="guilabel">Required options</span>
 and <span class="guilabel">Advanced options</span></p></li>
 <li><p>Use <kbd class="kbd docutils literal notranslate">Up</kbd> or <kbd class="kbd docutils literal notranslate">Down</kbd> arrow keys to navigate the submenus.</p></li>
 <li><p>Select <kbd class="kbd docutils literal notranslate">Confirm</kbd>, or <kbd class="kbd docutils literal notranslate">Cancel</kbd> in submenus.</p></li>
 </ul>
 </section>
 <section id="required-options">
 <h2><a class="toc-backref" href="#id32" role="doc-backlink">Required options</a><a class="headerlink" href="#required-options" title="Link to this heading">¶</a></h2>
 <section id="select-time-zone">
 <h3>Select Time Zone<a class="headerlink" href="#select-time-zone" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>From the Main Menu, select <span class="guilabel">Select Time Zone</span>. <cite>UTC</cite> is selected
 by default.</p></li>
 <li><p>In <span class="guilabel">Select Time Zone</span>, navigate to the desired time zone.
 Or start typing the region and then the city.
 (.e.g., <code class="file docutils literal notranslate"><span class="pre">America/Los_Angeles</span></code>).</p></li>
 <li><p>Select <span class="guilabel">Confirm</span>.</p>
 <figure class="align-default" id="id5">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-05.png"><img alt="Select System Timezone" src="../_images/bare-metal-install-desktop-05.png" style="width: 660.0px; height: 350.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 5: Select System Time Zone</span><a class="headerlink" href="#id5" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="select-keyboard">
 <h3>Select Keyboard<a class="headerlink" href="#select-keyboard" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>From the Main Menu, select <span class="guilabel">Select Keyboard</span>.</p></li>
 <li><p>Navigate to your desired keyboard layout. We select “us” for the
 United States.</p></li>
 <li><p>Select <span class="guilabel">Confirm</span>.</p>
 <figure class="align-default" id="id6">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-06.png"><img alt="Select Keyboard menu" src="../_images/bare-metal-install-desktop-06.png" style="width: 660.0px; height: 400.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 6: Select Keyboard menu</span><a class="headerlink" href="#id6" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="select-installation-media">
 <h3>Select Installation Media<a class="headerlink" href="#select-installation-media" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>From the Main Menu, select <span class="guilabel">Select Installation Media</span>.</p></li>
 <li><p>Choose an installation method: <a class="reference internal" href="#safe-installation">Safe Installation</a> or
 <a class="reference internal" href="#destructive-installation">Destructive Installation</a>.</p>
 <figure class="align-default" id="id7">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-07.png"><img alt="Select Installation Media" src="../_images/bare-metal-install-desktop-07.png" style="width: 660.0px; height: 415.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 7: Select Installation Media</span><a class="headerlink" href="#id7" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 <section id="safe-installation">
 <h4>Safe Installation<a class="headerlink" href="#safe-installation" title="Link to this heading">¶</a></h4>
 <p>Use this method to safely install Clear Linux OS on media with available space, or
 alongside existing partitions, and accept the <a class="reference internal" href="#default-partition-schema">Default partition schema</a>.
 If enough free space exists, safe installation is allowed.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Clear Linux OS allows installation alongside another OS. Typically, when you boot
 your system, you can press an <cite>F key</cite> to view and select a bootable
 device or partition during the BIOS POST stage. Some BIOSes present the
 Clear Linux OS 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 Clear Linux OS. Be aware of this possible limitation.</p>
 </div>
 </section>
 <section id="destructive-installation">
 <h4>Destructive Installation<a class="headerlink" href="#destructive-installation" title="Link to this heading">¶</a></h4>
 <p>Use this method to destroy the contents of the target device, install Clear Linux OS
 on it, and accept the <a class="reference internal" href="#default-partition-schema">Default partition schema</a>.</p>
 </section>
 <section id="disk-encryption">
 <h4>Disk encryption<a class="headerlink" href="#disk-encryption" title="Link to this heading">¶</a></h4>
 <p>For greater security, disk encryption is supported using LUKS. Encryption is
 optional.</p>
 <ol class="arabic">
 <li><p>To encrypt the root partition, select <span class="guilabel">Enable Encryption</span>,
 as shown in Figure 8.</p>
 <figure class="align-default" id="id8">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-08.png"><img alt="Enable Encryption" src="../_images/bare-metal-install-desktop-08.png" style="width: 660.0px; height: 350.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 8: Enable Encryption</span><a class="headerlink" href="#id8" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>When <span class="guilabel">Encryption Passphrase</span> appears, enter a passphrase.</p>
 <figure class="align-default" id="id9">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-09.png"><img alt="Encryption Passphrase" src="../_images/bare-metal-install-desktop-09.png" style="width: 660.0px; height: 348.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 9: Encryption Passphrase</span><a class="headerlink" href="#id9" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Minimum length is 8 characters. Maximum length is 94 characters.</p>
 </div>
 </li>
 <li><p>Enter the same passphrase in the second field.</p></li>
 <li><p>Select <span class="guilabel">Confirm</span> in the dialogue box.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p><span class="guilabel">Confirm</span> is only highlighted if passphrases match.</p>
 </div>
 </li>
 <li><p>Select <span class="guilabel">Confirm</span> in submenu.</p></li>
 </ol>
 </section>
 <section id="advanced-installation">
 <h4>Advanced Installation<a class="headerlink" href="#advanced-installation" title="Link to this heading">¶</a></h4>
 <p>Use this method to manually partition the target media using <cite>gparted</cite>.
 Our example uses the <a class="reference internal" href="#default-partition-schema">Default partition schema</a>. The space you allocate for
 <code class="docutils literal notranslate"><span class="pre">root</span></code>, or additional partitions, may vary.</p>
 <ol class="arabic">
 <li><p>Select <span class="guilabel">Advanced Installation</span>.</p></li>
 <li><p>Select <span class="guilabel">Partition Media</span>, shown in Figure 11.</p>
 <figure class="align-default" id="id10">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-10.png"><img alt="Advanced Installation" src="../_images/bare-metal-install-desktop-10.png" style="width: 660.0px; height: 415.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 10: Advanced Installation</span><a class="headerlink" href="#id10" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="boot-partition">
 <h4>boot partition<a class="headerlink" href="#boot-partition" title="Link to this heading">¶</a></h4>
 <ol class="arabic">
 <li><p>Select the available target media shown as <cite>unallocated</cite>.</p>
 <figure class="align-default" id="id11">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-11.png"><img alt="Advanced Disk Partitioning" src="../_images/bare-metal-install-desktop-11.png" style="width: 660.0px; height: 415.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 11: Advanced Disk Partitioning</span><a class="headerlink" href="#id11" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Choose <span class="menuselection">Device ‣ Create Partition Table</span>.</p></li>
 <li><p>In the <cite>Warning</cite> screen, under <span class="guilabel">Select new partition table type</span>
 , select <cite>gpt</cite> from the pull-down menu.</p></li>
 <li><p>Select <span class="guilabel">Apply</span>.</p></li>
 <li><p>Select <span class="menuselection">Partition ‣ New</span>.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The <cite>/boot</cite> partition must be <cite>VFAT(FAT32)</cite>.</p>
 </div>
 </li>
 <li><p>In <span class="guilabel">Create new Partition</span>, complete the following fields to
 match Figure 12. Don’t change other default values.</p>
 <ul class="simple">
 <li><p><span class="guilabel">New size:</span>                150</p></li>
 <li><p><span class="guilabel">Partition name:</span>          CLR_BOOT</p></li>
 <li><p><span class="guilabel">File system:</span>             fat32</p></li>
 <li><p><span class="guilabel">Label:</span>                   boot</p></li>
 </ul>
 <figure class="align-default" id="id12">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-12.png"><img alt="boot partition" src="../_images/bare-metal-install-desktop-12.png" style="width: 660.0px; height: 415.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 12: boot partition</span><a class="headerlink" href="#id12" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select <span class="guilabel">Add</span>.</p></li>
 </ol>
 </section>
 <section id="swap-partition-optional">
 <h4>swap partition (optional)<a class="headerlink" href="#swap-partition-optional" title="Link to this heading">¶</a></h4>
 <p>A swapfile is generated by default during installation. However, if you prefer to create a swap partition, follow the steps below.</p>
 <ol class="arabic">
 <li><p>With <span class="guilabel">unallocated</span> highlighted, select from the menu
 <span class="menuselection">Partition ‣ New</span>.</p></li>
 <li><p>In <span class="guilabel">Create new Partition</span>, complete the following fields to
 match Figure 13. Don’t change other default values.</p>
 <ul class="simple">
 <li><p><span class="guilabel">New size:</span>                256</p></li>
 <li><p><span class="guilabel">Partition name:</span>          CLR_SWAP</p></li>
 <li><p><span class="guilabel">File system:</span>             linux-swap</p></li>
 <li><p><span class="guilabel">Label:</span>                   swap</p></li>
 </ul>
 <figure class="align-default" id="id13">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-13.png"><img alt="swap partition" src="../_images/bare-metal-install-desktop-13.png" style="width: 660.0px; height: 414.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 13: swap partition</span><a class="headerlink" href="#id13" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select <span class="guilabel">Add</span>.</p></li>
 </ol>
 </section>
 <section id="root-partition">
 <h4>root partition<a class="headerlink" href="#root-partition" title="Link to this heading">¶</a></h4>
 <ol class="arabic">
 <li><p>With <span class="guilabel">unallocated</span> highlighted, select from the menu
 <span class="menuselection">Partition ‣ New</span>.</p></li>
 <li><p>In <span class="guilabel">Create new Partition</span>, complete the following fields to
 match Figure 14. Don’t change other default values.</p></li>
 <li><p>In <span class="guilabel">New size</span>, enter the desired size, or leave as is
 to accept the <em>default: remaining size</em>.</p>
 <ul class="simple">
 <li><p><span class="guilabel">New size:</span>                &lt;varies&gt;</p></li>
 <li><p><span class="guilabel">Partition name:</span>          CLR_ROOT</p></li>
 <li><p><span class="guilabel">File system:</span>             ext[234], XFS, or f2fs</p></li>
 <li><p><span class="guilabel">Label:</span>                   root</p></li>
 </ul>
 <figure class="align-default" id="id14">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-14.png"><img alt="root partition" src="../_images/bare-metal-install-desktop-14.png" style="width: 660.0px; height: 415.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 14: root partition</span><a class="headerlink" href="#id14" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>After all partitions are defined, verify your partition
 configuration is similar to Figure 15.</p>
 <figure class="align-default" id="id15">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-15.png"><img alt="Final partition configuration" src="../_images/bare-metal-install-desktop-15.png" style="width: 660.0px; height: 415.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 15: Final partition configuration</span><a class="headerlink" href="#id15" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select <span class="menuselection">Edit ‣ Apply All Operations</span>.</p></li>
 <li><p>A dialog box appears asking “Are you sure you want to apply the pending
 operations?”</p></li>
 <li><p>Select <span class="guilabel">Apply</span>.</p></li>
 <li><p>When dialog <span class="guilabel">Applying pending operations</span> is complete, select
 <span class="guilabel">Close</span>.</p></li>
 <li><p>Select <span class="menuselection">GParted ‣ Quit</span>.</p></li>
 </ol>
 <p>You are returned to installer.</p>
 </section>
 </section>
 <section id="manage-user">
 <h3>Manage User<a class="headerlink" href="#manage-user" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>In Required Options, select <span class="guilabel">Manage User</span>.</p></li>
 <li><p>In <span class="guilabel">User Name</span>, enter a user name.</p>
 <figure class="align-default" id="id16">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-16.png"><img alt="Manage User" src="../_images/bare-metal-install-desktop-16.png" style="width: 660.0px; height: 405.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 16: Manage User</span><a class="headerlink" href="#id16" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In <span class="guilabel">Login</span>, create a login name. It must start with a letter
 and can use numbers, hyphens, and underscores. Maximum length is 31
 characters.</p></li>
 <li><p>In <span class="guilabel">Password</span>, enter a password. Minimum length is
 8 characters. Maximum length is 255 characters.</p></li>
 <li><p>In <span class="guilabel">Confirm</span>, enter the same password.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p><span class="guilabel">Administrator</span> rights are selected by default.
 For security purposes, the default user must be assigned as an
 Administrator.</p>
 </div>
 </li>
 <li><p>Select <kbd class="kbd docutils literal notranslate">Confirm</kbd>.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Select <span class="guilabel">Cancel</span> to return to the Main Menu.</p>
 </div>
 </li>
 </ol>
 <section id="modify-user">
 <h4>Modify User<a class="headerlink" href="#modify-user" title="Link to this heading">¶</a></h4>
 <ol class="arabic">
 <li><p>In Manager User, select <span class="guilabel">Manage User</span>.</p></li>
 <li><p>Modify user details as desired.</p></li>
 <li><p>Select <span class="guilabel">Confirm</span> to save the changes you made.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Optional: Select <span class="guilabel">Cancel</span> to return to the Main Menu to
 revert changes.</p>
 </div>
 </li>
 </ol>
 <p>Optional: Skip to <a class="reference internal" href="#finish-installation">Finish installation</a>.</p>
 </section>
 </section>
 <section id="telemetry">
 <h3>Telemetry<a class="headerlink" href="#telemetry" title="Link to this heading">¶</a></h3>
 <p>Choose whether to participate in <cite>telemetry</cite>. <a class="reference internal" href="../guides/clear/telemetrics.html#telem-guide"><span class="std std-ref">Telemetrics</span></a> is a Clear Linux OS
 feature that reports failures and crashes to the Clear Linux OS development
 team for improvements.</p>
 <ol class="arabic">
 <li><p>From <span class="guilabel">Required Options</span>, select <span class="guilabel">Telemetry</span>.</p></li>
 <li><p>Select <kbd class="kbd docutils literal notranslate">Yes</kbd>.</p>
 <figure class="align-default" id="id17">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-17.png"><img alt="Enable Telemetry" src="../_images/bare-metal-install-desktop-17.png" style="width: 664.0px; height: 405.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 17: Enable Telemetry</span><a class="headerlink" href="#id17" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>If you don’t wish to participate, select <kbd class="kbd docutils literal notranslate">No</kbd>.</p></li>
 </ol>
 </section>
 </section>
 <section id="advanced-options">
 <h2><a class="toc-backref" href="#id33" role="doc-backlink">Advanced options</a><a class="headerlink" href="#advanced-options" title="Link to this heading">¶</a></h2>
 <p>After you complete the <a class="reference internal" href="#required-options">Required options</a>, we recommend completing
 <span class="guilabel">Advanced options</span>–though they’re not required. Doing so
 customizes your development environment, so you’re ready to go immediately
 after reboot.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>You can always add more bundles later with <a class="reference internal" href="../guides/clear/swupd.html#swupd-guide"><span class="std std-ref">swupd</span></a>.</p>
 </div>
 <section id="select-additional-bundles">
 <h3>Select Additional Bundles<a class="headerlink" href="#select-additional-bundles" title="Link to this heading">¶</a></h3>
 <p>This option is only available with a valid network connection.
 Bundle selection is disabled if no network connection exists.</p>
 <ol class="arabic">
 <li><p>On the Advanced menu, select <span class="guilabel">Select Additional Bundles</span>.</p></li>
 <li><p>Select your desired bundles.</p>
 <figure class="align-default" id="id18">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-18.png"><img alt="Bundle Selection" src="../_images/bare-metal-install-desktop-18.png" style="width: 660.0px; height: 350.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 18: Bundle Selection</span><a class="headerlink" href="#id18" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select <kbd class="kbd docutils literal notranslate">Confirm</kbd>.</p></li>
 <li><p>View the bundles that you selected.</p>
 <figure class="align-default" id="id19">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-19.png"><img alt="Select Additional Bundles" src="../_images/bare-metal-install-desktop-19.png" style="width: 660.0px; height: 405.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 19: Select Additional Bundles</span><a class="headerlink" href="#id19" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 <p>Optional: Skip to <a class="reference internal" href="#finish-installation">Finish installation</a>.</p>
 </section>
 <section id="assign-hostname">
 <h3>Assign Hostname<a class="headerlink" href="#assign-hostname" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>In Advanced Options, select <span class="guilabel">Assign Hostname</span>.</p></li>
 <li><p>In <span class="guilabel">Hostname</span>, enter the hostname only (excluding the domain).</p>
 <figure class="align-default" id="id20">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-20.png"><img alt="Assign Hostname" src="../_images/bare-metal-install-desktop-20.png" style="width: 660.0px; height: 350.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 20: Assign Hostname</span><a class="headerlink" href="#id20" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Hostname does not allow empty spaces. Hostname must start with an
 alphanumeric character but may also contain hyphens. Maximum length of
 63 characters.</p>
 </div>
 </li>
 <li><p>Select <kbd class="kbd docutils literal notranslate">Confirm</kbd>.</p></li>
 </ol>
 <p>Optional: Skip to <a class="reference internal" href="#finish-installation">Finish installation</a>.</p>
 </section>
 <section id="kernel-configuration">
 <h3>Kernel Configuration<a class="headerlink" href="#kernel-configuration" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>In <span class="guilabel">Kernel Configuration</span>, navigate to select your desired
 kernel. <span class="guilabel">Native</span> is selected by default.</p>
 <figure class="align-default" id="id21">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-21.png"><img alt="Kernel Configuration" src="../_images/bare-metal-install-desktop-21.png" style="width: 660.0px; height: 415.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 21: Kernel Configuration</span><a class="headerlink" href="#id21" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>To add arguments, enter the argument in <span class="guilabel">Add Extra Arguments</span>.</p></li>
 <li><p>To remove an argument, enter the argument in <span class="guilabel">Remove Arguments</span>.</p></li>
 <li><p>Select <kbd class="kbd docutils literal notranslate">Confirm</kbd>.</p></li>
 </ol>
 </section>
 <section id="software-updater-configuration">
 <h3>Software Updater Configuration<a class="headerlink" href="#software-updater-configuration" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>In Advanced Options, select <span class="guilabel">Software Updater Configuration</span>.</p></li>
 <li><p>In <span class="guilabel">Mirror URL</span>, follow the instructions if you wish to
 specify a different installation source.</p></li>
 <li><p><span class="guilabel">Enable Auto Updates</span> is selected by default. If you <strong>do not</strong>
 wish to enable automatic software updates, uncheck the box.</p>
 <figure class="align-default" id="id22">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-22.png"><img alt="Software Updater Configuration" src="../_images/bare-metal-install-desktop-22.png" style="width: 660.0px; height: 405.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 22: Software Updater Configuration</span><a class="headerlink" href="#id22" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select <kbd class="kbd docutils literal notranslate">Confirm</kbd>.</p></li>
 </ol>
 </section>
 </section>
 <section id="finish-installation">
 <h2><a class="toc-backref" href="#id34" role="doc-backlink">Finish installation</a><a class="headerlink" href="#finish-installation" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>When you are satisfied with your installation configuration, select
 <span class="guilabel">Install</span>.</p>
 <figure class="align-default" id="id23">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-23.png"><img alt="Assign Hostname" src="../_images/bare-metal-install-desktop-23.png" style="width: 660.0px; height: 350.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 23: Finish installation</span><a class="headerlink" href="#id23" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>If you do not enter a selection for all <span class="guilabel">Required Options</span>,
 the <span class="guilabel">Install</span> button remains disabled, as shown
 in Figure 24. Return to <a class="reference internal" href="#required-options">Required Options</a> and make selections.</p>
 <figure class="align-default" id="id24">
 <a class="reference internal image-reference" href="../_images/bare-metal-install-desktop-24.png"><img alt="Required Options - Incomplete" src="../_images/bare-metal-install-desktop-24.png" style="width: 660.0px; height: 350.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 24: Required Options - Incomplete</span><a class="headerlink" href="#id24" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>After installation is complete, select <span class="guilabel">Exit</span>.</p></li>
 <li><p>Shut down the target system.</p></li>
 <li><p>Remove the USB or any installation media.</p></li>
 <li><p>Power on your system.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Allow time for the graphical login to appear. A login prompt shows the administrative user that you created.</p>
 </div>
 </li>
 <li><p>Log in as the administrative user.</p></li>
 </ol>
 <p>Congratulations. You successfully installed Clear Linux OS.</p>
 <section id="default-partition-schema">
 <h3>Default partition schema<a class="headerlink" href="#default-partition-schema" title="Link to this heading">¶</a></h3>
 <p>Create partitions per requirements in Table 1.</p>
 <table class="docutils align-default" id="id25">
 <caption><span class="caption-text"><strong>Table 1. Default partition schema</strong></span><a class="headerlink" href="#id25" title="Link to this table">¶</a></caption>
 <colgroup>
 <col style="width: 25.0%" />
 <col style="width: 25.0%" />
 <col style="width: 25.0%" />
 <col style="width: 25.0%" />
 </colgroup>
 <thead>
 <tr class="row-odd"><th class="head"><p>FileSystem</p></th>
 <th class="head"><p>Label</p></th>
 <th class="head"><p>Mount Point</p></th>
 <th class="head"><p>Default size</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">VFAT</span> <span class="pre">(FAT32)</span></code></p></td>
 <td><p>boot</p></td>
 <td><p>/boot</p></td>
 <td><p>150MB</p></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ext[234],</span> <span class="pre">XFS,</span> <span class="pre">or</span> <span class="pre">f2fs</span></code></p></td>
 <td><p>root</p></td>
 <td><p>/</p></td>
 <td><p><em>Size depends upon use case/desired bundles.</em></p></td>
 </tr>
 </tbody>
 </table>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>A 64MiB swapfile is generated by default. The default size may be set
 manually with the <code class="docutils literal notranslate"><span class="pre">--swap-file-size</span></code> command-line option.</p>
 </div>
 </section>
 </section>
 <section id="troubleshooting">
 <h2><a class="toc-backref" href="#id35" role="doc-backlink">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Link to this heading">¶</a></h2>
 <p><a class="reference internal" href="bare-metal-install-server.html#erase-lvm-troubleshooting-tip"><span class="std std-ref">Erase LVM Partitions Before Installing Clear Linux OS</span></a></p>
 </section>
 <section id="related-topics">
 <h2><a class="toc-backref" href="#id36" role="doc-backlink">Related topics</a><a class="headerlink" href="#related-topics" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p><a class="reference internal" href="install-configfile.html#install-configfile"><span class="std std-ref">Install using clr-installer and a configuration file</span></a></p></li>
 </ul>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Install Clear Linux* OS from the live desktop</a><ul>
 <li><a class="reference internal" href="#system-requirements">System requirements</a></li>
 <li><a class="reference internal" href="#preliminary-steps">Preliminary steps</a></li>
 <li><a class="reference internal" href="#install-from-live-image">Install from live image</a><ul>
 <li><a class="reference internal" href="#choose-boot-menu-option">Choose boot menu option</a></li>
 <li><a class="reference internal" href="#verify-integrity-of-installer-media-optional">Verify integrity of installer media (optional)</a></li>
 <li><a class="reference internal" href="#launch-the-cl-installer">Launch the Clear Linux OS installer</a><ul>
 <li><a class="reference internal" href="#network-proxy-optional">Network Proxy (optional)</a></li>
 </ul>
 </li>
 </ul>
 </li>
 <li><a class="reference internal" href="#minimum-installation-requirements">Minimum installation requirements</a></li>
 <li><a class="reference internal" href="#cl-desktop-installer">Clear Linux OS Desktop Installer</a></li>
 <li><a class="reference internal" href="#navigation">Navigation</a></li>
 <li><a class="reference internal" href="#required-options">Required options</a><ul>
 <li><a class="reference internal" href="#select-time-zone">Select Time Zone</a></li>
 <li><a class="reference internal" href="#select-keyboard">Select Keyboard</a></li>
 <li><a class="reference internal" href="#select-installation-media">Select Installation Media</a><ul>
 <li><a class="reference internal" href="#safe-installation">Safe Installation</a></li>
 <li><a class="reference internal" href="#destructive-installation">Destructive Installation</a></li>
 <li><a class="reference internal" href="#disk-encryption">Disk encryption</a></li>
 <li><a class="reference internal" href="#advanced-installation">Advanced Installation</a></li>
 <li><a class="reference internal" href="#boot-partition">boot partition</a></li>
 <li><a class="reference internal" href="#swap-partition-optional">swap partition (optional)</a></li>
 <li><a class="reference internal" href="#root-partition">root partition</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#manage-user">Manage User</a><ul>
 <li><a class="reference internal" href="#modify-user">Modify User</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#telemetry">Telemetry</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#advanced-options">Advanced options</a><ul>
 <li><a class="reference internal" href="#select-additional-bundles">Select Additional Bundles</a></li>
 <li><a class="reference internal" href="#assign-hostname">Assign Hostname</a></li>
 <li><a class="reference internal" href="#kernel-configuration">Kernel Configuration</a></li>
 <li><a class="reference internal" href="#software-updater-configuration">Software Updater Configuration</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#finish-installation">Finish installation</a><ul>
 <li><a class="reference internal" href="#default-partition-schema">Default partition schema</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#troubleshooting">Troubleshooting</a></li>
 <li><a class="reference internal" href="#related-topics">Related topics</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="bootable-usb.html"
                          title="previous chapter">Create a bootable USB drive using Etcher*</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="bare-metal-install-server.html"
                          title="next chapter">Install Clear Linux* OS from the live server</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/get-started/bare-metal-install-desktop.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="bare-metal-install-server.html" title="Install Clear Linux* OS from the live server"
             >next</a> |</li>
        <li class="right" >
          <a href="bootable-usb.html" title="Create a bootable USB drive using Etcher*"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Install Clear Linux* OS from the live desktop</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,288 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Create a bootable USB drive using Etcher* &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/bootable-usb.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Install Clear Linux* OS from the live desktop" href="bare-metal-install-desktop.html" />
    <link rel="prev" title="Check Processor Compatibility" href="compatibility-check.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="bare-metal-install-desktop.html" title="Install Clear Linux* OS from the live desktop"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="compatibility-check.html" title="Check Processor Compatibility"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Create a bootable USB drive using Etcher*</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="create-a-bootable-usb-drive-using-etcher">
 <span id="bootable-usb"></span><h1>Create a bootable USB drive using Etcher*<a class="headerlink" href="#create-a-bootable-usb-drive-using-etcher" title="Link to this heading">¶</a></h1>
 <p>Use Etcher* software from Balena* to flash the Clear Linux OS image to a USB drive.
 An <a class="reference internal" href="#advanced-linux-cli">Advanced: Linux CLI</a> option is also available.</p>
 <section id="prerequisites">
 <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Download the Clear Linux OS Desktop or Server image from the <a class="reference external" href="https://clearlinux.org/downloads">Downloads</a> page</p></li>
 <li><p>Recommended minimum <strong>4GB</strong> USB drive or larger</p></li>
 <li><p>Download and install the <a class="reference external" href="https://www.balena.io/etcher/">Etcher</a> version per your operating system.</p></li>
 </ul>
 <section id="burn-the-cl-image-onto-a-usb-drive">
 <h3>Burn the Clear Linux OS image onto a USB drive<a class="headerlink" href="#burn-the-cl-image-onto-a-usb-drive" title="Link to this heading">¶</a></h3>
 <div class="admonition caution">
 <p class="admonition-title">Caution</p>
 <p>Burning an image formats the USB drive and destroys all pre-existing
 content.  Back up your data before proceeding.</p>
 </div>
 <ol class="arabic">
 <li><p>Launch Etcher.</p>
 <figure class="dropshadow align-default" id="id1">
 <a class="reference internal image-reference" href="../_images/balenaEtcher_Start.PNG"><img alt="Start screen" src="../_images/balenaEtcher_Start.PNG" style="width: 625.0px; height: 375.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: Start screen</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Press <span class="guilabel">Select Image</span>.</p></li>
 <li><p>Change directory to where the image resides.</p></li>
 <li><p>Select the image and click <span class="guilabel">Open</span>.</p>
 <figure class="dropshadow align-default" id="id2">
 <a class="reference internal image-reference" href="../_images/balenaEtcher_ImageSelect.PNG"><img alt="In Open, select the image" src="../_images/balenaEtcher_ImageSelect.PNG" style="width: 625.0px; height: 376.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 2: In Open, select the image</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Plug in the USB drive.</p></li>
 <li><p>Identify the USB drive or click <span class="guilabel">Change</span> to select a
 different USB.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>This shows all USB drives attached to the system.</p>
 </div>
 <figure class="dropshadow align-default" id="id3">
 <a class="reference internal image-reference" href="../_images/balenaEtcher_DriveSlect.PNG"><img alt="USB drives attached" src="../_images/balenaEtcher_DriveSlect.PNG" style="width: 625.0px; height: 375.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 3: USB drives attached</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select the proper device and press <span class="guilabel">Continue</span>.</p>
 <figure class="dropshadow align-default" id="id4">
 <a class="reference internal image-reference" href="../_images/balenaEtcher_ReadyToFlash.PNG"><img alt="USB Flash Device selected" src="../_images/balenaEtcher_ReadyToFlash.PNG" style="width: 625.0px; height: 375.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 4: USB Flash Device selected</span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>When ready press the <span class="guilabel">Flash!</span> Button.
 The dialog shows <span class="guilabel">Flashing</span> while in progress.</p>
 <figure class="dropshadow align-default" id="id5">
 <a class="reference internal image-reference" href="../_images/balenaEtcher_StartingToFlash.PNG"><img alt="Starting to flash" src="../_images/balenaEtcher_StartingToFlash.PNG" style="width: 625.0px; height: 375.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 5: Starting to flash</span><a class="headerlink" href="#id5" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <figure class="dropshadow align-default" id="id6">
 <a class="reference internal image-reference" href="../_images/balenaEtcher_Flashing.PNG"><img alt="Flashing, percentage complete" src="../_images/balenaEtcher_Flashing.PNG" style="width: 625.0px; height: 375.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 6: Flashing, percentage complete</span><a class="headerlink" href="#id6" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p><span class="guilabel">Flash complete!</span> shows when the process is finished.</p>
 <figure class="dropshadow align-default" id="id7">
 <a class="reference internal image-reference" href="../_images/balenaEtcher_Done.PNG"><img alt="Flash Complete!" src="../_images/balenaEtcher_Done.PNG" style="width: 625.0px; height: 375.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 7: Flash Complete!</span><a class="headerlink" href="#id7" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The process may take more than a few minutes. When the process completes, close BalenaEtcher.</p>
 </div>
 </li>
 </ol>
 </section>
 <section id="advanced-linux-cli">
 <h3>Advanced: Linux CLI<a class="headerlink" href="#advanced-linux-cli" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>Open a Terminal window.</p></li>
 <li><p>Change directory to where the image resides.</p></li>
 <li><p>Plug in the USB drive.</p></li>
 <li><p>Identify all drives attached to the system. In the example output below, there are 3 drives (<cite>/dev/sda</cite>, <cite>/dev/sdb</cite>, and <cite>/dev/sdc</cite>) attached, where <cite>/dev/sda</cite> is the primary drive and the remaining are USB drives.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>lsblk<span class="w"> </span>-po<span class="w"> </span>NAME,SIZE,VENDOR,MODEL,TRAN,TYPE,PARTLABEL,MOUNTPOINT
 </pre></div>
 </div>
 <p>Example output:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">NAME          SIZE VENDOR   MODEL                    TRAN   TYPE PARTLABEL                    MOUNTPOINT</span>
 <span class="go">/dev/sda    119.2G ATA      SAMSUNG_MZ7PC128HAFU-000 sata   disk</span>
 <span class="go">├─/dev/sda1   450M                                          part Basic data partition</span>
 <span class="go">├─/dev/sda2   100M                                          part EFI system partition</span>
 <span class="go">├─/dev/sda3    16M                                          part Microsoft reserved partition</span>
 <span class="go">├─/dev/sda4  97.2G                                          part Basic data partition</span>
 <span class="go">├─/dev/sda5   142M                                          part EFI</span>
 <span class="go">├─/dev/sda6   245M                                          part linux-swap                   [SWAP]</span>
 <span class="go">└─/dev/sda7  21.1G                                          part /                            /</span>
 <span class="go">/dev/sdb      7.5G General  UDisk                    usb    disk</span>
 <span class="go">└─/dev/sdb1   7.5G                                          part Microsoft Basic Data         /run/media/clear/CENA_X64FRE</span>
 <span class="go">/dev/sdc       15G          Patriot_Memory           usb    disk</span>
 <span class="go">└─/dev/sdc1    15G                                          part                              /run/media/clear/U</span>
 </pre></div>
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Some Linux distros may automatically mount a USB drive when it is plugged in.</p>
 </div>
 </li>
 <li><p>Unmount the USB drive you want to use before burning an image onto it.
 Use the <strong class="command">umount</strong> command followed by the device identifier/partition. For example, to unmount all <code class="docutils literal notranslate"><span class="pre">/dev/sdc</span></code> partitions:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>umount<span class="w"> </span>/dev/sdc*
 </pre></div>
 </div>
 </li>
 <li><p>Burn the image onto the USB drive. This example burns an image onto
 <code class="docutils literal notranslate"><span class="pre">/dev/sdc</span></code>. The device name of the USB may vary.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>dd<span class="w"> </span><span class="k">if</span><span class="o">=</span>./clear-<span class="o">[</span>version<span class="w"> </span>number<span class="o">]</span>-live-<span class="o">[</span>desktop<span class="w"> </span><span class="p">|</span><span class="w"> </span>server<span class="o">]</span>.iso<span class="w"> </span><span class="nv">of</span><span class="o">=</span>/dev/sdc<span class="w"> </span><span class="nv">oflag</span><span class="o">=</span>sync<span class="w"> </span><span class="nv">bs</span><span class="o">=</span>4M<span class="w"> </span><span class="nv">status</span><span class="o">=</span>progress
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="eject-the-cl-image-usb-drive">
 <h3>Eject the Clear Linux OS image USB drive<a class="headerlink" href="#eject-the-cl-image-usb-drive" title="Link to this heading">¶</a></h3>
 <div class="admonition caution">
 <p class="admonition-title">Caution</p>
 <p>If you do not properly unmount the USB drive before removing it, it may cause file system checksum errors in it. If this happens, burn the image again, ensuring all the USB drive partitions are unmounted first before removing drive.</p>
 </div>
 <ol class="arabic simple">
 <li><p>Unmount the USB per your OS instructions.</p></li>
 <li><p>Then eject the USB.</p></li>
 </ol>
 </section>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Create a bootable USB drive using Etcher*</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a><ul>
 <li><a class="reference internal" href="#burn-the-cl-image-onto-a-usb-drive">Burn the Clear Linux OS image onto a USB drive</a></li>
 <li><a class="reference internal" href="#advanced-linux-cli">Advanced: Linux CLI</a></li>
 <li><a class="reference internal" href="#eject-the-cl-image-usb-drive">Eject the Clear Linux OS image USB drive</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="compatibility-check.html"
                          title="previous chapter">Check Processor Compatibility</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="bare-metal-install-desktop.html"
                          title="next chapter">Install Clear Linux* OS from the live desktop</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/get-started/bootable-usb.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="bare-metal-install-desktop.html" title="Install Clear Linux* OS from the live desktop"
             >next</a> |</li>
        <li class="right" >
          <a href="compatibility-check.html" title="Check Processor Compatibility"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Create a bootable USB drive using Etcher*</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,432 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS on Amazon Web Services* &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/cloud-install/aws-web.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Clear Linux* OS on Microsoft* Azure*" href="azure.html" />
    <link rel="prev" title="Increase Virtual Disk Size of an Image" href="../../guides/maintenance/increase-virtual-disk-size.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="azure.html" title="Clear Linux* OS on Microsoft* Azure*"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../../guides/maintenance/increase-virtual-disk-size.html" title="Increase Virtual Disk Size of an Image"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Amazon Web Services*</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-on-amazon-web-services">
 <span id="aws-web"></span><h1>Clear Linux* OS on Amazon Web Services*<a class="headerlink" href="#cl-attr-on-amazon-web-services" title="Link to this heading">¶</a></h1>
 <p>This tutorial explains how to create and launch a Clear Linux OS
 <abbr title="Amazon Machine Image">AMI</abbr> instance from the
 <abbr title="Amazon Web Services">AWS*</abbr> console and complete the following tasks:</p>
 <ol class="arabic simple">
 <li><p>Locate and select the Clear Linux OS OS Basic AMI in the AWS Marketplace.</p></li>
 <li><p>Create a new public and private key pair to allow you to connect to your
 Clear Linux OS instance securely.</p></li>
 <li><p>Launch the new Clear Linux OS instance and connect to it.</p></li>
 <li><p>Update your instance of Clear Linux OS using the <strong class="command">swupd</strong> command.</p></li>
 <li><p>Stop the Clear Linux OS instance.</p></li>
 </ol>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#prerequisites" id="id15">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#locate-select-and-launch-the-cl-basic-ami" id="id16">Locate, select, and launch the Clear Linux OS Basic AMI</a></p></li>
 <li><p><a class="reference internal" href="#connect-to-your-clear-linux-os-basic-instance" id="id17">Connect to your Clear Linux OS basic instance</a></p></li>
 <li><p><a class="reference internal" href="#update-the-cl-instance" id="id18">Update the Clear Linux OS instance</a></p></li>
 <li><p><a class="reference internal" href="#stop-the-cl-instance" id="id19">Stop the Clear Linux OS instance</a></p></li>
 <li><p><a class="reference internal" href="#related-topics" id="id20">Related topics</a></p></li>
 </ul>
 </nav>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id15" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <p>This tutorial assumes the following statements are true:</p>
 <ul class="simple">
 <li><p>You are using a linux-based system to access AWS and can run <strong class="command">SSH</strong>
 to access the remote Clear Linux OS AWS image.</p></li>
 <li><p>Your browser puts downloaded files in the <code class="file docutils literal notranslate"><span class="pre">$HOME/Downloads</span></code>
 directory.</p></li>
 <li><p>You have already set up an AWS user account and logged into the AWS
 console.</p></li>
 </ul>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>This tutorial uses a Clear Linux OS 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 <a class="reference external" href="http://aws.amazon.com">http://aws.amazon.com</a>.</p>
 </div>
 </section>
 <section id="locate-select-and-launch-the-cl-basic-ami">
 <h2><a class="toc-backref" href="#id16" role="doc-backlink">Locate, select, and launch the Clear Linux OS Basic AMI</a><a class="headerlink" href="#locate-select-and-launch-the-cl-basic-ami" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Start from your main AWS services console menu in your browser and select
 the <span class="guilabel">EC2</span> text as shown in Figure 1:</p>
 <figure class="align-default" id="id1">
 <a class="reference internal image-reference" href="../../_images/aws-web-1.png"><img alt="AWS Console" src="../../_images/aws-web-1.png" style="width: 737.5px; height: 596.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: <span class="guilabel">AWS Console</span></span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <p>This selection brings up your <span class="guilabel">EC2 Dashboard</span> menu.</p>
 </li>
 <li><p>To create a new Clear Linux OS instance from the <span class="guilabel">EC2 Dashboard</span> menu,
 select the <span class="guilabel">Launch Instance</span> button as shown in Figure 2:</p>
 <figure class="align-default" id="id2">
 <a class="reference internal image-reference" href="../../_images/aws-web-2.png"><img alt="EC2 Dashboard" src="../../_images/aws-web-2.png" style="width: 737.5px; height: 596.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 2: <span class="guilabel">EC2 Dashboard</span></span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <p>This selection takes you to the
 <span class="guilabel">Step 1: Choose an Amazon Machine Image (AMI)</span> menu.</p>
 </li>
 <li><p>To find the <span class="guilabel">Clear Linux OS Basic</span> AMI in the
 <span class="guilabel">Step 1: Choose an Amazon Machine Image (AMI)</span> menu, do the
 following:</p>
 <ol class="arabic">
 <li><p>In the lefthand navigation window, select the
 <span class="guilabel">AWS Marketplace</span> menu item to bring up the search bar to
 <span class="guilabel">Search AWS Marketplace Products</span>.</p></li>
 <li><p>In the search bar, type “clear linux os” and press the <kbd class="kbd docutils literal notranslate">Enter</kbd> key
 to search for and locate the <span class="guilabel">Clear Linux OS Basic</span> AMI.</p></li>
 <li><p>Select the <span class="guilabel">Clear Linux OS Basic</span> AMI by clicking the
 <span class="guilabel">Select</span> button as shown in Figure 3:</p>
 <figure class="align-default" id="id3">
 <a class="reference internal image-reference" href="../../_images/aws-web-3.png"><img alt="Step 1: Choose AMI" src="../../_images/aws-web-3.png" style="width: 737.5px; height: 596.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 3: <span class="guilabel">Step 1: Choose AMI</span></span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>A pop-up dialog box appears showing you more information about the
 <span class="guilabel">Clear Linux OS Basic</span> AMI along with the pricing details for
 running Clear Linux OS on different platform configurations as shown in Figure 4.
 Select the <span class="guilabel">Continue</span> button.</p>
 <figure class="align-default" id="id4">
 <a class="reference internal image-reference" href="../../_images/aws-web-4.png"><img alt="Clear Linux OS Basic" src="../../_images/aws-web-4.png" style="width: 737.5px; height: 596.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 4: <span class="guilabel">Clear Linux OS Basic</span></span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </li>
 <li><p>The <span class="guilabel">Choose Instance Type</span> menu appears as shown in Figure 5.</p>
 <figure class="align-default" id="id5">
 <a class="reference internal image-reference" href="../../_images/aws-web-5.png"><img alt="Choose an Instance Type" src="../../_images/aws-web-5.png" style="width: 737.5px; height: 596.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 5: <span class="guilabel">Choose an Instance Type</span></span><a class="headerlink" href="#id5" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <p>Select the <span class="guilabel">t2.micro</span> type by clicking the box on the left side
 of the instance and then select the <span class="guilabel">Review and Launch</span> button to
 move to the <span class="guilabel">Step 7: Review the Instance Launch</span> menu.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>You can configure the instance details, add additional storage, add
 tags, and configure the security group before selecting the
 <span class="guilabel">Review and Launch</span> button if you want to further customize
 this Clear Linux OS instance.</p>
 </div>
 </li>
 <li><p>The <span class="guilabel">Step 7: Review the Instance Launch</span> menu, shown in Figure 6,
 allows you to <span class="guilabel">Cancel</span> the process, return to
 the <span class="guilabel">Previous</span> screen to change the configuration
 or <span class="guilabel">Launch</span> the instance defined.</p>
 <figure class="align-default" id="id6">
 <a class="reference internal image-reference" href="../../_images/aws-web-6.png"><img alt="Step 7: Review the Instance Launch" src="../../_images/aws-web-6.png" style="width: 737.5px; height: 596.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 6: <span class="guilabel">Step 7: Review the Instance Launch</span></span><a class="headerlink" href="#id6" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <ol class="arabic">
 <li><p>Select the <span class="guilabel">Launch</span> button. A dialog box appears, as shown in
 Figure 7, asking you to
 <span class="guilabel">Select an existing key pair or create a new pair</span>.</p>
 <figure class="align-default" id="id7">
 <a class="reference internal image-reference" href="../../_images/aws-web-7.png"><img alt="Select an existing key pair or create a new pair" src="../../_images/aws-web-7.png" style="width: 737.5px; height: 596.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 7: <span class="guilabel">Select an existing key pair or create a new pair</span></span><a class="headerlink" href="#id7" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <ol class="arabic">
 <li><p>Select the <span class="guilabel">Create a new key pair</span> option.</p></li>
 <li><p>For the <span class="guilabel">Key pair name</span> field, enter <cite>AWSClearTestKey</cite>.</p></li>
 <li><p>Select the <span class="guilabel">Download Key Pair</span> button to download the
 <code class="file docutils literal notranslate"><span class="pre">AWSClearTestKey.pem</span></code> to your browser’s defined
 <code class="file docutils literal notranslate"><span class="pre">Downloads</span></code> directory.</p></li>
 <li><p>When the file finishes downloading, select the
 <span class="guilabel">Launch Instances</span> button to proceed to the
 <span class="guilabel">Launch Status</span> menu shown in Figure 8.</p>
 <figure class="align-default" id="id8">
 <a class="reference internal image-reference" href="../../_images/aws-web-8.png"><img alt="Launch Status" src="../../_images/aws-web-8.png" style="width: 737.5px; height: 596.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 8: <span class="guilabel">Launch Status</span></span><a class="headerlink" href="#id8" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </li>
 <li><p>Once the <span class="guilabel">Launch Status</span> page changes to what is shown in
 Figure 9, select the <span class="guilabel">View Instances</span> button to view your
 <span class="guilabel">Instances</span> dashboard.</p>
 <figure class="align-default" id="id9">
 <a class="reference internal image-reference" href="../../_images/aws-web-9.png"><img alt="View Instance" src="../../_images/aws-web-9.png" style="width: 737.5px; height: 660.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 9: <span class="guilabel">View Instance</span></span><a class="headerlink" href="#id9" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </li>
 </ol>
 </section>
 <section id="connect-to-your-clear-linux-os-basic-instance">
 <h2><a class="toc-backref" href="#id17" role="doc-backlink">Connect to your Clear Linux OS basic instance</a><a class="headerlink" href="#connect-to-your-clear-linux-os-basic-instance" title="Link to this heading">¶</a></h2>
 <p>Your <span class="guilabel">Instances</span> Dashboard is shown in Figure 10 with the new Clear Linux OS
 OS basic instance already selected and in the running state. If there are
 other instances available, they are also listed but not selected.</p>
 <figure class="align-default" id="id10">
 <a class="reference internal image-reference" href="../../_images/aws-web-10.png"><img alt="Instance Dashboard" src="../../_images/aws-web-10.png" style="width: 737.5px; height: 660.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 10: <span class="guilabel">Instance Dashboard</span></span><a class="headerlink" href="#id10" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <ol class="arabic simple">
 <li><p>To connect to your running instance, click the <span class="guilabel">Connect</span> 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.</p></li>
 </ol>
 <figure class="align-default" id="id11">
 <span id="fig-aws-web-11"></span><a class="reference internal image-reference" href="../../_images/aws-web-11.png"><img alt="Connect to Your Instance" src="../../_images/aws-web-11.png" style="width: 737.5px; height: 660.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 11: <span class="guilabel">Connect to Your Instance</span></span><a class="headerlink" href="#id11" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <ol class="arabic">
 <li><p>Open a terminal on your system. You should be in your <code class="file docutils literal notranslate"><span class="pre">$HOME</span></code>
 directory.</p></li>
 <li><p>Copy the previously downloaded keyfile from the <code class="file docutils literal notranslate"><span class="pre">Downloads</span></code>
 directory to the current directory.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">cp Downloads/AWSClearTestKey.pem .</span>
 </pre></div>
 </div>
 </li>
 <li><p>Change the attributes of the <code class="file docutils literal notranslate"><span class="pre">AWSClearTestKey.pem</span></code> using the
 <strong class="command">chmod</strong> command as instructed in the dialog box shown in Figure
 11.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">chmod 400 AWSClearTestKey.pem</span>
 </pre></div>
 </div>
 </li>
 <li><p>Copy the text highlighted in the <span class="guilabel">Example:</span> section that is
 shown in <a class="reference internal" href="#fig-aws-web-11"><span class="std std-ref">figure 11</span></a>. Paste the copied text into your
 terminal, change the text before the <cite>&#64;</cite> sign to the username <cite>clear</cite>, and
 press the <kbd class="kbd docutils literal notranslate">Enter</kbd> key to execute the command.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">ssh -i &quot;AWSClearTestKey.pem&quot; clear@ec2-34-209-39-184.us-west-2.compute.amazonaws.com</span>
 </pre></div>
 </div>
 </li>
 <li><p>A message appears on the terminal stating the authenticity of the host
 can’t be established and prompts you with the message:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">The authenticity of host &#39;ec2-34-209-39-184.us-west-2.compute.amazonaws.com (34.209.39.184)&#39; can&#39;t be established.</span>
 <span class="go">ECDSA key fingerprint is SHA256:LrziT5Ar66iBTfia8qmiIsrfBUm/UGam76U8bDR6yJc.</span>
 <span class="go">Are you sure you want to continue connecting (yes/no)?</span>
 </pre></div>
 </div>
 </li>
 <li><p>Type <cite>yes</cite> and press the <kbd class="kbd docutils literal notranslate">Enter</kbd> key. Another warning is printed to
 the terminal and you are now at the command prompt of your new Clear Linux OS
 instance.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">Warning: Permanently added &#39;ec2-34-209-39-184.us-west-2.compute.amazonaws.com,34.209.39.184&#39; (ECDSA) to the list of known hosts.</span>
 <span class="gp">clear@clr-96a8565d0ca54b0c80364a1e5e7b0f88 ~ $</span>
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="update-the-cl-instance">
 <h2><a class="toc-backref" href="#id18" role="doc-backlink">Update the Clear Linux OS instance</a><a class="headerlink" href="#update-the-cl-instance" title="Link to this heading">¶</a></h2>
 <p>Run the <strong class="command">sudo swupd update</strong> command to update the operating
 system as shown in Figure 12:</p>
 <figure class="align-default" id="id12">
 <a class="reference internal image-reference" href="../../_images/aws-web-12.png"><img alt="sudo swupd update" src="../../_images/aws-web-12.png" style="width: 661.5px; height: 432.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 12: <span class="guilabel">sudo swupd update</span></span><a class="headerlink" href="#id12" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <p>In this example, we updated from version 18940 to 19100.</p>
 </section>
 <section id="stop-the-cl-instance">
 <h2><a class="toc-backref" href="#id19" role="doc-backlink">Stop the Clear Linux OS instance</a><a class="headerlink" href="#stop-the-cl-instance" title="Link to this heading">¶</a></h2>
 <p>When you are finished using your AWS Clear Linux OS instance, you must stop it using
 the <span class="guilabel">Instances</span> dashboard to stop accruing charges. Complete the
 following steps from the <span class="guilabel">Instances</span> dashboard to stop your AWS Clear Linux OS
 instance from running.</p>
 <ol class="arabic">
 <li><p>Select the <span class="guilabel">Actions</span> button to bring up a pull-down menu.</p></li>
 <li><p>Select the <span class="guilabel">Instance State</span> menu item to expand the options.</p></li>
 <li><p>Select <span class="guilabel">Stop</span> menu item to shut down the running instance.</p>
 <p>Figure 13 illustrates these steps.</p>
 <figure class="align-default" id="id13">
 <a class="reference internal image-reference" href="../../_images/aws-web-13.png"><img alt="Stop Instance" src="../../_images/aws-web-13.png" style="width: 737.5px; height: 660.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 13: <span class="guilabel">Stop Instance</span></span><a class="headerlink" href="#id13" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>A pop-up dialog box appears warning you that any ephemeral storage of
 your instance will be lost. Select the <span class="guilabel">Yes, Stop</span> button to stop
 your Clear Linux OS instance.</p></li>
 </ol>
 <figure class="align-default" id="id14">
 <a class="reference internal image-reference" href="../../_images/aws-web-14.png"><img alt="Stop Instances" src="../../_images/aws-web-14.png" style="width: 737.5px; height: 660.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 14: <span class="guilabel">Stop Instances</span></span><a class="headerlink" href="#id14" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <p>Congratulations! You are up and running with Clear Linux OS on AWS. To see what you
 can do with your Clear Linux OS instance, visit our <a class="reference internal" href="../../tutorials/index.html#tutorials"><span class="std std-ref">tutorials</span></a>
 section for examples on using your Clear Linux OS system.</p>
 </section>
 <section id="related-topics">
 <h2><a class="toc-backref" href="#id20" role="doc-backlink">Related topics</a><a class="headerlink" href="#related-topics" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p><a class="reference internal" href="azure.html#azure"><span class="std std-ref">Clear Linux* OS on Microsoft* Azure*</span></a></p></li>
 <li><p><a class="reference internal" href="gce.html#gce"><span class="std std-ref">Clear Linux* OS on Google Cloud Platform*</span></a></p></li>
 <li><p><a class="reference internal" href="digitalocean.html#clr-digitalocean"><span class="std std-ref">Clear Linux* OS on DigitalOcean*</span></a></p></li>
 </ul>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS on Amazon Web Services*</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#locate-select-and-launch-the-cl-basic-ami">Locate, select, and launch the Clear Linux OS Basic AMI</a></li>
 <li><a class="reference internal" href="#connect-to-your-clear-linux-os-basic-instance">Connect to your Clear Linux OS basic instance</a></li>
 <li><a class="reference internal" href="#update-the-cl-instance">Update the Clear Linux OS instance</a></li>
 <li><a class="reference internal" href="#stop-the-cl-instance">Stop the Clear Linux OS instance</a></li>
 <li><a class="reference internal" href="#related-topics">Related topics</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="../../guides/maintenance/increase-virtual-disk-size.html"
                          title="previous chapter">Increase Virtual Disk Size of an Image</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="azure.html"
                          title="next chapter">Clear Linux* OS on Microsoft* Azure*</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/cloud-install/aws-web.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="azure.html" title="Clear Linux* OS on Microsoft* Azure*"
             >next</a> |</li>
        <li class="right" >
          <a href="../../guides/maintenance/increase-virtual-disk-size.html" title="Increase Virtual Disk Size of an Image"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Amazon Web Services*</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,619 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS on Microsoft* Azure* &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/cloud-install/azure.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Clear Linux* OS on DigitalOcean*" href="digitalocean.html" />
    <link rel="prev" title="Clear Linux* OS on Amazon Web Services*" href="aws-web.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="digitalocean.html" title="Clear Linux* OS on DigitalOcean*"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="aws-web.html" title="Clear Linux* OS on Amazon Web Services*"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Microsoft* Azure*</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-on-microsoft-azure">
 <span id="azure"></span><h1>Clear Linux* OS on Microsoft* Azure*<a class="headerlink" href="#cl-attr-on-microsoft-azure" title="Link to this heading">¶</a></h1>
 <p>This tutorial shows how to install and use the Azure <abbr title="Command Line Interface">CLI</abbr> on Clear Linux OS. The Azure CLI offers the ability to create and
 manage resources in MS Azure from the command line.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#description" id="id4">Description</a></p></li>
 <li><p><a class="reference internal" href="#prerequisites" id="id5">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#install-ms-azure-cli-2-0-on-cl" id="id6">Install MS Azure CLI 2.0 on Clear Linux OS</a></p></li>
 <li><p><a class="reference internal" href="#log-into-your-microsoft-azure-account" id="id7">Log into your Microsoft Azure account</a></p></li>
 <li><p><a class="reference internal" href="#create-a-ms-azure-resource-group" id="id8">Create a MS Azure resource group</a></p></li>
 <li><p><a class="reference internal" href="#create-and-log-into-the-cl-virtual-machine" id="id9">Create and log into the Clear Linux OS virtual machine</a></p></li>
 <li><p><a class="reference internal" href="#stop-and-deallocate-the-cl-vm-and-resources" id="id10">Stop and deallocate the Clear Linux OS VM and resources</a></p></li>
 <li><p><a class="reference internal" href="#next-steps" id="id11">Next steps</a></p></li>
 <li><p><a class="reference internal" href="#related-topics" id="id12">Related topics</a></p></li>
 </ul>
 </nav>
 <section id="description">
 <h2><a class="toc-backref" href="#id4" role="doc-backlink">Description</a><a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
 <p>Clear Linux OS is available for you to use in the Microsoft Azure marketplace and
 is offered with three different images, also known as a
 <abbr title="Stock Keeping Unit">SKU</abbr>.</p>
 <ul class="simple">
 <li><p>Clear Linux OS 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.</p></li>
 <li><p>Clear Linux OS Containers - This SKU comes with the containers-basic software bundle
 already installed.</p></li>
 <li><p>Clear Linux OS Machine-learning - This SKU comes pre-loaded with popular open source
 tools for developing machine learning applications.</p></li>
 </ul>
 <p>Sign in at the <a class="reference external" href="https://portal.azure.com">Azure portal</a> to access these images from the Azure dashboard,
 or use the MS Azure CLI 2.0. If you do not already have an account set up with
 MS Azure, you can sign up for a <a class="reference external" href="https://azure.microsoft.com/en-us/free/">MS Azure free account</a> to access the
 Clear Linux OS <abbr title="Virtual Machine">VM</abbr> images.</p>
 </section>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id5" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <p>To use the MS Azure CLI 2.0 on your Clear Linux OS system, your system must have the
 following packages installed:</p>
 <ul class="simple">
 <li><p>Python 2.7 or later</p></li>
 <li><p>libffi</p></li>
 <li><p>OpenSSL 1.0.2</p></li>
 </ul>
 <p>You can check to see which versions you have installed on your system by
 running the individual commands as follows:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>--version
 </pre></div>
 </div>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">python 2.7.12</span>
 </pre></div>
 </div>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>openssl<span class="w"> </span>version
 </pre></div>
 </div>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">OpenSSL 1.0.2n 7 Dec 2017</span>
 </pre></div>
 </div>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ls<span class="w"> </span>-l<span class="w"> </span>/usr/lib64/libffi*
 </pre></div>
 </div>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">lrwxrwxrwx 1 root root    15 Jan 12  2017 /usr/lib64/libffi.so.6 -&gt; libffi.so.6.0.4</span>
 <span class="go">-rwxr-xr-x 1 root root 38792 Jan 12  2017 /usr/lib64/libffi.so.6.0.4</span>
 </pre></div>
 </div>
 <p>If you do not have these packages installed on your Clear Linux OS system, install the
 sysadmin-basic software bundle using the <strong class="command">swupd</strong> command:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>swupd<span class="w"> </span>bundle-add<span class="w"> </span>sysadmin-basic
 </pre></div>
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>These instructions are for installing the MS Azure CLI 2.0 tools on a Clear Linux OS
 system. If you are installing the CLI on another platform, follow the
 instructions in the <a class="reference external" href="https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest">MS Azure Install Azure CLI tutorial</a> for your
 specific operating system.</p>
 </div>
 </section>
 <section id="install-ms-azure-cli-2-0-on-cl">
 <h2><a class="toc-backref" href="#id6" role="doc-backlink">Install MS Azure CLI 2.0 on Clear Linux OS</a><a class="headerlink" href="#install-ms-azure-cli-2-0-on-cl" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>To install the MS Azure CLI 2.0 on Clear Linux OS, use the <strong class="command">curl</strong> command as
 follows:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-L<span class="w"> </span>https://aka.ms/InstallAzureCli<span class="w"> </span><span class="p">|</span><span class="w"> </span>bash
 </pre></div>
 </div>
 <p>If you get an error message from <strong class="command">curl</strong> 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:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>https://azurecliprod.blob.core.windows.net/install<span class="w"> </span><span class="p">|</span><span class="w"> </span>bash
 </pre></div>
 </div>
 </li>
 <li><p>The installation script begins and prompts you several times during
 execution for information.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The console output from the script displays your username instead of the
 <strong>[user]</strong> variable shown on this tutorial.</p>
 </div>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">===&gt; In what directory would you like to place the install? (leave blank to use &#39;/home/[user]/lib/azure-cli&#39;):</span>
 </pre></div>
 </div>
 <p>Press the <kbd class="kbd docutils literal notranslate">Enter</kbd> key to accept the default or chose another
 directory in which to install the MS Azure CLI 2.0 tools.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">===&gt; In what directory would you like to place the &#39;az&#39; executable? (leave blank to use &#39;/home/[user]/bin&#39;):</span>
 </pre></div>
 </div>
 <p>Press the <kbd class="kbd docutils literal notranslate">Enter</kbd> key to accept the default or chose another
 directory in which to install the <strong class="command">az</strong> executable.</p>
 </li>
 <li><p>The installation downloads and builds all the required tools. When it is
 complete, it prompts you:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">===&gt; Modify profile to update your $PATH and enable shell/tab completion now? (Y/n): Y</span>
 </pre></div>
 </div>
 <p>Type <kbd class="kbd docutils literal notranslate">Y</kbd> and press the <kbd class="kbd docutils literal notranslate">Enter</kbd> key to allow this modification.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">===&gt; Enter a path to an rc file to update (leave blank to use &#39;/home/[user]/.bashrc&#39;):</span>
 </pre></div>
 </div>
 <p>Press the <kbd class="kbd docutils literal notranslate">Enter</kbd> key to accept the default or enter the pathname to
 your <code class="file docutils literal notranslate"><span class="pre">.bashrc</span></code> file. The installation completes with the final output
 shown below:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">-- Backed up &#39;/home/[user].bashrc&#39; to &#39;/home/[user]/.bashrc.backup&#39;</span>
 <span class="go">-- Tab completion set up complete.</span>
 <span class="go">-- If tab completion is not activated, verify that &#39;/home/[user]/.bashrc&#39; is sourced by your shell.</span>
 <span class="go">--</span>
 <span class="go">-- ** Run `exec -l $SHELL` to restart your shell. **</span>
 <span class="go">--</span>
 <span class="go">-- Installation successful.</span>
 <span class="go">-- Run the CLI with /home/[user]/bin/az --help</span>
 </pre></div>
 </div>
 </li>
 <li><p>When the installation program finishes, you must restart your shell for
 the changes to take effect. When the installation is successful, run the
 following command to restart your shell.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">exec</span><span class="w"> </span>-l<span class="w"> </span><span class="nv">$SHELL</span>
 </pre></div>
 </div>
 </li>
 </ol>
 <p>With the MS Azure CLI 2.0 executable successfully built and installed, run
 the <strong class="command">az</strong> command.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>az
 </pre></div>
 </div>
 <p>The output from the <strong class="command">az</strong> command is shown below:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">     /\</span>
 <span class="go">    /  \    _____   _ _ __ ___</span>
 <span class="go">   / /\ \  |_  / | | | \&#39;__/ _ \</span>
 <span class="go">  / ____ \  / /| |_| | | |  __/</span>
 <span class="go"> /_/    \_\/___|\__,_|_|  \___|</span>
 <span class="go">Welcome to the cool new Azure CLI!</span>
 <span class="go">Here are the base commands:</span>
 <span class="go">    account          : Manage Azure subscription information.</span>
 <span class="go">    acr              : Manage Azure Container Registries.</span>
 <span class="go">    acs              : Manage Azure Container Services.</span>
 <span class="go">    ad               : Synchronize on-premises directories and manage Azure Active Directory</span>
 <span class="go">                       resources.</span>
 <span class="go">    advisor          : (PREVIEW) Manage Azure Advisor.</span>
 <span class="go">    aks              : Manage Kubernetes clusters.</span>
 <span class="go">    appservice       : Manage App Service plans.</span>
 <span class="go">    backup           : Commands to manage Azure Backups.</span>
 <span class="go">    batch            : Manage Azure Batch.</span>
 <span class="go">    batchai          : Batch AI.</span>
 <span class="go">    billing          : Manage Azure Billing.</span>
 <span class="go">    cdn              : Manage Azure Content Delivery Networks (CDNs).</span>
 <span class="go">    cloud            : Manage registered Azure clouds.</span>
 <span class="go">    cognitiveservices: Manage Azure Cognitive Services accounts.</span>
 <span class="go">    configure        : Display and manage the Azure CLI 2.0 configuration. This command is</span>
 <span class="go">                       interactive.</span>
 <span class="go">    consumption      : Manage consumption of Azure resources.</span>
 <span class="go">    container        : (PREVIEW) Manage Azure Container Instances.</span>
 <span class="go">    cosmosdb         : Manage Azure Cosmos DB database accounts.</span>
 <span class="go">    disk             : Manage Azure Managed Disks.</span>
 <span class="go">    dla              : (PREVIEW) Manage Data Lake Analytics accounts, jobs, and catalogs.</span>
 <span class="go">    dls              : (PREVIEW) Manage Data Lake Store accounts and filesystems.</span>
 <span class="go">    eventgrid        : Manage Azure Event Grid topics and subscriptions.</span>
 <span class="go">    extension        : Manage and update CLI extensions.</span>
 <span class="go">    feature          : Manage resource provider features.</span>
 <span class="go">    feedback         : Loving or hating the CLI?  Let us know!</span>
 <span class="go">    find             : Find Azure CLI commands.</span>
 <span class="go">    functionapp      : Manage function apps.</span>
 <span class="go">    group            : Manage resource groups and template deployments.</span>
 <span class="go">    image            : Manage custom virtual machine images.</span>
 <span class="go">    interactive      : Start interactive mode.</span>
 <span class="go">    iot              : (PREVIEW) Manage Internet of Things (IoT) assets.</span>
 <span class="go">    keyvault         : Safeguard and maintain control of keys, secrets, and certificates.</span>
 <span class="go">    lab              : Manage Azure DevTest Labs.</span>
 <span class="go">    lock             : Manage Azure locks.</span>
 <span class="go">    login            : Log in to Azure.</span>
 <span class="go">    logout           : Log out to remove access to Azure subscriptions.</span>
 <span class="go">    managedapp       : Manage template solutions provided and maintained by Independent Software</span>
 <span class="go">                       Vendors (ISVs).</span>
 <span class="go">    monitor          : Manage the Azure Monitor Service.</span>
 <span class="go">    mysql            : Manage Azure Database for MySQL servers.</span>
 <span class="go">    network          : Manage Azure Network resources.</span>
 <span class="go">    policy           : Manage resource policies.</span>
 <span class="go">    postgres         : Manage Azure Database for PostgreSQL servers.</span>
 <span class="go">    provider         : Manage resource providers.</span>
 <span class="go">    redis            : Access to a secure, dedicated Redis cache for your Azure applications.</span>
 <span class="go">    reservations     : Manage Azure Reservations.</span>
 <span class="go">    resource         : Manage Azure resources.</span>
 <span class="go">    role             : Manage user roles for access control with Azure Active Directory and service</span>
 <span class="go">                       principals.</span>
 <span class="go">    sf               : Manage and administer Azure Service Fabric clusters.</span>
 <span class="go">    snapshot         : Manage point-in-time copies of managed disks, native blobs, or other</span>
 <span class="go">                       snapshots.</span>
 <span class="go">    sql              : Manage Azure SQL Databases and Data Warehouses.</span>
 <span class="go">    storage          : Manage Azure Cloud Storage resources.</span>
 <span class="go">    tag              : Manage resource tags.</span>
 <span class="go">    vm               : Provision Linux or Windows virtual machines.</span>
 <span class="go">    vmss             : Manage groupings of virtual machines in an Azure Virtual Machine Scale Set</span>
 <span class="go">                       (VMSS).</span>
 <span class="go">    webapp           : Manage web apps.</span>
 </pre></div>
 </div>
 </section>
 <section id="log-into-your-microsoft-azure-account">
 <h2><a class="toc-backref" href="#id7" role="doc-backlink">Log into your Microsoft Azure account</a><a class="headerlink" href="#log-into-your-microsoft-azure-account" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>With the <strong class="command">az</strong> command properly installed and functional, login to
 your MS Azure account using the <strong class="command">az login</strong> command shown below:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>az<span class="w"> </span>login
 </pre></div>
 </div>
 <p>The output from this command is:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">To sign in, use a web browser to open the page https://aka.ms/devicelogin and enter the code BQ9MG442B to authenticate.</span>
 </pre></div>
 </div>
 </li>
 <li><p>Open your browser and enter the page <cite>https://aka.ms/devicelogin</cite> as shown
 in figure 1:</p>
 <figure class="align-default" id="id1">
 <a class="reference internal image-reference" href="../../_images/azure-1.png"><img alt="Microsoft Device Login" src="../../_images/azure-1.png" style="width: 627.0px; height: 464.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: <span class="guilabel">Microsoft Device Login</span></span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Enter the code <cite>BQ9MG442B</cite> to authenticate your device as shown in figure
 2. The code <cite>BQ9MG442B</cite> is a random authentication code generated for each
 session login and will be different each time you log into MS Azure using
 the <strong class="command">az login</strong> command.</p>
 <figure class="align-default" id="id2">
 <a class="reference internal image-reference" href="../../_images/azure-2.png"><img alt="Microsoft Device Login - Azure CLI" src="../../_images/azure-2.png" style="width: 627.0px; height: 464.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 2: <span class="guilabel">Microsoft Device Login - Azure CLI</span></span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Once you enter the authentication code, the website displays a screen to
 enter your existing Microsoft Azure credentials.</p></li>
 <li><p>Log in with your existing MS Azure account credentials. The
 browser screen shows you have signed into the Microsoft Cross-platform
 Command Line Interface application on your device, as shown in figure 3.
 You can close the page.</p>
 <figure class="align-default" id="id3">
 <a class="reference internal image-reference" href="../../_images/azure-3.png"><img alt="Microsoft Azure Cross-platform CLI" src="../../_images/azure-3.png" style="width: 627.0px; height: 464.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 3: <span class="guilabel">Microsoft Azure Cross-platform CLI</span></span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 <p>The MS Azure CLI 2.0 interface is now active using your existing MS Azure
 account credentials.</p>
 </section>
 <section id="create-a-ms-azure-resource-group">
 <h2><a class="toc-backref" href="#id8" role="doc-backlink">Create a MS Azure resource group</a><a class="headerlink" href="#create-a-ms-azure-resource-group" title="Link to this heading">¶</a></h2>
 <p>To learn more about MS Azure resource groups, visit the
 <a class="reference external" href="https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview">Azure Resource Manager overview</a> for an overview and detailed description
 of resources within MS Azure.</p>
 <ol class="arabic">
 <li><p>To create a new resource group, run the <strong class="command">az group create ...</strong>
 command shown below to create a resource group named <cite>ClearResourceGroup</cite>
 using the <cite>-n</cite> parameter and locate it in the <cite>westus</cite> region using the
 <cite>-l</cite> parameter.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>az<span class="w"> </span>group<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span>ClearResourceGroup<span class="w"> </span>-l<span class="w"> </span>westus
 </pre></div>
 </div>
 </li>
 <li><p>When the command has completed, the output from this command is similar to
 the following:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">{</span>
 <span class="go">  &quot;id&quot;: &quot;/subscriptions/{unique-id}/resourceGroups/ClearResourceGroup&quot;,</span>
 <span class="go">  &quot;location&quot;: &quot;westus&quot;,</span>
 <span class="go">  &quot;managedBy&quot;: null,</span>
 <span class="go">  &quot;name&quot;: &quot;ClearResourceGroup&quot;,</span>
 <span class="go">  &quot;properties&quot;: {</span>
 <span class="go">    &quot;provisioningState&quot;: &quot;Succeeded&quot;</span>
 <span class="go">  },</span>
 <span class="go">  &quot;tags&quot;: null</span>
 <span class="go">}</span>
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="create-and-log-into-the-cl-virtual-machine">
 <h2><a class="toc-backref" href="#id9" role="doc-backlink">Create and log into the Clear Linux OS virtual machine</a><a class="headerlink" href="#create-and-log-into-the-cl-virtual-machine" title="Link to this heading">¶</a></h2>
 <p>For this tutorial, we are using the Clear Linux OS Basic SKU for our VM.</p>
 <ol class="arabic">
 <li><p>To locate the available Clear Linux OS Basic VM SKU images in the MS Azure
 marketplace, run the <strong class="command">az vm image ...</strong> command:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>az<span class="w"> </span>vm<span class="w"> </span>image<span class="w"> </span>list<span class="w"> </span>--offer<span class="w"> </span>clear-linux<span class="w"> </span>--sku<span class="w"> </span>basic<span class="w"> </span>--all<span class="w"> </span>--output<span class="w"> </span>table
 </pre></div>
 </div>
 <p>This command may take some time to finish. The output lists all available
 Clear Linux OS Basic images available in the Microsoft Azure marketplace as shown
 below:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">Offer           Publisher            Sku               Urn                                                            Version</span>
 <span class="go">--------------  -------------------  ----------------  -------------------------------------------------------------  ---------</span>
 <span class="go">clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:15780.0.0             15780.0.0</span>
 <span class="go">clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:15960.0.0             15960.0.0</span>
 <span class="go">clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:16050.0.0             16050.0.0</span>
 <span class="go">clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:16150.0.0             16150.0.0</span>
 <span class="go">clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:16500.0.0             16500.0.0</span>
 <span class="go">clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:16810.0.0             16810.0.0</span>
 <span class="go">clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:18080.0.0             18080.0.0</span>
 <span class="go">clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:18620.0.0             18620.0.0</span>
 <span class="go">clear-linux-os  clear-linux-project  basic             clear-linux-project:clear-linux-os:basic:18860.0.0             18860.0.0</span>
 </pre></div>
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>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 <cite>latest</cite> when specifying an image.</p>
 </div>
 </li>
 <li><p>The information shown in the <cite>Urn</cite> column lists the
 <cite>Publisher:Offer:Sku:Version</cite> for each image available. This is the
 information we want to create the Clear Linux OS Basic VM. Since we are creating a
 Clear Linux OS Basic VM, highlight the <cite>clear-linux-project:clear-linux-os:basic:</cite>
 string and copy it to your clipboard. Use the label
 <cite>latest</cite> instead of referencing a specific version.</p></li>
 <li><p>Create the new Clear Linux OS Basic VM. Run the <strong class="command">az vm create ...</strong>
 command using the URN <cite>:clear-linux-project:clear-linux-os:basic:latest</cite>
 that we copied to the clipboard on the previous step.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>az<span class="w"> </span>vm<span class="w"> </span>create<span class="w"> </span>--resource-group<span class="w"> </span>ClearResourceGroup<span class="w"> </span>--name<span class="w"> </span>ClearVM<span class="w"> </span>--image<span class="w"> </span>clear-linux-project:clear-linux-os:basic:latest<span class="w"> </span>--generate-ssh-keys
 </pre></div>
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>If you have already defined your public/private SSH key pair and they
 are stored in your <code class="file docutils literal notranslate"><span class="pre">$HOME/.ssh</span></code> directory, you do not need to
 include the <em>–generate-ssh-keys</em> option.</p>
 </div>
 <p>The output from this command will look similar to this output, where
 [user] is your user name:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">SSH key files &#39;/home/[user]/.ssh/id_rsa&#39; and &#39;/home/[user]/.ssh/id_rsa.pub&#39; 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.</span>
 <span class="go">running...</span>
 <span class="go">{</span>
 <span class="go">  &quot;fqdns&quot;: &quot;&quot;,</span>
 <span class="go">  &quot;id&quot;: &quot;/subscriptions/{unique-id}/resourceGroups/ClearResourceGroup/providers/Microsoft.Compute/virtualMachines/ClearVM&quot;,</span>
 <span class="go">  &quot;location&quot;: &quot;westus&quot;,</span>
 <span class="go">  &quot;macAddress&quot;: &quot;00-0D-3A-37-C7-59&quot;,</span>
 <span class="go">  &quot;powerState&quot;: &quot;VM running&quot;,</span>
 <span class="go">  &quot;privateIpAddress&quot;: &quot;10.0.0.4&quot;,</span>
 <span class="go">  &quot;publicIpAddress&quot;: &quot;13.91.4.245&quot;,</span>
 <span class="go">  &quot;resourceGroup&quot;: &quot;ClearResourceGroup&quot;,</span>
 <span class="go">  &quot;zones&quot;: &quot;&quot;</span>
 <span class="go">}</span>
 </pre></div>
 </div>
 <p>Take note of the public IP address from the output.</p>
 </li>
 <li><p>Login into the new Clear Linux OS Basic VM, run the <strong class="command">ssh</strong> command with the
 public IP address obtained from the previous step as shown:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ssh<span class="w"> </span><span class="o">[</span>user<span class="o">]</span>@13.91.4.245
 </pre></div>
 </div>
 <p>You may see the following message about the authenticity of the host. If
 this appears, type <cite>yes</cite> to proceed connecting to your new Clear Linux OS VM.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">The authenticity of host &#39;13.91.4.245 (13.91.4.245)&#39; can&#39;t be established.</span>
 <span class="go">RSA key fingerprint is SHA256:{unique-number}.</span>
 <span class="go">Are you sure you want to continue connecting (yes/no)? yes</span>
 <span class="go">Warning: Permanently added &#39;13.91.4.245&#39; (RSA) to the list of known hosts.</span>
 <span class="go">[user]@ClearVM ~ $</span>
 </pre></div>
 </div>
 <p>You are now logged into your new Clear Linux OS VM as [user], where [user] is your
 user name. To check which software bundles are included with
 this VM image, run the <strong class="command">sudo swupd bundle-list</strong> command inside the
 VM:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>swupd<span class="w"> </span>bundle-list
 </pre></div>
 </div>
 <p>The output shown should be similar to:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">swupd-client bundle list 3.14.1</span>
 <span class="go">   Copyright (C) 2012-2017 Intel Corporation</span>
 <span class="go">bootloader</span>
 <span class="go">editors</span>
 <span class="go">kernel-hyperv</span>
 <span class="go">network-basic</span>
 <span class="go">openssh-server</span>
 <span class="go">os-cloudguest-azure</span>
 <span class="go">os-core</span>
 <span class="go">os-core-update</span>
 <span class="go">perl-basic</span>
 <span class="go">python-basic</span>
 <span class="go">python3-basic</span>
 <span class="go">storage-utils</span>
 <span class="go">sysadmin-basic</span>
 <span class="go">Current OS version: 19600</span>
 </pre></div>
 </div>
 <p>When you are finished using your new Clear Linux OS VM, type <strong class="command">exit</strong> to close
 the <strong class="command">SSH</strong> terminal and logout.</p>
 </li>
 </ol>
 </section>
 <section id="stop-and-deallocate-the-cl-vm-and-resources">
 <h2><a class="toc-backref" href="#id10" role="doc-backlink">Stop and deallocate the Clear Linux OS VM and resources</a><a class="headerlink" href="#stop-and-deallocate-the-cl-vm-and-resources" title="Link to this heading">¶</a></h2>
 <p>When you finish using your new Clear Linux OS 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 <strong class="command">az vm start...</strong> 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.</p>
 <ol class="arabic">
 <li><p>At the command prompt, enter the <strong class="command">az vm stop...</strong> command as
 follows:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>az<span class="w"> </span>vm<span class="w"> </span>stop<span class="w"> </span>--resource-group<span class="w"> </span>ClearResourceGroup<span class="w"> </span>--name<span class="w"> </span>ClearVM
 </pre></div>
 </div>
 <p>This will stop the VM and then output text similar to:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">{</span>
 <span class="go">  &quot;endTime&quot;: &quot;2017-12-13T23:04:02.346676+00:00&quot;,</span>
 <span class="go">  &quot;error&quot;: null,</span>
 <span class="go">  &quot;name&quot;: &quot;{unique-name}&quot;,</span>
 <span class="go">  &quot;startTime&quot;: &quot;2017-12-13T23:03:59.018536+00:00&quot;,</span>
 <span class="go">  &quot;status&quot;: &quot;Succeeded&quot;</span>
 <span class="go">}</span>
 </pre></div>
 </div>
 </li>
 <li><p>Once the VM stops, deallocate the VM resources to stop incurring
 charges for the Clear Linux OS instance. Enter the following command:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">az vm deallocate --resource-group ClearResourceGroup --name ClearVM</span>
 </pre></div>
 </div>
 </li>
 </ol>
 <p><strong>Congratulations!</strong> You are up and running with Clear Linux OS on MS Azure using the
 Azure CLI 2.0 command line tools.</p>
 </section>
 <section id="next-steps">
 <h2><a class="toc-backref" href="#id11" role="doc-backlink">Next steps</a><a class="headerlink" href="#next-steps" title="Link to this heading">¶</a></h2>
 <p>To see use cases you can fulfill with your Clear Linux OS instance, visit our
 <a class="reference internal" href="../../tutorials/index.html#tutorials"><span class="std std-ref">tutorials</span></a> section.</p>
 <p>For additional information visit the Clear Linux OS
 <a class="reference external" href="http://download.microsoft.com/download/D/9/E/D9E22342-96D9-4455-BB15-99A1AF514DDD/Microsoft%20Azure%20Partner%20Mini%20Case%20Study%20-%20Intel%20Clear%20Linux.pdf">Azure Partner Mini Case Study</a> and the <a class="reference external" href="http://download.microsoft.com/download/D/9/E/D9E22342-96D9-4455-BB15-99A1AF514DDD/Microsoft%20Azure%20Partner%20Datasheet%20-%20Intel%20Clear%20Linux.pdf">Azure Partner Datasheet</a>.</p>
 <p>To learn more about the MS Azure CLI 2.0 tool and options that are available,
 visit the <a class="reference external" href="https://docs.microsoft.com/en-us/cli/azure/overview?view=azure-cli-latest">MS Azure documentation and tutorials</a> website.</p>
 </section>
 <section id="related-topics">
 <h2><a class="toc-backref" href="#id12" role="doc-backlink">Related topics</a><a class="headerlink" href="#related-topics" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p><a class="reference internal" href="gce.html#gce"><span class="std std-ref">Clear Linux* OS on Google Cloud Platform*</span></a></p></li>
 <li><p><a class="reference internal" href="aws-web.html#aws-web"><span class="std std-ref">Clear Linux* OS on Amazon Web Services*</span></a></p></li>
 <li><p><a class="reference internal" href="digitalocean.html#clr-digitalocean"><span class="std std-ref">Clear Linux* OS on DigitalOcean*</span></a></p></li>
 </ul>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS on Microsoft* Azure*</a><ul>
 <li><a class="reference internal" href="#description">Description</a></li>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#install-ms-azure-cli-2-0-on-cl">Install MS Azure CLI 2.0 on Clear Linux OS</a></li>
 <li><a class="reference internal" href="#log-into-your-microsoft-azure-account">Log into your Microsoft Azure account</a></li>
 <li><a class="reference internal" href="#create-a-ms-azure-resource-group">Create a MS Azure resource group</a></li>
 <li><a class="reference internal" href="#create-and-log-into-the-cl-virtual-machine">Create and log into the Clear Linux OS virtual machine</a></li>
 <li><a class="reference internal" href="#stop-and-deallocate-the-cl-vm-and-resources">Stop and deallocate the Clear Linux OS VM and resources</a></li>
 <li><a class="reference internal" href="#next-steps">Next steps</a></li>
 <li><a class="reference internal" href="#related-topics">Related topics</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="aws-web.html"
                          title="previous chapter">Clear Linux* OS on Amazon Web Services*</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="digitalocean.html"
                          title="next chapter">Clear Linux* OS on DigitalOcean*</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/cloud-install/azure.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="digitalocean.html" title="Clear Linux* OS on DigitalOcean*"
             >next</a> |</li>
        <li class="right" >
          <a href="aws-web.html" title="Clear Linux* OS on Amazon Web Services*"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Microsoft* Azure*</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,489 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS on DigitalOcean* &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/cloud-install/digitalocean.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Clear Linux* OS on Google Cloud Platform*" href="gce.html" />
    <link rel="prev" title="Clear Linux* OS on Microsoft* Azure*" href="azure.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="gce.html" title="Clear Linux* OS on Google Cloud Platform*"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="azure.html" title="Clear Linux* OS on Microsoft* Azure*"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on DigitalOcean*</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-on-digitalocean">
 <span id="clr-digitalocean"></span><h1>Clear Linux* OS on DigitalOcean*<a class="headerlink" href="#cl-attr-on-digitalocean" title="Link to this heading">¶</a></h1>
 <p>This guide explains how to import a Clear Linux* OS image to <a class="reference external" href="https://www.digitalocean.com/">DigitalOcean</a>
 and then deploy a VM instance.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#prerequisites" id="id12">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#add-cl-image-to-digitalocean" id="id13">Add Clear Linux OS Image to DigitalOcean</a></p></li>
 <li><p><a class="reference internal" href="#create-and-deploy-a-cl-instance" id="id14">Create and Deploy a Clear Linux OS Instance</a></p></li>
 <li><p><a class="reference internal" href="#connect-to-your-cl-instance" id="id15">Connect to Your Clear Linux OS Instance</a></p></li>
 <li><p><a class="reference internal" href="#related-topics" id="id16">Related topics</a></p></li>
 </ul>
 </nav>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id12" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Set up a DigitalOcean account.</p></li>
 <li><p>Create an SSH key on your client system that you will use to remote
 into the VM. You can follow the <a class="reference external" href="https://www.digitalocean.com/docs/droplets/how-to/add-ssh-keys/create-with-openssh/">DigitalOcean’s SSH key creation guide</a>.</p></li>
 </ul>
 </section>
 <section id="add-cl-image-to-digitalocean">
 <h2><a class="toc-backref" href="#id13" role="doc-backlink">Add Clear Linux OS Image to DigitalOcean</a><a class="headerlink" href="#add-cl-image-to-digitalocean" title="Link to this heading">¶</a></h2>
 <p>Before you can deploy a Clear Linux OS instance on DigitalOcean, you need to add
 an image since it’s currently not available in its marketplace.
 You can use our pre-built image or you can build your own custom image.</p>
 <section id="use-pre-built-image">
 <h3>Use pre-built image<a class="headerlink" href="#use-pre-built-image" title="Link to this heading">¶</a></h3>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Our cloud images (<cite>clear-&lt;release version&gt;-digitalocean.img.gz</cite>) for
 DigitalOcean are considered <strong>Beta</strong> until we finish setting up our
 automated testing of the images against the DigitalOcean environment.
 Apart from the initial version, <a class="reference external" href="https://cdn.download.clearlinux.org/releases/31870/clear/clear-31870-digitalocean.img.gz">clear-31870-digitalocean.img.gz</a>, we
 cannot guarantee that future versions and updates to the initial
 version is problems-free.</p>
 </div>
 <ol class="arabic simple">
 <li><p>Copy the URL for <a class="reference external" href="https://cdn.download.clearlinux.org/releases/31870/clear/clear-31870-digitalocean.img.gz">clear-31870-digitalocean.img.gz</a>.</p></li>
 <li><p>Skip to the <a class="reference internal" href="#upload-image">Upload image</a> section.</p></li>
 </ol>
 </section>
 <section id="build-custom-image">
 <h3>Build custom image<a class="headerlink" href="#build-custom-image" title="Link to this heading">¶</a></h3>
 <p>For this method, you need a Clear Linux OS system to generate an image using
 the <em>clr-installer</em> tool.</p>
 <ol class="arabic">
 <li><p>Add the <em>clr-installer</em> and <em>gzip</em> bundles.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>swupd<span class="w"> </span>bundle-add<span class="w"> </span>clr-installer<span class="w"> </span>gzip
 </pre></div>
 </div>
 </li>
 <li><p>Create an image configuration YAML file.
 See <a class="reference external" href="https://github.com/clearlinux/clr-installer/blob/master/scripts/InstallerYAMLSyntax.md">Installer YAML Syntax</a> for more information on the clr-installer
 configuration YAML syntax.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cat<span class="w"> </span>&gt;<span class="w"> </span>clear-digitalocean.yaml<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">#clear-linux-config</span>
 <span class="s"># switch between aliases if you want to install to an actual block device</span>
 <span class="s"># i.e /dev/sda</span>
 <span class="s">block-devices: [</span>
 <span class="s">   {name: &quot;bdevice&quot;, file: &quot;clear-digitalocean.img&quot;}</span>
 <span class="s">]</span>
 <span class="s">targetMedia:</span>
 <span class="s">- name: \${bdevice}</span>
 <span class="s">  size: &quot;800M&quot;</span>
 <span class="s">  type: disk</span>
 <span class="s">  children:</span>
 <span class="s">  - name: \${bdevice}1</span>
 <span class="s">    fstype: ext4</span>
 <span class="s">    options: -O ^64bit</span>
 <span class="s">    mountpoint: /</span>
 <span class="s">    size: &quot;800M&quot;</span>
 <span class="s">    type: part</span>
 <span class="s">bundles: [</span>
 <span class="s">    bootloader,</span>
 <span class="s">    openssh-server,</span>
 <span class="s">    os-cloudguest,</span>
 <span class="s">    os-core,</span>
 <span class="s">    os-core-update,</span>
 <span class="s">    systemd-networkd-autostart</span>
 <span class="s">  ]</span>
 <span class="s">autoUpdate: false</span>
 <span class="s">postArchive: false</span>
 <span class="s">postReboot: false</span>
 <span class="s">telemetry: false</span>
 <span class="s">legacyBios: true</span>
 <span class="s">keyboard: us</span>
 <span class="s">language: en_US.UTF-8</span>
 <span class="s">kernel: kernel-kvm</span>
 <span class="s">version: 0</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 <p>The settings that are required in order to make the image
 work on DigitalOcean are:</p>
 <ul class="simple">
 <li><p><em>os-cloudguest</em> bundle: Allows DigitalOcean to provision the
 image with settings such as hostname, resource (CPU, memory,
 storage) sizing, and user creation.</p></li>
 <li><p><em>legacyBios: true</em>: The image need to support legacy BIOS to boot
 on DigitalOcean.</p></li>
 </ul>
 </li>
 <li><p>Generate the image.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>clr-installer<span class="w"> </span>-c<span class="w"> </span>clear-digitalocean.yaml
 </pre></div>
 </div>
 <p>The output should be <code class="file docutils literal notranslate"><span class="pre">clear-digitalocean.img</span></code>.</p>
 </li>
 <li><p>Compress the image with <em>gzip</em> to save bandwidth and upload time.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>gzip<span class="w"> </span>clear-digitalocean.img
 </pre></div>
 </div>
 <p>The output should be <code class="file docutils literal notranslate"><span class="pre">clear-digitalocean.img.gz</span></code>.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p><em>bzip2</em> is the other compression format DigitalOcean accepts.</p>
 </div>
 </li>
 </ol>
 </section>
 <section id="upload-image">
 <h3>Upload image<a class="headerlink" href="#upload-image" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>On DigitalOcean’s website, go to <span class="menuselection">MANAGE ‣ Images
 ‣ Custom Images</span>.</p>
 <p>See Figure 1.</p>
 <figure class="align-default" id="id1">
 <a class="reference internal image-reference" href="../../_images/01-digitalocean.png"><img alt="DigitalOcean - Upload custom images" src="../../_images/01-digitalocean.png" style="width: 1349.0px; height: 725.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: DigitalOcean - Upload custom images</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select an upload method.</p>
 <ul>
 <li><p>To import a pre-built image from Clear Linux OS <a class="reference external" href="https://clearlinux.org/downloads">downloads</a>, click
 <span class="guilabel">Import via URL</span>, paste the URL, and click <span class="guilabel">Next</span>.</p>
 <p>See Figure 2.</p>
 <figure class="align-default" id="id2">
 <a class="reference internal image-reference" href="../../_images/02-digitalocean.png"><img alt="DigitalOcean - Import via URL" src="../../_images/02-digitalocean.png" style="width: 1350.0px; height: 452.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 2: DigitalOcean - Import via URL</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>To import your custom image, click <span class="guilabel">Upload Image</span>
 and select the image from your client system.</p></li>
 </ul>
 </li>
 <li><p>Set the <span class="guilabel">DISTRIBUTION</span> type as <span class="guilabel">Unknown</span>.</p>
 <p>See Figure 3.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </li>
 <li><p>Choose your preferred datacenter region.</p></li>
 <li><p>Click <span class="guilabel">Upload Image</span>.
 Wait for the upload to finish before proceeding to the next section.</p>
 <figure class="align-default" id="id3">
 <a class="reference internal image-reference" href="../../_images/03-digitalocean.png"><img alt="DigitalOcean - Set image distribution type, region, tag" src="../../_images/03-digitalocean.png" style="width: 1350.0px; height: 1381.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 3: DigitalOcean - Set image distribution type, region, tag</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 </section>
 <section id="create-and-deploy-a-cl-instance">
 <h2><a class="toc-backref" href="#id14" role="doc-backlink">Create and Deploy a Clear Linux OS Instance</a><a class="headerlink" href="#create-and-deploy-a-cl-instance" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>On DigitalOcean’s website, go to <span class="menuselection">MANAGE ‣ Droplets</span>
 and then click <span class="guilabel">Create Droplet</span>.</p>
 <p>See Figure 4.</p>
 <figure class="align-default" id="id4">
 <a class="reference internal image-reference" href="../../_images/04-digitalocean.png"><img alt="DigitalOcean - Create Droplet" src="../../_images/04-digitalocean.png" style="width: 1350.0px; height: 697.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 4: DigitalOcean - Create Droplet</span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Under <span class="guilabel">Choose an image</span>, select <span class="guilabel">Custom images</span>.</p>
 <p>See Figure 5.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </li>
 <li><p>Select your uploaded Clear Linux OS image.</p>
 <figure class="align-default" id="id5">
 <a class="reference internal image-reference" href="../../_images/05-digitalocean.png"><img alt="DigitalOcean - Choose custom image" src="../../_images/05-digitalocean.png" style="width: 1349.0px; height: 481.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 5: DigitalOcean - Choose custom image</span><a class="headerlink" href="#id5" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Under <span class="guilabel">Choose a plan</span>, select your preferred plan.</p>
 <p>See Figure 6.</p>
 <figure class="align-default" id="id6">
 <a class="reference internal image-reference" href="../../_images/06-digitalocean.png"><img alt="DigitalOcean - Choose plan" src="../../_images/06-digitalocean.png" style="width: 1349.0px; height: 671.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 6: DigitalOcean - Choose plan</span><a class="headerlink" href="#id6" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Under <span class="guilabel">Choose a datacenter region</span>, select the region you
 want the instance deployed to.</p>
 <p>See Figure 7.</p>
 <figure class="align-default" id="id7">
 <a class="reference internal image-reference" href="../../_images/07-digitalocean.png"><img alt="DigitalOcean - Choose datacenter region" src="../../_images/07-digitalocean.png" style="width: 1349.0px; height: 520.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 7: DigitalOcean - Choose datacenter region</span><a class="headerlink" href="#id7" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Assign SSH key to default <em>clear</em> user.</p>
 <p>By default, the user <em>clear</em> will be added to the instance and
 an SSH key must be assigned to this account.</p>
 <ol class="loweralpha">
 <li><p>Under <span class="guilabel">Authentication</span>, select <span class="guilabel">SSH keys</span> and
 click <span class="guilabel">New SSH Key</span>.</p>
 <p>See Figure 8.</p>
 <figure class="align-default" id="id8">
 <a class="reference internal image-reference" href="../../_images/08-digitalocean.png"><img alt="DigitalOcean - Add SSH key" src="../../_images/08-digitalocean.png" style="width: 1349.0px; height: 457.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 8: DigitalOcean - Add SSH key</span><a class="headerlink" href="#id8" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Copy and paste your SSH public key in the <span class="guilabel">SSH key content</span>
 text field.</p>
 <p>See Figure 9.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </li>
 <li><p>Give a name for the SSH key.</p></li>
 <li><p>Click <span class="guilabel">Add SSH Key</span>.</p>
 <figure class="align-default" id="id9">
 <a class="reference internal image-reference" href="../../_images/09-digitalocean.png"><img alt="DigitalOcean - Add public SSH key" src="../../_images/09-digitalocean.png" style="width: 1350.0px; height: 714.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 9: DigitalOcean - Add public SSH key</span><a class="headerlink" href="#id9" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>If you need to add additional users to the instance, you can do that
 wth a YAML-formatted <em>cloud-config</em> user data script.
 For more information on cloud-config scripting for Clear Linux OS, see our
 subset implementation of cloud-init called <a class="reference external" href="https://github.com/clearlinux/micro-config-drive">micro-config-drive</a>.</p>
 <ol class="loweralpha">
 <li><p>Under <span class="guilabel">Select additional options</span>,
 select <span class="guilabel">User data</span>.</p></li>
 <li><p>Add your YAML-formatted <em>cloud-config</em> user data in the field below.
 Here is a simple example:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">#</span>cloud-config
 <span class="go">users:</span>
 <span class="go">- name: foobar</span>
 <span class="go">  gecos: Foo B. Bar</span>
 <span class="go">  homedir: /home/foobar</span>
 <span class="go">  ssh-authorized-keys:</span>
 <span class="go">    - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC65OihS4UP27xKOpqKWgT9</span>
 <span class="go">      mgUNwEqhUEpTGGvopjT65Y/KU9Wfj6EYsdGzbHHcMUhFSTxAUAV4POH5d0LR</span>
 <span class="go">      MzI7sXMe528eCmpm2fTOHDDkVrurP/Jr2bjB9IrfSMkBYS8uRd603xNg/RDq</span>
 <span class="go">      EH3XzVeEDdEAxoej0mzsJ2UkQSBi+PD1J7JeCbX2lsb55x2yWzaUa+BTai7+</span>
 <span class="go">      /TU4UabTRDtFTiXhx2rImSSguofDISVll6W5TTzbGmHdoEI+8DIAFU66ZgC9</span>
 <span class="go">      SzL75LQi1YAWlj5XG+dXhN6Ev6KFM34odvWdxeCj0jcx5UIXcieBfOuLujEH</span>
 <span class="go">      dVybwNLG7hxDy/67BA1j username@mydomain.com</span>
 <span class="go">  sudo:</span>
 <span class="go">    - [ &quot;ALL=(ALL) NOPASSWD:ALL&quot; ]</span>
 </pre></div>
 </div>
 </li>
 </ol>
 </div>
 </li>
 <li><p>Under <span class="guilabel">Finalize and create</span>:</p>
 <ol class="loweralpha simple">
 <li><p>Set the number of instances you want to deploy.</p></li>
 <li><p>Set the hostname for the instance.</p></li>
 </ol>
 <p>See Figure 10.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </li>
 <li><p>Click <span class="guilabel">Create Droplet</span> to deploy the instance.</p>
 <figure class="align-default" id="id10">
 <a class="reference internal image-reference" href="../../_images/10-digitalocean.png"><img alt="DigitalOcean - Finalize and create Droplet" src="../../_images/10-digitalocean.png" style="width: 1350.0px; height: 920.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 10: DigitalOcean - Finalize and create Droplet</span><a class="headerlink" href="#id10" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="connect-to-your-cl-instance">
 <h2><a class="toc-backref" href="#id15" role="doc-backlink">Connect to Your Clear Linux OS Instance</a><a class="headerlink" href="#connect-to-your-cl-instance" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>On DigitalOcean’s website, go to <span class="menuselection">MANAGE ‣ Droplets</span>.</p>
 <p>See Figure 11.</p>
 <div class="line-block">
 <div class="line"><br /></div>
 </div>
 </li>
 <li><p>Get the IP address of your Clear Linux OS instance.</p>
 <figure class="align-default" id="id11">
 <a class="reference internal image-reference" href="../../_images/11-digitalocean.png"><img alt="DigitalOcean - Get Droplet IP address" src="../../_images/11-digitalocean.png" style="width: 1349.0px; height: 418.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 11: DigitalOcean - Get Droplet IP address</span><a class="headerlink" href="#id11" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>On your client system, SSH into your instance.
 For example:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ssh<span class="w"> </span>clear@&lt;IP-address-of-instance&gt;<span class="w"> </span>-i<span class="w"> </span>&lt;SSH-private-key&gt;
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="related-topics">
 <h2><a class="toc-backref" href="#id16" role="doc-backlink">Related topics</a><a class="headerlink" href="#related-topics" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p><a class="reference internal" href="gce.html#gce"><span class="std std-ref">Clear Linux* OS on Google Cloud Platform*</span></a></p></li>
 <li><p><a class="reference internal" href="azure.html#azure"><span class="std std-ref">Clear Linux* OS on Microsoft* Azure*</span></a></p></li>
 <li><p><a class="reference internal" href="aws-web.html#aws-web"><span class="std std-ref">Clear Linux* OS on Amazon Web Services*</span></a></p></li>
 </ul>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS on DigitalOcean*</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#add-cl-image-to-digitalocean">Add Clear Linux OS Image to DigitalOcean</a><ul>
 <li><a class="reference internal" href="#use-pre-built-image">Use pre-built image</a></li>
 <li><a class="reference internal" href="#build-custom-image">Build custom image</a></li>
 <li><a class="reference internal" href="#upload-image">Upload image</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#create-and-deploy-a-cl-instance">Create and Deploy a Clear Linux OS Instance</a></li>
 <li><a class="reference internal" href="#connect-to-your-cl-instance">Connect to Your Clear Linux OS Instance</a></li>
 <li><a class="reference internal" href="#related-topics">Related topics</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="azure.html"
                          title="previous chapter">Clear Linux* OS on Microsoft* Azure*</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="gce.html"
                          title="next chapter">Clear Linux* OS on Google Cloud Platform*</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/cloud-install/digitalocean.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="gce.html" title="Clear Linux* OS on Google Cloud Platform*"
             >next</a> |</li>
        <li class="right" >
          <a href="azure.html" title="Clear Linux* OS on Microsoft* Azure*"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on DigitalOcean*</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,415 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS on Google Cloud Platform* &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/cloud-install/gce.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Import Clear Linux Image and Launch Instance on AWS" href="import-clr-aws.html" />
    <link rel="prev" title="Clear Linux* OS on DigitalOcean*" href="digitalocean.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="import-clr-aws.html" title="Import Clear Linux Image and Launch Instance on AWS"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="digitalocean.html" title="Clear Linux* OS on DigitalOcean*"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Google Cloud Platform*</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-on-google-cloud-platform">
 <span id="gce"></span><h1>Clear Linux* OS on Google Cloud Platform*<a class="headerlink" href="#cl-attr-on-google-cloud-platform" title="Link to this heading">¶</a></h1>
 <p>This page explains the steps to create a virtual machine instance of
 Clear Linux* OS on <a class="reference external" href="https://cloud.google.com/">Google Cloud Platform</a> (<abbr title="Google Cloud Platform">GCP</abbr>).</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#prerequisites" id="id21">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#setup-cl-vm-on-gcp" id="id22">Setup Clear Linux OS VM on GCP</a></p></li>
 <li><p><a class="reference internal" href="#related-topics" id="id23">Related topics</a></p></li>
 </ul>
 </nav>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id21" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Set up a Google account and a GCP billing account.</p></li>
 <li><p>Generate and install a user SSH key in the Linux PCs that will connect to
 the VMs in GCP.</p></li>
 </ul>
 </section>
 <section id="setup-cl-vm-on-gcp">
 <h2><a class="toc-backref" href="#id22" role="doc-backlink">Setup Clear Linux OS VM on GCP</a><a class="headerlink" href="#setup-cl-vm-on-gcp" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Sign in to your Google* account on the
 <a class="reference external" href="https://console.cloud.google.com/">Google Cloud Console</a>:</p>
 <figure class="align-default" id="id1">
 <a class="reference internal image-reference" href="../../_images/00-sign-in.png"><img alt="Sign in to Google services" src="../../_images/00-sign-in.png" style="width: 229.0px; height: 281.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: Google sign in screen</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Google Cloud Platform uses <strong>Projects</strong> to manage resources.
 Select or create a new project for hosting the Clear Linux OS VM.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Refer to the
 <a class="reference external" href="https://cloud.google.com/compute/docs/quickstart-linux">Quickstart Using a Linux VM</a>
 guide to learn about the process of creating VM instances on GCP.</p>
 </div>
 </li>
 <li><p>Navigate to the latest Clear Linux OS
 <a class="reference external" href="https://download.clearlinux.org/releases/current/clear/">release folder</a>
 to view the currently released <abbr title="Google Compute Engine*">GCE</abbr>
 image, and download the <code class="file docutils literal notranslate"><span class="pre">clear-&lt;release</span> <span class="pre">number&gt;-gce.tar.gz</span></code>
 image archive.</p>
 <p>You don’t need to uncompress the image archive, the intact file will
 be uploaded to the Google Cloud Storage later.</p>
 </li>
 <li><p>Create a <em>Storage Bucket</em> for hosting the Clear Linux OS image source archive
 downloaded in the previous step:</p>
 <ul class="simple">
 <li><p>Click the <span class="guilabel">Navigation menu</span> icon on the upper left screen menu.</p></li>
 <li><p>Select the <span class="menuselection">Storage</span> item from the sidebar on the left.
 You will be sent to the Storage Browser tool or the Cloud Storage
 overview page.</p></li>
 </ul>
 <figure class="align-default" id="id2">
 <a class="reference internal image-reference" href="../../_images/01-cloud-storage.png"><img alt="Browse Google Cloud Storage" src="../../_images/01-cloud-storage.png" style="width: 641.5px; height: 372.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 2: Browse Google Cloud Storage</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>You may need to create a billing account and link to this project
 before you create a bucket.</p>
 </div>
 <figure class="align-default" id="id3">
 <a class="reference internal image-reference" href="../../_images/02-storage-browser.png"><img alt="Cloud Storage Browser tool" src="../../_images/02-storage-browser.png" style="width: 604.5px; height: 370.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 3: Cloud Storage Browser tool</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <ul>
 <li><p>Click the <span class="guilabel">CREATE BUCKET</span> button to enter the bucket creation tool.
 The bucket name must be unique because buckets in the Cloud Storage share
 a single global namespace.</p>
 <p>Leave the remaining options set to the defaults, and click the
 <span class="guilabel">Create</span> button at the bottom to create a <em>Bucket</em>.</p>
 <figure class="align-default" id="id4">
 <a class="reference internal image-reference" href="../../_images/03-create-bucket.png"><img alt="Set a unique bucket name" src="../../_images/03-create-bucket.png" style="width: 605.5px; height: 371.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 4: Set bucket name</span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ul>
 </li>
 <li><p>Once the bucket is created, click the <span class="guilabel">Upload files</span> button
 on the Bucket details page to upload the Clear Linux OS GCE image archive
 to the named bucket:</p>
 <figure class="align-default" id="id5">
 <a class="reference internal image-reference" href="../../_images/04-bucket-created.png"><img alt="Cloud Storage bucket is available for storing objects" src="../../_images/04-bucket-created.png" style="width: 641.5px; height: 372.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 5: Cloud Storage bucket</span><a class="headerlink" href="#id5" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <figure class="align-default" id="id6">
 <a class="reference internal image-reference" href="../../_images/10-image-upload.png"><img alt="Uploading the image source archive file" src="../../_images/10-image-upload.png" style="width: 641.5px; height: 371.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 6: Uploading the image source archive file</span><a class="headerlink" href="#id6" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <figure class="align-default" id="id7">
 <a class="reference internal image-reference" href="../../_images/11-bucket-uploaded.png"><img alt="Image archive imported complete" src="../../_images/11-bucket-uploaded.png" style="width: 640.0px; height: 370.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 7: Importing complete</span><a class="headerlink" href="#id7" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Browse the Compute Engine Image library page:</p>
 <ul>
 <li><p>Click the <span class="guilabel">Navigation menu</span> icon on the upper left screen menu.</p></li>
 <li><p>Select the <span class="menuselection">Compute Engine ‣ Images</span> from the side bar
 on the left.</p>
 <figure class="align-default" id="id8">
 <a class="reference internal image-reference" href="../../_images/20-gce-image.png"><img alt="Go to Google Compute Engine Image library" src="../../_images/20-gce-image.png" style="width: 641.5px; height: 372.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 8: Image library</span><a class="headerlink" href="#id8" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ul>
 </li>
 <li><p>On the Compute Engine Image library page, click the
 <span class="guilabel">[+] CREATE IMAGE</span> menu item to create a custom image:</p>
 <figure class="align-default" id="id9">
 <a class="reference internal image-reference" href="../../_images/20-image-library.png"><img alt="Create a Google Compute Engine image" src="../../_images/20-image-library.png" style="width: 641.5px; height: 372.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 9: Create image</span><a class="headerlink" href="#id9" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the VM image creation page, change the image source type to
 <em>Cloud Storage file</em>.</p></li>
 <li><p>Under <span class="guilabel">Source</span>, select <span class="guilabel">Browse</span>.</p></li>
 <li><p>Locate the <code class="file docutils literal notranslate"><span class="pre">clear-&lt;release</span> <span class="pre">number&gt;-gce.tar.gz</span></code> file,
 and click <span class="guilabel">Select</span>.</p>
 <figure class="align-default" id="id10">
 <a class="reference internal image-reference" href="../../_images/21-create-image.png"><img alt="Create the image using the imported image archive object" src="../../_images/21-create-image.png" style="width: 641.0px; height: 371.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 10: Create image using imported object</span><a class="headerlink" href="#id10" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <p>Accept all default options, and click the <span class="guilabel">Create</span> button
 at the bottom to import the Clear Linux GCE image to the image library.</p>
 <figure class="align-default" id="id11">
 <a class="reference internal image-reference" href="../../_images/22-image-list.png"><img alt="Clear Linux Compute Engine image is created" src="../../_images/22-image-list.png" style="width: 641.5px; height: 371.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 11: Image is created</span><a class="headerlink" href="#id11" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>After the Clear Linux OS image is imported, you can launch a VM instance running
 Clear Linux OS:</p>
 <ul class="simple">
 <li><p>Click the <span class="guilabel">Navigation menu</span> icon on the upper left screen menu.</p></li>
 <li><p>Select <span class="menuselection">Compute Engine ‣ VM Instances</span> from the side bar
 on the left.</p></li>
 </ul>
 <figure class="align-default" id="id12">
 <a class="reference internal image-reference" href="../../_images/30-vm-instances.png"><img alt="Go to VM instances catalog" src="../../_images/30-vm-instances.png" style="width: 641.5px; height: 372.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 12: VM instances catalog</span><a class="headerlink" href="#id12" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>If no VM instance was created in this project, you will be prompted to
 create one.</p></li>
 <li><p>Alternatively, click the <span class="guilabel">CREATE INSTANCE</span> button on the VM
 instances page to create a VM instance.</p>
 <figure class="align-default" id="id13">
 <a class="reference internal image-reference" href="../../_images/30-vm-none.png"><img alt="Prompt for VM creation" src="../../_images/30-vm-none.png" style="width: 605.5px; height: 371.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 13: VM creation</span><a class="headerlink" href="#id13" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <figure class="align-default" id="id14">
 <a class="reference internal image-reference" href="../../_images/30-vm-catalog.png"><img alt="List of VM instances" src="../../_images/30-vm-catalog.png" style="width: 641.0px; height: 371.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 14: VM instances list</span><a class="headerlink" href="#id14" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <ul>
 <li><p>Under <span class="guilabel">Region</span>, choose a region based on the
 <a class="reference external" href="https://cloud.google.com/solutions/best-practices-compute-engine-region-selection">Best practices for Compute Engine regions selection</a>.</p></li>
 <li><p>Under <span class="guilabel">Boot disk</span>, click the <span class="guilabel">Change</span> button.</p>
 <figure class="align-default" id="id15">
 <a class="reference internal image-reference" href="../../_images/30-create-vm.png"><img alt="Use custom image while creating Clear Linux VM instance" src="../../_images/30-create-vm.png" style="width: 605.5px; height: 371.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 15: Use custom image</span><a class="headerlink" href="#id15" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select the <span class="menuselection">Custom images</span> tab for using Clear Linux OS GCE image.</p>
 <figure class="align-default" id="id16">
 <a class="reference internal image-reference" href="../../_images/31-select-boot-disk.png"><img alt="Select Clear Linux boot disk to create a VM instance" src="../../_images/31-select-boot-disk.png" style="width: 640.5px; height: 370.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 16: Select Clear Linux boot disk to create a VM instance</span><a class="headerlink" href="#id16" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Scroll down to the bottom of the VM instance creation page,
 expand the <span class="guilabel">Management, security, disks, networking, sole tenancy</span>
 group.</p>
 <figure class="align-default" id="id17">
 <a class="reference internal image-reference" href="../../_images/40-clear-vm-security.png"><img alt="Clear Linux requires setting up SSH keys" src="../../_images/40-clear-vm-security.png" style="width: 641.5px; height: 372.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 17: Set up SSH keys</span><a class="headerlink" href="#id17" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Clear Linux OS 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.</p>
 <p>Refer to <a class="reference internal" href="../../guides/clear/security.html#security"><span class="std std-ref">OS Security</span></a> for more details.</p>
 </div>
 </li>
 <li><p>Click the <span class="menuselection">Security</span> tab, copy and paste your SSH public key:</p>
 <figure class="align-default" id="id18">
 <a class="reference internal image-reference" href="../../_images/40-ssh-key.png"><img alt="Set SSH key for remote login" src="../../_images/40-ssh-key.png" style="width: 641.0px; height: 370.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 18: Set SSH key for remote login</span><a class="headerlink" href="#id18" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The username is assigned from characters preceding <code class="docutils literal notranslate"><span class="pre">&#64;</span></code> in the email
 address, included in the SSH key.</p>
 </div>
 </li>
 <li><p>Click the <span class="guilabel">Create</span> button to create the Clear Linux OS VM.</p></li>
 </ul>
 </li>
 <li><p>The Clear Linux VM instance is created and assigned a public IP address:</p>
 <figure class="align-default" id="id19">
 <a class="reference internal image-reference" href="../../_images/41-vm-created.png"><img alt="Clear Linux VM instance is created and started" src="../../_images/41-vm-created.png" style="width: 641.0px; height: 371.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 19: Clear Linux VM instance is created and started</span><a class="headerlink" href="#id19" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>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:</p>
 <figure class="align-default" id="id20">
 <a class="reference internal image-reference" href="../../_images/42-ssh-vm.png"><img alt="SSH login to the Clear Linux VM" src="../../_images/42-ssh-vm.png" style="width: 334.5px; height: 208.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 20: SSH login to Clear Linux VM</span><a class="headerlink" href="#id20" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="related-topics">
 <h2><a class="toc-backref" href="#id23" role="doc-backlink">Related topics</a><a class="headerlink" href="#related-topics" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p><a class="reference internal" href="azure.html#azure"><span class="std std-ref">Clear Linux* OS on Microsoft* Azure*</span></a></p></li>
 <li><p><a class="reference internal" href="aws-web.html#aws-web"><span class="std std-ref">Clear Linux* OS on Amazon Web Services*</span></a></p></li>
 <li><p><a class="reference internal" href="digitalocean.html#clr-digitalocean"><span class="std std-ref">Clear Linux* OS on DigitalOcean*</span></a></p></li>
 </ul>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS on Google Cloud Platform*</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#setup-cl-vm-on-gcp">Setup Clear Linux OS VM on GCP</a></li>
 <li><a class="reference internal" href="#related-topics">Related topics</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="digitalocean.html"
                          title="previous chapter">Clear Linux* OS on DigitalOcean*</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="import-clr-aws.html"
                          title="next chapter">Import Clear Linux Image and Launch Instance on AWS</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/cloud-install/gce.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="import-clr-aws.html" title="Import Clear Linux Image and Launch Instance on AWS"
             >next</a> |</li>
        <li class="right" >
          <a href="digitalocean.html" title="Clear Linux* OS on DigitalOcean*"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Google Cloud Platform*</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,658 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Import Clear Linux Image and Launch Instance on AWS &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/cloud-install/import-clr-aws.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Clear Linux* OS on QingCloud*" href="qingcloud.html" />
    <link rel="prev" title="Clear Linux* OS on Google Cloud Platform*" href="gce.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="qingcloud.html" title="Clear Linux* OS on QingCloud*"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="gce.html" title="Clear Linux* OS on Google Cloud Platform*"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Import Clear Linux Image and Launch Instance on AWS</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="import-clear-linux-image-and-launch-instance-on-aws">
 <span id="import-clr-aws"></span><h1>Import Clear Linux Image and Launch Instance on AWS<a class="headerlink" href="#import-clear-linux-image-and-launch-instance-on-aws" title="Link to this heading">¶</a></h1>
 <p>Clear Linux is available on the AWS marketplace.  However, it may not
 be the latest version because we only update the marketplace on a
 periodic basis, as often as weekly or but maybe monthly as well.
 If you want to use the latest release from us or upload your own
 custom image, follow this guide.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#prerequisites" id="id29">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#download-or-create-a-cl-image-for-aws" id="id30">Download or create a Clear Linux OS image for AWS</a></p></li>
 <li><p><a class="reference internal" href="#create-an-s3-bucket" id="id31">Create an S3 bucket</a></p></li>
 <li><p><a class="reference internal" href="#upload-the-cl-image-into-the-bucket" id="id32">Upload the Clear Linux OS image into the bucket</a></p></li>
 <li><p><a class="reference internal" href="#add-a-user-to-iam-with-aws-cli-privilege" id="id33">Add a user to IAM with AWS_CLI privilege</a></p></li>
 <li><p><a class="reference internal" href="#install-and-configure-the-aws-cli-tool-on-your-system" id="id34">Install and configure the AWS CLI tool on your system</a></p></li>
 <li><p><a class="reference internal" href="#import-a-snapshot-of-the-cl-image" id="id35">Import a snapshot of the Clear Linux OS image</a></p></li>
 <li><p><a class="reference internal" href="#create-an-ami-from-the-snapshot" id="id36">Create an AMI from the snapshot</a></p></li>
 <li><p><a class="reference internal" href="#launch-an-instance" id="id37">Launch an instance</a></p></li>
 <li><p><a class="reference internal" href="#connect-to-your-cl-instance" id="id38">Connect to your Clear Linux OS instance</a></p></li>
 <li><p><a class="reference internal" href="#related-topics" id="id39">Related topics</a></p></li>
 </ul>
 </nav>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id29" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>You are familiar with AWS and how to use it</p></li>
 </ul>
 </section>
 <section id="download-or-create-a-cl-image-for-aws">
 <h2><a class="toc-backref" href="#id30" role="doc-backlink">Download or create a Clear Linux OS image for AWS</a><a class="headerlink" href="#download-or-create-a-cl-image-for-aws" title="Link to this heading">¶</a></h2>
 <p>Obtain an AWS Clear Linux OS image using one of these methods.</p>
 <section id="download-pre-built-image">
 <h3>Download pre-built image<a class="headerlink" href="#download-pre-built-image" title="Link to this heading">¶</a></h3>
 <ol class="arabic simple">
 <li><p>Go to the <a class="reference external" href="https://clearlinux.org/downloads">Downloads</a> page and download the
 <em>Amazon* Web Services (AWS)</em> image.</p></li>
 <li><p>Uncompress it.</p></li>
 </ol>
 </section>
 <section id="create-a-custom-image-using-clr-installer">
 <h3>Create a custom image using clr-installer<a class="headerlink" href="#create-a-custom-image-using-clr-installer" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>On a Clear Linux OS system, open a terminal.</p></li>
 <li><p>Install the <cite>clr-installer</cite> bundle.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>swupd<span class="w"> </span>bundle-add<span class="w"> </span>clr-installer
 </pre></div>
 </div>
 </li>
 <li><p>Download a sample <a class="reference external" href="https://cdn.download.clearlinux.org/current/config/image/aws.yaml">aws.yaml</a> configuration file.</p></li>
 <li><p>Make changes to the configuration file as needed.
 See <a class="reference external" href="https://github.com/clearlinux/clr-installer/blob/master/scripts/InstallerYAMLSyntax.md">Installer YAML Syntax</a> for more information on clr-installer
 configuration YAML syntax.</p></li>
 <li><p>Download the <a class="reference external" href="https://cdn.download.clearlinux.org/current/config/image/aws-disable-root.sh">AWS image post-install script</a> and make it executable.</p></li>
 <li><p>Produce an image with clr-installer.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>clr-installer<span class="w"> </span>--template<span class="w"> </span><span class="nv">$PWD</span>/aws.yaml
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 </section>
 <section id="create-an-s3-bucket">
 <h2><a class="toc-backref" href="#id31" role="doc-backlink">Create an S3 bucket</a><a class="headerlink" href="#create-an-s3-bucket" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Log into AWS.</p></li>
 <li><p>Go to <span class="guilabel">Services</span>, <span class="guilabel">Storage</span>, and select <span class="guilabel">S3</span>.
 See Figure 1.</p>
 <figure class="align-default" id="id1">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-01.png"><img alt="AWS Services - S3 Management Console" src="../../_images/import-clr-aws-01.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: AWS Services - S3 Management Console</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">+ Create bucket</span>.</p>
 <figure class="align-default" id="id2">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-02.png"><img alt="AWS S3 - Create bucket" src="../../_images/import-clr-aws-02.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 2: AWS S3 - Create bucket</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Set a bucket name and select a region.
 See Figure 3.</p>
 <figure class="align-default" id="id3">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-03.png"><img alt="AWS S3 - Create bucket - Set bucket name and region" src="../../_images/import-clr-aws-03.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 3: AWS S3 - Create bucket - Set bucket name and region</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Leave the <span class="guilabel">Configure options</span> and <span class="guilabel">Set permissions</span>
 settings as is or configure as desired.  See Figure 4 and 5.</p>
 <figure class="align-default" id="id4">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-04.png"><img alt="AWS S3 - Create bucket - Configure options" src="../../_images/import-clr-aws-04.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 4: AWS S3 - Create bucket - Configure options</span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <figure class="align-default" id="id5">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-05.png"><img alt="AWS S3 - Create bucket - Set permissions" src="../../_images/import-clr-aws-05.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 5: AWS S3 - Create bucket - Set permissions</span><a class="headerlink" href="#id5" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>At the <span class="guilabel">Review</span> screen, click <span class="guilabel">Create bucket</span>.</p>
 <figure class="align-default" id="id6">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-06.png"><img alt="AWS S3 - Create bucket - Review" src="../../_images/import-clr-aws-06.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 6: AWS S3 - Create bucket - Review</span><a class="headerlink" href="#id6" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <p>The created bucket should appear.  See Figure 7.</p>
 <figure class="align-default" id="id7">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-07.png"><img alt="AWS S3 - Created bucket" src="../../_images/import-clr-aws-07.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 7: AWS S3 - Created bucket</span><a class="headerlink" href="#id7" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="upload-the-cl-image-into-the-bucket">
 <h2><a class="toc-backref" href="#id32" role="doc-backlink">Upload the Clear Linux OS image into the bucket</a><a class="headerlink" href="#upload-the-cl-image-into-the-bucket" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Click on the bucket.
 See Figure 8.</p>
 <figure class="align-default" id="id8">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-08.png"><img alt="AWS S3 - Select bucket" src="../../_images/import-clr-aws-08.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 8: AWS S3 - Select bucket</span><a class="headerlink" href="#id8" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Upload</span>.
 See Figure 9.</p>
 <figure class="align-default" id="id9">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-09.png"><img alt="AWS S3 - Upload" src="../../_images/import-clr-aws-09.png" style="width: 875.6999999999999px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 9: AWS S3 - Upload</span><a class="headerlink" href="#id9" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Add files</span> and select the Clear Linux OS image file to upload.
 See Figure 10.</p>
 <figure class="align-default" id="id10">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-10.png"><img alt="AWS S3 - Add files" src="../../_images/import-clr-aws-10.png" style="width: 875.6999999999999px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 10: AWS S3 - Add files</span><a class="headerlink" href="#id10" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Next</span>.  Leave remaining settings as is or set as desired.
 See Figure 11, Figure 12, and Figure 13.</p>
 <figure class="align-default" id="id11">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-11.png"><img alt="AWS S3 - Add files" src="../../_images/import-clr-aws-11.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 11: AWS S3 - Add files</span><a class="headerlink" href="#id11" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <figure class="align-default" id="id12">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-12.png"><img alt="AWS S3 - Set permissions" src="../../_images/import-clr-aws-12.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 12: AWS S3 - Set permissions</span><a class="headerlink" href="#id12" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <figure class="align-default" id="id13">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-13.png"><img alt="AWS S3 - Set properties" src="../../_images/import-clr-aws-13.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 13: AWS S3 - Set properties</span><a class="headerlink" href="#id13" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Upload</span> to upload the image.
 See Figure 14.</p>
 <figure class="align-default" id="id14">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-14.png"><img alt="AWS S3 - Upload" src="../../_images/import-clr-aws-14.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 14: AWS S3 - Upload</span><a class="headerlink" href="#id14" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="add-a-user-to-iam-with-aws-cli-privilege">
 <h2><a class="toc-backref" href="#id33" role="doc-backlink">Add a user to IAM with AWS_CLI privilege</a><a class="headerlink" href="#add-a-user-to-iam-with-aws-cli-privilege" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Go to <span class="guilabel">Services</span>, <span class="guilabel">Security, Identity, &amp; Compliance</span>,
 and select <span class="guilabel">IAM</span>.
 See Figure 15.</p>
 <figure class="align-default" id="id15">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-15.png"><img alt="AWS Services - IAM" src="../../_images/import-clr-aws-15.png" style="width: 873.5999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 15: AWS Services - IAM</span><a class="headerlink" href="#id15" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>On the left navigation bar under <span class="guilabel">Access management</span>,
 select <span class="guilabel">Users</span>.
 See Figure 16.</p>
 <figure class="align-default" id="id16">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-16.png"><img alt="AWS AIM - Access management" src="../../_images/import-clr-aws-16.png" style="width: 873.5999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 16: AWS AIM - Access management</span><a class="headerlink" href="#id16" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Add user</span>.
 See Figure 17.</p>
 <figure class="align-default" id="id17">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-17.png"><img alt="AWS AIM - Add user" src="../../_images/import-clr-aws-17.png" style="width: 873.5999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 17: AWS AIM - Add user</span><a class="headerlink" href="#id17" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Under the <span class="guilabel">Set user details</span> section, enter a user name.
 See Figure 18.</p>
 <figure class="align-default" id="id18">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-18.png"><img alt="AWS AIM - Enter user name and select access type" src="../../_images/import-clr-aws-18.png" style="width: 873.5999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 18: AWS AIM - Enter user name and select access type</span><a class="headerlink" href="#id18" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Under the <span class="guilabel">Select AWS access type</span> section,
 checkmark <span class="guilabel">Programmatic access</span>.
 See Figure 18.</p></li>
 <li><p>Click <span class="guilabel">Next: Permissions</span>.</p></li>
 <li><p>Under <span class="guilabel">Set permissions</span>, select <span class="guilabel">Add user to group</span>.
 See Figure 19.</p>
 <figure class="align-default" id="id19">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-19.png"><img alt="AWS AIM - Set user permissions" src="../../_images/import-clr-aws-19.png" style="width: 873.5999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 19: AWS AIM - Set user permissions</span><a class="headerlink" href="#id19" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Under <span class="guilabel">Add user to group</span>, enter <cite>AWS_CLI</cite> into search window.
 Checkmark <span class="guilabel">AWS_CLI</span>.
 See Figure 19.</p></li>
 <li><p>Click <span class="guilabel">Next: Tags</span>.</p></li>
 <li><p>Click <span class="guilabel">Next: Review</span>.</p></li>
 <li><p>Click <span class="guilabel">Create user</span>.
 See Figure 20.</p>
 <figure class="align-default" id="id20">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-20.png"><img alt="AWS AIM - Create user" src="../../_images/import-clr-aws-20.png" style="width: 873.5999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 20: AWS AIM - Create user</span><a class="headerlink" href="#id20" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>After the user is successfully added, save the <span class="guilabel">Access key ID</span>
 and the <span class="guilabel">Secret access key</span>.  These will be used when setting up
 the AWS CLI tool at a later step.
 See Figure 21.</p>
 <figure class="align-default" id="id21">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-21.png"><img alt="AWS AIM - Access key ID and secret access key" src="../../_images/import-clr-aws-21.png" style="width: 873.5999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 21: AWS AIM - Access key ID and secret access key</span><a class="headerlink" href="#id21" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Close</span>.</p></li>
 </ol>
 </section>
 <section id="install-and-configure-the-aws-cli-tool-on-your-system">
 <h2><a class="toc-backref" href="#id34" role="doc-backlink">Install and configure the AWS CLI tool on your system</a><a class="headerlink" href="#install-and-configure-the-aws-cli-tool-on-your-system" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>To install the tool on Clear Linux OS, simply run:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>swupd<span class="w"> </span>bundle-add<span class="w"> </span>cloud-api
 </pre></div>
 </div>
 </li>
 <li><p>Configure it with your security credentials, default region,
 and default output format. See <a class="reference external" href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the AWS CLI</a> for more information.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>aws<span class="w"> </span>configure
 </pre></div>
 </div>
 <p>Below is an example (using the security credentials that was created in
 the previous section):</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">AWS Access Key ID [None]: AKIA5LEGQPQ3EUB3JMS7</span>
 <span class="go">AWS Secret Access Key [None]: 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</span>
 <span class="go">Default region name [None]: us-west-2</span>
 <span class="go">Default output format [None]: json</span>
 </pre></div>
 </div>
 </li>
 <li><p>Verify your credentials are good.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>aws<span class="w"> </span>iam<span class="w"> </span>list-access-keys
 </pre></div>
 </div>
 <p>If you get something like the example below, then make sure you set your
 system date and time properly.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">An error occurred (SignatureDoesNotMatch) when calling the ListAccessKeys operation: Signature expired: 20200305T153154Z is now earlier than 20200305T231847Z (20200305T233347Z - 15 min.)</span>
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="import-a-snapshot-of-the-cl-image">
 <h2><a class="toc-backref" href="#id35" role="doc-backlink">Import a snapshot of the Clear Linux OS image</a><a class="headerlink" href="#import-a-snapshot-of-the-cl-image" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Create a <code class="file docutils literal notranslate"><span class="pre">container.json</span></code> with the description of the image to import.
 Specify the name of the S3 bucket that was created earlier for the
 <cite>S3Bucket</cite> field and the name of Clear Linux OS image that was uploaded to the S3 bucket
 for the <cite>S3Key</cite>.</p>
 <p>Here’s an example:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">{</span>
 <span class="go">  &quot;Description&quot;: &quot;My Clear Linux AWS 32400 Image&quot;,</span>
 <span class="go">  &quot;Format&quot;: &quot;raw&quot;,</span>
 <span class="go">  &quot;UserBucket&quot;: {</span>
 <span class="go">    &quot;S3Bucket&quot;: &quot;my-clearlinux-bucket&quot;,</span>
 <span class="go">    &quot;S3Key&quot;: &quot;clear-32400-aws.img&quot;</span>
 <span class="go">  }</span>
 <span class="go">}</span>
 </pre></div>
 </div>
 </li>
 <li><p>Import a snapshot of the image.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>aws<span class="w"> </span>ec2<span class="w"> </span>import-snapshot<span class="w"> </span><span class="se">\</span>
 --description<span class="w"> </span><span class="s2">&quot;My Clear Linux AWS 32400 Snapshot&quot;</span><span class="w"> </span><span class="se">\</span>
 --disk-container<span class="w"> </span>file://container.json
 </pre></div>
 </div>
 <p>You should get an output similar this example:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">  {</span>
 <span class="go">    &quot;Description&quot;: &quot;My Clear Linux AWS 32400 Snapshot&quot;,</span>
 <span class="go">    &quot;ImportTaskId&quot;: &quot;import-snap-00fa9ccd98e9b8378&quot;,</span>
 <span class="go">    &quot;SnapshotTaskDetail&quot;: {</span>
 <span class="go">        &quot;Description&quot;: &quot;My Clear Linux AWS 32400 Snapshot&quot;,</span>
 <span class="go">        &quot;DiskImageSize&quot;: 0.0,</span>
 <span class="go">        &quot;Format&quot;: &quot;RAW&quot;,</span>
 <span class="go">        &quot;Progress&quot;: &quot;3&quot;,</span>
 <span class="go">        &quot;Status&quot;: &quot;active&quot;,</span>
 <span class="go">        &quot;StatusMessage&quot;: &quot;pending&quot;,</span>
 <span class="go">        &quot;UserBucket&quot;: {</span>
 <span class="go">            &quot;S3Bucket&quot;: &quot;my-clearlinux-bucket&quot;,</span>
 <span class="go">            &quot;S3Key&quot;: &quot;clear-32400-aws.img&quot;</span>
 <span class="go">        }</span>
 <span class="go">    }</span>
 <span class="go">}</span>
 </pre></div>
 </div>
 </li>
 <li><p>Using the <cite>ImportTaskId</cite> from the previous step, check the status
 of the import.  For example:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">snapshot_id</span><span class="o">=</span><span class="k">$(</span>aws<span class="w"> </span>ec2<span class="w"> </span>describe-import-snapshot-tasks<span class="w"> </span><span class="se">\</span>
 --import-task-ids<span class="w"> </span><span class="s2">&quot;import-snap-00fa9ccd98e9b8378&quot;</span><span class="w"> </span><span class="se">\</span>
 <span class="p">|</span><span class="w"> </span>grep<span class="w"> </span>SnapshotId<span class="w"> </span><span class="p">|</span><span class="w"> </span>awk<span class="w"> </span>-F<span class="w"> </span><span class="s1">&#39;&quot;&#39;</span><span class="w"> </span><span class="s1">&#39;{print $4}&#39;</span><span class="k">)</span>
 </pre></div>
 </div>
 <p>Wait for the <cite>Status</cite> field to show <cite>completed</cite> before proceeding.</p>
 <p>The resulting <cite>snapshot_id</cite> will be used to create an AMI in
 the next section.</p>
 </li>
 </ol>
 </section>
 <section id="create-an-ami-from-the-snapshot">
 <h2><a class="toc-backref" href="#id36" role="doc-backlink">Create an AMI from the snapshot</a><a class="headerlink" href="#create-an-ami-from-the-snapshot" title="Link to this heading">¶</a></h2>
 <p>There are 2 methods to create an AMI from the snapshot.</p>
 <ul>
 <li><p><em>AWS CLI Method</em>:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>aws<span class="w"> </span>ec2<span class="w"> </span>register-image<span class="w"> </span><span class="se">\</span>
 --name<span class="w"> </span><span class="s2">&quot;My-Clear-Linux-32400-AMI&quot;</span><span class="w"> </span><span class="se">\</span>
 --description<span class="w"> </span><span class="s2">&quot;My Clear Linux 32400 AMI&quot;</span><span class="w"> </span><span class="se">\</span>
 --architecture<span class="w"> </span>x86_64<span class="w"> </span><span class="se">\</span>
 --virtualization-type<span class="w"> </span>hvm<span class="w"> </span><span class="se">\</span>
 --ena-support<span class="w"> </span><span class="se">\</span>
 --root-device-name<span class="w"> </span><span class="s2">&quot;/dev/sda1&quot;</span><span class="w"> </span><span class="se">\</span>
 --block-device-mappings<span class="w"> </span><span class="s2">&quot;[</span>
 <span class="s2">  {</span>
 <span class="s2">    \”Deviceame\&quot;: \&quot;/dev/sda1\&quot;,</span>
 <span class="s2">    \&quot;Ebs\&quot;: {</span>
 <span class="s2">      \&quot;SnapshotId\&quot;: \&quot;</span><span class="nv">$snapshot_id</span><span class="s2">\&quot;</span>
 <span class="s2">    }</span>
 <span class="s2">  }</span>
 <span class="s2">]&quot;</span>
 </pre></div>
 </div>
 </li>
 <li><p><em>GUI Method</em>:</p>
 <ol class="arabic">
 <li><p>Go to <span class="guilabel">Services</span>, <span class="guilabel">Compute</span>, and select
 <span class="guilabel">EC2</span>.
 See Figure 22.</p>
 <figure class="align-default" id="id22">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-22.png"><img alt="AWS Services - EC2" src="../../_images/import-clr-aws-22.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 22: AWS Services - EC2</span><a class="headerlink" href="#id22" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Snapshots</span>.
 See Figure 23.</p>
 <figure class="align-default" id="id23">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-23.png"><img alt="AWS Services - Snapshots" src="../../_images/import-clr-aws-23.png" style="width: 873.5999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 23: AWS Services - Snapshots</span><a class="headerlink" href="#id23" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Locate the snaphot using the <cite>Snapshot ID</cite>.
 See Figure 24.</p>
 <figure class="align-default" id="id24">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-24.png"><img alt="AWS Services - Snapshots" src="../../_images/import-clr-aws-24.png" style="width: 873.5999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 24: AWS Services - Snapshots</span><a class="headerlink" href="#id24" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Right-click it and select <span class="guilabel">Create Image</span>.</p></li>
 <li><p>Configure as follows:</p>
 <ul class="simple">
 <li><p>Enter the name in the <span class="guilabel">Name</span> field</p></li>
 <li><p>Enter the description in the <span class="guilabel">Description</span> field</p></li>
 <li><p>Set the <span class="guilabel">Architecture</span> as <cite>x86_64</cite></p></li>
 <li><p>Set the <span class="guilabel">Virtualization type</span> as <cite>Hardware-assisted virtualization</cite></p></li>
 <li><p>Set the <span class="guilabel">Root device name</span> as <cite>/dev/sda1</cite></p></li>
 </ul>
 <p>See Figure 25.</p>
 <figure class="align-default" id="id25">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-25.png"><img alt="AWS Services - Snapshots" src="../../_images/import-clr-aws-25.png" style="width: 945.6999999999999px; height: 599.1999999999999px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 25: AWS Services - Snapshots</span><a class="headerlink" href="#id25" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Create</span>.</p></li>
 </ol>
 </li>
 </ul>
 </section>
 <section id="launch-an-instance">
 <h2><a class="toc-backref" href="#id37" role="doc-backlink">Launch an instance</a><a class="headerlink" href="#launch-an-instance" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Go to <span class="guilabel">Services</span>, <span class="guilabel">Compute</span>, and select
 <span class="guilabel">EC2</span>.
 See Figure 26.</p>
 <figure class="align-default" id="id26">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-26.png"><img alt="AWS Services - EC2" src="../../_images/import-clr-aws-26.png" style="width: 875.0px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 26: AWS Services - EC2</span><a class="headerlink" href="#id26" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click the <span class="guilabel">Launch Instance</span> dropdown and select
 <span class="guilabel">Launch Instance</span>.
 See Figure 27.</p>
 <figure class="align-default" id="id27">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-27.png"><img alt="AWS Services - Launch instance" src="../../_images/import-clr-aws-27.png" style="width: 875.6999999999999px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 27: AWS Services - Launch instance</span><a class="headerlink" href="#id27" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>On the left navigation bar, select <span class="guilabel">My AMIs</span>.
 See Figure 28.</p>
 <figure class="align-default" id="id28">
 <a class="reference internal image-reference" href="../../_images/import-clr-aws-28.png"><img alt="AWS Services - Select AMI" src="../../_images/import-clr-aws-28.png" style="width: 875.6999999999999px; height: 598.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 28: AWS Services - Select AMI</span><a class="headerlink" href="#id28" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Find your AMI and click <span class="guilabel">Select</span>.</p></li>
 <li><p>From here onward, configure the details of your instance as desired
 and launch it.</p></li>
 </ol>
 </section>
 <section id="connect-to-your-cl-instance">
 <h2><a class="toc-backref" href="#id38" role="doc-backlink">Connect to your Clear Linux OS instance</a><a class="headerlink" href="#connect-to-your-cl-instance" title="Link to this heading">¶</a></h2>
 <ol class="arabic simple">
 <li><p>Follow these steps to <a class="reference external" href="https://docs.01.org/clearlinux/latest/get-started/cloud-install/aws-web.html#connect-to-your-clear-linux-os-basic-instance">connect to your instance</a>.</p></li>
 </ol>
 </section>
 <section id="related-topics">
 <h2><a class="toc-backref" href="#id39" role="doc-backlink">Related topics</a><a class="headerlink" href="#related-topics" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p><a class="reference internal" href="azure.html#azure"><span class="std std-ref">Clear Linux* OS on Microsoft* Azure*</span></a></p></li>
 <li><p><a class="reference internal" href="gce.html#gce"><span class="std std-ref">Clear Linux* OS on Google Cloud Platform*</span></a></p></li>
 <li><p><a class="reference internal" href="digitalocean.html#clr-digitalocean"><span class="std std-ref">Clear Linux* OS on DigitalOcean*</span></a></p></li>
 </ul>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Import Clear Linux Image and Launch Instance on AWS</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#download-or-create-a-cl-image-for-aws">Download or create a Clear Linux OS image for AWS</a><ul>
 <li><a class="reference internal" href="#download-pre-built-image">Download pre-built image</a></li>
 <li><a class="reference internal" href="#create-a-custom-image-using-clr-installer">Create a custom image using clr-installer</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#create-an-s3-bucket">Create an S3 bucket</a></li>
 <li><a class="reference internal" href="#upload-the-cl-image-into-the-bucket">Upload the Clear Linux OS image into the bucket</a></li>
 <li><a class="reference internal" href="#add-a-user-to-iam-with-aws-cli-privilege">Add a user to IAM with AWS_CLI privilege</a></li>
 <li><a class="reference internal" href="#install-and-configure-the-aws-cli-tool-on-your-system">Install and configure the AWS CLI tool on your system</a></li>
 <li><a class="reference internal" href="#import-a-snapshot-of-the-cl-image">Import a snapshot of the Clear Linux OS image</a></li>
 <li><a class="reference internal" href="#create-an-ami-from-the-snapshot">Create an AMI from the snapshot</a></li>
 <li><a class="reference internal" href="#launch-an-instance">Launch an instance</a></li>
 <li><a class="reference internal" href="#connect-to-your-cl-instance">Connect to your Clear Linux OS instance</a></li>
 <li><a class="reference internal" href="#related-topics">Related topics</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="gce.html"
                          title="previous chapter">Clear Linux* OS on Google Cloud Platform*</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="qingcloud.html"
                          title="next chapter">Clear Linux* OS on QingCloud*</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/cloud-install/import-clr-aws.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="qingcloud.html" title="Clear Linux* OS on QingCloud*"
             >next</a> |</li>
        <li class="right" >
          <a href="gce.html" title="Clear Linux* OS on Google Cloud Platform*"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Import Clear Linux Image and Launch Instance on AWS</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,421 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS on QingCloud* &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/cloud-install/qingcloud.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Clear Linux* OS container images" href="../containers/container-images.html" />
    <link rel="prev" title="Import Clear Linux Image and Launch Instance on AWS" href="import-clr-aws.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../containers/container-images.html" title="Clear Linux* OS container images"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="import-clr-aws.html" title="Import Clear Linux Image and Launch Instance on AWS"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on QingCloud*</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-on-qingcloud">
 <span id="qingcloud"></span><h1>Clear Linux* OS on QingCloud*<a class="headerlink" href="#cl-attr-on-qingcloud" title="Link to this heading">¶</a></h1>
 <p>This tutorial describes how to create and launch a Clear Linux OS instance
 from the QingCloud console.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#prerequisites" id="id21">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#select-and-start-cl-virtual-host-with-qingcloud-console" id="id22">Select and start Clear Linux OS virtual host with QingCloud console</a></p></li>
 <li><p><a class="reference internal" href="#apply-for-a-public-ip-and-add-it-to-the-virtual-host" id="id23">Apply for a public IP and add it to the virtual host</a></p></li>
 <li><p><a class="reference internal" href="#connect-to-cl-virtual-host" id="id24">Connect to Clear Linux OS virtual host</a></p></li>
 <li><p><a class="reference internal" href="#remove-cl-virtual-host" id="id25">Remove Clear Linux OS virtual host</a></p></li>
 <li><p><a class="reference internal" href="#delete-the-applied-public-ip" id="id26">Delete the applied public IP</a></p></li>
 </ul>
 </nav>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id21" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <p>This tutorial assumes that you have completed the following configuration steps:</p>
 <ul class="simple">
 <li><p>Your environment can run SSH to access remote Clear Linux OS virtual hosts.</p></li>
 <li><p>You know the absolute path where the browser downloaded the file.</p></li>
 <li><p>You have set up a user account for QingCloud and that the account is
 enabled and logged in to the QingCloud console. To learn more about
 QingCloud and setting up an account, please visit QingCloud’s official
 <a class="reference external" href="https://www.qingcloud.com">website</a>.</p></li>
 </ul>
 </section>
 <section id="select-and-start-cl-virtual-host-with-qingcloud-console">
 <h2><a class="toc-backref" href="#id22" role="doc-backlink">Select and start Clear Linux OS virtual host with QingCloud console</a><a class="headerlink" href="#select-and-start-cl-virtual-host-with-qingcloud-console" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Select <span class="guilabel">计算&gt;主机</span> (Compute&gt;Host) in the main menu of the
 QingCloud console and click the <span class="guilabel">创建</span> (Create) option.</p>
 <figure class="align-default">
 <a class="reference internal image-reference" href="../../_images/QingCloud-1.png"><img alt="QingCloud console" src="../../_images/QingCloud-1.png" style="width: 960.0px; height: 515.5px;" />
 </a>
 </figure>
 </li>
 <li><p>On the host creation page, first click the <span class="guilabel">系统</span> (System) option,
 click the Clear Linux OS icon on the far right.  Click the <span class="guilabel">下一步</span> (Next)
 button to continue.</p>
 <figure class="align-default" id="id1">
 <a class="reference internal image-reference" href="../../_images/QingCloud-2.png"><img alt="Select Clear Linux OS to create virtual host" src="../../_images/QingCloud-2.png" style="width: 960.0px; height: 514.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Select Clear Linux OS to create a virtual host</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the configuration selection interface, you can configure the
 number of CPU cores, memory size, and the storage backup method.
 For demonstration purposes, we will choose the default configuration.
 Click the <span class="guilabel">下一步</span> (Next) button to go to the network settings
 interface.</p>
 <figure class="align-default" id="id2">
 <a class="reference internal image-reference" href="../../_images/QingCloud-3.png"><img alt="Configuration selection" src="../../_images/QingCloud-3.png" style="width: 960.0px; height: 514.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Configuration selection</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select <span class="guilabel">基础网络</span> (Basic Network) in the network settings
 interface.</p>
 <figure class="align-default" id="id3">
 <a class="reference internal image-reference" href="../../_images/QingCloud-4.png"><img alt="Network settings" src="../../_images/QingCloud-4.png" style="width: 959.0px; height: 513.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Network Settings</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the basic information setting interface, you need to enter the virtual
 host name and set the SSH key login method.</p></li>
 </ol>
 <section id="create-an-ssh-key-optional">
 <h3>Create an SSH key (Optional)<a class="headerlink" href="#create-an-ssh-key-optional" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p>If you haven’t created an SSH key before, click the <span class="guilabel">创建一个</span>
 (Create one) button to create an SSH key.</p>
 <figure class="align-default" id="id4">
 <a class="reference internal image-reference" href="../../_images/QingCloud-6.png"><img alt="Create SSH key" src="../../_images/QingCloud-6.png" style="width: 959.0px; height: 515.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Create SSH Key</span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the SSH key creation interface, you can fill in the key name, and select
 encryption method you prefer. After confirming that they are correct, click
 the <span class="guilabel">提交</span> (Submit) button.</p>
 <figure class="align-default" id="id5">
 <a class="reference internal image-reference" href="../../_images/QingCloud-6.png"><img alt="New SSH key" src="../../_images/QingCloud-6.png" style="width: 959.0px; height: 515.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">New SSH Key</span><a class="headerlink" href="#id5" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>After the download button appears, please download the key within 10
 minutes, and save the key locally for connecting to the virtual host later.</p>
 <figure class="align-default" id="id6">
 <a class="reference internal image-reference" href="../../_images/QingCloud-7.png"><img alt="Download SSH key" src="../../_images/QingCloud-7.png" style="width: 960.0px; height: 515.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Download SSH Key</span><a class="headerlink" href="#id6" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>After ensuring that the SSH key has been properly downloaded and saved,
 check the basic information of the virtual host. After confirming that they
 are correct, click the <span class="guilabel">创建</span> (Create) button.</p>
 <figure class="align-default" id="id7">
 <a class="reference internal image-reference" href="../../_images/QingCloud-8.png"><img alt="Confirm the information and create a virtual host" src="../../_images/QingCloud-8.png" style="width: 960.0px; height: 514.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Confirm the information and create a virtual host</span><a class="headerlink" href="#id7" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 <p>QingCloud will now create the Clear Linux OS virtual host. You
 can check the state of the virtual host in the new interface.</p>
 </section>
 </section>
 <section id="apply-for-a-public-ip-and-add-it-to-the-virtual-host">
 <h2><a class="toc-backref" href="#id23" role="doc-backlink">Apply for a public IP and add it to the virtual host</a><a class="headerlink" href="#apply-for-a-public-ip-and-add-it-to-the-virtual-host" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Since QingCloud does not automatically assign a public IP address to a
 virtual host created using the default network, we need to manually apply
 and add it to the virtual host. Click the <span class="guilabel">网络与CDN</span> (Network and
 CDN) button on the left side of the navigation bar .</p>
 <figure class="align-default" id="id8">
 <a class="reference internal image-reference" href="../../_images/QingCloud-9.png"><img alt="Network and CDN" src="../../_images/QingCloud-9.png" style="width: 960.0px; height: 515.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Network and CDN</span><a class="headerlink" href="#id8" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the network and CDN configuration interface, click the <span class="guilabel">公网IP</span>
 (Public IP) button on the left , and click the <span class="guilabel">申请</span> (Apply)
 button in the middle to create a public IP.</p>
 <figure class="align-default" id="id9">
 <a class="reference internal image-reference" href="../../_images/QingCloud-10.png"><img alt="Apply for public IP" src="../../_images/QingCloud-10.png" style="width: 960.0px; height: 516.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Apply for public IP</span><a class="headerlink" href="#id9" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <p>After clicking the apply button, a dialog will pop up. Read it
 carefully and click the <span class="guilabel">继续申请公网IP</span> (Continue to apply for
 public IP) button.</p>
 <figure class="align-default" id="id10">
 <a class="reference internal image-reference" href="../../_images/QingCloud-11.png"><img alt="Confirmation dialog" src="../../_images/QingCloud-11.png" style="width: 960.0px; height: 515.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Confirmation dialog</span><a class="headerlink" href="#id10" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>On the public network IP application page, confirm and fill in the
 relevant information, including the charging mode and bandwidth upper limit
 (the charge-by-bandwidth mode is used in this tutorial and the 2Mbps
 bandwidth limit is set). After confirming that they are correct, click
 <span class="guilabel">提交</span> (Submit) button.</p>
 <figure class="align-default" id="id11">
 <a class="reference internal image-reference" href="../../_images/QingCloud-12.png"><img alt="Confirmation of Public IP Application" src="../../_images/QingCloud-12.png" style="width: 960.0px; height: 513.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Confirmation of Public IP Application</span><a class="headerlink" href="#id11" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>After that, click the <span class="guilabel">计算&gt;网卡</span> (Compute&gt;Network Card) buttons
 in the navigation bar to come to the network card interface.</p>
 <figure class="align-default" id="id12">
 <a class="reference internal image-reference" href="../../_images/QingCloud-13.png"><img alt="NIC interface" src="../../_images/QingCloud-13.png" style="width: 960.0px; height: 514.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Network Interface</span><a class="headerlink" href="#id12" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>On the network card interface, select the network card of the Clear Linux OS host
 that you just created. Click the <span class="guilabel">更多操作</span> (More Actions)
 button above, and then click the <span class="guilabel">绑定公网IPv4</span> (Binding Public
 Network IPv4) button.</p>
 <figure class="align-default" id="id13">
 <a class="reference internal image-reference" href="../../_images/QingCloud-14.png"><img alt="Bind selected" src="../../_images/QingCloud-14.png" style="width: 960.0px; height: 513.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Bind selected</span><a class="headerlink" href="#id13" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>On the binding public network IP confirmation interface, select the public
 IP address that has just been applied for, and click the <span class="guilabel">提交</span>
 (Submit) button below . After waiting a moment, the state of the Clear Linux OS
 virtual host will change.</p>
 <figure class="align-default" id="id14">
 <a class="reference internal image-reference" href="../../_images/QingCloud-15.png"><img alt="Commit binding" src="../../_images/QingCloud-15.png" style="width: 960.0px; height: 515.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Commit binding</span><a class="headerlink" href="#id14" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <figure class="align-default" id="id15">
 <a class="reference internal image-reference" href="../../_images/QingCloud-16.png"><img alt="Public network IP binding succeeded" src="../../_images/QingCloud-16.png" style="width: 960.0px; height: 516.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Public network IP binding succeeded</span><a class="headerlink" href="#id15" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="connect-to-cl-virtual-host">
 <h2><a class="toc-backref" href="#id24" role="doc-backlink">Connect to Clear Linux OS virtual host</a><a class="headerlink" href="#connect-to-cl-virtual-host" title="Link to this heading">¶</a></h2>
 <p>Click the <span class="guilabel">计算&gt;主机</span> (Compute&gt;Host) buttons on the left side of the
 navigation bar to confirm that the current virtual host is running and has a public IP address.</p>
 <figure class="align-default" id="id16">
 <a class="reference internal image-reference" href="../../_images/QingCloud-17.png"><img alt="Confirm that the virtual host is currently in a normal state" src="../../_images/QingCloud-17.png" style="width: 960.0px; height: 514.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Confirm that the virtual host is currently in a normal state</span><a class="headerlink" href="#id16" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <ol class="arabic">
 <li><p>Copy the public IP address of the current Clear Linux OS virtual host and
 connect to it from an SSH client. Here we need to use the previously saved
 SSH key.</p></li>
 <li><p>In this tutorial, the MobaXterm client is used as an example to demonstrate
 the login process. Check each item as shown. For the user name, we choose
 <code class="docutils literal notranslate"><span class="pre">root</span></code>. For the key, select the SSH key that was downloaded and saved to
 the local computer .</p>
 <figure class="align-default" id="id17">
 <a class="reference internal image-reference" href="../../_images/QingCloud-18.png"><img alt="SSH login virtual host settings" src="../../_images/QingCloud-18.png" style="width: 960.0px; height: 500.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">SSH login virtual host settings</span><a class="headerlink" href="#id17" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Login</span> to log in to the
 Clear Linux OS virtual host after completing the setup process.</p>
 <figure class="align-default" id="id18">
 <a class="reference internal image-reference" href="../../_images/QingCloud-19.png"><img alt="SSH login successful" src="../../_images/QingCloud-19.png" style="width: 959.5px; height: 501.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">SSH login successful</span><a class="headerlink" href="#id18" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="remove-cl-virtual-host">
 <h2><a class="toc-backref" href="#id25" role="doc-backlink">Remove Clear Linux OS virtual host</a><a class="headerlink" href="#remove-cl-virtual-host" title="Link to this heading">¶</a></h2>
 <p>This section explains how to delete a Clear Linux OS virtual host created on QingCloud.</p>
 <p>On the left navigation bar select <span class="guilabel">计算&gt;主机</span> (Compute&gt;Master), find
 the Clear Linux OS host you just created, and click the checkbox next to it. Select
 <span class="guilabel">更多操作&gt;删除</span> (More Actions&gt;Delete) to delete the virtual host.</p>
 <figure class="align-default" id="id19">
 <a class="reference internal image-reference" href="../../_images/QingCloud-20.png"><img alt="Remove Clear Linux OS Virtual Host" src="../../_images/QingCloud-20.png" style="width: 960.0px; height: 516.5px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Remove Clear Linux OS Virtual Host</span><a class="headerlink" href="#id19" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </section>
 <section id="delete-the-applied-public-ip">
 <h2><a class="toc-backref" href="#id26" role="doc-backlink">Delete the applied public IP</a><a class="headerlink" href="#delete-the-applied-public-ip" title="Link to this heading">¶</a></h2>
 <p>Select <span class="guilabel">网络与CDN&gt;公网IP</span> (Network and CDN&gt;Public IP) from the
 navigation bar on the left , and then find the public IP address just applied.
 Select it as shown, then click <span class="guilabel">更多操作&gt;删除</span> (More Actions&gt;Delete)
 to delete.</p>
 <figure class="align-default" id="id20">
 <a class="reference internal image-reference" href="../../_images/QingCloud-21.png"><img alt="Delete public network IP address" src="../../_images/QingCloud-21.png" style="width: 956.0px; height: 517.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Delete public network IP address</span><a class="headerlink" href="#id20" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS on QingCloud*</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#select-and-start-cl-virtual-host-with-qingcloud-console">Select and start Clear Linux OS virtual host with QingCloud console</a><ul>
 <li><a class="reference internal" href="#create-an-ssh-key-optional">Create an SSH key (Optional)</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#apply-for-a-public-ip-and-add-it-to-the-virtual-host">Apply for a public IP and add it to the virtual host</a></li>
 <li><a class="reference internal" href="#connect-to-cl-virtual-host">Connect to Clear Linux OS virtual host</a></li>
 <li><a class="reference internal" href="#remove-cl-virtual-host">Remove Clear Linux OS virtual host</a></li>
 <li><a class="reference internal" href="#delete-the-applied-public-ip">Delete the applied public IP</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="import-clr-aws.html"
                          title="previous chapter">Import Clear Linux Image and Launch Instance on AWS</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="../containers/container-images.html"
                          title="next chapter">Clear Linux* OS container images</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/cloud-install/qingcloud.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../containers/container-images.html" title="Clear Linux* OS container images"
             >next</a> |</li>
        <li class="right" >
          <a href="import-clr-aws.html" title="Import Clear Linux Image and Launch Instance on AWS"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on QingCloud*</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,226 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Check Processor Compatibility &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/compatibility-check.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Create a bootable USB drive using Etcher*" href="bootable-usb.html" />
    <link rel="prev" title="Get started" href="index.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="bootable-usb.html" title="Create a bootable USB drive using Etcher*"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Get started"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Check Processor Compatibility</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="check-processor-compatibility">
 <span id="compatibility-check"></span><h1>Check Processor Compatibility<a class="headerlink" href="#check-processor-compatibility" title="Link to this heading">¶</a></h1>
 <p>Before installing Clear Linux* OS, check your host system’s processor compatibility using one of
 the following options:</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>This does not check other system components (for example: storage and
 graphics) for compatibility with Clear Linux OS.</p>
 </div>
 <section id="option-1-use-the-clear-linux-check-config-sh-script-on-an-existing-linux-system">
 <h2>Option 1: Use the <strong class="command">clear-linux-check-config.sh</strong> script on an existing Linux system<a class="headerlink" href="#option-1-use-the-clear-linux-check-config-sh-script-on-an-existing-linux-system" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Download the <a class="reference external" href="https://cdn.download.clearlinux.org/current/clear-linux-check-config.sh">clear-linux-check-config.sh</a> file.</p>
 <p>If a browser is not available, use:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/current/clear-linux-check-config.sh
 </pre></div>
 </div>
 </li>
 <li><p>Make the script executable.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>chmod<span class="w"> </span>+x<span class="w"> </span>clear-linux-check-config.sh
 </pre></div>
 </div>
 </li>
 <li><p>Run the script.</p>
 <ol class="arabic">
 <li><p>Check to see if the host’s processor is capable of running Clear Linux OS.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./clear-linux-check-config.sh<span class="w"> </span>host
 </pre></div>
 </div>
 </li>
 <li><p>Check to see if the host is capable of running Clear Linux OS in a container.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./clear-linux-check-config.sh<span class="w"> </span>container
 </pre></div>
 </div>
 </li>
 </ol>
 <p>The script prints a list of test results similar to the output below.
 All items should return a <cite>SUCCESS</cite> status. This example indicates the
 host’s processor supports running Clear Linux OS.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">Checking if host is capable of running Clear Linux* OS</span>
 <span class="go">SUCCESS: 64-bit CPU (lm)</span>
 <span class="go">SUCCESS: Supplemental Streaming SIMD Extensions 3 (ssse3)</span>
 <span class="go">SUCCESS: Streaming SIMD Extension v4.1 (sse4_1)</span>
 <span class="go">SUCCESS: Streaming SIMD Extensions v4.2 (sse4_2)</span>
 <span class="go">SUCCESS: Carry-less Multiplication extensions (pclmulqdq)</span>
 </pre></div>
 </div>
 </li>
 </ol>
 <section id="option-2-use-a-cl-live-image-on-a-non-linux-system">
 <h3>Option 2: Use a Clear Linux OS live image on a non-Linux system<a class="headerlink" href="#option-2-use-a-cl-live-image-on-a-non-linux-system" title="Link to this heading">¶</a></h3>
 <ol class="arabic">
 <li><p><a class="reference external" href="https://clearlinux.org/downloads">Download</a> either the <cite>Desktop</cite> or <cite>Server</cite> version of the live image ISO.</p></li>
 <li><p>Follow the instruction to <a class="reference internal" href="bootable-usb.html#bootable-usb"><span class="std std-ref">Create a bootable USB drive using Etcher*</span></a>.</p></li>
 <li><p>Boot up the Clear Linux OS live image on the USB.</p></li>
 <li><p>Check compatibility as follows:</p>
 <ul>
 <li><p><em>Desktop version:</em></p>
 <ol class="loweralpha">
 <li><p>Open a terminal.</p></li>
 <li><p>Check compatibility.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>clr-installer<span class="w"> </span>--system-check
 </pre></div>
 </div>
 </li>
 </ol>
 </li>
 <li><p><em>Server version:</em></p>
 <ol class="loweralpha">
 <li><p>Log in as <cite>root</cite> and set a password.</p></li>
 <li><p>Check compatibility.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>clr-installer<span class="w"> </span>--system-check
 </pre></div>
 </div>
 </li>
 </ol>
 </li>
 </ul>
 <p>Expected output for a compatible host processor:</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">Checking for required CPU feature: lm [success]</span>
 <span class="go">Checking for required CPU feature: sse4_2 [success]</span>
 <span class="go">Checking for required CPU feature: sse4_1 [success]</span>
 <span class="go">Checking for required CPU feature: pclmulqdq [success]</span>
 <span class="go">Checking for required CPU feature: ssse3 [success]</span>
 <span class="go">Success: System is compatible</span>
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Check Processor Compatibility</a><ul>
 <li><a class="reference internal" href="#option-1-use-the-clear-linux-check-config-sh-script-on-an-existing-linux-system">Option 1: Use the <strong class="command">clear-linux-check-config.sh</strong> script on an existing Linux system</a><ul>
 <li><a class="reference internal" href="#option-2-use-a-cl-live-image-on-a-non-linux-system">Option 2: Use a Clear Linux OS live image on a non-Linux system</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="index.html"
                          title="previous chapter">Get started</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="bootable-usb.html"
                          title="next chapter">Create a bootable USB drive using Etcher*</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/get-started/compatibility-check.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="bootable-usb.html" title="Create a bootable USB drive using Etcher*"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Get started"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Check Processor Compatibility</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,201 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS container images &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/containers/container-images.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="About" href="../../about.html" />
    <link rel="prev" title="Clear Linux* OS on QingCloud*" href="../cloud-install/qingcloud.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../about.html" title="About"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../cloud-install/qingcloud.html" title="Clear Linux* OS on QingCloud*"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS container images</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-container-images">
 <span id="container-images"></span><h1>Clear Linux* OS container images<a class="headerlink" href="#cl-attr-container-images" title="Link to this heading">¶</a></h1>
 <p>Clear Linux OS can run inside of a container on top of any operating system as long as
 it is hosting a containerized environment, such as Docker* or Kubernetes*. A
 Clear Linux OS base image is available for standalone use as well as variations of
 popular application images built from the Clear Linux OS base image.</p>
 <p>Browse all Clear Linux OS container images on <a class="reference external" href="https://hub.docker.com/search?q=clearlinux&amp;type=image">the Docker Hub* website</a>. Find the
 Dockerfiles used to build Clear Linux OS container images <a class="reference external" href="https://github.com/clearlinux/dockerfiles">on GitHub</a>.</p>
 <p>See the <a class="reference external" href="https://clearlinux.org/downloads/containers">containers</a> page for
 the benefits of using Clear Linux OS containers and using Clear Linux OS as a container host.</p>
 <section id="container-image-types">
 <h2>Container image types<a class="headerlink" href="#container-image-types" title="Link to this heading">¶</a></h2>
 <section id="cl-base-image">
 <h3>Clear Linux OS base image<a class="headerlink" href="#cl-base-image" title="Link to this heading">¶</a></h3>
 <p>The <a class="reference external" href="https://hub.docker.com/_/clearlinux">Clear Linux OS base container</a> is
 an official image on Docker Hub*. The Clear Linux OS base container image can be used to
 run a standalone or as a <a class="reference external" href="https://docs.docker.com/glossary/#parent_image">parent image</a> for building other
 container images.</p>
 <p>On a Docker host simply use the command <strong class="command">docker run clearlinux</strong> to
 pull and start a Clear Linux OS container.</p>
 </section>
 <section id="cl-based-runtime-images">
 <h3>Clear Linux OS-based runtime images<a class="headerlink" href="#cl-based-runtime-images" title="Link to this heading">¶</a></h3>
 <p>Clear Linux OS container images for programming languages and their runtimes are
 available on Docker Hub*. These can be used by developers to create and run
 applications using these popular runtimes.</p>
 <p>Below are some popular Clear Linux OS-based runtime images:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/golang">clearlinux/golang</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/node">clearlinux/node</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/numpy">clearlinux/numpy</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/python">clearlinux/python</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/perl">clearlinux/perl</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/r-base">clearlinux/r-base</a></p></li>
 </ul>
 <p>More Clear Linux OS-based images can be found on Docker Hub:
 <a class="reference external" href="https://hub.docker.com/u/clearlinux">https://hub.docker.com/u/clearlinux</a>.</p>
 </section>
 <section id="cl-based-application-images">
 <h3>Clear Linux OS-based application images<a class="headerlink" href="#cl-based-application-images" title="Link to this heading">¶</a></h3>
 <p>Clear Linux OS container images for common applications are available on Docker Hub.
 These can be used to create and deploy containerized services.</p>
 <p>Below are some popular Clear Linux OS-based runtime images:</p>
 <ul class="simple">
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/nginx">clearlinux/nginx</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/mariadb">clearlinux/mariadb</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/postgres">clearlinux/postgres</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/redis">clearlinux/redis</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/tensorflow">clearlinux/tensorflow</a></p></li>
 <li><p><a class="reference external" href="https://hub.docker.com/r/clearlinux/wordpress">clearlinux/wordpress</a></p></li>
 </ul>
 <p>More Clear Linux OS-based images can be found on Docker Hub:
 <a class="reference external" href="https://hub.docker.com/u/clearlinux">https://hub.docker.com/u/clearlinux</a>.</p>
 </section>
 <section id="related-topics">
 <h3>Related topics<a class="headerlink" href="#related-topics" title="Link to this heading">¶</a></h3>
 <ul class="simple">
 <li><p><a class="reference internal" href="../../guides/maintenance/container-image-new.html#container-image-new"><span class="std std-ref">Build a new Clear Linux OS-based container image</span></a></p></li>
 <li><p><a class="reference internal" href="../../guides/maintenance/container-image-modify.html#container-image-modify"><span class="std std-ref">Modify a Clear Linux OS-based container image</span></a></p></li>
 <li><p><a class="reference internal" href="../../tutorials/docker.html#docker"><span class="std std-ref">Docker*</span></a></p></li>
 <li><p><a class="reference internal" href="../../tutorials/kata.html#kata"><span class="std std-ref">Kata Containers*</span></a></p></li>
 </ul>
 </section>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS container images</a><ul>
 <li><a class="reference internal" href="#container-image-types">Container image types</a><ul>
 <li><a class="reference internal" href="#cl-base-image">Clear Linux OS base image</a></li>
 <li><a class="reference internal" href="#cl-based-runtime-images">Clear Linux OS-based runtime images</a></li>
 <li><a class="reference internal" href="#cl-based-application-images">Clear Linux OS-based application images</a></li>
 <li><a class="reference internal" href="#related-topics">Related topics</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="../cloud-install/qingcloud.html"
                          title="previous chapter">Clear Linux* OS on QingCloud*</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="../../about.html"
                          title="next chapter">About</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/containers/container-images.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../about.html" title="About"
             >next</a> |</li>
        <li class="right" >
          <a href="../cloud-install/qingcloud.html" title="Clear Linux* OS on QingCloud*"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS container images</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,201 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Get started &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/index.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Check Processor Compatibility" href="compatibility-check.html" />
    <link rel="prev" title="Clear Linux* Project Documentation" href="../index.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="compatibility-check.html" title="Check Processor Compatibility"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../index.html" title="Clear Linux* Project Documentation"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Get started</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="get-started">
 <span id="id1"></span><h1>Get started<a class="headerlink" href="#get-started" title="Link to this heading">¶</a></h1>
 <p>The Get Started section guides you through the requirements and installation
 of Clear Linux* OS. Follow these step-by-step instructions to get started with Clear Linux OS,
 fast.</p>
 <section id="pre-install">
 <h2>Pre-install<a class="headerlink" href="#pre-install" title="Link to this heading">¶</a></h2>
 <p>There are a couple of things to take care of before you install.</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="../reference/system-requirements.html#system-requirements"><span class="std std-ref">Recommended minimum system requirements</span></a></p></li>
 <li><p><a class="reference internal" href="compatibility-check.html#compatibility-check"><span class="std std-ref">Check Processor Compatibility</span></a></p></li>
 <li><p><a class="reference internal" href="bootable-usb.html#bootable-usb"><span class="std std-ref">Create a bootable USB drive using Etcher*</span></a></p></li>
 </ul>
 <p>When installing Clear Linux* OS in a VM, consider which kernel to use.</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="../guides/clear/compatible-kernels.html#vm-kernels"><span class="std std-ref">Compatible VM kernels</span></a></p></li>
 </ul>
 <div class="toctree-wrapper compound">
 </div>
 </section>
 <section id="install">
 <h2>Install<a class="headerlink" href="#install" title="Link to this heading">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="bare-metal-install-desktop.html">Install Clear Linux* OS from the live desktop</a></li>
 <li class="toctree-l1"><a class="reference internal" href="bare-metal-install-server.html">Install Clear Linux* OS from the live server</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install-configfile.html">Install using clr-installer and a configuration file</a></li>
 <li class="toctree-l1"><a class="reference internal" href="ipxe-install.html">Install Clear Linux OS Over the Network with iPXE</a></li>
 </ul>
 </div>
 </section>
 <section id="install-in-a-virtual-machine">
 <span id="virtual-machine-install"></span><h2>Install in a virtual machine<a class="headerlink" href="#install-in-a-virtual-machine" title="Link to this heading">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="virtual-machine-install/hyper-v.html">Clear Linux* OS on Microsoft Hyper-V*</a></li>
 <li class="toctree-l1"><a class="reference internal" href="virtual-machine-install/kvm.html">Clear Linux* OS on KVM</a></li>
 <li class="toctree-l1"><a class="reference internal" href="virtual-machine-install/parallels.html">Clear Linux* OS on Parallels* Desktop for Mac*</a></li>
 <li class="toctree-l1"><a class="reference internal" href="virtual-machine-install/proxmox.html">Clear Linux* OS on Proxmox* Virtual Environment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="virtual-machine-install/virt-manager.html">Clear Linux* OS using virt-manager</a></li>
 <li class="toctree-l1"><a class="reference internal" href="virtual-machine-install/virtualbox-cl-installer.html">Clear Linux* OS on VirtualBox*</a></li>
 <li class="toctree-l1"><a class="reference internal" href="virtual-machine-install/vmw-player.html">Clear Linux* OS on VMware* Workstation Player</a></li>
 <li class="toctree-l1"><a class="reference internal" href="virtual-machine-install/vmware-esxi-install-cl.html">Clear Linux* OS on VMware* ESXi</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../guides/maintenance/increase-virtual-disk-size.html">Increase Virtual Disk Size of an Image</a></li>
 </ul>
 </div>
 </section>
 <section id="deploy-to-the-cloud">
 <h2>Deploy to the cloud<a class="headerlink" href="#deploy-to-the-cloud" title="Link to this heading">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="cloud-install/aws-web.html">Clear Linux* OS on Amazon Web Services*</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cloud-install/azure.html">Clear Linux* OS on Microsoft* Azure*</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cloud-install/digitalocean.html">Clear Linux* OS on DigitalOcean*</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cloud-install/gce.html">Clear Linux* OS on Google Cloud Platform*</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cloud-install/import-clr-aws.html">Import Clear Linux Image and Launch Instance on AWS</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cloud-install/qingcloud.html">Clear Linux* OS on QingCloud*</a></li>
 </ul>
 </div>
 </section>
 <section id="containers">
 <h2>Containers<a class="headerlink" href="#containers" title="Link to this heading">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="containers/container-images.html">Clear Linux* OS container images</a></li>
 </ul>
 </div>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Get started</a><ul>
 <li><a class="reference internal" href="#pre-install">Pre-install</a></li>
 <li><a class="reference internal" href="#install">Install</a></li>
 <li><a class="reference internal" href="#install-in-a-virtual-machine">Install in a virtual machine</a></li>
 <li><a class="reference internal" href="#deploy-to-the-cloud">Deploy to the cloud</a></li>
 <li><a class="reference internal" href="#containers">Containers</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="../index.html"
                          title="previous chapter">Clear Linux* Project Documentation</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="compatibility-check.html"
                          title="next chapter">Check Processor Compatibility</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/get-started/index.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="compatibility-check.html" title="Check Processor Compatibility"
             >next</a> |</li>
        <li class="right" >
          <a href="../index.html" title="Clear Linux* Project Documentation"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Get started</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,313 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Install using clr-installer and a configuration file &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/install-configfile.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Install Clear Linux OS Over the Network with iPXE" href="ipxe-install.html" />
    <link rel="prev" title="Install Clear Linux* OS from the live server" href="bare-metal-install-server.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="ipxe-install.html" title="Install Clear Linux OS Over the Network with iPXE"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="bare-metal-install-server.html" title="Install Clear Linux* OS from the live server"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Install using clr-installer and a configuration file</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="install-using-clr-installer-and-a-configuration-file">
 <span id="install-configfile"></span><h1>Install using clr-installer and a configuration file<a class="headerlink" href="#install-using-clr-installer-and-a-configuration-file" title="Link to this heading">¶</a></h1>
 <p>In addition to the interactive GUI and text-based modes,
 <strong class="command">clr-installer</strong> also supports an unattended mode where you
 simply provide it a YAML configuration file.</p>
 <p>This guide shows you two examples of how to use its unattended mode.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#prerequisites" id="id1">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#download-and-make-bootable-usb-of-the-live-server-image" id="id2">Download and make bootable USB of the live server image</a></p></li>
 <li><p><a class="reference internal" href="#example-1-fresh-installation-onto-bare-metal" id="id3">Example 1: Fresh installation onto bare metal</a></p></li>
 <li><p><a class="reference internal" href="#example-2-replicate-a-previous-installation" id="id4">Example 2: Replicate a previous installation</a></p></li>
 <li><p><a class="reference internal" href="#references" id="id5">References</a></p></li>
 </ul>
 </nav>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id1" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <p>For installation onto bare metal, ensure that your target system
 supports these requirements:</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="../reference/system-requirements.html#system-requirements"><span class="std std-ref">Recommended minimum system requirements</span></a></p></li>
 <li><p><a class="reference internal" href="compatibility-check.html#compatibility-check"><span class="std std-ref">Check Processor Compatibility</span></a></p></li>
 </ul>
 </section>
 <section id="download-and-make-bootable-usb-of-the-live-server-image">
 <h2><a class="toc-backref" href="#id2" role="doc-backlink">Download and make bootable USB of the live server image</a><a class="headerlink" href="#download-and-make-bootable-usb-of-the-live-server-image" title="Link to this heading">¶</a></h2>
 <p>See <a class="reference internal" href="bootable-usb.html#bootable-usb"><span class="std std-ref">Create a bootable USB drive using Etcher*</span></a>.</p>
 </section>
 <section id="example-1-fresh-installation-onto-bare-metal">
 <h2><a class="toc-backref" href="#id3" role="doc-backlink">Example 1: Fresh installation onto bare metal</a><a class="headerlink" href="#example-1-fresh-installation-onto-bare-metal" title="Link to this heading">¶</a></h2>
 <p>This example uses a YAML configuration file to perform a new installation.</p>
 <ol class="arabic">
 <li><p>Boot up the Clear Linux OS Live Server USB thumb drive.</p></li>
 <li><p>Select <span class="guilabel">Clear Linux OS</span> from the menu.</p></li>
 <li><p>In the console window, log in as <cite>root</cite> and set a password.</p></li>
 <li><p>Verify you have a network connection to the Internet and configure proxy
 settings if you’re working behind a firewall.</p></li>
 <li><p>Download a sample YAML configuration file. For example, if you want to
 install Clear Linux OS with a desktop GUI, you might want to use <code class="file docutils literal notranslate"><span class="pre">live-desktop.yaml</span></code>.
 Or you can use the <code class="file docutils literal notranslate"><span class="pre">live-server.yaml</span></code> if you want to install a non-GUI version
 of Clear Linux OS.</p>
 <ul>
 <li><p><em>Desktop:</em></p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/current/config/image/live-desktop.yaml
 </pre></div>
 </div>
 </li>
 <li><p><em>Server:</em></p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/current/config/image/live-server.yaml
 </pre></div>
 </div>
 </li>
 </ul>
 </li>
 <li><p>Edit the YAML configuration file and change the settings as needed.</p>
 <p>Commonly-changed settings include (refer to the example below):</p>
 <ol class="loweralpha simple">
 <li><p>Under <em>block-devices</em> (line 15), set your target media.  For example: <code class="docutils literal notranslate"><span class="pre">file:</span> <span class="pre">&quot;/dev/sda&quot;</span></code>.</p></li>
 <li><p>Under <em>targetMedia</em> (line 34), set the third partition size to “0” to use the entire disk space.</p></li>
 <li><p>Under <em>bundles</em> (line 37), add additional bundles as needed.</p></li>
 <li><p>Delete the <em>post-install</em> section unless you have post-installation scripts.</p></li>
 <li><p>Under <em>Version</em> (line 50), set a version number. To use the latest version, set to “0”.</p></li>
 </ol>
 <p>See <a class="reference external" href="https://github.com/clearlinux/clr-installer/blob/master/scripts/InstallerYAMLSyntax.md">Installer YAML Syntax</a> for more details.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="gp">          #</span>clear-linux-config
 <span class="linenos"> 2</span>
 <span class="linenos"> 3</span><span class="gp">          # </span>c-basic-offset:<span class="w"> </span><span class="m">2</span><span class="p">;</span><span class="w"> </span>tab-width:<span class="w"> </span><span class="m">2</span><span class="p">;</span><span class="w"> </span>indent-tabs-mode:<span class="w"> </span>nil
 <span class="linenos"> 4</span><span class="gp">          # </span>vi:<span class="w"> </span><span class="nb">set</span><span class="w"> </span><span class="nv">shiftwidth</span><span class="o">=</span><span class="m">2</span><span class="w"> </span><span class="nv">tabstop</span><span class="o">=</span><span class="m">2</span><span class="w"> </span>expandtab:
 <span class="linenos"> 5</span><span class="gp">          # </span>:indentSize<span class="o">=</span><span class="m">2</span>:tabSize<span class="o">=</span><span class="m">2</span>:noTabs<span class="o">=</span>true:
 <span class="linenos"> 6</span>
 <span class="linenos"> 7</span><span class="gp">          # </span>File:<span class="w">         </span>developer-live-server.yaml
 <span class="linenos"> 8</span><span class="gp">          # </span>Use<span class="w"> </span>Case:<span class="w">     </span>Live<span class="w"> </span>Image<span class="w"> </span>which<span class="w"> </span>boots<span class="w"> </span>into<span class="w"> </span>login<span class="w"> </span>prompt
 <span class="linenos"> 9</span><span class="gp">          #               </span>Optionally<span class="w"> </span>allows<span class="w"> </span><span class="k">for</span><span class="w"> </span>installing<span class="w"> </span>Clear<span class="w"> </span>Linux<span class="w"> </span>OS
 <span class="linenos">10</span><span class="gp">          #               </span>using<span class="w"> </span>the<span class="w"> </span>TUI<span class="w"> </span>clr-installer<span class="w"> </span>by<span class="w"> </span>running<span class="w"> </span>clr-installer
 <span class="linenos">11</span>
 <span class="linenos">12</span><span class="gp">          # </span>switch<span class="w"> </span>between<span class="w"> </span>aliases<span class="w"> </span><span class="k">if</span><span class="w"> </span>you<span class="w"> </span>want<span class="w"> </span>to<span class="w"> </span>install<span class="w"> </span>to<span class="w"> </span>an<span class="w"> </span>actual<span class="w"> </span>block<span class="w"> </span>device
 <span class="linenos">13</span><span class="gp">          # </span>i.e<span class="w"> </span>/dev/sda
 <span class="hll"><span class="linenos">14</span><span class="go">          block-devices: [</span>
 </span><span class="hll"><span class="linenos">15</span><span class="go">             {name: &quot;bdevice&quot;, file: &quot;/dev/sda&quot;}</span>
 </span><span class="linenos">16</span><span class="go">          ]</span>
 <span class="linenos">17</span>
 <span class="linenos">18</span><span class="go">          targetMedia:</span>
 <span class="linenos">19</span><span class="go">          - name: ${bdevice}</span>
 <span class="linenos">20</span><span class="go">            type: disk</span>
 <span class="linenos">21</span><span class="go">            children:</span>
 <span class="linenos">22</span><span class="go">            - name: ${bdevice}1</span>
 <span class="linenos">23</span><span class="go">              fstype: vfat</span>
 <span class="linenos">24</span><span class="go">              mountpoint: /boot</span>
 <span class="linenos">25</span><span class="go">              size: &quot;150M&quot;</span>
 <span class="linenos">26</span><span class="go">              type: part</span>
 <span class="linenos">27</span><span class="go">            - name: ${bdevice}2</span>
 <span class="linenos">28</span><span class="go">              fstype: swap</span>
 <span class="linenos">29</span><span class="go">              size: &quot;32M&quot;</span>
 <span class="linenos">30</span><span class="go">              type: part</span>
 <span class="linenos">31</span><span class="go">            - name: ${bdevice}3</span>
 <span class="linenos">32</span><span class="go">              fstype: ext4</span>
 <span class="linenos">33</span><span class="go">              mountpoint: /</span>
 <span class="hll"><span class="linenos">34</span><span class="go">              size: &quot;0&quot;</span>
 </span><span class="linenos">35</span><span class="go">              type: part</span>
 <span class="linenos">36</span>
 <span class="hll"><span class="linenos">37</span><span class="go">          bundles: [os-core, os-core-update, NetworkManager, clr-installer, vim]</span>
 </span><span class="linenos">38</span>
 <span class="linenos">39</span><span class="go">          autoUpdate: false</span>
 <span class="linenos">40</span><span class="go">          postArchive: false</span>
 <span class="linenos">41</span><span class="go">          postReboot: false</span>
 <span class="linenos">42</span><span class="go">          telemetry: false</span>
 <span class="linenos">43</span><span class="go">          iso: true</span>
 <span class="linenos">44</span><span class="go">          keepImage: true</span>
 <span class="linenos">45</span>
 <span class="linenos">46</span><span class="go">          keyboard: us</span>
 <span class="linenos">47</span><span class="go">          language: en_US.UTF-8</span>
 <span class="linenos">48</span><span class="go">          kernel: kernel-native</span>
 <span class="linenos">49</span>
 <span class="hll"><span class="linenos">50</span><span class="go">          version: 30010</span>
 </span></pre></div>
 </div>
 </li>
 <li><p>Start the unattended installation using the <cite>–config</cite> option.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>clr-installer<span class="w"> </span>--config<span class="w"> </span>live-server.yaml
 </pre></div>
 </div>
 </li>
 <li><p>Reboot your system after installation is completed.</p></li>
 </ol>
 </section>
 <section id="example-2-replicate-a-previous-installation">
 <h2><a class="toc-backref" href="#id4" role="doc-backlink">Example 2: Replicate a previous installation</a><a class="headerlink" href="#example-2-replicate-a-previous-installation" title="Link to this heading">¶</a></h2>
 <p>This example uses a saved configuration file from a previous installation,
 which you can use to easily clone the installation on additional machines
 , ideally with the same hardware configuration.</p>
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
 <p>Be aware of the following when applying a saved configuration on a new machine:</p>
 <ul class="simple">
 <li><p>Make sure the target media on the new machine matches up</p></li>
 <li><p>The users’ credentials will be replicated as well</p></li>
 </ul>
 </div>
 <ol class="arabic">
 <li><p>On a system where Clear Linux OS was installed, open a terminal window.</p></li>
 <li><p>Get root privilege.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>su
 </pre></div>
 </div>
 </li>
 <li><p>Copy the <code class="file docutils literal notranslate"><span class="pre">clr-installer.yaml</span></code> from <code class="file docutils literal notranslate"><span class="pre">/root</span></code> to a USB thumb drive.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cp<span class="w"> </span>/root/clr-installer.yaml<span class="w"> </span>&lt;USB-thumb-drive&gt;
 </pre></div>
 </div>
 </li>
 <li><p>Install on target system.</p>
 <ol class="loweralpha">
 <li><p>Boot up the Clear Linux OS Live Server USB thumb drive.</p></li>
 <li><p>Select <span class="guilabel">Clear Linux OS</span> from the menu.</p></li>
 <li><p>In the console window, log in as <cite>root</cite> and set a password.</p></li>
 <li><p>Verify you have a network connection to the Internet and configure proxy
 settings if you’re working behind a firewall.</p></li>
 <li><p>Plug in and mount the USB thumb drive containing the retrieved
 <code class="file docutils literal notranslate"><span class="pre">clr-installer.yaml</span></code> configuration file.</p></li>
 <li><p>Doublecheck to make sure the target media in the saved configuration file
 matches with the target system’s.</p></li>
 <li><p>Start the installation.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>clr-installer<span class="w"> </span>--config<span class="w"> </span>clr-installer.yaml
 </pre></div>
 </div>
 </li>
 <li><p>Reboot your system after installation is completed.</p></li>
 </ol>
 </li>
 </ol>
 </section>
 <section id="references">
 <h2><a class="toc-backref" href="#id5" role="doc-backlink">References</a><a class="headerlink" href="#references" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p><a class="reference external" href="https://github.com/clearlinux/clr-installer">Clear Linux Installer</a></p></li>
 <li><p><a class="reference external" href="https://github.com/clearlinux/clr-installer/blob/master/scripts/InstallerYAMLSyntax.md">Installer YAML Syntax</a></p></li>
 </ul>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Install using clr-installer and a configuration file</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#download-and-make-bootable-usb-of-the-live-server-image">Download and make bootable USB of the live server image</a></li>
 <li><a class="reference internal" href="#example-1-fresh-installation-onto-bare-metal">Example 1: Fresh installation onto bare metal</a></li>
 <li><a class="reference internal" href="#example-2-replicate-a-previous-installation">Example 2: Replicate a previous installation</a></li>
 <li><a class="reference internal" href="#references">References</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="bare-metal-install-server.html"
                          title="previous chapter">Install Clear Linux* OS from the live server</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="ipxe-install.html"
                          title="next chapter">Install Clear Linux OS Over the Network with iPXE</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/get-started/install-configfile.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="ipxe-install.html" title="Install Clear Linux OS Over the Network with iPXE"
             >next</a> |</li>
        <li class="right" >
          <a href="bare-metal-install-server.html" title="Install Clear Linux* OS from the live server"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Install using clr-installer and a configuration file</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,703 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Install Clear Linux OS Over the Network with iPXE &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <script src="../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=a56c686a"></script>
    <script src="../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/ipxe-install.html" />
    <link rel="icon" href="../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../about.html" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Clear Linux* OS on Microsoft Hyper-V*" href="virtual-machine-install/hyper-v.html" />
    <link rel="prev" title="Install using clr-installer and a configuration file" href="install-configfile.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="virtual-machine-install/hyper-v.html" title="Clear Linux* OS on Microsoft Hyper-V*"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="install-configfile.html" title="Install using clr-installer and a configuration file"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Install Clear Linux OS Over the Network with iPXE</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="install-cl-over-the-network-with-ipxe">
 <span id="ipxe-install"></span><h1>Install Clear Linux OS Over the Network with iPXE<a class="headerlink" href="#install-cl-over-the-network-with-ipxe" title="Link to this heading">¶</a></h1>
 <p>PXE <abbr title="Pre-boot Execution Environment">PXE</abbr> is an industry standard
 that describes client-server interaction with network-boot software and
 uses the DHCP and TFTP protocols. iPXE, a fork of gPXE, is an open-source
 version of PXE. It enables computers without built-in PXE capability to
 network-boot using protocols such as HTTP, <abbr title="Internet Small Computer Systems Interface">iSCSI</abbr>, <abbr title="ATA over Ethernet*">AoE</abbr>, and
 <abbr title="Fiber Channel over Ethernet*">FCoE</abbr>.</p>
 <p>This guide demonstrates how to setup an iPXE server to install Clear Linux* OS
 over the network.</p>
 <p>Figure 1 depicts the flow of information between an iPXE server and a
 PXE client.</p>
 <figure class="align-default" id="id1">
 <img alt="PXE information flow" src="../_images/ipxe-install-1.png" />
 <figcaption>
 <p><span class="caption-text">Figure 1: PXE information flow</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <div class="admonition caution">
 <p class="admonition-title">Caution</p>
 <p>The Clear Linux OS PXE image that boots through the iPXE process automatically
 erases all data and partitions on the PXE client system and performs
 a fresh installation according to a clr-installer YAML configuration
 file.</p>
 </div>
 <section id="prerequisites">
 <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <p>Your iPXE server must have:</p>
 <ul class="simple">
 <li><p>Ethernet/LAN boot option</p></li>
 <li><p>At least two network adapters</p></li>
 <li><p>Connection to a public (WAN) network</p></li>
 <li><p>Secure Boot option disabled in BIOS</p></li>
 </ul>
 <p>Your clients must have:</p>
 <ul class="simple">
 <li><p>Ethernet/LAN boot option</p></li>
 <li><p>One network adapter</p></li>
 <li><p>Secure Boot option disabled in BIOS</p></li>
 <li><p>The minimum requirements to run Clear Linux OS. Review the <a class="reference internal" href="compatibility-check.html#compatibility-check"><span class="std std-ref">Check Processor Compatibility</span></a>.</p></li>
 </ul>
 <p>Connect the iPXE server and clients to a network switch on a private
 (LAN) network, as shown in Figure 2.</p>
 <figure class="align-default" id="id2">
 <img alt="Network topology" src="../_images/ipxe-install-2.png" />
 <figcaption>
 <p><span class="caption-text">Figure 2: Network topology</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </section>
 <section id="install-cl-on-server">
 <h2>Install Clear Linux OS on server<a class="headerlink" href="#install-cl-on-server" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Install Clear Linux OS on the system that will serve as the iPXE server.
 We recommend using the <cite>server</cite> version.</p></li>
 <li><p>Open a terminal window.</p></li>
 <li><p>Add the <strong class="command">pxe-server</strong> bundle to your Clear Linux OS system.
 The bundle contains all the necessary apps (web server, iPXE firmwares,
 dnsmasq which provides TFTP, DNS, DHCP functionalities) to run an
 iPXE server.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>swupd<span class="w"> </span>bundle-add<span class="w"> </span>pxe-server
 </pre></div>
 </div>
 </li>
 <li><p>Define the following variables used for setting up the iPXE server.
 Be sure to substitute the value for the WAN_INTERFACE and
 LAN_INTERFACE variables with your LAN and WAN interfaces names.
 Use <strong class="command">ip a</strong> to list your network devices and get their
 names.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">IPXE_APP_NAME</span><span class="o">=</span>ipxe
 <span class="nv">IPXE_PORT</span><span class="o">=</span><span class="m">50000</span>
 <span class="nv">WEB_ROOT_DIR</span><span class="o">=</span>/var/www
 <span class="nv">IPXE_ROOT_DIR</span><span class="o">=</span><span class="si">${</span><span class="nv">WEB_ROOT_DIR</span><span class="si">}</span>/<span class="si">${</span><span class="nv">IPXE_APP_NAME</span><span class="si">}</span>
 <span class="nv">TFTP_ROOT_DIR</span><span class="o">=</span>/srv/tftp
 <span class="nv">CLR_INSTALLER_CONF_DIR</span><span class="o">=</span>clr-installer-configs
 <span class="nv">WAN_INTERFACE</span><span class="o">=</span>eno1
 <span class="nv">LAN_INTERFACE</span><span class="o">=</span>eno2
 <span class="nv">IPXE_SUBNET</span><span class="o">=</span><span class="m">192</span>.168.100
 <span class="nv">IPXE_LAN_IP</span><span class="o">=</span><span class="si">${</span><span class="nv">IPXE_SUBNET</span><span class="si">}</span>.1
 <span class="nv">IPXE_SUBNET_MASK_IP</span><span class="o">=</span><span class="m">255</span>.255.255.0
 <span class="nv">IPXE_SUBNET_BITMASK</span><span class="o">=</span><span class="m">16</span>
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="setup-nginx-web-server-to-host-ipxe">
 <h2>Setup nginx web server to host iPXE<a class="headerlink" href="#setup-nginx-web-server-to-host-ipxe" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Set up an nginx web server to serve the Clear Linux OS PXE image to clients
 using these steps:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># setup nginx</span>
 sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span>/etc/nginx/conf.d
 sudo<span class="w"> </span>cp<span class="w"> </span>/usr/share/nginx/conf/nginx.conf.example<span class="w"> </span>/etc/nginx/nginx.conf
 <span class="c1"># grant $USER permission to run the web server</span>
 sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/nginx/nginx.conf<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">user $USER;</span>
 <span class="s">EOF</span>
 <span class="c1"># web server config</span>
 sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/nginx/conf.d/<span class="si">${</span><span class="nv">IPXE_APP_NAME</span><span class="si">}</span>.conf<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">server {</span>
 <span class="s">  listen ${IPXE_PORT};</span>
 <span class="s">  server_name localhost;</span>
 <span class="s">  # directory to store ipxe</span>
 <span class="s">  location /${IPXE_APP_NAME}/ {</span>
 <span class="s">    root ${WEB_ROOT_DIR}/${IPXE_APP_NAME};</span>
 <span class="s">    rewrite ^/${IPXE_APP_NAME}(/.*)$ \$1 break;</span>
 <span class="s">  }</span>
 <span class="s">  # directory to store clr-installer configs</span>
 <span class="s">  location /${CLR_INSTALLER_CONF_DIR}/ {</span>
 <span class="s">    root ${WEB_ROOT_DIR}/${CLR_INSTALLER_CONF_DIR};</span>
 <span class="s">    rewrite ^/${CLR_INSTALLER_CONF_DIR}(/.*)$ \$1 break;</span>
 <span class="s">  }</span>
 <span class="s">}</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 </li>
 <li><p>Set nginx to start automatically on boot and then start it.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>systemctl<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>nginx<span class="w"> </span>--now
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="configure-ipxe">
 <h2>Configure iPXE<a class="headerlink" href="#configure-ipxe" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Download the latest Clear Linux OS PXE image and extract the files into the iPXE root.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>curl<span class="w"> </span>-o<span class="w"> </span>/tmp/clear-pxe.tar.xz<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>https://cdn.download.clearlinux.org/current/clear-<span class="k">$(</span>curl<span class="w"> </span><span class="se">\</span>
 <span class="w">  </span>https://cdn.download.clearlinux.org/latest<span class="k">)</span>-pxe.tar.xz
 sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span><span class="si">${</span><span class="nv">IPXE_ROOT_DIR</span><span class="si">}</span>
 sudo<span class="w"> </span>tar<span class="w"> </span>-xJf<span class="w"> </span>/tmp/clear-pxe.tar.xz<span class="w"> </span>-C<span class="w"> </span><span class="si">${</span><span class="nv">IPXE_ROOT_DIR</span><span class="si">}</span>
 sudo<span class="w"> </span>ln<span class="w"> </span>-sf<span class="w"> </span><span class="k">$(</span>ls<span class="w"> </span><span class="si">${</span><span class="nv">IPXE_ROOT_DIR</span><span class="si">}</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>grep<span class="w"> </span><span class="s1">&#39;org.clearlinux.*&#39;</span><span class="k">)</span><span class="w"> </span><span class="si">${</span><span class="nv">IPXE_ROOT_DIR</span><span class="si">}</span>/linux
 </pre></div>
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Ensure that the initial ramdisk file is named <code class="file docutils literal notranslate"><span class="pre">initrd</span></code> and
 the kernel file is named <code class="file docutils literal notranslate"><span class="pre">linux</span></code>, which is a symbolic link to the
 actual kernel file.</p>
 </div>
 </li>
 <li><p>Create an iPXE boot script. The script presents a menu of bootable images to
 download, boot, and install Clear Linux OS, according to a designated clr-installer
 YAML configuration file.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span><span class="si">${</span><span class="nv">IPXE_ROOT_DIR</span><span class="si">}</span>/ipxe_boot_script.ipxe<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">#!ipxe</span>
 <span class="s">set menu-timeout 5000</span>
 <span class="s">set submenu-timeout \${menu-timeout}</span>
 <span class="s">isset \${menu-default} || set menu-default clr-server</span>
 <span class="s">:menu</span>
 <span class="s">menu Select a version of Clear Linux OS to install</span>
 <span class="s">item clr-desktop Clear Linux OS (Desktop)</span>
 <span class="s">item clr-server Clear Linux OS (Server)</span>
 <span class="s">item ipxe-shell iPXE Shell</span>
 <span class="s">item reboot Reboot</span>
 <span class="s">choose --timeout \${menu-timeout} --default \${menu-default} selected || goto cancel</span>
 <span class="s">set menu-timeout 0</span>
 <span class="s">goto \${selected}</span>
 <span class="s">:clr-desktop</span>
 <span class="s">echo Booting and installing Clear Linux OS (Desktop)...</span>
 <span class="s">kernel linux quiet init=/usr/lib/systemd/systemd-bootchart initcall_debug \\</span>
 <span class="s">tsc=reliable no_timer_check noreplace-smp rw initrd=initrd \\</span>
 <span class="s">clri.descriptor=http://${IPXE_LAN_IP}:${IPXE_PORT}/${CLR_INSTALLER_CONF_DIR}/clr-desktop.yaml</span>
 <span class="s">initrd initrd</span>
 <span class="s">boot || goto failed</span>
 <span class="s">:clr-server</span>
 <span class="s">echo Booting and installing Clear Linux OS (Server)...</span>
 <span class="s">kernel linux quiet init=/usr/lib/systemd/systemd-bootchart initcall_debug \\</span>
 <span class="s">tsc=reliable no_timer_check noreplace-smp rw initrd=initrd \\</span>
 <span class="s">clri.descriptor=http://${IPXE_LAN_IP}:${IPXE_PORT}/${CLR_INSTALLER_CONF_DIR}/clr-server.yaml</span>
 <span class="s">initrd initrd</span>
 <span class="s">boot || goto failed</span>
 <span class="s">:cancel</span>
 <span class="s">echo Menu canceled, going to iPXE shell</span>
 <span class="s">:ipxe-shell</span>
 <span class="s">echo Type &#39;exit&#39; to return to the menu</span>
 <span class="s">shell</span>
 <span class="s">set menu-timeout 0</span>
 <span class="s">set submenu-timeout 0</span>
 <span class="s">goto menu</span>
 <span class="s">echo Booting</span>
 <span class="s">:failed</span>
 <span class="s">echo Booting failed, going to iPXE shell</span>
 <span class="s">goto shell</span>
 <span class="s">:reboot</span>
 <span class="s">echo Rebooting...</span>
 <span class="s">sleep 1</span>
 <span class="s">reboot</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The <cite>clri.discriptor</cite> option tells clr-installer where to download a YAML
 configuration file to use. Without this option, the Clear Linux OS PXE image will
 simply boot and not perform any installation.</p>
 </div>
 </li>
 </ol>
 </section>
 <section id="add-clr-installer-yaml-configuration-files">
 <h2>Add clr-installer YAML configuration files<a class="headerlink" href="#add-clr-installer-yaml-configuration-files" title="Link to this heading">¶</a></h2>
 <p>After the Clear Linux OS PXE image boot, clr-installer downloads the YAML configuration file
 specified in the kernel command-line and installs accordingly.</p>
 <p>See <a class="reference external" href="https://github.com/clearlinux/clr-installer/blob/master/scripts/InstallerYAMLSyntax.md">Installer YAML Syntax</a> for more information on clr-installer configuration
 YAML syntax.</p>
 <ol class="arabic">
 <li><p>Create the directory to store the configuration files.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span><span class="si">${</span><span class="nv">WEB_ROOT_DIR</span><span class="si">}</span>/<span class="si">${</span><span class="nv">CLR_INSTALLER_CONF_DIR</span><span class="si">}</span>
 </pre></div>
 </div>
 </li>
 <li><p>Create this sample <cite>Desktop</cite> configuration called <code class="file docutils literal notranslate"><span class="pre">clr-desktop.yaml</span></code>.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span><span class="si">${</span><span class="nv">WEB_ROOT_DIR</span><span class="si">}</span>/<span class="si">${</span><span class="nv">CLR_INSTALLER_CONF_DIR</span><span class="si">}</span>/clr-desktop.yaml<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">#clear-linux-config</span>
 <span class="s"># switch between aliases if you want to install to an actuall block device</span>
 <span class="s"># i.e /dev/sda</span>
 <span class="s">block-devices: [</span>
 <span class="s">   {name: &quot;bdevice&quot;, file: &quot;/dev/sda&quot;}</span>
 <span class="s">]</span>
 <span class="s">targetMedia:</span>
 <span class="s">- name: \${bdevice}</span>
 <span class="s">  type: disk</span>
 <span class="s">  children:</span>
 <span class="s">  - name: \${bdevice}1</span>
 <span class="s">    fstype: vfat</span>
 <span class="s">    mountpoint: /boot</span>
 <span class="s">    size: &quot;150M&quot;</span>
 <span class="s">    type: part</span>
 <span class="s">  - name: \${bdevice}2</span>
 <span class="s">    fstype: swap</span>
 <span class="s">    size: &quot;250M&quot;</span>
 <span class="s">    type: part</span>
 <span class="s">  - name: \${bdevice}3</span>
 <span class="s">    fstype: ext4</span>
 <span class="s">    mountpoint: /</span>
 <span class="s">    size: &quot;0&quot;     # Use remaining disk space</span>
 <span class="s">    type: part</span>
 <span class="s">bundles: [ bootloader, os-core, os-core-update, desktop-autostart, libreoffice,</span>
 <span class="s">           vlc, c-basic, git, openssh-server, vim ]</span>
 <span class="s">autoUpdate: true</span>
 <span class="s">postArchive: false</span>
 <span class="s">postReboot: true</span>
 <span class="s">telemetry: false</span>
 <span class="s">hostname: clrlinux-desktop</span>
 <span class="s">keyboard: us</span>
 <span class="s">language: en_US.UTF-8</span>
 <span class="s">kernel: kernel-native</span>
 <span class="s">users:</span>
 <span class="s">- login: clrlinux</span>
 <span class="s">  username: Clear Linux</span>
 <span class="s">  # Password is &quot;clear123&quot;</span>
 <span class="s">  password: $6$SJJMfnInWQg.CvMA$m2F8dJGj71zvi9mSNMktHMsPH3qhBm8pgXDNdaBe2yFfgi479JXvEqWkvQ6OxIUgGNQ5YXFIF0tCn.hEXB90G/</span>
 <span class="s">  admin: true</span>
 <span class="s">- login: root</span>
 <span class="s">  username: Root Root</span>
 <span class="s">  # Password is &quot;clear123&quot;</span>
 <span class="s">  password: $6$SJJMfnInWQg.CvMA$m2F8dJGj71zvi9mSNMktHMsPH3qhBm8pgXDNdaBe2yFfgi479JXvEqWkvQ6OxIUgGNQ5YXFIF0tCn.hEXB90G/</span>
 <span class="s">  admin: true</span>
 <span class="s">pre-install: [</span>
 <span class="s">  {cmd: &quot;curl -o /tmp/add-issue.sh http://${IPXE_LAN_IP}:${IPXE_PORT}/${CLR_INSTALLER_CONF_DIR}/add-issue.sh&quot;},</span>
 <span class="s">  {cmd: &quot;chmod +x /tmp/add-issue.sh&quot;}</span>
 <span class="s">]</span>
 <span class="s">post-install: [</span>
 <span class="s">  {cmd: &quot;echo PermitRootLogin yes &gt; \${chrootDir}/etc/ssh/sshd_config&quot;},</span>
 <span class="s">  {cmd: &quot;/tmp/add-issue.sh \${chrootDir}&quot;}</span>
 <span class="s">]</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 </li>
 <li><p>Create this sample <cite>Server</cite> configuration called <code class="file docutils literal notranslate"><span class="pre">clr-server.yaml</span></code>.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span><span class="si">${</span><span class="nv">WEB_ROOT_DIR</span><span class="si">}</span>/<span class="si">${</span><span class="nv">CLR_INSTALLER_CONF_DIR</span><span class="si">}</span>/clr-server.yaml<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">#clear-linux-config</span>
 <span class="s"># switch between aliases if you want to install to an actuall block device</span>
 <span class="s"># i.e /dev/sda</span>
 <span class="s">block-devices: [</span>
 <span class="s">   {name: &quot;bdevice&quot;, file: &quot;/dev/sda&quot;}</span>
 <span class="s">]</span>
 <span class="s">targetMedia:</span>
 <span class="s">- name: \${bdevice}</span>
 <span class="s">  type: disk</span>
 <span class="s">  children:</span>
 <span class="s">  - name: \${bdevice}1</span>
 <span class="s">    fstype: vfat</span>
 <span class="s">    mountpoint: /boot</span>
 <span class="s">    size: &quot;150M&quot;</span>
 <span class="s">    type: part</span>
 <span class="s">  - name: \${bdevice}2</span>
 <span class="s">    fstype: swap</span>
 <span class="s">    size: &quot;250M&quot;</span>
 <span class="s">    type: part</span>
 <span class="s">  - name: \${bdevice}3</span>
 <span class="s">    fstype: ext4</span>
 <span class="s">    mountpoint: /</span>
 <span class="s">    size: &quot;0&quot;     # Use remaining disk space</span>
 <span class="s">    type: part</span>
 <span class="s">bundles: [ bootloader, os-core, os-core-update, vim ]</span>
 <span class="s">autoUpdate: true</span>
 <span class="s">postArchive: false</span>
 <span class="s">postReboot: true</span>
 <span class="s">telemetry: false</span>
 <span class="s">hostname: clrlinux-server</span>
 <span class="s">keyboard: us</span>
 <span class="s">language: en_US.UTF-8</span>
 <span class="s">kernel: kernel-native</span>
 <span class="s">users:</span>
 <span class="s">- login: clrlinux</span>
 <span class="s">  username: Clear Linux</span>
 <span class="s">  # Password is &quot;clear123&quot;</span>
 <span class="s">  password: \$6\$SJJMfnInWQg.CvMA\$m2F8dJGj71zvi9mSNMktHMsPH3qhBm8pgXDNdaBe2yFfgi479JXvEqWkvQ6OxIUgGNQ5YXFIF0tCn.hEXB90G/</span>
 <span class="s">  admin: true</span>
 <span class="s">- login: root</span>
 <span class="s">  username: Root Root</span>
 <span class="s">  # Password is &quot;clear123&quot;</span>
 <span class="s">  password: \$6\$SJJMfnInWQg.CvMA\$m2F8dJGj71zvi9mSNMktHMsPH3qhBm8pgXDNdaBe2yFfgi479JXvEqWkvQ6OxIUgGNQ5YXFIF0tCn.hEXB90G/</span>
 <span class="s">  admin: true</span>
 <span class="s">pre-install: [</span>
 <span class="s">  {cmd: &quot;curl -o /tmp/add-issue.sh http://${IPXE_LAN_IP}:${IPXE_PORT}/${CLR_INSTALLER_CONF_DIR}/add-issue.sh&quot;},</span>
 <span class="s">  {cmd: &quot;chmod +x /tmp/add-issue.sh&quot;}</span>
 <span class="s">]</span>
 <span class="s">post-install: [</span>
 <span class="s">  {cmd: &quot;echo PermitRootLogin yes &gt; \${chrootDir}/etc/ssh/sshd_config&quot;},</span>
 <span class="s">  {cmd: &quot;/tmp/add-issue.sh \${chrootDir}&quot;}</span>
 <span class="s">]</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 </li>
 <li><p>Add following content to the <code class="file docutils literal notranslate"><span class="pre">add-issue.sh</span></code> script, which will be
 used by the above two YAML configuration files:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span><span class="si">${</span><span class="nv">WEB_ROOT_DIR</span><span class="si">}</span>/<span class="si">${</span><span class="nv">CLR_INSTALLER_CONF_DIR</span><span class="si">}</span>/add-issue.sh<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">#!/bin/bash</span>
 <span class="s">echo &quot;Creating custom issue file for \$1&quot;</span>
 <span class="s">echo &quot;Welcome to the Clear Linux* OS</span>
 <span class="s">* Documentation:     https://clearlinux.org/documentation</span>
 <span class="s">* Community Support: https://community.clearlinux.org</span>
 <span class="s">&quot; &gt;&gt; \$1/etc/issue</span>
 <span class="s">exit 0</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="configure-network">
 <h2>Configure network<a class="headerlink" href="#configure-network" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>The DNS server, included with the <cite>pxe-server</cite> bundle,
 conflicts with the DNS stub listener provided in <cite>systemd-resolved</cite>.
 Disable the DNS stub listener and temporarily stop <cite>systemd-resolved</cite>.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span>/etc/systemd
 sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/systemd/resolved.conf<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">[Resolve]</span>
 <span class="s">DNSStubListener=no</span>
 <span class="s">EOF</span>
 sudo<span class="w"> </span>systemctl<span class="w"> </span>stop<span class="w"> </span>systemd-resolved
 </pre></div>
 </div>
 </li>
 <li><p>Disable NetworkManager. The base installation of Clear Linux OS comes with two
 network managers, systemd-networkd and NetworkManager, with the latter
 being the default. systemd-networkd is recommended for a server use case,
 so we will disable NetworkManager.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>systemctl<span class="w"> </span>mask<span class="w"> </span>--now<span class="w"> </span>NetworkManager
 </pre></div>
 </div>
 </li>
 <li><p>Assign a static IP address to the LAN side network adapter
 and restart <cite>systemd-networkd</cite>.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span>/etc/systemd/network
 sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/systemd/network/70-internal-static.network<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">[Match]</span>
 <span class="s">Name=${LAN_INTERFACE}</span>
 <span class="s">[Network]</span>
 <span class="s">DHCP=no</span>
 <span class="s">Address=${IPXE_LAN_IP}/${IPXE_SUBNET_BITMASK}</span>
 <span class="s">EOF</span>
 sudo<span class="w"> </span>systemctl<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>systemd-networkd
 sudo<span class="w"> </span>systemctl<span class="w"> </span>restart<span class="w"> </span>systemd-networkd
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="setup-nat">
 <h2>Setup NAT<a class="headerlink" href="#setup-nat" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Configure <abbr title="Network Address Translation">NAT</abbr> to route traffic from
 the LAN to the WAN network so clients can download upstream bundles for
 installation. And to make these changes persistent during reboots, save the
 changes to the firewall.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>iptables<span class="w"> </span>-t<span class="w"> </span>nat<span class="w"> </span>-F<span class="w"> </span>POSTROUTING
 sudo<span class="w"> </span>iptables<span class="w"> </span>-t<span class="w"> </span>nat<span class="w"> </span>-A<span class="w"> </span>POSTROUTING<span class="w"> </span>-o<span class="w"> </span><span class="si">${</span><span class="nv">WAN_INTERFACE</span><span class="si">}</span><span class="w"> </span>-j<span class="w"> </span>MASQUERADE
 sudo<span class="w"> </span>systemctl<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>iptables-save.service
 sudo<span class="w"> </span>systemctl<span class="w"> </span>restart<span class="w"> </span>iptables-save.service
 sudo<span class="w"> </span>systemctl<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>iptables-restore.service
 sudo<span class="w"> </span>systemctl<span class="w"> </span>restart<span class="w"> </span>iptables-restore.service
 </pre></div>
 </div>
 </li>
 <li><p>Configure the kernel to forward network packets to different interfaces.
 Otherwise, NAT will not work.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span>/etc/sysctl.d
 sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/sysctl.d/80-nat-forwarding.conf<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">net.ipv4.ip_forward=1</span>
 <span class="s">EOF</span>
 sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/proc/sys/net/ipv4/ip_forward<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">1</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="setup-dnsmaq-for-dhcp-dns-and-tftp-functionalities">
 <h2>Setup dnsmaq for DHCP, DNS, and TFTP functionalities<a class="headerlink" href="#setup-dnsmaq-for-dhcp-dns-and-tftp-functionalities" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Create a configuration file for <cite>dnsmasq</cite> to listen on a dedicated IP address
 for TFTP, DNS, and DHCP functions. PXE clients on the LAN network will talk to
 this IP address.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/dnsmasq.conf<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">listen-address=${IPXE_LAN_IP}</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 </li>
 <li><p>Add the options to serve iPXE firmware images to clients over TFTP to
 the <code class="file docutils literal notranslate"><span class="pre">dnsmasq</span></code> configuration file.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/dnsmasq.conf<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">enable-tftp</span>
 <span class="s">tftp-root=${TFTP_ROOT_DIR}</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 </li>
 <li><p>Add the options to host a DHCP server for clients to the <code class="file docutils literal notranslate"><span class="pre">dnsmasq</span></code>
 configuration file.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>tee<span class="w"> </span>-a<span class="w"> </span>/etc/dnsmasq.conf<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
 <span class="s">dhcp-leasefile=/var/db/dnsmasq.leases</span>
 <span class="s">dhcp-authoritative</span>
 <span class="s">dhcp-option=option:router,${IPXE_LAN_IP}</span>
 <span class="s">dhcp-option=option:dns-server,${IPXE_LAN_IP}</span>
 <span class="s">dhcp-match=set:ipxeclient,60,IPXEClient*</span>
 <span class="s">dhcp-range=tag:ipxeclient,${IPXE_SUBNET}.2,${IPXE_SUBNET}.253,${IPXE_SUBNET_MASK_IP},15m</span>
 <span class="s">dhcp-range=tag:!ipxeclient,${IPXE_SUBNET}.2,${IPXE_SUBNET}.253,${IPXE_SUBNET_MASK_IP},6h</span>
 <span class="s">dhcp-match=set:ipxeboot,175</span>
 <span class="s">dhcp-boot=tag:ipxeboot,http://${IPXE_LAN_IP}:${IPXE_PORT}/${IPXE_APP_NAME}/ipxe_boot_script.ipxe</span>
 <span class="s">dhcp-boot=tag:!ipxeboot,undionly.kpxe,${IPXE_LAN_IP}</span>
 <span class="s">EOF</span>
 </pre></div>
 </div>
 <p>The configuration provides the following important functions:</p>
 <ul class="simple">
 <li><p>Directs clients without an iPXE implementation to the TFTP server
 to acquire architecture-specific iPXE firmware images that allow them
 to perform an iPXE boot.</p></li>
 <li><p>Activates only on the network adapter that has an IP address on the
 defined subnet.</p></li>
 <li><p>Directs clients to the DNS server.</p></li>
 <li><p>Directs clients to the iPXE server for routing via NAT.</p></li>
 <li><p>Divides the private network into two pools of IP addresses. One pool
 is for network boot and one pool is used after boot. Each pool has
 their own lease times.</p></li>
 </ul>
 </li>
 <li><p>Create a file for <cite>dnsmasq</cite> to record the IP addresses it provides
 to clients.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span>/var/db
 sudo<span class="w"> </span>touch<span class="w"> </span>/var/db/dnsmasq.leases
 </pre></div>
 </div>
 </li>
 <li><p>Create a TFTP hosting directory and populate it with the iPXE firmware.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>mkdir<span class="w"> </span>-p<span class="w"> </span><span class="si">${</span><span class="nv">TFTP_ROOT_DIR</span><span class="si">}</span>
 sudo<span class="w"> </span>ln<span class="w"> </span>-sf<span class="w"> </span>/usr/share/ipxe/undionly.kpxe<span class="w"> </span><span class="si">${</span><span class="nv">TFTP_ROOT_DIR</span><span class="si">}</span>/undionly.kpxe
 </pre></div>
 </div>
 </li>
 <li><p>Start <cite>dnsmasq</cite> and enable startup on boot.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>systemctl<span class="w"> </span>daemon-reload
 sudo<span class="w"> </span>systemctl<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>dnsmasq
 sudo<span class="w"> </span>systemctl<span class="w"> </span>restart<span class="w"> </span>dnsmasq
 </pre></div>
 </div>
 </li>
 <li><p>Start <cite>systemd-resolved</cite>.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>systemctl<span class="w"> </span>start<span class="w"> </span>systemd-resolved
 </pre></div>
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p><cite>systemd-resolved</cite> dynamically updates the list of DNS servers for the
 LAN network if you use the <cite>dnsmasq</cite> DNS server. The setup creates a
 pass-through DNS server that relies on the DNS servers listed in
 <code class="file docutils literal notranslate"><span class="pre">/etc/resolv.conf</span></code>.</p>
 </div>
 </li>
 </ol>
 </section>
 <section id="verify-setup">
 <h2>Verify setup<a class="headerlink" href="#verify-setup" title="Link to this heading">¶</a></h2>
 <p>Verify you can access these URLs before deploying:</p>
 <ul class="simple">
 <li><p>http://{$IPXE_LAN_IP}:{$IPXE_PORT}/${IPXE_APP_NAME}/ipxe_boot_script.ipxe</p></li>
 <li><p>http://{$IPXE_LAN_IP}:{$IPXE_PORT}/${CLR_INSTALLER_CONF_DIR}/clr-desktop.yaml</p></li>
 <li><p>http://{$IPXE_LAN_IP}:{$IPXE_PORT}/${CLR_INSTALLER_CONF_DIR}/clr-server.yaml</p></li>
 <li><p>http://{$IPXE_LAN_IP}:{$IPXE_PORT}/${CLR_INSTALLER_CONF_DIR}/add-issue.sh</p></li>
 </ul>
 </section>
 <section id="deploy">
 <h2>Deploy<a class="headerlink" href="#deploy" title="Link to this heading">¶</a></h2>
 <ol class="arabic simple">
 <li><p>Connect your client system to the LAN network.</p></li>
 <li><p>Power on the client.</p></li>
 <li><p>Set your client to network boot. It should get an IP address and download
 the iPXE script.</p></li>
 <li><p>When presented with the iPXE menu, select one of the options.  The client
 will then download and boot the Clear Linux OS image. Once booted, clr-installer will
 download the assigned YAML configuration file and begin to install Clear Linux OS.
 After installation, the client will reboot to Clear Linux OS.</p></li>
 </ol>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../index.html">
              <img class="logo" src="../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Install Clear Linux OS Over the Network with iPXE</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#install-cl-on-server">Install Clear Linux OS on server</a></li>
 <li><a class="reference internal" href="#setup-nginx-web-server-to-host-ipxe">Setup nginx web server to host iPXE</a></li>
 <li><a class="reference internal" href="#configure-ipxe">Configure iPXE</a></li>
 <li><a class="reference internal" href="#add-clr-installer-yaml-configuration-files">Add clr-installer YAML configuration files</a></li>
 <li><a class="reference internal" href="#configure-network">Configure network</a></li>
 <li><a class="reference internal" href="#setup-nat">Setup NAT</a></li>
 <li><a class="reference internal" href="#setup-dnsmaq-for-dhcp-dns-and-tftp-functionalities">Setup dnsmaq for DHCP, DNS, and TFTP functionalities</a></li>
 <li><a class="reference internal" href="#verify-setup">Verify setup</a></li>
 <li><a class="reference internal" href="#deploy">Deploy</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="install-configfile.html"
                          title="previous chapter">Install using clr-installer and a configuration file</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="virtual-machine-install/hyper-v.html"
                          title="next chapter">Clear Linux* OS on Microsoft Hyper-V*</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../_sources/get-started/ipxe-install.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="virtual-machine-install/hyper-v.html" title="Clear Linux* OS on Microsoft Hyper-V*"
             >next</a> |</li>
        <li class="right" >
          <a href="install-configfile.html" title="Install using clr-installer and a configuration file"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Install Clear Linux OS Over the Network with iPXE</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,279 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS on Microsoft Hyper-V* &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/virtual-machine-install/hyper-v.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Clear Linux* OS on KVM" href="kvm.html" />
    <link rel="prev" title="Install Clear Linux OS Over the Network with iPXE" href="../ipxe-install.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="kvm.html" title="Clear Linux* OS on KVM"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="../ipxe-install.html" title="Install Clear Linux OS Over the Network with iPXE"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Microsoft Hyper-V*</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-on-microsoft-hyper-v">
 <span id="hyper-v"></span><h1>Clear Linux* OS on Microsoft Hyper-V*<a class="headerlink" href="#cl-attr-on-microsoft-hyper-v" title="Link to this heading">¶</a></h1>
 <p>This page explains how to run a Clear Linux* OS <abbr title="virtual machine">VM</abbr> on a
 Microsoft* Hyper-V* hypervisor.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#overview" id="id4">Overview</a></p></li>
 <li><p><a class="reference internal" href="#prerequisites" id="id5">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#download-the-cl-disk-image-for-hyper-v" id="id6">Download the Clear Linux OS disk image for Hyper-V</a></p></li>
 <li><p><a class="reference internal" href="#create-and-configure-new-vm" id="id7">Create and configure new VM</a></p></li>
 <li><p><a class="reference internal" href="#start-the-vm" id="id8">Start the VM</a></p></li>
 <li><p><a class="reference internal" href="#related-topics" id="id9">Related topics</a></p></li>
 </ul>
 </nav>
 <section id="overview">
 <h2><a class="toc-backref" href="#id4" role="doc-backlink">Overview</a><a class="headerlink" href="#overview" title="Link to this heading">¶</a></h2>
 <p>Hyper-V is a type 1 bare-metal hypervisor that runs directly on system
 hardware. It is available for <a class="reference external" href="https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/hyper-v-on-windows-server">Windows* server</a> and client operating
 systems, including <a class="reference external" href="https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/index">Windows 10</a>.</p>
 <p>Clear Linux OS provides a virtual disk image for Hyper-V, which also includes
 a <a class="reference internal" href="../../guides/clear/compatible-kernels.html#compatible-kernels"><span class="std std-ref">Hyper-V specific kernel</span></a> and drivers.</p>
 </section>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id5" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Enable virtualization on the host system from EFI/BIOS, such as:</p>
 <ul>
 <li><p><a class="reference external" href="http://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html">Intel® Virtualization Technology</a> (Intel® VT)</p></li>
 <li><p><a class="reference external" href="https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices">Intel® Virtualization Technology for Directed I/O</a> (Intel® VT-d)</p></li>
 </ul>
 </li>
 <li><p>Install Hyper-V on the appropriate Windows operating system:</p>
 <ul>
 <li><p><a class="reference external" href="https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/get-started/install-the-hyper-v-role-on-windows-server">Install the Hyper-V role on Windows Server</a></p></li>
 <li><p><a class="reference external" href="https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v">Install Hyper-V on Windows 10</a></p></li>
 </ul>
 </li>
 <li><p>Configure the appropriate virtual networking in Hyper-V:</p>
 <ul>
 <li><p><a class="reference external" href="https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/get-started/create-a-virtual-switch-for-hyper-v-virtual-machines">Create a virtual network on Windows Server</a></p></li>
 <li><p><a class="reference external" href="https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network">Create a virtual network on Windows 10</a></p></li>
 </ul>
 </li>
 </ul>
 </section>
 <section id="download-the-cl-disk-image-for-hyper-v">
 <h2><a class="toc-backref" href="#id6" role="doc-backlink">Download the Clear Linux OS disk image for Hyper-V</a><a class="headerlink" href="#download-the-cl-disk-image-for-hyper-v" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Download the <code class="file docutils literal notranslate"><span class="pre">clear-[VERSION]-azure-hyperv.vhd.gz</span></code> for Microsoft*
 Hyper-V from the <a class="reference external" href="https://clearlinux.org/downloads">downloads</a> website.</p></li>
 <li><p>Verify and extract the image using these instructions:
 <a class="reference internal" href="../../guides/maintenance/download-verify-decompress.html#download-verify-decompress"><span class="std std-ref">Download, verify, and decompress a Clear Linux* OS image</span></a>.</p></li>
 <li><p>Extract the compressed file using software such as the
 7-Zip* tool or the WinZip* tool.</p>
 <p>After extraction, the file should be named <code class="file docutils literal notranslate"><span class="pre">clear-[VERSION]-azure-hyperv.vhd</span></code>.</p>
 </li>
 </ol>
 </section>
 <section id="create-and-configure-new-vm">
 <h2><a class="toc-backref" href="#id7" role="doc-backlink">Create and configure new VM</a><a class="headerlink" href="#create-and-configure-new-vm" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Open the <strong>Hyper-V Manager</strong> from the Start menu.</p>
 <figure class="align-default" id="id1">
 <a class="reference internal image-reference" href="../../_images/hyper-v-01.png"><img alt="Hyper-V Manager from the Start menu" src="../../_images/hyper-v-01.png" style="width: 394.0px; height: 109.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: Hyper-V Manager from the Start menu</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>You may need to manually enable Hyper-V on a Windows* machine. Review
 <code class="docutils literal notranslate"><span class="pre">Windows</span> <span class="pre">Features</span></code>.</p>
 </div>
 </li>
 <li><p>Create a <em>New Virtual Machine</em> by clicking the <span class="guilabel">Action</span> menu,
 then selecting <span class="guilabel">New</span> and <span class="guilabel">Virtual Machine…</span>.</p>
 <figure class="align-default" id="id2">
 <a class="reference internal image-reference" href="../../_images/hyper-v-02.png"><img alt="New Virtual Machine in Hyper-V Manager" src="../../_images/hyper-v-02.png" style="width: 432.0px; height: 327.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 2: New Virtual Machine in Hyper-V Manager</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Follow the <em>New Virtual Machine Wizard</em> to create a new virtual machine
 specifying the options below:</p>
 <ul class="simple">
 <li><p><strong>Name</strong>: Choose name (for example, ClearLinuxOS-VM)</p></li>
 <li><p><strong>Specify Generation</strong>: Generation 1</p></li>
 <li><p><strong>Startup memory</strong>: 2048 MB or more</p></li>
 <li><p><strong>Configure Networking</strong>: Change <span class="guilabel">Connection</span> to <cite>Default Switch</cite></p></li>
 <li><p><strong>Connect Virtual Hard Disk</strong>: Select <span class="guilabel">Use an existing virtual
 hard disk</span> and browse to find the
 <code class="file docutils literal notranslate"><span class="pre">clear-[VERSION]-azure-hyperv.vhd</span></code> file.</p></li>
 </ul>
 <p>After finishing the wizard, the VM will be created but not powered on.</p>
 </li>
 <li><p>Configure the VM by right-clicking it in the Hyper-V Manager and selecting
 <span class="guilabel">Settings…</span>. Figure 3 shows the Settings page after configuration selections.</p>
 <p><strong>Optional</strong></p>
 <ul class="simple">
 <li><p>If you wish to <cite>Encrypt state and virtual machine traffic, under
 :guilabel:`Security</cite>, select <span class="guilabel">Add Key Storage Drive</span>.</p></li>
 <li><p>Under <span class="guilabel">Processor</span>, consider increasing the number of virtual
 processors assigned to the Clear Linux OS VM to improve performance.</p></li>
 </ul>
 <figure class="align-default" id="id3">
 <a class="reference internal image-reference" href="../../_images/hyper-v-03.png"><img alt="|CL| VM Settings in Hyper-V Manager" src="../../_images/hyper-v-03.png" style="width: 236.0px; height: 251.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 3: Clear Linux OS VM Settings page after configuration</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Apply</span> at the bottom of the VM Settings screen.</p></li>
 <li><p>Click <span class="guilabel">OK</span> at the bottom of the VM Settings screen.</p></li>
 </ol>
 </section>
 <section id="start-the-vm">
 <h2><a class="toc-backref" href="#id8" role="doc-backlink">Start the VM</a><a class="headerlink" href="#start-the-vm" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Start the Clear Linux OS VM by right-clicking the VM in Hyper-V Manager and
 selecting <span class="guilabel">Start</span>.</p></li>
 <li><p>Connect to the VM console by right-clicking the VM in Hyper-V Manager and
 selecting <span class="guilabel">Connect…</span>. A new <em>Virtual Machine Connection</em>
 window is displayed.</p></li>
 <li><p>After Clear Linux OS is booted, log in to the console with user <em>root</em>. You are
 prompted to set a new password immediately.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">&gt; User: root</span>
 </pre></div>
 </div>
 </li>
 </ol>
 <p>Clear Linux* OS on Microsoft Hyper-V* is ready for use.</p>
 </section>
 <section id="related-topics">
 <h2><a class="toc-backref" href="#id9" role="doc-backlink">Related topics</a><a class="headerlink" href="#related-topics" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p><a class="reference internal" href="../../guides/maintenance/increase-virtual-disk-size.html#increase-virtual-disk-size"><span class="std std-ref">Increase Virtual Disk Size of an Image</span></a></p></li>
 </ul>
 <p><em>Intel and the Intel logo are trademarks of Intel Corporation or its subsidiaries.</em></p>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS on Microsoft Hyper-V*</a><ul>
 <li><a class="reference internal" href="#overview">Overview</a></li>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#download-the-cl-disk-image-for-hyper-v">Download the Clear Linux OS disk image for Hyper-V</a></li>
 <li><a class="reference internal" href="#create-and-configure-new-vm">Create and configure new VM</a></li>
 <li><a class="reference internal" href="#start-the-vm">Start the VM</a></li>
 <li><a class="reference internal" href="#related-topics">Related topics</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="../ipxe-install.html"
                          title="previous chapter">Install Clear Linux OS Over the Network with iPXE</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="kvm.html"
                          title="next chapter">Clear Linux* OS on KVM</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/virtual-machine-install/hyper-v.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="kvm.html" title="Clear Linux* OS on KVM"
             >next</a> |</li>
        <li class="right" >
          <a href="../ipxe-install.html" title="Install Clear Linux OS Over the Network with iPXE"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Microsoft Hyper-V*</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,342 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS on KVM &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/virtual-machine-install/kvm.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Clear Linux* OS on Parallels* Desktop for Mac*" href="parallels.html" />
    <link rel="prev" title="Clear Linux* OS on Microsoft Hyper-V*" href="hyper-v.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="parallels.html" title="Clear Linux* OS on Parallels* Desktop for Mac*"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="hyper-v.html" title="Clear Linux* OS on Microsoft Hyper-V*"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on KVM</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-on-kvm">
 <span id="kvm"></span><h1>Clear Linux* OS on KVM<a class="headerlink" href="#cl-attr-on-kvm" title="Link to this heading">¶</a></h1>
 <p>This page explains how to run Clear Linux* OS in a virtualized environment using
 <abbr title="Kernel-based Virtual Machine">KVM</abbr>.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#install-qemu-kvm" id="id2">Install QEMU-KVM</a></p></li>
 <li><p><a class="reference internal" href="#download-and-launch-the-virtual-machine-image" id="id3">Download and launch the virtual machine image</a></p></li>
 <li><p><a class="reference internal" href="#optional-enable-ssh-access" id="id4">Optional: Enable SSH access</a></p></li>
 <li><p><a class="reference internal" href="#optional-install-a-graphical-user-interface-gui" id="id5">Optional: Install a graphical user interface (GUI)</a></p></li>
 </ul>
 </nav>
 <section id="install-qemu-kvm">
 <h2><a class="toc-backref" href="#id2" role="doc-backlink">Install QEMU-KVM</a><a class="headerlink" href="#install-qemu-kvm" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Enable the <a class="reference external" href="https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html">Intel® Virtualization Technology</a> (Intel® VT) and the
 <a class="reference external" href="https://software.intel.com/en-us/articles/intel-virtualization-technology-for-directed-io-vt-d-enhancing-intel-platforms-for-efficient-virtualization-of-io-devices">Intel® Virtualization Technology for Directed I/O</a> (Intel® VT-d) in the
 host machine’s BIOS.</p></li>
 <li><p>Log in and open a terminal emulator.</p></li>
 <li><p>Install <cite>QEMU*-KVM</cite> on the host machine. Below are some examples using
 different distros:</p>
 <table class="docutils align-default">
 <thead>
 <tr class="row-odd"><th class="head"><p>Host OS</p></th>
 <th class="head"><p>Installation command</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><p>Clear Linux OS</p></td>
 <td><p><strong class="command">sudo swupd bundle-add kvm-host</strong></p></td>
 </tr>
 <tr class="row-odd"><td><p>Ubuntu* and Mint*</p></td>
 <td><p><strong class="command">sudo apt-get install qemu-kvm</strong></p></td>
 </tr>
 <tr class="row-even"><td><p>Fedora</p></td>
 <td><p><strong class="command">dnf install qemu-kvm</strong></p></td>
 </tr>
 </tbody>
 </table>
 </li>
 </ol>
 </section>
 <section id="download-and-launch-the-virtual-machine-image">
 <h2><a class="toc-backref" href="#id3" role="doc-backlink">Download and launch the virtual machine image</a><a class="headerlink" href="#download-and-launch-the-virtual-machine-image" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Download the latest pre-built Clear Linux OS KVM image file from
 the <a class="reference external" href="https://cdn.download.clearlinux.org/image/">image</a> directory. Look for
 <code class="docutils literal notranslate"><span class="pre">clear-&lt;version&gt;-kvm.img.xz</span></code>.  You can also use this command:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-o<span class="w"> </span>clear.img.xz<span class="w"> </span>https://cdn.download.clearlinux.org/image/<span class="k">$(</span>curl<span class="w"> </span>https://cdn.download.clearlinux.org/image/latest-images.json<span class="w"> </span><span class="p">|</span><span class="w"> </span>grep<span class="w"> </span>-o<span class="w"> </span><span class="s1">&#39;clear-[0-9]*-kvm.img.xz&#39;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>head<span class="w"> </span>-1<span class="k">)</span>
 </pre></div>
 </div>
 </li>
 <li><p>Uncompress the downloaded image:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>xz<span class="w"> </span>-dv<span class="w"> </span>clear.img.xz
 </pre></div>
 </div>
 </li>
 <li><p>Download the 3 OVMF files (<cite>OVMF.fd</cite>, <cite>OVMF_CODE.fd</cite>, <cite>OVMF_VARS.fd</cite>) that
 provides UEFI  support for virtual machines.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/image/OVMF.fd
 curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/image/OVMF_CODE.fd
 curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/image/OVMF_VARS.fd
 </pre></div>
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The default OVMF files from Clear Linux OS may not work for some non-Clear Linux OS distro
 version(s). You may get an <cite>ASSERT</cite> in the <cite>debug.log</cite> file when
 starting the VM. If you encounter this, use the distro-specific OVMF
 files instead.</p>
 </div>
 </li>
 <li><p>Download the <a class="reference external" href="https://cdn.download.clearlinux.org/image/start_qemu.sh">start_qemu.sh</a> script from the
 <a class="reference external" href="https://cdn.download.clearlinux.org/image/">image</a> directory.  This script
 will launch the Clear Linux OS VM and provide console interaction within the same
 terminal emulator window.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/image/start_qemu.sh
 </pre></div>
 </div>
 </li>
 <li><p>Start the Clear Linux OS KVM virtual machine:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>bash<span class="w"> </span>./start_qemu.sh<span class="w"> </span>clear.img
 </pre></div>
 </div>
 </li>
 <li><p>Log in as <code class="docutils literal notranslate"><span class="pre">root</span></code> user and set a new password.</p></li>
 </ol>
 </section>
 <section id="optional-enable-ssh-access">
 <h2><a class="toc-backref" href="#id4" role="doc-backlink">Optional: Enable SSH access</a><a class="headerlink" href="#optional-enable-ssh-access" title="Link to this heading">¶</a></h2>
 <p>To interact with the Clear Linux OS VM remotely through SSH instead of the console it
 was launched from, follow these steps.</p>
 <ol class="arabic">
 <li><p>Enable and configure SSH in the Clear Linux OS VM to allow root login as described in
 <a class="reference internal" href="../../guides/network/openssh-server.html#openssh-server"><span class="std std-ref">Enable and configure SSH service</span></a>.</p></li>
 <li><p>SSH into the Clear Linux OS VM using the port <cite>10022</cite>. This port number is set in
 <code class="file docutils literal notranslate"><span class="pre">start_qemu.sh</span></code> and passed through to the SSH service running on port
 22</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ssh<span class="w"> </span>-p<span class="w"> </span><span class="m">10022</span><span class="w"> </span>root@&lt;ip-addr-of-kvm-host&gt;
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="optional-install-a-graphical-user-interface-gui">
 <h2><a class="toc-backref" href="#id5" role="doc-backlink">Optional: Install a graphical user interface (GUI)</a><a class="headerlink" href="#optional-install-a-graphical-user-interface-gui" title="Link to this heading">¶</a></h2>
 <p>To add <abbr title="GNOME Display Manager">GDM</abbr> to the Clear Linux OS VM, follow these steps:</p>
 <ol class="arabic">
 <li><p>Shutdown the active Clear Linux OS VM.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>poweroff
 </pre></div>
 </div>
 </li>
 <li><p>Install the Spice viewer on the localhost or remote system. Below are some
 examples using different distros:</p>
 <table class="docutils align-default">
 <thead>
 <tr class="row-odd"><th class="head"><p>Host OS</p></th>
 <th class="head"><p>Installation command</p></th>
 </tr>
 </thead>
 <tbody>
 <tr class="row-even"><td><p>Clear Linux OS</p></td>
 <td><p><strong class="command">sudo swupd bundle-add virt-viewer</strong></p></td>
 </tr>
 <tr class="row-odd"><td><p>Ubuntu* and Mint*</p></td>
 <td><p><strong class="command">sudo apt-get install virt-viewer</strong></p></td>
 </tr>
 <tr class="row-even"><td><p>Fedora</p></td>
 <td><p><strong class="command">dnf install virt-viewer</strong></p></td>
 </tr>
 </tbody>
 </table>
 </li>
 <li><p>Modify the <code class="file docutils literal notranslate"><span class="pre">start_qemu.sh</span></code> script to increase memory (<cite>-m</cite>), add
 graphics driver (<cite>-vga</cite>), and add Spice (<cite>-spice</cite>, <cite>-usb</cite>, and
 <cite>-device</cite>) support.</p>
 <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">qemu-system-x86_64 \</span>
 <span class="go">    -enable-kvm \</span>
 <span class="gp">    $</span><span class="o">{</span>UEFI_BIOS<span class="o">}</span><span class="w"> </span><span class="se">\</span>
 <span class="w">    </span>-smp<span class="w"> </span><span class="nv">sockets</span><span class="o">=</span><span class="m">1</span>,cpus<span class="o">=</span><span class="m">4</span>,cores<span class="o">=</span><span class="m">2</span><span class="w"> </span>-cpu<span class="w"> </span>host<span class="w"> </span><span class="se">\</span>
 <span class="hll"><span class="w">    </span>-m<span class="w"> </span><span class="m">4096</span><span class="w"> </span><span class="se">\</span>
 </span><span class="hll"><span class="w">    </span>-vga<span class="w"> </span>qxl<span class="w"> </span><span class="se">\</span>
 </span><span class="hll"><span class="w">    </span>-nographic<span class="w"> </span><span class="se">\</span>
 </span><span class="hll"><span class="w">    </span>-spice<span class="w"> </span><span class="nv">port</span><span class="o">=</span><span class="m">5924</span>,disable-ticketing<span class="w"> </span><span class="se">\</span>
 </span><span class="hll"><span class="w">    </span>-usb<span class="w"> </span><span class="se">\</span>
 </span><span class="hll"><span class="w">    </span>-device<span class="w"> </span>usb-tablet,bus<span class="o">=</span>usb-bus.0<span class="w"> </span><span class="se">\</span>
 </span><span class="w">    </span>-drive<span class="w"> </span><span class="nv">file</span><span class="o">=</span><span class="s2">&quot;</span><span class="nv">$IMAGE</span><span class="s2">&quot;</span>,if<span class="o">=</span>virtio,aio<span class="o">=</span>threads,format<span class="o">=</span>raw<span class="w"> </span><span class="se">\</span>
 <span class="w">    </span>-netdev<span class="w"> </span>user,id<span class="o">=</span>mynet0,hostfwd<span class="o">=</span>tcp::<span class="si">${</span><span class="nv">VMN</span><span class="si">}</span><span class="m">0022</span>-:22,hostfwd<span class="o">=</span>tcp::<span class="si">${</span><span class="nv">VMN</span><span class="si">}</span><span class="m">2375</span>-:2375<span class="w"> </span><span class="se">\</span>
 <span class="w">    </span>-device<span class="w"> </span>virtio-net-pci,netdev<span class="o">=</span>mynet0<span class="w"> </span><span class="se">\</span>
 <span class="w">    </span>-debugcon<span class="w"> </span>file:debug.log<span class="w"> </span>-global<span class="w"> </span>isa-debugcon.iobase<span class="o">=</span>0x402<span class="w"> </span><span class="nv">$@</span>
 </pre></div>
 </div>
 </li>
 <li><p>Due to changes in the <code class="file docutils literal notranslate"><span class="pre">start_qemu.sh</span></code> script from the previous step,
 having previously used OVMF files will result in the VM not booting
 properly and you returning to the UEFI shell. The easiest way to avoid this
 is to delete the 3 OVMF files and reobtain originals before relaunching the
 VM:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>rm<span class="w"> </span>-v<span class="w"> </span>OVMF*.fd
 curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/image/OVMF.fd
 curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/image/OVMF_CODE.fd
 curl<span class="w"> </span>-O<span class="w"> </span>https://cdn.download.clearlinux.org/image/OVMF_VARS.fd
 </pre></div>
 </div>
 </li>
 <li><p>Increase the size of the VM by 10GB to accommodate the GDM installation:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>qemu-img<span class="w"> </span>resize<span class="w"> </span>-f<span class="w"> </span>raw<span class="w"> </span>clear-&lt;version&gt;-kvm.img<span class="w"> </span>+10G
 </pre></div>
 </div>
 </li>
 <li><p>Relaunch the Clear Linux OS VM:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>./start_qemu.sh<span class="w"> </span>clear.img
 </pre></div>
 </div>
 </li>
 <li><p>Determine the IP address of the host on which you will launch the VM.
 Substitute &lt;ip-addr-of-kvm-host&gt; in the next step with this information.</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ip<span class="w"> </span>a
 </pre></div>
 </div>
 </li>
 <li><p>From the local host or remote system, open a new terminal emulator window
 and connect into the Clear Linux OS VM using the Spice viewer:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>remote-viewer<span class="w"> </span>spice://&lt;ip-address-of-kvm-host&gt;:5924
 </pre></div>
 </div>
 </li>
 <li><p>Log in as <cite>root</cite> user into the Clear Linux OS VM.</p></li>
 <li><p>Follow these steps from <a class="reference internal" href="../../guides/maintenance/increase-virtual-disk-size.html#increase-virtual-disk-size"><span class="std std-ref">Increase Virtual Disk Size of an Image</span></a> to resize the
 partition of the virtual disk of the VM.</p></li>
 <li><p>Add GDM to the Clear Linux OS VM:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>swupd<span class="w"> </span>bundle-add<span class="w"> </span>desktop-autostart
 </pre></div>
 </div>
 </li>
 <li><p>Reboot the Clear Linux OS VM to start GDM:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>reboot
 </pre></div>
 </div>
 </li>
 <li><p>Go through the GDM out-of-box experience (OOBE).</p></li>
 <li><p>The default aspect ratio of the GDM GUI for the Clear Linux OS VM is 4:3. To change
 it, use GDM’s <cite>Devices &gt; Displays</cite> setting tool (located at the top-right
 corner).</p></li>
 </ol>
 <p><em>Intel and the Intel logo are trademarks of Intel Corporation or its subsidiaries.</em></p>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS on KVM</a><ul>
 <li><a class="reference internal" href="#install-qemu-kvm">Install QEMU-KVM</a></li>
 <li><a class="reference internal" href="#download-and-launch-the-virtual-machine-image">Download and launch the virtual machine image</a></li>
 <li><a class="reference internal" href="#optional-enable-ssh-access">Optional: Enable SSH access</a></li>
 <li><a class="reference internal" href="#optional-install-a-graphical-user-interface-gui">Optional: Install a graphical user interface (GUI)</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="hyper-v.html"
                          title="previous chapter">Clear Linux* OS on Microsoft Hyper-V*</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="parallels.html"
                          title="next chapter">Clear Linux* OS on Parallels* Desktop for Mac*</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/virtual-machine-install/kvm.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="parallels.html" title="Clear Linux* OS on Parallels* Desktop for Mac*"
             >next</a> |</li>
        <li class="right" >
          <a href="hyper-v.html" title="Clear Linux* OS on Microsoft Hyper-V*"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on KVM</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,273 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS on Parallels* Desktop for Mac* &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/virtual-machine-install/parallels.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Clear Linux* OS on Proxmox* Virtual Environment" href="proxmox.html" />
    <link rel="prev" title="Clear Linux* OS on KVM" href="kvm.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="proxmox.html" title="Clear Linux* OS on Proxmox* Virtual Environment"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="kvm.html" title="Clear Linux* OS on KVM"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Parallels* Desktop for Mac*</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-on-parallels-desktop-for-mac">
 <span id="parallels"></span><h1>Clear Linux* OS on Parallels* Desktop for Mac*<a class="headerlink" href="#cl-attr-on-parallels-desktop-for-mac" title="Link to this heading">¶</a></h1>
 <p>This page explains how to run Clear Linux OS Server in <abbr title="command-line interface">CLI</abbr> mode as a guest OS in Parallels Desktop 14 for Mac.</p>
 <p>Parallels Desktop for Mac is virtualization software that allows other
 operating systems, such as Linux, to run side-by-side with macOS*.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#prerequisites" id="id10">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#download-iso-image" id="id11">Download ISO image</a></p></li>
 <li><p><a class="reference internal" href="#initialize-new-vm" id="id12">Initialize new VM</a></p></li>
 <li><p><a class="reference internal" href="#install-cl-on-vm" id="id13">Install Clear Linux OS on VM</a></p></li>
 </ul>
 </nav>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id10" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Install Parallels Desktop 14 for Mac.</p></li>
 </ul>
 </section>
 <section id="download-iso-image">
 <h2><a class="toc-backref" href="#id11" role="doc-backlink">Download ISO image</a><a class="headerlink" href="#download-iso-image" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Download a live-server ISO installation file from <a class="reference external" href="https://clearlinux.org/downloads">https://clearlinux.org/downloads</a>.
 This guide uses Clear Linux OS Server 30140 as its example.</p></li>
 <li><p>Unzip the ISO image with the command:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>gunzip<span class="w"> </span>clear-30140-live-server.iso.xz
 </pre></div>
 </div>
 </li>
 </ol>
 </section>
 <section id="initialize-new-vm">
 <h2><a class="toc-backref" href="#id12" role="doc-backlink">Initialize new VM</a><a class="headerlink" href="#initialize-new-vm" title="Link to this heading">¶</a></h2>
 <p>Start Parallels and initialize your <abbr title="Virtual Machine">VM</abbr> with the
 following steps.</p>
 <ol class="arabic">
 <li><p>Go to <span class="menuselection">File &gt; New</span>.</p></li>
 <li><p>In the opening dialog window, select
 <span class="guilabel">Install Windows or another OS from a DVD or image</span>, then click
 <span class="guilabel">Continue</span>. (See Figure 1.)</p>
 <figure class="align-default" id="id1">
 <img alt="Parallels opening dialog" src="../../_images/parallels-01.png" />
 <figcaption>
 <p><span class="caption-text">Figure 1: Parallels opening dialog</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>On the next screen, select <span class="guilabel">Image File</span>, then click
 <span class="guilabel">Select a file…</span> as shown in Figure 2.</p>
 <figure class="align-default" id="id2">
 <img alt="Dialog to select source for VM" src="../../_images/parallels-02.png" />
 <figcaption>
 <p><span class="caption-text">Figure 2: Dialog to select source for VM</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Select your ISO file. The system displays the warning message “Unable to
 detect operating system”, as shown in Figure 3. This message is expected and
 can be ignored. Click <span class="guilabel">Continue</span>.</p>
 <figure class="align-default" id="id3">
 <img alt="Warning that OS is not detected" src="../../_images/parallels-03.png" />
 <figcaption>
 <p><span class="caption-text">Figure 3: Warning that OS is not detected</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>You are prompted to select your OS, as shown in Figure 4. Select
 <span class="menuselection">More Linux &gt; Other Linux</span> from the drop-down menu and click
 <span class="guilabel">Continue</span>.</p>
 <figure class="align-default" id="id4">
 <img alt="Select OS from drop-down menu" src="../../_images/parallels-04.png" />
 <figcaption>
 <p><span class="caption-text">Figure 4: Select OS from drop-down menu</span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Name your VM and check <span class="guilabel">Customize settings before installation</span>.
 (See Figure 5.)</p>
 <figure class="align-default" id="id5">
 <img alt="Name and Location screen" src="../../_images/parallels-05.png" />
 <figcaption>
 <p><span class="caption-text">Figure 5: Name and Location screen</span><a class="headerlink" href="#id5" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Click <span class="guilabel">Create</span>. The Configuration window for the new VM opens, as
 shown in Figure 6.</p>
 <p>Select <span class="menuselection">Hardware &gt; Boot Order</span>.</p>
 <figure class="align-default" id="id6">
 <img alt="VM Configuration window" src="../../_images/parallels-06.png" />
 <figcaption>
 <p><span class="caption-text">Figure 6: VM Configuration window</span><a class="headerlink" href="#id6" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Expand <span class="guilabel">Advanced Settings</span>. Set <span class="guilabel">BIOS</span> to “EFI 64-bit”
 and in the <span class="guilabel">Boot flags</span> field, enter “vm.bios.efi=1” as shown in
 Figure 7.</p>
 <figure class="align-default" id="id7">
 <img alt="Advanced configuration settings" src="../../_images/parallels-07.png" />
 <figcaption>
 <p><span class="caption-text">Figure 7: Advanced configuration settings</span><a class="headerlink" href="#id7" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Close the Configuration window and click <span class="guilabel">Continue</span>.</p>
 <p>If camera and microphone access restriction warnings are displayed, you can
 ignore them.</p>
 </li>
 </ol>
 </section>
 <section id="install-cl-on-vm">
 <h2><a class="toc-backref" href="#id13" role="doc-backlink">Install Clear Linux OS on VM</a><a class="headerlink" href="#install-cl-on-vm" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Follow the prompts and install Clear Linux OS using the text-based installer as shown
 in Figure 8.</p>
 <p>Refer to <a class="reference internal" href="../bare-metal-install-server.html#bare-metal-install-server"><span class="std std-ref">Install Clear Linux* OS from the live server</span></a> for additional installation
 instructions.</p>
 <figure class="align-default" id="id8">
 <img alt="On screen instructions from text-based installer" src="../../_images/parallels-08.png" />
 <figcaption>
 <p><span class="caption-text">Figure 8: On screen instructions from text-based installer</span><a class="headerlink" href="#id8" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>After installation, reboot the VM. You are prompted to log in, as shown
 in Figure 9. Log in with the credentials you used when you installed Clear Linux OS
 on the VM.</p>
 <figure class="align-default" id="id9">
 <img alt="Log in prompt" src="../../_images/parallels-09.png" />
 <figcaption>
 <p><span class="caption-text">Figure 9: Log in prompt</span><a class="headerlink" href="#id9" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 <p>Congratulations! You have successfully set up a Clear Linux OS VM using Parallels
 Desktop for Mac.</p>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS on Parallels* Desktop for Mac*</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#download-iso-image">Download ISO image</a></li>
 <li><a class="reference internal" href="#initialize-new-vm">Initialize new VM</a></li>
 <li><a class="reference internal" href="#install-cl-on-vm">Install Clear Linux OS on VM</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="kvm.html"
                          title="previous chapter">Clear Linux* OS on KVM</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="proxmox.html"
                          title="next chapter">Clear Linux* OS on Proxmox* Virtual Environment</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/virtual-machine-install/parallels.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="proxmox.html" title="Clear Linux* OS on Proxmox* Virtual Environment"
             >next</a> |</li>
        <li class="right" >
          <a href="kvm.html" title="Clear Linux* OS on KVM"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Parallels* Desktop for Mac*</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
@@ -1,355 +0,0 @@
 <!DOCTYPE html>
 <html lang="en" data-content_root="../../">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Clear Linux* OS on Proxmox* Virtual Environment &#8212; Documentation for Clear Linux* project</title>
    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
    <link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
    <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
    <script src="../../_static/documentation_options.js?v=5929fcd5"></script>
    <script src="../../_static/doctools.js?v=9bcbadda"></script>
    <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../../_static/copybutton.js?v=a56c686a"></script>
    <script src="../../_static/bizstyle.js"></script>
    <link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/get-started/virtual-machine-install/proxmox.html" />
    <link rel="icon" href="../../_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="../../about.html" />
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="Clear Linux* OS using virt-manager" href="virt-manager.html" />
    <link rel="prev" title="Clear Linux* OS on Parallels* Desktop for Mac*" href="parallels.html" />
    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
    <!--[if lt IE 9]>
    <script src="_static/css3-mediaqueries.js"></script>
    <![endif]-->
  </head><body>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="virt-manager.html" title="Clear Linux* OS using virt-manager"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="parallels.html" title="Clear Linux* OS on Parallels* Desktop for Mac*"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Proxmox* Virtual Environment</a></li> 
      </ul>
    </div>  
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
  <section id="cl-attr-on-proxmox-virtual-environment">
 <span id="proxmox"></span><h1>Clear Linux* OS on Proxmox* Virtual Environment<a class="headerlink" href="#cl-attr-on-proxmox-virtual-environment" title="Link to this heading">¶</a></h1>
 <p>This guide explains how to create a new VM in Proxmox VE 6.1-3, install and run Clear Linux OS on as a guest OS.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#prerequisites" id="id14">Prerequisites</a></p></li>
 <li><p><a class="reference internal" href="#download-the-latest-cl-live-server-image" id="id15">Download the Latest Clear Linux OS Live Server Image</a></p></li>
 <li><p><a class="reference internal" href="#upload-cl-live-server-image-to-promox-server" id="id16">Upload Clear Linux OS Live Server Image to Promox Server</a></p></li>
 <li><p><a class="reference internal" href="#create-vm-on-proxmox" id="id17">Create VM on Proxmox</a></p></li>
 <li><p><a class="reference internal" href="#start-vm-and-install-cl-on-promox" id="id18">Start VM and Install Clear Linux OS on Promox</a></p></li>
 </ul>
 </nav>
 <section id="prerequisites">
 <h2><a class="toc-backref" href="#id14" role="doc-backlink">Prerequisites</a><a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>Proxmox VE 6.1-3 server already set up and you have familiarity with how
 to use it.</p></li>
 </ul>
 </section>
 <section id="download-the-latest-cl-live-server-image">
 <h2><a class="toc-backref" href="#id15" role="doc-backlink">Download the Latest Clear Linux OS Live Server Image</a><a class="headerlink" href="#download-the-latest-cl-live-server-image" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Visit our <a class="reference external" href="https://clearlinux.org/downloads">Downloads</a> page.</p></li>
 <li><p>Download the file <code class="file docutils literal notranslate"><span class="pre">clear-&lt;release</span> <span class="pre">number&gt;-live-server.iso</span></code>,
 also called the Clear Linux OS Server.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>&lt;release-number&gt; is the latest Clear Linux OS auto-numbered release.</p>
 </div>
 </li>
 </ol>
 </section>
 <section id="upload-cl-live-server-image-to-promox-server">
 <h2><a class="toc-backref" href="#id16" role="doc-backlink">Upload Clear Linux OS Live Server Image to Promox Server</a><a class="headerlink" href="#upload-cl-live-server-image-to-promox-server" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Connect to your Proxmox server and log into an account with sufficient
 permission to create and manage VMs.</p></li>
 <li><p>Under the <span class="guilabel">Server View</span> window, select the <span class="guilabel">local</span>
 storage.  See Figure 1.</p></li>
 <li><p>On the right window, click <span class="guilabel">Upload</span>.</p>
 <figure class="align-default" id="id1">
 <a class="reference internal image-reference" href="../../_images/proxmox-01.png"><img alt="Proxmox - Upload ISO" src="../../_images/proxmox-01.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 1: Proxmox - Upload ISO</span><a class="headerlink" href="#id1" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Set the <span class="guilabel">Content</span> as <cite>ISO image</cite>. See Figure 2.</p></li>
 <li><p>Click <span class="guilabel">Select File…</span> and select the Clear Linux OS ISO.</p></li>
 <li><p>Click <span class="guilabel">Upload</span>.</p>
 <figure class="align-default" id="id2">
 <a class="reference internal image-reference" href="../../_images/proxmox-02.png"><img alt="Proxmox - Select ISO to upload" src="../../_images/proxmox-02.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 2: Proxmox - Select ISO to upload</span><a class="headerlink" href="#id2" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 <p>The ISO should now appear in the <span class="guilabel">Content</span> list.  See Figure 3.</p>
 <figure class="align-default" id="id3">
 <a class="reference internal image-reference" href="../../_images/proxmox-03.png"><img alt="Proxmox - Content list" src="../../_images/proxmox-03.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 3: Proxmox - Content list</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="create-vm-on-proxmox">
 <h2><a class="toc-backref" href="#id17" role="doc-backlink">Create VM on Proxmox</a><a class="headerlink" href="#create-vm-on-proxmox" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Under the <span class="guilabel">Server View</span> window, select your Proxmox node.
 See Figure 4.</p></li>
 <li><p>On the right window, click <span class="guilabel">Create VM</span>.</p>
 <figure class="align-default" id="id4">
 <a class="reference internal image-reference" href="../../_images/proxmox-04.png"><img alt="Proxmox - Create VM" src="../../_images/proxmox-04.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 4: Proxmox - Create VM</span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the <span class="guilabel">General</span> tab:
 | See Figure 5.</p>
 <ol class="loweralpha simple">
 <li><p>Check the <span class="guilabel">Advanced</span> checkbox.</p></li>
 <li><p>In the <span class="guilabel">Name</span> field, give the VM a name.</p></li>
 </ol>
 <figure class="align-default" id="id5">
 <a class="reference internal image-reference" href="../../_images/proxmox-05.png"><img alt="Proxmox - Create VM - General settings" src="../../_images/proxmox-05.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 5: Proxmox - Create VM - General settings</span><a class="headerlink" href="#id5" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the <span class="guilabel">OS</span> tab:
 See Figure 6.</p>
 <ol class="loweralpha simple">
 <li><p>Select <span class="guilabel">Use CD/DVD disc image file (iso)</span>.</p></li>
 <li><p>For <span class="guilabel">Storage</span>, select <span class="guilabel">local</span>.</p></li>
 <li><p>For <span class="guilabel">ISO image</span>, select the Clear Linux OS ISO you uploaded earlier.</p></li>
 <li><p>Set the <span class="guilabel">Type</span> to <span class="guilabel">Linux</span>.</p></li>
 <li><p>Set the <span class="guilabel">Version</span> to <span class="guilabel">5.x - 2.6 kernel</span>.</p></li>
 </ol>
 <figure class="align-default" id="id6">
 <a class="reference internal image-reference" href="../../_images/proxmox-06.png"><img alt="Proxmox - Create VM - OS settings" src="../../_images/proxmox-06.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 6: Proxmox - Create VM - OS settings</span><a class="headerlink" href="#id6" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the <span class="guilabel">System</span> tab:
 See Figure 7.</p>
 <ol class="loweralpha simple">
 <li><p>For <span class="guilabel">BIOS</span>, select <span class="guilabel">OVMF (UEFI)</span>.</p></li>
 <li><p>For <span class="guilabel">Storage</span>, select an appropriate location.</p></li>
 <li><p>For <span class="guilabel">Machine</span>, select <span class="guilabel">q35</span>.</p></li>
 </ol>
 <figure class="align-default" id="id7">
 <a class="reference internal image-reference" href="../../_images/proxmox-07.png"><img alt="Proxmox - Create VM - System settings" src="../../_images/proxmox-07.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 7: Proxmox - Create VM - System settings</span><a class="headerlink" href="#id7" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the <span class="guilabel">Hard Disk</span> tab:
 See Figure 8.</p>
 <ol class="loweralpha simple">
 <li><p>For <span class="guilabel">Disk size (GiB)</span>, set the desired disk size for your VM.
 A minimum of 4GB is required for Clear Linux OS.</p></li>
 </ol>
 <figure class="align-default" id="id8">
 <a class="reference internal image-reference" href="../../_images/proxmox-08.png"><img alt="Proxmox - Create VM - Hard Disk settings" src="../../_images/proxmox-08.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 8: Proxmox - Create VM - Hard Disk settings</span><a class="headerlink" href="#id8" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the <span class="guilabel">CPU</span> tab:
 See Figure 9.</p>
 <ol class="loweralpha simple">
 <li><p>Set the <span class="guilabel">Type</span> to <span class="guilabel">host</span>.</p></li>
 <li><p>For the <span class="guilabel">Extra CPU Flags</span>, scroll to the bottom and turn on the
 <span class="guilabel">aes</span> setting by clicking the <span class="guilabel">+</span> radio button.</p></li>
 </ol>
 <figure class="align-default" id="id9">
 <a class="reference internal image-reference" href="../../_images/proxmox-09.png"><img alt="Proxmox - Create VM - CPU settings" src="../../_images/proxmox-09.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 9: Proxmox - Create VM - CPU settings</span><a class="headerlink" href="#id9" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the <span class="guilabel">Memory</span> tab:
 See Figure 10.</p>
 <ol class="loweralpha simple">
 <li><p>For <span class="guilabel">Memory (MiB)</span>, set a desired value.</p></li>
 </ol>
 <figure class="align-default" id="id10">
 <a class="reference internal image-reference" href="../../_images/proxmox-10.png"><img alt="Proxmox - Create VM - Memory settings" src="../../_images/proxmox-10.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 10: Proxmox - Create VM - Memory settings</span><a class="headerlink" href="#id10" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the <span class="guilabel">Network</span> tab:
 See Figure 11.</p>
 <ol class="loweralpha simple">
 <li><p>For <span class="guilabel">Model</span>, select <span class="guilabel">E1000</span>.</p></li>
 </ol>
 <figure class="align-default" id="id11">
 <a class="reference internal image-reference" href="../../_images/proxmox-11.png"><img alt="Proxmox - Create VM - Network settings" src="../../_images/proxmox-11.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 11: Proxmox - Create VM - Network settings</span><a class="headerlink" href="#id11" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>In the <span class="guilabel">Confirm</span> tab:
 See Figure 12.</p>
 <ol class="loweralpha simple">
 <li><p>Confirm the settings.</p></li>
 <li><p>Click <span class="guilabel">Finish</span> to create the VM.  The new VM should appear
 under the <span class="guilabel">Server View</span> window.</p></li>
 </ol>
 <figure class="align-default" id="id12">
 <a class="reference internal image-reference" href="../../_images/proxmox-12.png"><img alt="Proxmox - Create VM - Confirm settings" src="../../_images/proxmox-12.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 12: Proxmox - Create VM - Confirm settings</span><a class="headerlink" href="#id12" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 </ol>
 </section>
 <section id="start-vm-and-install-cl-on-promox">
 <h2><a class="toc-backref" href="#id18" role="doc-backlink">Start VM and Install Clear Linux OS on Promox</a><a class="headerlink" href="#start-vm-and-install-cl-on-promox" title="Link to this heading">¶</a></h2>
 <ol class="arabic">
 <li><p>Under the <span class="guilabel">Server View</span> window, select your newly-created VM.
 See Figure 13.</p></li>
 <li><p>On the right window, click <span class="guilabel">Start</span>.</p></li>
 <li><p>Click <span class="guilabel">Console</span> button to bring up a console and interact with it.</p>
 <figure class="align-default" id="id13">
 <a class="reference internal image-reference" href="../../_images/proxmox-13.png"><img alt="Proxmox - Start VM" src="../../_images/proxmox-13.png" style="width: 1122.0px; height: 884.0px;" />
 </a>
 <figcaption>
 <p><span class="caption-text">Figure 13: Proxmox - Start VM</span><a class="headerlink" href="#id13" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </li>
 <li><p>Follow the instructions in the <a class="reference internal" href="../bare-metal-install-server.html#bare-metal-install-server"><span class="std std-ref">Install Clear Linux* OS from the live server</span></a> guide
 starting at the <cite>Launch the Clear Linux OS Installer</cite> section.</p></li>
 </ol>
 </section>
 </section>
            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="Main">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
            </a></p>
  <div>
    <h3><a href="../../index.html">Table of Contents</a></h3>
    <ul>
 <li><a class="reference internal" href="#">Clear Linux* OS on Proxmox* Virtual Environment</a><ul>
 <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
 <li><a class="reference internal" href="#download-the-latest-cl-live-server-image">Download the Latest Clear Linux OS Live Server Image</a></li>
 <li><a class="reference internal" href="#upload-cl-live-server-image-to-promox-server">Upload Clear Linux OS Live Server Image to Promox Server</a></li>
 <li><a class="reference internal" href="#create-vm-on-proxmox">Create VM on Proxmox</a></li>
 <li><a class="reference internal" href="#start-vm-and-install-cl-on-promox">Start VM and Install Clear Linux OS on Promox</a></li>
 </ul>
 </li>
 </ul>
  </div>
  <div>
    <h4>Previous topic</h4>
    <p class="topless"><a href="parallels.html"
                          title="previous chapter">Clear Linux* OS on Parallels* Desktop for Mac*</a></p>
  </div>
  <div>
    <h4>Next topic</h4>
    <p class="topless"><a href="virt-manager.html"
                          title="next chapter">Clear Linux* OS using virt-manager</a></p>
  </div>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="../../_sources/get-started/virtual-machine-install/proxmox.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
 <search id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>
    </div>
 </search>
 <script>document.getElementById('searchbox').style.display = "block"</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="Related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="virt-manager.html" title="Clear Linux* OS using virt-manager"
             >next</a> |</li>
        <li class="right" >
          <a href="parallels.html" title="Clear Linux* OS on Parallels* Desktop for Mac*"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Get started</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Clear Linux* OS on Proxmox* Virtual Environment</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
    &#169; Copyright 2022 Intel Corporation. All Rights Reserved..
      Last updated on Nov 04, 2024.
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
    </div>
  </body>
 </html>
--- a/Show More
+++ b/Show More