Skip to content

Commit

Permalink
New lorax documentation - 34.3
Browse files Browse the repository at this point in the history
  • Loading branch information
bcl committed Oct 1, 2020
1 parent e3e8ff8 commit 9b06645
Show file tree
Hide file tree
Showing 110 changed files with 1,462 additions and 3,150 deletions.
17 changes: 9 additions & 8 deletions docs/composer-cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -202,10 +202,7 @@ without actually composing anything.


Blueprint Reference
===================

Blueprints
----------
-------------------

Blueprints are simple text files in `TOML <https://github.com/toml-lang/toml>`_ format that describe
which packages, and what versions, to install into the image. They can also define a limited set
Expand Down Expand Up @@ -234,7 +231,7 @@ set to ``0.1.0`` when the existing blueprint ``version`` is ``0.0.1`` will
result in the new blueprint being stored as ``version 0.1.0``.

[[packages]] and [[modules]]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

These entries describe the package names and matching version glob to be installed into the image.

Expand All @@ -260,7 +257,7 @@ this to your blueprint::


[[groups]]
~~~~~~~~~~
^^^^^^^^^^

The ``groups`` entries describe a group of packages to be installed into the image. Package groups are
defined in the repository metadata. Each group has a descriptive name used primarily for display
Expand All @@ -282,7 +279,7 @@ no version number.


Customizations
~~~~~~~~~~~~~~
^^^^^^^^^^^^^^

The ``[customizations]`` section can be used to configure the hostname of the final image. eg.::

Expand Down Expand Up @@ -484,7 +481,11 @@ repository with a large amount of history may take a while to clone and use a si
amount of disk space. The clone is temporary and is removed once the rpm is created.

Example Blueprint
=================
-----------------

This example blueprint will install the ``tmux``, ``git``, and ``vim-enhanced``
packages. It will set the ``root`` ssh key, add the ``widget`` and ``admin``
users as well as a ``students`` group::

name = "example-custom-base"
description = "A base system with customizations"
Expand Down
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: db185bc49407d9d7e5a899df753f5afa
config: d9d287449bd26afc7e34fe721edb25e6
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/html/.doctrees/composer-cli.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/composer.cli.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/html/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/lifted.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/livemedia-creator.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/lorax-composer.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/lorax.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/mkksiso.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/modules.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/pylorax.doctree
Binary file not shown.
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli &mdash; Lorax 34.0 documentation</title>
<title>composer.cli &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../product-images.html">Product and Updates Images</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli/blueprints.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.blueprints &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.blueprints &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli/cmdline.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.cmdline &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.cmdline &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli/compose.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.compose &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.compose &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.modules &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.modules &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli/projects.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.projects &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.projects &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli/providers.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.providers &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.providers &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli/sources.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.sources &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.sources &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli/status.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.status &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.status &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/cli/upload.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.upload &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.upload &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down
7 changes: 3 additions & 4 deletions docs/html/_modules/composer/cli/utilities.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.cli.utilities &mdash; Lorax 34.0 documentation</title>
<title>composer.cli.utilities &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
Expand Down Expand Up @@ -262,7 +261,7 @@ <h1>Source code for composer.cli.utilities</h1><div class="highlight"><pre>
<span class="sd"> :type name: string</span>
<span class="sd"> :param argtype: Type to use for checking the argument value</span>
<span class="sd"> :type argtype: type</span>
<span class="sd"> :returns (args, value)</span>
<span class="sd"> :returns: (args, value)</span>
<span class="sd"> :rtype: tuple</span>

<span class="sd"> This removes the optional argument and value from the argument list, returns the new list,</span>
Expand Down
5 changes: 2 additions & 3 deletions docs/html/_modules/composer/http_client.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>composer.http_client &mdash; Lorax 34.0 documentation</title>
<title>composer.http_client &mdash; Lorax 34.3 documentation</title>



Expand Down Expand Up @@ -58,7 +58,7 @@


<div class="version">
34.0
34.3
</div>


Expand Down Expand Up @@ -87,7 +87,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../intro.html#before-lorax">Before Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../lorax.html">Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../livemedia-creator.html">livemedia-creator</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../lorax-composer.html">lorax-composer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../composer-cli.html">composer-cli</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../product-images.html">Product and Updates Images</a></li>
Expand Down
Loading

0 comments on commit 9b06645

Please sign in to comment.