Brian C. Lane
parent
354ee6d301
commit
6e0c52ce78
|
|
@ -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: 70a7edc36d19abd5eeb8cb6028d02c14
|
||||
config: 6b412c1cb8a574fbaeacd67cced1e5e1
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -1,38 +1,44 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<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.0" />
|
||||
|
||||
<title>Overview: module code — Lorax 28.14.42 documentation</title>
|
||||
<title>Overview: module code — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
</head>
|
||||
|
|
@ -58,7 +64,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -75,6 +81,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -87,6 +94,7 @@
|
|||
<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="../mkksiso.html">mkksiso</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="../product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -96,6 +104,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -130,11 +139,13 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="../index.html">Docs</a> »</li>
|
||||
<li><a href="../index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>Overview: module code</li>
|
||||
|
||||
|
|
@ -186,20 +197,25 @@
|
|||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -208,7 +224,6 @@
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
|
|
@ -4,12 +4,14 @@ composer-cli
|
|||
:Authors:
|
||||
Brian C. Lane <bcl@redhat.com>
|
||||
|
||||
``composer-cli`` is used to interact with the ``lorax-composer`` API server, managing blueprints, exploring available packages, and building new images.
|
||||
``composer-cli`` is an interactive tool for use with a WELDR API server,
|
||||
managing blueprints, exploring available packages, and building new images.
|
||||
`lorax-composer <lorax-composer.html>` and `osbuild-composer
|
||||
<https://osbuild.org>` both implement compatible servers.
|
||||
|
||||
It requires `lorax-composer <lorax-composer.html>`_ to be installed on the
|
||||
local system, and the user running it needs to be a member of the ``weldr``
|
||||
group. They do not need to be root, but all of the `security precautions
|
||||
<lorax-composer.html#security>`_ apply.
|
||||
It requires server to be installed on the local system, and the user running it
|
||||
needs to be a member of the ``weldr`` group. They do not need to be root, but
|
||||
all of the `security precautions <lorax-composer.html#security>`_ apply.
|
||||
|
||||
composer-cli cmdline arguments
|
||||
------------------------------
|
||||
|
|
@ -25,13 +27,16 @@ Start out by listing the available blueprints using ``composer-cli blueprints
|
|||
list``, pick one and save it to the local directory by running ``composer-cli
|
||||
blueprints save http-server``. If there are no blueprints available you can
|
||||
copy one of the examples `from the test suite
|
||||
<https://github.com/weldr/lorax/tree/master/tests/pylorax/blueprints/>`_.
|
||||
<https://github.com/weldr/lorax/tree/rhel8-branch/tests/pylorax/blueprints/>`_.
|
||||
|
||||
Edit the file (it will be saved with a .toml extension) and change the
|
||||
description, add a package or module to it. Send it back to the server by
|
||||
running ``composer-cli blueprints push http-server.toml``. You can verify that it was
|
||||
saved by viewing the changelog - ``composer-cli blueprints changes http-server``.
|
||||
|
||||
The full blueprint documentation `is here
|
||||
<https://www.osbuild.org/guides/blueprint-reference/blueprint-reference.html>`_.
|
||||
|
||||
Build an image
|
||||
----------------
|
||||
|
||||
|
|
@ -60,3 +65,80 @@ Downloading the final image is done with ``composer-cli compose image UUID`` and
|
|||
save the qcow2 image as ``UUID-disk.qcow2`` which you can then use to boot a VM like this::
|
||||
|
||||
qemu-kvm --name test-image -m 1024 -hda ./UUID-disk.qcow2
|
||||
|
||||
|
||||
Image Uploads
|
||||
-------------
|
||||
|
||||
``composer-cli`` can upload the images to a number of services, including AWS,
|
||||
OpenStack, and vSphere. The upload can be started when the build is finished
|
||||
by using ``composer-cli compose start ...``. In order to access the service you need
|
||||
to pass authentication details to composer-cli using a TOML file.
|
||||
|
||||
.. note::
|
||||
|
||||
This is only supported when running the ``osbuild-composer`` API server.
|
||||
|
||||
|
||||
Providers
|
||||
---------
|
||||
|
||||
Providers are where the images are uploaded to. You
|
||||
will need to gather some provider
|
||||
specific information in order to authenticate with it. Please refer to the ``osbuild-composer``
|
||||
documentation for the provider specific fields. You will then create a TOML file with the
|
||||
name of the provider and the settings, like this::
|
||||
|
||||
provider = "aws"
|
||||
|
||||
[settings]
|
||||
aws_access_key = "AWS Access Key"
|
||||
aws_bucket = "AWS Bucket"
|
||||
aws_region = "AWS Region"
|
||||
aws_secret_key = "AWS Secret Key"
|
||||
|
||||
Save this into an ``aws-credentials.toml`` file and use it when running ``start``.
|
||||
|
||||
AWS
|
||||
^^^
|
||||
|
||||
The access key and secret key can be created by going to the
|
||||
``IAM->Users->Security Credentials`` section and creating a new access key. The
|
||||
secret key will only be shown when it is first created so make sure to record
|
||||
it in a secure place. The region should be the region that you want to use the
|
||||
AMI in, and the bucket can be an existing bucket, or a new one, following the
|
||||
normal AWS bucket naming rules. It will be created if it doesn't already exist.
|
||||
|
||||
When uploading the image it is first uploaded to the s3 bucket, and then
|
||||
converted to an AMI. If the conversion is successful the s3 object will be
|
||||
deleted. If it fails, re-trying after correcting the problem will re-use the
|
||||
object if you have not deleted it in the meantime, speeding up the process.
|
||||
|
||||
|
||||
Build an image and upload results
|
||||
---------------------------------
|
||||
|
||||
With the settings stored in a TOML file::
|
||||
|
||||
composer-cli compose start example-http-server ami "http image" aws-settings.toml
|
||||
|
||||
It will return the UUID of the image build. Once
|
||||
the build has finished successfully it will start the upload process.
|
||||
|
||||
|
||||
Debugging
|
||||
---------
|
||||
|
||||
There are a couple of arguments that can be helpful when debugging problems.
|
||||
These are only meant for debugging and should not be used to script access to
|
||||
the API. If you need to do that you can communicate with it directly in the
|
||||
language of your choice.
|
||||
|
||||
``--json`` will return the server's response as a nicely formatted json output
|
||||
instead of printing what the command would usually print.
|
||||
|
||||
``--test=1`` will cause a compose start to start creating an image, and then
|
||||
end with a failed state.
|
||||
|
||||
``--test=2`` will cause a compose to start and then end with a finished state,
|
||||
without actually composing anything.
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@ Contents:
|
|||
intro
|
||||
lorax
|
||||
livemedia-creator
|
||||
mkksiso
|
||||
lorax-composer
|
||||
composer-cli
|
||||
product-images
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ lorax-composer
|
|||
:Authors:
|
||||
Brian C. Lane <bcl@redhat.com>
|
||||
|
||||
``lorax-composer`` is an API server that allows you to build disk images using
|
||||
``lorax-composer`` is a WELDR API server that allows you to build disk images using
|
||||
`Blueprints`_ to describe the package versions to be installed into the image.
|
||||
It is compatible with the Weldr project's bdcs-api REST protocol. More
|
||||
information on Weldr can be found `on the Weldr blog <http://www.weldr.io>`_.
|
||||
|
|
@ -13,6 +13,15 @@ Behind the scenes it uses `livemedia-creator <livemedia-creator.html>`_ and
|
|||
`Anaconda <https://anaconda-installer.readthedocs.io/en/latest/>`_ to handle the
|
||||
installation and configuration of the images.
|
||||
|
||||
.. note::
|
||||
|
||||
``lorax-composer`` is now deprecated. It is being replaced by the
|
||||
``osbuild-composer`` WELDR API server which implements more features (eg.
|
||||
ostree, image uploads, etc.) You can still use ``composer-cli`` and
|
||||
``cockpit-composer`` with ``osbuild-composer``. See the documentation or
|
||||
the `osbuild website <https://www.osbuild.org/>`_ for more information.
|
||||
|
||||
|
||||
Important Things To Note
|
||||
------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,129 @@
|
|||
mkksiso
|
||||
=======
|
||||
|
||||
:Authors:
|
||||
Brian C. Lane <bcl@redhat.com>
|
||||
|
||||
``mkksiso`` is a tool for creating kickstart boot isos. In it's simplest form
|
||||
you can add a kickstart to a boot.iso and the kickstart will be executed when
|
||||
the iso is booted. If the original iso was created with EFI and Mac support the
|
||||
kickstart boot.iso will include this support as well.
|
||||
|
||||
``mkksiso`` needs to be run as root, it depends on mounting the original iso
|
||||
and you need to be root to be able to do that.
|
||||
|
||||
|
||||
mkksiso cmdline arguments
|
||||
-------------------------
|
||||
|
||||
Add a kickstart and files to an iso
|
||||
|
||||
``usage: mkksiso [-h] [-a ADD_PATHS] [-c CMDLINE] [--debug] ks input_iso output_iso``
|
||||
|
||||
Optional arguments
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
-h, --help show this help message and exit
|
||||
-a ADD_PATHS, --add ADD_PATHS
|
||||
File or directory to add to ISO (may be used multiple
|
||||
times)
|
||||
-c CMDLINE, --cmdline CMDLINE
|
||||
Arguments to add to kernel cmdline
|
||||
--debug print debugging info
|
||||
-V VOLID, --volid VOLID
|
||||
Set the ISO volume id, defaults to input's
|
||||
|
||||
Positional arguments
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
:ks: Kickstart to add to the ISO
|
||||
|
||||
:input_iso: ISO to modify
|
||||
|
||||
:output_iso: Full pathname of iso to be created
|
||||
|
||||
|
||||
Create a kickstart boot.iso or DVD
|
||||
----------------------------------
|
||||
|
||||
Create a kickstart like you normally would, kickstart documentation can be
|
||||
`found here <https://pykickstart.readthedocs.io/en/latest/>`_, including the
|
||||
``url`` and ``repo`` commands. If you are creating a DVD and only need the
|
||||
content on the DVD you can use the ``cdrom`` command to install without a
|
||||
network connection. Then run ``mkksiso`` like this::
|
||||
|
||||
mkksiso /PATH/TO/KICKSTART /PATH/TO/ISO /PATH/TO/NEW-ISO
|
||||
|
||||
This will create a new iso with the kickstart in the root directory, and the
|
||||
kernel cmdline will have ``inst.ks=...`` added to it so that it will be
|
||||
executed when the iso is booted (be careful not to boot on a system you don't
|
||||
want to wipe out! There will be no prompting).
|
||||
|
||||
By default the volume id of the iso is preserved. You can set a custom volid
|
||||
by passing ``-V`` and the string to set. The kernel cmdline will be changes, and the iso will have th custom volume id.
|
||||
eg.::
|
||||
|
||||
mkksiso -V "Test Only" /PATH/TO/KICKSTART /PATH/TO/ISO /PATH/TO/NEW-ISO
|
||||
|
||||
|
||||
Adding package repos to a boot.iso
|
||||
----------------------------------
|
||||
|
||||
You can add repo directories to the iso using ``--add /PATH/TO/REPO/``, make
|
||||
sure it contains the ``repodata`` directory by running ``createrepo_c`` on it
|
||||
first. In the kickstart you can refer to the directories (and files) on the iso
|
||||
using ``file:///run/install/repo/DIRECTORY/``. You can then use these repos in
|
||||
the kickstart like this::
|
||||
|
||||
repo --name=extra-repo --baseurl=file:///run/install/repo/extra-repo/
|
||||
|
||||
Run ``mkksiso`` like so::
|
||||
|
||||
mkksiso --add /PATH/TO/REPO/ /PATH/TO/KICKSTART /PATH/TO/ISO /PATH/TO/NEW-ISO
|
||||
|
||||
|
||||
Create a liveimg boot.iso
|
||||
-------------------------
|
||||
|
||||
You can use the kickstart `liveimg command
|
||||
<https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html#liveimg>`_,
|
||||
to install a pre-generated disk image or tar to the system the iso is booting
|
||||
on.
|
||||
|
||||
Create a disk image or tar with ``osbuild-composer`` or ``livemedia-creator``,
|
||||
make sure the image includes tools expected by ``anaconda``, as well as the
|
||||
kernel and bootloader support. In ``osbuild-composer`` use the ``tar`` image
|
||||
type and make sure to include the ``kernel``, ``grub2``, and ``grub2-tools``
|
||||
packages. If you plan to install it to a UEFI machine make sure to include
|
||||
``grub2-efi`` and ``efibootmgr`` in the blueprint.
|
||||
|
||||
Add the ``root.tar.xz`` file to the iso using ``--add /PATH/TO/ROOT.TAR.XZ``,
|
||||
and in the kickstart reference it with the ``liveimg`` command like this::
|
||||
|
||||
liveimg --url=file:///run/install/repo/root.tar.xz
|
||||
|
||||
It is also a good idea to use the ``--checksum`` argument to ``liveimg`` to be
|
||||
sure the file hasn't been corrupted::
|
||||
|
||||
mkksiso --add /PATH/TO/root.tar.xz /PATH/TO/KICKSTART /PATH/TO/ISO /PATH/TO/NEW-ISO
|
||||
|
||||
When this iso is booted it will execute the kickstart and install the liveimg
|
||||
contents to the system without any prompting.
|
||||
|
||||
|
||||
How it works
|
||||
------------
|
||||
|
||||
``mkksiso`` first examines the system to make sure the tools it needs are installed,
|
||||
it will work with ``xorrisofs`` or ``mkisofs`` installed. It mounts the source iso,
|
||||
and copies the directories that need to be modified to a temporary directory.
|
||||
|
||||
It then modifies the boot configuration files to include the ``inst.ks`` command,
|
||||
and checks to see if the original iso supports EFI. If it does it regenerates the
|
||||
EFI boot images with the new configuration, and then runs the available iso creation
|
||||
tool to add the new files and directories to the new iso. If the architecture is
|
||||
``x86_64`` it will also make sure the iso can be booted as an iso or from a USB
|
||||
stick (hybridiso).
|
||||
|
||||
The last step is to update the iso checksums so that booting with test enabled
|
||||
will pass.
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -15,6 +15,12 @@ div.clearer {
|
|||
clear: both;
|
||||
}
|
||||
|
||||
div.section::after {
|
||||
display: block;
|
||||
content: '';
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
|
|
@ -124,7 +130,7 @@ ul.search li a {
|
|||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li div.context {
|
||||
ul.search li p.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
|
|
@ -271,25 +277,25 @@ p.rubric {
|
|||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left {
|
||||
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, object.align-right {
|
||||
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, object.align-center {
|
||||
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 {
|
||||
img.align-default, figure.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
|
|
@ -313,24 +319,31 @@ img.align-default, .figure.align-default {
|
|||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar {
|
||||
div.sidebar,
|
||||
aside.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px 7px 0 7px;
|
||||
padding: 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
clear: right;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition, div.topic, blockquote {
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px 7px 0 7px;
|
||||
padding: 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
|
|
@ -352,10 +365,6 @@ div.admonition dt {
|
|||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition dl {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
|
|
@ -366,9 +375,30 @@ div.body p.centered {
|
|||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||
|
||||
div.sidebar > :last-child,
|
||||
aside.sidebar > :last-child,
|
||||
div.topic > :last-child,
|
||||
div.admonition > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sidebar::after,
|
||||
aside.sidebar::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;
|
||||
}
|
||||
|
|
@ -416,32 +446,34 @@ table.citation td {
|
|||
border-bottom: none;
|
||||
}
|
||||
|
||||
th > p:first-child,
|
||||
td > p:first-child {
|
||||
th > :first-child,
|
||||
td > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
th > p:last-child,
|
||||
td > p:last-child {
|
||||
th > :last-child,
|
||||
td > :last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
div.figure, figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
div.figure p.caption, figcaption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
div.figure p.caption span.caption-number,
|
||||
figcaption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
div.figure p.caption span.caption-text,
|
||||
figcaption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
|
|
@ -468,10 +500,71 @@ table.field-list td, table.field-list th {
|
|||
|
||||
/* -- 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 ----------------------------------------------------- */
|
||||
|
||||
|
|
@ -495,17 +588,37 @@ ol.upperroman {
|
|||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
li > p:first-child {
|
||||
:not(li) > ol > li:first-child > :first-child,
|
||||
:not(li) > ul > li:first-child > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
li > p:last-child {
|
||||
: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;
|
||||
}
|
||||
|
||||
dl.footnote > dt,
|
||||
dl.citation > dt {
|
||||
float: left;
|
||||
margin-right: 0.5em;
|
||||
}
|
||||
|
||||
dl.footnote > dd,
|
||||
|
|
@ -520,14 +633,15 @@ dl.citation > dd:after {
|
|||
}
|
||||
|
||||
dl.field-list {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
display: grid;
|
||||
grid-template-columns: fit-content(30%) auto;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
flex-basis: 20%;
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
padding-left: 0.5em;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
dl.field-list > dt:after {
|
||||
|
|
@ -535,8 +649,8 @@ dl.field-list > dt:after {
|
|||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
flex-basis: 70%;
|
||||
padding-left: 1em;
|
||||
padding-left: 0.5em;
|
||||
margin-top: 0em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
|
@ -545,7 +659,7 @@ dl {
|
|||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd > p:first-child {
|
||||
dd > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
|
|
@ -559,6 +673,11 @@ dd {
|
|||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dl > dd:last-child,
|
||||
dl > dd:last-child > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
dt:target, span.highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
|
@ -572,14 +691,6 @@ dl.glossary dt {
|
|||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
|
@ -636,6 +747,10 @@ pre {
|
|||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
pre, div[class*="highlight-"] {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
span.pre {
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
|
|
@ -643,22 +758,57 @@ span.pre {
|
|||
hyphens: none;
|
||||
}
|
||||
|
||||
div[class*="highlight-"] {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
padding: 5px 0px;
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
margin-left: 0.5em;
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tbody {
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tr {
|
||||
display: flex;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
padding: 0 0.5em 0 0.5em;
|
||||
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;
|
||||
}
|
||||
|
|
@ -667,8 +817,14 @@ div.code-block-caption code {
|
|||
background-color: transparent;
|
||||
}
|
||||
|
||||
div.code-block-caption + div > div.highlight > pre {
|
||||
margin-top: 0;
|
||||
table.highlighttable td.linenos,
|
||||
span.linenos,
|
||||
div.doctest > 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 {
|
||||
|
|
@ -680,21 +836,7 @@ div.code-block-caption span.caption-text {
|
|||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
padding: 1em 1em 0;
|
||||
}
|
||||
|
||||
div.literal-block-wrapper div.highlight {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
|
|
@ -735,8 +877,7 @@ span.eqno {
|
|||
}
|
||||
|
||||
span.eqno a.headerlink {
|
||||
position: relative;
|
||||
left: 0px;
|
||||
position: absolute;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 434 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because one or more lines are too long
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -29,9 +29,14 @@ if (!window.console || !console.firebug) {
|
|||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
return decodeURIComponent(x).replace(/\+/g, ' ');
|
||||
if (!x) {
|
||||
return x
|
||||
}
|
||||
return decodeURIComponent(x.replace(/\+/g, ' '));
|
||||
};
|
||||
|
||||
/**
|
||||
|
|
@ -283,10 +288,12 @@ var Documentation = {
|
|||
},
|
||||
|
||||
initOnKeyListeners: function() {
|
||||
$(document).keyup(function(event) {
|
||||
$(document).keydown(function(event) {
|
||||
var activeElementType = document.activeElement.tagName;
|
||||
// don't navigate when in search box or textarea
|
||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
|
||||
// don't navigate when in search box, textarea, dropdown or button
|
||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
|
||||
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
|
||||
&& !event.shiftKey) {
|
||||
switch (event.keyCode) {
|
||||
case 37: // left
|
||||
var prevHref = $('link[rel="prev"]').prop('href');
|
||||
|
|
|
|||
|
|
@ -1,9 +1,11 @@
|
|||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '28.14.42',
|
||||
VERSION: '28.14.59',
|
||||
LANGUAGE: 'None',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
FILE_SUFFIX: '.html',
|
||||
LINK_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1 @@
|
|||
!function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
/**
|
||||
* @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||
*/
|
||||
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document);
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
/**
|
||||
* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
|
||||
*/
|
||||
!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);
|
||||
|
|
@ -1,3 +1 @@
|
|||
/* sphinx_rtd_theme version 0.4.3 | MIT license */
|
||||
/* Built 20190212 16:02 */
|
||||
require=function r(s,a,l){function c(e,n){if(!a[e]){if(!s[e]){var i="function"==typeof require&&require;if(!n&&i)return i(e,!0);if(u)return u(e,!0);var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}var o=a[e]={exports:{}};s[e][0].call(o.exports,function(n){return c(s[e][1][n]||n)},o,o.exports,r,s,a,l)}return a[e].exports}for(var u="function"==typeof require&&require,n=0;n<l.length;n++)c(l[n]);return c}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(e){var i=this;void 0===e&&(e=!0),i.isRunning||(i.isRunning=!0,jQuery(function(n){i.init(n),i.reset(),i.win.on("hashchange",i.reset),e&&i.win.on("scroll",function(){i.linkScroll||i.winScroll||(i.winScroll=!0,requestAnimationFrame(function(){i.onScroll()}))}),i.win.on("resize",function(){i.winResize||(i.winResize=!0,requestAnimationFrame(function(){i.onResize()}))}),i.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(i){i(document);var t=this;this.navBar=i("div.wy-side-scroll:first"),this.win=i(window),i(document).on("click","[data-toggle='wy-nav-top']",function(){i("[data-toggle='wy-nav-shift']").toggleClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var n=i(this);i("[data-toggle='wy-nav-shift']").removeClass("shift"),i("[data-toggle='rst-versions']").toggleClass("shift"),t.toggleCurrent(n),t.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){i("[data-toggle='rst-versions']").toggleClass("shift-up")}),i("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),i("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),i("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var e=i(this);expand=i('<span class="toctree-expand"></span>'),expand.on("click",function(n){return t.toggleCurrent(e),n.stopPropagation(),!1}),e.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}0<i.length&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"),i[0].scrollIntoView())}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var r=0,n=["ms","moz","webkit","o"],e=0;e<n.length&&!window.requestAnimationFrame;++e)window.requestAnimationFrame=window[n[e]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[n[e]+"CancelAnimationFrame"]||window[n[e]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(n,e){var i=(new Date).getTime(),t=Math.max(0,16-(i-r)),o=window.setTimeout(function(){n(i+t)},t);return r=i+t,o}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);
|
||||
!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),n("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),n("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n('<span class="toctree-expand"></span>'),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}t.length>0&&($(".wy-menu-vertical .current").removeClass("current"),t.addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l1").parent().addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l2").addClass("current"),t.closest("li.toctree-l3").addClass("current"),t.closest("li.toctree-l4").addClass("current"),t.closest("li.toctree-l5").addClass("current"),t[0].scrollIntoView())}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t<e.length&&!window.requestAnimationFrame;++t)window.requestAnimationFrame=window[e[t]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[e[t]+"CancelAnimationFrame"]||window[e[t]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(e,t){var i=(new Date).getTime(),o=Math.max(0,16-(i-n)),r=window.setTimeout((function(){e(i+o)}),o);return n=i+o,r}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()}).call(window)},function(n,e){n.exports=jQuery},function(n,e,t){}]);
|
||||
|
|
@ -5,7 +5,7 @@
|
|||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -13,7 +13,8 @@
|
|||
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 JS is _stemmer.js if file is provided */
|
||||
/* Non-minified version is copied as a separate JS file, is available */
|
||||
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
|
|
@ -199,7 +200,6 @@ var Stemmer = function() {
|
|||
|
||||
|
||||
|
||||
|
||||
var splitChars = (function() {
|
||||
var result = {};
|
||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||
|
|
|
|||
|
|
@ -1,5 +1,10 @@
|
|||
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 { 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 */
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -59,10 +59,15 @@ var Search = {
|
|||
_pulse_status : -1,
|
||||
|
||||
htmlToText : function(htmlString) {
|
||||
var htmlElement = document.createElement('span');
|
||||
htmlElement.innerHTML = htmlString;
|
||||
$(htmlElement).find('.headerlink').remove();
|
||||
docContent = $(htmlElement).find('[role=main]')[0];
|
||||
var virtualDocument = document.implementation.createHTMLDocument('virtual');
|
||||
var htmlElement = $(htmlString, virtualDocument);
|
||||
htmlElement.find('.headerlink').remove();
|
||||
docContent = htmlElement.find('[role=main]')[0];
|
||||
if(docContent === undefined) {
|
||||
console.warn("Content block not found. Sphinx search tries to obtain it " +
|
||||
"via '[role=main]'. Could you check your theme or template.");
|
||||
return "";
|
||||
}
|
||||
return docContent.textContent || docContent.innerText;
|
||||
},
|
||||
|
||||
|
|
@ -161,8 +166,7 @@ var Search = {
|
|||
objectterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
|
||||
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
|
||||
tmp[i] === "") {
|
||||
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
|
||||
// skip this "word"
|
||||
continue;
|
||||
}
|
||||
|
|
@ -244,8 +248,10 @@ var Search = {
|
|||
// results left, load the summary and display it
|
||||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li style="display:none"></li>');
|
||||
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
|
||||
var listItem = $('<li></li>');
|
||||
var requestUrl = "";
|
||||
var linkUrl = "";
|
||||
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
||||
// dirhtml builder
|
||||
var dirname = item[0] + '/';
|
||||
if (dirname.match(/\/index\/$/)) {
|
||||
|
|
@ -253,23 +259,25 @@ var Search = {
|
|||
} else if (dirname == 'index/') {
|
||||
dirname = '';
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
|
||||
linkUrl = requestUrl;
|
||||
|
||||
} else {
|
||||
// normal html builders
|
||||
listItem.append($('<a/>').attr('href',
|
||||
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
linkUrl +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}, 5);
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
|
||||
$.ajax({url: requestUrl,
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
|
|
@ -277,16 +285,16 @@ var Search = {
|
|||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}, 5);
|
||||
}});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
listItem.slideDown(5, function() {
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
});
|
||||
}, 5);
|
||||
}
|
||||
}
|
||||
// search finished, update title and status message
|
||||
|
|
@ -371,6 +379,13 @@ var Search = {
|
|||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
|
||||
*/
|
||||
escapeRegExp : function(string) {
|
||||
return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
|
||||
},
|
||||
|
||||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
|
|
@ -394,13 +409,14 @@ var Search = {
|
|||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
var word_regex = this.escapeRegExp(word);
|
||||
for (var w in terms) {
|
||||
if (w.match(word) && !terms[word]) {
|
||||
if (w.match(word_regex) && !terms[word]) {
|
||||
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||
}
|
||||
}
|
||||
for (var w in titleterms) {
|
||||
if (w.match(word) && !titleterms[word]) {
|
||||
if (w.match(word_regex) && !titleterms[word]) {
|
||||
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||
}
|
||||
}
|
||||
|
|
@ -424,7 +440,7 @@ var Search = {
|
|||
for (j = 0; j < _files.length; j++) {
|
||||
file = _files[j];
|
||||
if (!(file in scoreMap))
|
||||
scoreMap[file] = {}
|
||||
scoreMap[file] = {};
|
||||
scoreMap[file][word] = o.score;
|
||||
}
|
||||
});
|
||||
|
|
@ -432,7 +448,7 @@ var Search = {
|
|||
// create the mapping
|
||||
for (j = 0; j < files.length; j++) {
|
||||
file = files[j];
|
||||
if (file in fileMap)
|
||||
if (file in fileMap && fileMap[file].indexOf(word) === -1)
|
||||
fileMap[file].push(word);
|
||||
else
|
||||
fileMap[file] = [word];
|
||||
|
|
@ -493,7 +509,7 @@ var Search = {
|
|||
var excerpt = ((start > 0) ? '...' : '') +
|
||||
$.trim(text.substr(start, 240)) +
|
||||
((start + 240 - text.length) ? '...' : '');
|
||||
var rv = $('<div class="context"></div>').text(excerpt);
|
||||
var rv = $('<p class="context"></p>').text(excerpt);
|
||||
$.each(hlwords, function() {
|
||||
rv = rv.highlightText(this, 'highlighted');
|
||||
});
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
|
|
@ -1,38 +1,45 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>composer-cli — Lorax 28.14.42 documentation</title>
|
||||
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>composer-cli — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Product and Updates Images" href="product-images.html" />
|
||||
|
|
@ -60,7 +67,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -77,6 +84,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -89,13 +97,25 @@
|
|||
<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="mkksiso.html">mkksiso</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="lorax-composer.html">lorax-composer</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">composer-cli</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#composer-cli-cmdline-arguments">composer-cli cmdline arguments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#composer-cli-cmdline-arguments">composer-cli cmdline arguments</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#Positional Arguments">Positional Arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#Named Arguments">Named Arguments</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#edit-a-blueprint">Edit a Blueprint</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#build-an-image">Build an image</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#monitor-the-build-status">Monitor the build status</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#download-the-image">Download the image</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#image-uploads">Image Uploads</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#providers">Providers</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#aws">AWS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#build-an-image-and-upload-results">Build an image and upload results</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#debugging">Debugging</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -105,6 +125,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -139,18 +160,20 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>composer-cli</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="_sources/composer-cli.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
|
|
@ -164,32 +187,157 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="composer-cli">
|
||||
<section id="composer-cli">
|
||||
<h1>composer-cli<a class="headerlink" href="#composer-cli" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Authors</dt>
|
||||
<dd class="field-odd"><p>Brian C. Lane <<a class="reference external" href="mailto:bcl%40redhat.com">bcl<span>@</span>redhat<span>.</span>com</a>></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">composer-cli</span></code> is used to interact with the <code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code> API server, managing blueprints, exploring available packages, and building new images.</p>
|
||||
<p>It requires <a class="reference external" href="lorax-composer.html">lorax-composer</a> to be installed on the
|
||||
local system, and the user running it needs to be a member of the <code class="docutils literal notranslate"><span class="pre">weldr</span></code>
|
||||
group. They do not need to be root, but all of the <a class="reference external" href="lorax-composer.html#security">security precautions</a> apply.</p>
|
||||
<div class="section" id="composer-cli-cmdline-arguments">
|
||||
<p><code class="docutils literal notranslate"><span class="pre">composer-cli</span></code> is an interactive tool for use with a WELDR API server,
|
||||
managing blueprints, exploring available packages, and building new images.
|
||||
<cite>lorax-composer <lorax-composer.html></cite> and <cite>osbuild-composer
|
||||
<https://osbuild.org></cite> both implement compatible servers.</p>
|
||||
<p>It requires server to be installed on the local system, and the user running it
|
||||
needs to be a member of the <code class="docutils literal notranslate"><span class="pre">weldr</span></code> group. They do not need to be root, but
|
||||
all of the <a class="reference external" href="lorax-composer.html#security">security precautions</a> apply.</p>
|
||||
<section id="composer-cli-cmdline-arguments">
|
||||
<h2>composer-cli cmdline arguments<a class="headerlink" href="#composer-cli-cmdline-arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<p><p>Lorax Composer commandline tool</p>
|
||||
</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">composer</span><span class="o">-</span><span class="n">cli</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">j</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">s</span> <span class="n">SOCKET</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">log</span> <span class="n">LOG</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">a</span> <span class="n">APIVER</span><span class="p">]</span>
|
||||
<span class="p">[</span><span class="o">--</span><span class="n">test</span> <span class="n">TESTMODE</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">V</span><span class="p">]</span>
|
||||
<span class="o">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="edit-a-blueprint">
|
||||
<section id="Positional Arguments">
|
||||
<h3>Positional Arguments<a class="headerlink" href="#Positional Arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>args</kbd></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section id="Named Arguments">
|
||||
<h3>Named Arguments<a class="headerlink" href="#Named Arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>-j, --json</kbd></dt>
|
||||
<dd><p>Output the raw JSON response instead of the normal output.</p>
|
||||
<p>Default: False</p>
|
||||
</dd>
|
||||
<dt><kbd>-s, --socket</kbd></dt>
|
||||
<dd><p>Path to the socket file to listen on</p>
|
||||
<p>Default: “/run/weldr/api.socket”</p>
|
||||
</dd>
|
||||
<dt><kbd>--log</kbd></dt>
|
||||
<dd><p>Path to logfile (./composer-cli.log)</p>
|
||||
</dd>
|
||||
<dt><kbd>-a, --api</kbd></dt>
|
||||
<dd><p>API Version to use (overrides server API version)</p>
|
||||
</dd>
|
||||
<dt><kbd>--test</kbd></dt>
|
||||
<dd><p>Pass test mode to compose. 1=Mock compose with fail. 2=Mock compose with finished.</p>
|
||||
<p>Default: 0</p>
|
||||
</dd>
|
||||
<dt><kbd>-V</kbd></dt>
|
||||
<dd><p>show program’s version number and exit</p>
|
||||
<p>Default: False</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<p><dl class="simple">
|
||||
<dt>compose start [–size XXXX] <BLUEPRINT> <TYPE> [<IMAGE-NAME> <PROVIDER> <PROFILE> | <IMAGE-NAME> <PROFILE.TOML>]</dt><dd><p>Start a compose using the selected blueprint and output type. –size is in MiB.
|
||||
NOTE: uploading and –size are only supported by osbuild-composer.</p>
|
||||
</dd>
|
||||
<dt>compose start-ostree [–size XXXX] [–parent PARENT] [–ref REF] [–url url] <BLUEPRINT> <TYPE> [<IMAGE-NAME> <PROFILE.TOML>]</dt><dd><p>Start an ostree compose using the selected blueprint and output type. Optionally start an upload. This command
|
||||
is only supported by osbuild-composer. –size is in MiB.</p>
|
||||
</dd>
|
||||
<dt>compose types</dt><dd><p>List the supported output types.</p>
|
||||
</dd>
|
||||
<dt>compose status</dt><dd><p>List the status of all running and finished composes.</p>
|
||||
</dd>
|
||||
<dt>compose list [waiting|running|finished|failed]</dt><dd><p>List basic information about composes.</p>
|
||||
</dd>
|
||||
<dt>compose log <UUID> [<SIZE>]</dt><dd><p>Show the last SIZE kB of the compose log.</p>
|
||||
</dd>
|
||||
<dt>compose cancel <UUID></dt><dd><p>Cancel a running compose and delete any intermediate results.</p>
|
||||
</dd>
|
||||
<dt>compose delete <UUID,…></dt><dd><p>Delete the listed compose results.</p>
|
||||
</dd>
|
||||
<dt>compose info <UUID></dt><dd><p>Show detailed information on the compose.</p>
|
||||
</dd>
|
||||
<dt>compose metadata <UUID></dt><dd><p>Download the metadata use to create the compose to <uuid>-metadata.tar</p>
|
||||
</dd>
|
||||
<dt>compose logs <UUID></dt><dd><p>Download the compose logs to <uuid>-logs.tar</p>
|
||||
</dd>
|
||||
<dt>compose results <UUID></dt><dd><p>Download all of the compose results; metadata, logs, and image to <uuid>.tar</p>
|
||||
</dd>
|
||||
<dt>compose image <UUID></dt><dd><p>Download the output image from the compose. Filename depends on the type.</p>
|
||||
</dd>
|
||||
<dt>blueprints list</dt><dd><p>List the names of the available blueprints.</p>
|
||||
</dd>
|
||||
<dt>blueprints show <BLUEPRINT,…></dt><dd><p>Display the blueprint in TOML format.</p>
|
||||
</dd>
|
||||
<dt>blueprints changes <BLUEPRINT,…></dt><dd><p>Display the changes for each blueprint.</p>
|
||||
</dd>
|
||||
<dt>blueprints diff <BLUEPRINT> <FROM-COMMIT> <TO-COMMIT></dt><dd><p>Display the differences between 2 versions of a blueprint.
|
||||
FROM-COMMIT can be a commit hash or NEWEST
|
||||
TO-COMMIT can be a commit hash, NEWEST, or WORKSPACE</p>
|
||||
</dd>
|
||||
<dt>blueprints save <BLUEPRINT,…></dt><dd><p>Save the blueprint to a file, <BLUEPRINT>.toml</p>
|
||||
</dd>
|
||||
<dt>blueprints delete <BLUEPRINT></dt><dd><p>Delete a blueprint from the server</p>
|
||||
</dd>
|
||||
<dt>blueprints depsolve <BLUEPRINT,…></dt><dd><p>Display the packages needed to install the blueprint.</p>
|
||||
</dd>
|
||||
<dt>blueprints push <BLUEPRINT></dt><dd><p>Push a blueprint TOML file to the server.</p>
|
||||
</dd>
|
||||
<dt>blueprints freeze <BLUEPRINT,…></dt><dd><p>Display the frozen blueprint’s modules and packages.</p>
|
||||
</dd>
|
||||
<dt>blueprints freeze show <BLUEPRINT,…></dt><dd><p>Display the frozen blueprint in TOML format.</p>
|
||||
</dd>
|
||||
<dt>blueprints freeze save <BLUEPRINT,…></dt><dd><p>Save the frozen blueprint to a file, <blueprint-name>.frozen.toml.</p>
|
||||
</dd>
|
||||
<dt>blueprints tag <BLUEPRINT></dt><dd><p>Tag the most recent blueprint commit as a release.</p>
|
||||
</dd>
|
||||
<dt>blueprints undo <BLUEPRINT> <COMMIT></dt><dd><p>Undo changes to a blueprint by reverting to the selected commit.</p>
|
||||
</dd>
|
||||
<dt>blueprints workspace <BLUEPRINT></dt><dd><p>Push the blueprint TOML to the temporary workspace storage.</p>
|
||||
</dd>
|
||||
<dt>modules list</dt><dd><p>List the available modules.</p>
|
||||
</dd>
|
||||
<dt>projects list</dt><dd><p>List the available projects.</p>
|
||||
</dd>
|
||||
<dt>projects info <PROJECT,…></dt><dd><p>Show details about the listed projects.</p>
|
||||
</dd>
|
||||
<dt>sources list</dt><dd><p>List the available sources</p>
|
||||
</dd>
|
||||
<dt>sources info <SOURCE-NAME,…></dt><dd><p>Details about the source.</p>
|
||||
</dd>
|
||||
<dt>sources add <SOURCE.TOML></dt><dd><p>Add a package source to the server.</p>
|
||||
</dd>
|
||||
<dt>sources change <SOURCE.TOML></dt><dd><p>Change an existing source</p>
|
||||
</dd>
|
||||
<dt>sources delete <SOURCE-NAME></dt><dd><p>Delete a package source.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>status show Show API server status.</p>
|
||||
<p>NOTE: uploading is only available as part of the compose command
|
||||
using the osbuild-composer API server.</p>
|
||||
</p>
|
||||
</section>
|
||||
<section id="edit-a-blueprint">
|
||||
<h2>Edit a Blueprint<a class="headerlink" href="#edit-a-blueprint" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Start out by listing the available blueprints using <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">blueprints</span>
|
||||
<span class="pre">list</span></code>, pick one and save it to the local directory by running <code class="docutils literal notranslate"><span class="pre">composer-cli</span>
|
||||
<span class="pre">blueprints</span> <span class="pre">save</span> <span class="pre">http-server</span></code>. If there are no blueprints available you can
|
||||
copy one of the examples <a class="reference external" href="https://github.com/weldr/lorax/tree/master/tests/pylorax/blueprints/">from the test suite</a>.</p>
|
||||
copy one of the examples <a class="reference external" href="https://github.com/weldr/lorax/tree/rhel8-branch/tests/pylorax/blueprints/">from the test suite</a>.</p>
|
||||
<p>Edit the file (it will be saved with a .toml extension) and change the
|
||||
description, add a package or module to it. Send it back to the server by
|
||||
running <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">blueprints</span> <span class="pre">push</span> <span class="pre">http-server.toml</span></code>. You can verify that it was
|
||||
saved by viewing the changelog - <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">blueprints</span> <span class="pre">changes</span> <span class="pre">http-server</span></code>.</p>
|
||||
</div>
|
||||
<div class="section" id="build-an-image">
|
||||
<p>The full blueprint documentation <a class="reference external" href="https://www.osbuild.org/guides/blueprint-reference/blueprint-reference.html">is here</a>.</p>
|
||||
</section>
|
||||
<section id="build-an-image">
|
||||
<h2>Build an image<a class="headerlink" href="#build-an-image" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Build a <code class="docutils literal notranslate"><span class="pre">qcow2</span></code> disk image from this blueprint by running <code class="docutils literal notranslate"><span class="pre">composer-cli</span>
|
||||
<span class="pre">compose</span> <span class="pre">start</span> <span class="pre">http-server</span> <span class="pre">qcow2</span></code>. It will print a UUID that you can use to
|
||||
|
|
@ -197,53 +345,117 @@ keep track of the build. You can also cancel the build if needed.</p>
|
|||
<p>The available types of images is displayed by <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">compose</span> <span class="pre">types</span></code>.
|
||||
Currently this consists of: alibaba, ami, ext4-filesystem, google, live-iso,
|
||||
openstack, partitioned-disk, qcow2, tar, vhd, vmdk</p>
|
||||
</div>
|
||||
<div class="section" id="monitor-the-build-status">
|
||||
</section>
|
||||
<section id="monitor-the-build-status">
|
||||
<h2>Monitor the build status<a class="headerlink" href="#monitor-the-build-status" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Monitor it using <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">compose</span> <span class="pre">status</span></code>, which will show the status of
|
||||
all the builds on the system. You can view the end of the anaconda build logs
|
||||
once it is in the <code class="docutils literal notranslate"><span class="pre">RUNNING</span></code> state using <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">compose</span> <span class="pre">log</span> <span class="pre">UUID</span></code>
|
||||
where UUID is the UUID returned by the start command.</p>
|
||||
<p>Once the build is in the <code class="docutils literal notranslate"><span class="pre">FINISHED</span></code> state you can download the image.</p>
|
||||
</div>
|
||||
<div class="section" id="download-the-image">
|
||||
</section>
|
||||
<section id="download-the-image">
|
||||
<h2>Download the image<a class="headerlink" href="#download-the-image" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Downloading the final image is done with <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">compose</span> <span class="pre">image</span> <span class="pre">UUID</span></code> and it will
|
||||
save the qcow2 image as <code class="docutils literal notranslate"><span class="pre">UUID-disk.qcow2</span></code> which you can then use to boot a VM like this:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qemu</span><span class="o">-</span><span class="n">kvm</span> <span class="o">--</span><span class="n">name</span> <span class="n">test</span><span class="o">-</span><span class="n">image</span> <span class="o">-</span><span class="n">m</span> <span class="mi">1024</span> <span class="o">-</span><span class="n">hda</span> <span class="o">./</span><span class="n">UUID</span><span class="o">-</span><span class="n">disk</span><span class="o">.</span><span class="n">qcow2</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="image-uploads">
|
||||
<h2>Image Uploads<a class="headerlink" href="#image-uploads" title="Permalink to this headline">¶</a></h2>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">composer-cli</span></code> can upload the images to a number of services, including AWS,
|
||||
OpenStack, and vSphere. The upload can be started when the build is finished
|
||||
by using <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">compose</span> <span class="pre">start</span> <span class="pre">...</span></code>. In order to access the service you need
|
||||
to pass authentication details to composer-cli using a TOML file.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This is only supported when running the <code class="docutils literal notranslate"><span class="pre">osbuild-composer</span></code> API server.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="providers">
|
||||
<h2>Providers<a class="headerlink" href="#providers" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Providers are where the images are uploaded to. You
|
||||
will need to gather some provider
|
||||
specific information in order to authenticate with it. Please refer to the <code class="docutils literal notranslate"><span class="pre">osbuild-composer</span></code>
|
||||
documentation for the provider specific fields. You will then create a TOML file with the
|
||||
name of the provider and the settings, like this:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">provider</span> <span class="o">=</span> <span class="s2">"aws"</span>
|
||||
|
||||
<span class="p">[</span><span class="n">settings</span><span class="p">]</span>
|
||||
<span class="n">aws_access_key</span> <span class="o">=</span> <span class="s2">"AWS Access Key"</span>
|
||||
<span class="n">aws_bucket</span> <span class="o">=</span> <span class="s2">"AWS Bucket"</span>
|
||||
<span class="n">aws_region</span> <span class="o">=</span> <span class="s2">"AWS Region"</span>
|
||||
<span class="n">aws_secret_key</span> <span class="o">=</span> <span class="s2">"AWS Secret Key"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Save this into an <code class="docutils literal notranslate"><span class="pre">aws-credentials.toml</span></code> file and use it when running <code class="docutils literal notranslate"><span class="pre">start</span></code>.</p>
|
||||
<section id="aws">
|
||||
<h3>AWS<a class="headerlink" href="#aws" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The access key and secret key can be created by going to the
|
||||
<code class="docutils literal notranslate"><span class="pre">IAM->Users->Security</span> <span class="pre">Credentials</span></code> section and creating a new access key. The
|
||||
secret key will only be shown when it is first created so make sure to record
|
||||
it in a secure place. The region should be the region that you want to use the
|
||||
AMI in, and the bucket can be an existing bucket, or a new one, following the
|
||||
normal AWS bucket naming rules. It will be created if it doesn’t already exist.</p>
|
||||
<p>When uploading the image it is first uploaded to the s3 bucket, and then
|
||||
converted to an AMI. If the conversion is successful the s3 object will be
|
||||
deleted. If it fails, re-trying after correcting the problem will re-use the
|
||||
object if you have not deleted it in the meantime, speeding up the process.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="build-an-image-and-upload-results">
|
||||
<h2>Build an image and upload results<a class="headerlink" href="#build-an-image-and-upload-results" title="Permalink to this headline">¶</a></h2>
|
||||
<p>With the settings stored in a TOML file:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">composer</span><span class="o">-</span><span class="n">cli</span> <span class="n">compose</span> <span class="n">start</span> <span class="n">example</span><span class="o">-</span><span class="n">http</span><span class="o">-</span><span class="n">server</span> <span class="n">ami</span> <span class="s2">"http image"</span> <span class="n">aws</span><span class="o">-</span><span class="n">settings</span><span class="o">.</span><span class="n">toml</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>It will return the UUID of the image build. Once
|
||||
the build has finished successfully it will start the upload process.</p>
|
||||
</section>
|
||||
<section id="debugging">
|
||||
<h2>Debugging<a class="headerlink" href="#debugging" title="Permalink to this headline">¶</a></h2>
|
||||
<p>There are a couple of arguments that can be helpful when debugging problems.
|
||||
These are only meant for debugging and should not be used to script access to
|
||||
the API. If you need to do that you can communicate with it directly in the
|
||||
language of your choice.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">--json</span></code> will return the server’s response as a nicely formatted json output
|
||||
instead of printing what the command would usually print.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">--test=1</span></code> will cause a compose start to start creating an image, and then
|
||||
end with a failed state.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">--test=2</span></code> will cause a compose to start and then end with a finished state,
|
||||
without actually composing anything.</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="product-images.html" class="btn btn-neutral float-right" title="Product and Updates Images" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="lorax-composer.html" class="btn btn-neutral float-left" title="lorax-composer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
<a href="product-images.html" class="btn btn-neutral float-right" title="Product and Updates Images" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="lorax-composer.html" class="btn btn-neutral float-left" title="lorax-composer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -252,7 +464,6 @@ save the qcow2 image as <code class="docutils literal notranslate"><span class="
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
|
|
@ -1,39 +1,44 @@
|
|||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<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.0" />
|
||||
|
||||
<title>Index — Lorax 28.14.42 documentation</title>
|
||||
<title>Index — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="#" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
</head>
|
||||
|
|
@ -59,7 +64,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -76,6 +81,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -88,6 +94,7 @@
|
|||
<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="mkksiso.html">mkksiso</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="product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -97,6 +104,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -131,18 +139,20 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>Index</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -295,10 +305,12 @@
|
|||
<li><a href="pylorax.html#pylorax.treebuilder.TreeBuilder.copy_dracut_hooks">copy_dracut_hooks() (pylorax.treebuilder.TreeBuilder method)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.imgutils.copytree">copytree() (in module pylorax.imgutils)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.treebuilder.RuntimeBuilder.create_ext4_runtime">create_ext4_runtime() (pylorax.treebuilder.RuntimeBuilder method)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.creator.create_pxe_config">create_pxe_config() (in module pylorax.creator)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.treebuilder.RuntimeBuilder.create_runtime">create_runtime() (pylorax.treebuilder.RuntimeBuilder method)</a>
|
||||
<li><a href="pylorax.html#pylorax.treebuilder.RuntimeBuilder.create_squashfs_runtime">create_squashfs_runtime() (pylorax.treebuilder.RuntimeBuilder method)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.installer.create_vagrant_metadata">create_vagrant_metadata() (in module pylorax.installer)</a>
|
||||
</li>
|
||||
|
|
@ -338,7 +350,7 @@
|
|||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pylorax.api.html#pylorax.api.server.GitLock.dir">dir() (pylorax.api.server.GitLock property)</a>
|
||||
<li><a href="pylorax.api.html#pylorax.api.server.GitLock.dir">dir (pylorax.api.server.GitLock property)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.discinfo.DiscInfo">DiscInfo (class in pylorax.discinfo)</a>
|
||||
</li>
|
||||
|
|
@ -352,7 +364,7 @@
|
|||
</li>
|
||||
<li><a href="pylorax.html#pylorax.imgutils.do_grafts">do_grafts() (in module pylorax.imgutils)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.treebuilder.TreeBuilder.dracut_hooks_path">dracut_hooks_path() (pylorax.treebuilder.TreeBuilder property)</a>
|
||||
<li><a href="pylorax.html#pylorax.treebuilder.TreeBuilder.dracut_hooks_path">dracut_hooks_path (pylorax.treebuilder.TreeBuilder property)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
@ -388,7 +400,7 @@
|
|||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pylorax.html#pylorax.creator.FakeDNF">FakeDNF (class in pylorax.creator)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.filename">filename() (pylorax.api.recipes.Recipe property)</a>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.filename">filename (pylorax.api.recipes.Recipe property)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.find_commit_tag">find_commit_tag() (in module pylorax.api.recipes)</a>
|
||||
</li>
|
||||
|
|
@ -472,7 +484,7 @@
|
|||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.server.GitLock">GitLock (class in pylorax.api.server)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.group_names">group_names() (pylorax.api.recipes.Recipe property)</a>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.group_names">group_names (pylorax.api.recipes.Recipe property)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
@ -548,7 +560,7 @@
|
|||
<h2 id="K">K</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pylorax.html#pylorax.treebuilder.TreeBuilder.kernels">kernels() (pylorax.treebuilder.TreeBuilder property)</a>
|
||||
<li><a href="pylorax.html#pylorax.treebuilder.TreeBuilder.kernels">kernels (pylorax.treebuilder.TreeBuilder property)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
|
|
@ -576,7 +588,7 @@
|
|||
</li>
|
||||
<li><a href="pylorax.html#pylorax.cmdline.lmc_parser">lmc_parser() (in module pylorax.cmdline)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.server.GitLock.lock">lock() (pylorax.api.server.GitLock property)</a>
|
||||
<li><a href="pylorax.api.html#pylorax.api.server.GitLock.lock">lock (pylorax.api.server.GitLock property)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.log">log() (pylorax.ltmpl.LoraxTemplateRunner method)</a>
|
||||
</li>
|
||||
|
|
@ -652,8 +664,6 @@
|
|||
</li>
|
||||
<li><a href="pylorax.html#pylorax.imgutils.mkfsimage_from_disk">mkfsimage_from_disk() (in module pylorax.imgutils)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pylorax.html#pylorax.imgutils.mkhfsimg">mkhfsimg() (in module pylorax.imgutils)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.imgutils.mkqcow2">mkqcow2() (in module pylorax.imgutils)</a>
|
||||
|
|
@ -668,9 +678,76 @@
|
|||
</li>
|
||||
<li><a href="pylorax.html#pylorax.imgutils.mktar">mktar() (in module pylorax.imgutils)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.module_names">module_names() (pylorax.api.recipes.Recipe property)</a>
|
||||
<li>
|
||||
module
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax">pylorax</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.module_nver">module_nver() (pylorax.api.recipes.Recipe property)</a>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api">pylorax.api</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.cmdline">pylorax.api.cmdline</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.compose">pylorax.api.compose</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.config">pylorax.api.config</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.crossdomain">pylorax.api.crossdomain</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.projects">pylorax.api.projects</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.queue">pylorax.api.queue</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.recipes">pylorax.api.recipes</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.server">pylorax.api.server</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.v0">pylorax.api.v0</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.workspace">pylorax.api.workspace</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.base">pylorax.base</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.buildstamp">pylorax.buildstamp</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.cmdline">pylorax.cmdline</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.creator">pylorax.creator</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.decorators">pylorax.decorators</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.discinfo">pylorax.discinfo</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.dnfbase">pylorax.dnfbase</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.dnfhelper">pylorax.dnfhelper</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.executils">pylorax.executils</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.imgutils">pylorax.imgutils</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.installer">pylorax.installer</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.ltmpl">pylorax.ltmpl</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.monitor">pylorax.monitor</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.mount">pylorax.mount</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.output">pylorax.output</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.sysutils">pylorax.sysutils</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.treebuilder">pylorax.treebuilder</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.treeinfo">pylorax.treeinfo</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.module_names">module_names (pylorax.api.recipes.Recipe property)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.module_nver">module_nver (pylorax.api.recipes.Recipe property)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.projects.modules_info">modules_info() (in module pylorax.api.projects)</a>
|
||||
</li>
|
||||
|
|
@ -716,9 +793,9 @@
|
|||
<h2 id="P">P</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.package_names">package_names() (pylorax.api.recipes.Recipe property)</a>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.package_names">package_names (pylorax.api.recipes.Recipe property)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.package_nver">package_nver() (pylorax.api.recipes.Recipe property)</a>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.Recipe.package_nver">package_nver (pylorax.api.recipes.Recipe property)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.ltmpl.LoraxTemplate.parse">parse() (pylorax.ltmpl.LoraxTemplate method)</a>
|
||||
</li>
|
||||
|
|
@ -764,68 +841,218 @@
|
|||
</li>
|
||||
<li><a href="pylorax.html#pylorax.base.BaseLoraxClass.pwarning">pwarning() (pylorax.base.BaseLoraxClass method)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax">pylorax (module)</a>
|
||||
<li>
|
||||
pylorax
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api">pylorax.api (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.cmdline">pylorax.api.cmdline (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api.cmdline
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.cmdline">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api.compose
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.compose">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api.config
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.config">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api.crossdomain
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.crossdomain">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api.projects
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.projects">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api.queue
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.queue">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api.recipes
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.recipes">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.compose">pylorax.api.compose (module)</a>
|
||||
<li>
|
||||
pylorax.api.server
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.server">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.config">pylorax.api.config (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api.v0
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.v0">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.crossdomain">pylorax.api.crossdomain (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.api.workspace
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.workspace">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.projects">pylorax.api.projects (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.base
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.base">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.queue">pylorax.api.queue (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.buildstamp
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.buildstamp">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.recipes">pylorax.api.recipes (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.cmdline
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.cmdline">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.server">pylorax.api.server (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.creator
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.creator">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.v0">pylorax.api.v0 (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.decorators
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.decorators">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#module-pylorax.api.workspace">pylorax.api.workspace (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.discinfo
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.discinfo">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.base">pylorax.base (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.dnfbase
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.dnfbase">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.buildstamp">pylorax.buildstamp (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.dnfhelper
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.dnfhelper">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.cmdline">pylorax.cmdline (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.executils
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.executils">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.creator">pylorax.creator (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.imgutils
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.imgutils">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.decorators">pylorax.decorators (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.installer
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.installer">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.discinfo">pylorax.discinfo (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.ltmpl
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.ltmpl">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.dnfbase">pylorax.dnfbase (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.monitor
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.monitor">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.dnfhelper">pylorax.dnfhelper (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.mount
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.mount">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.executils">pylorax.executils (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.output
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.output">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.imgutils">pylorax.imgutils (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.sysutils
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.sysutils">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.installer">pylorax.installer (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.treebuilder
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.treebuilder">module</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.ltmpl">pylorax.ltmpl (module)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.monitor">pylorax.monitor (module)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.mount">pylorax.mount (module)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.output">pylorax.output (module)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.sysutils">pylorax.sysutils (module)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.treebuilder">pylorax.treebuilder (module)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#module-pylorax.treeinfo">pylorax.treeinfo (module)</a>
|
||||
</ul></li>
|
||||
<li>
|
||||
pylorax.treeinfo
|
||||
|
||||
<ul>
|
||||
<li><a href="pylorax.html#module-pylorax.treeinfo">module</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
|
|
@ -900,7 +1127,7 @@
|
|||
<li><a href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.replace">(pylorax.ltmpl.LoraxTemplateRunner method)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.server.GitLock.repo">repo() (pylorax.api.server.GitLock property)</a>
|
||||
<li><a href="pylorax.api.html#pylorax.api.server.GitLock.repo">repo (pylorax.api.server.GitLock property)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.recipes.repo_file_exists">repo_file_exists() (in module pylorax.api.recipes)</a>
|
||||
</li>
|
||||
|
|
@ -992,7 +1219,7 @@
|
|||
</li>
|
||||
<li><a href="pylorax.api.html#pylorax.api.v0.take_limits">take_limits() (in module pylorax.api.v0)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.Lorax.templatedir">templatedir() (pylorax.Lorax property)</a>
|
||||
<li><a href="pylorax.html#pylorax.Lorax.templatedir">templatedir (pylorax.Lorax property)</a>
|
||||
</li>
|
||||
<li><a href="pylorax.html#pylorax.ltmpl.TemplateRunner">TemplateRunner (class in pylorax.ltmpl)</a>
|
||||
</li>
|
||||
|
|
@ -1105,20 +1332,25 @@
|
|||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -1127,7 +1359,6 @@
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
|
|
@ -1,38 +1,45 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Welcome to Lorax’s documentation! — Lorax 28.14.42 documentation</title>
|
||||
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>Welcome to Lorax’s documentation! — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Introduction to Lorax" href="intro.html" />
|
||||
|
|
@ -59,7 +66,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -76,6 +83,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -88,6 +96,7 @@
|
|||
<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="mkksiso.html">mkksiso</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="product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -97,6 +106,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -131,18 +141,20 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="#">Docs</a> »</li>
|
||||
<li><a href="#" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>Welcome to Lorax’s documentation!</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
|
|
@ -156,7 +168,7 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="welcome-to-lorax-s-documentation">
|
||||
<section id="welcome-to-lorax-s-documentation">
|
||||
<h1>Welcome to Lorax’s documentation!<a class="headerlink" href="#welcome-to-lorax-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Contents:</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
|
|
@ -165,55 +177,57 @@
|
|||
<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="mkksiso.html">mkksiso</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="product-images.html">Product and Updates Images</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="modules.html">pylorax</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="documentation-for-other-lorax-branches">
|
||||
</section>
|
||||
<section id="documentation-for-other-lorax-branches">
|
||||
<h1>Documentation for other Lorax Branches<a class="headerlink" href="#documentation-for-other-lorax-branches" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference external" href="f28-branch/">Fedora 28</a></p></li>
|
||||
<li><p><a class="reference external" href="lorax-composer/">RHEL7 lorax-composer</a></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="indices-and-tables">
|
||||
</section>
|
||||
<section id="indices-and-tables">
|
||||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="intro.html" class="btn btn-neutral float-right" title="Introduction to Lorax" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="intro.html" class="btn btn-neutral float-right" title="Introduction to Lorax" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -222,7 +236,6 @@
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
|
|
@ -1,38 +1,45 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Introduction to Lorax — Lorax 28.14.42 documentation</title>
|
||||
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>Introduction to Lorax — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Lorax" href="lorax.html" />
|
||||
|
|
@ -60,7 +67,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -77,6 +84,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -89,6 +97,7 @@
|
|||
<li class="toctree-l1"><a class="reference internal" href="#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="mkksiso.html">mkksiso</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="product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -98,6 +107,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -132,18 +142,20 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>Introduction to Lorax</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="_sources/intro.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
|
|
@ -157,7 +169,7 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="introduction-to-lorax">
|
||||
<section id="introduction-to-lorax">
|
||||
<h1>Introduction to Lorax<a class="headerlink" href="#introduction-to-lorax" title="Permalink to this headline">¶</a></h1>
|
||||
<p>I am the Lorax. I speak for the trees [and images].</p>
|
||||
<p>Lorax is used to build the Anaconda Installer boot.iso, it consists of a
|
||||
|
|
@ -165,8 +177,8 @@ library, pylorax, a set of templates, and the lorax script. Its operation
|
|||
is driven by a customized set of Mako templates that lists the packages
|
||||
to be installed, steps to execute to remove unneeded files, and creation
|
||||
of the iso for all of the supported architectures.</p>
|
||||
</div>
|
||||
<div class="section" id="before-lorax">
|
||||
</section>
|
||||
<section id="before-lorax">
|
||||
<h1>Before Lorax<a class="headerlink" href="#before-lorax" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Tree building tools such as pungi and revisor rely on ‘buildinstall’ in
|
||||
anaconda/scripts/ to produce the boot images and other such control files
|
||||
|
|
@ -206,36 +218,36 @@ it’s not completely clear from reading the scripts.</p>
|
|||
<p>Create a new central driver with all information living in Python modules.
|
||||
Configuration files will provide the knowledge previously contained in the
|
||||
upd-instroot and mk-images* scripts.</p>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="lorax.html" class="btn btn-neutral float-right" title="Lorax" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to Lorax’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
<a href="lorax.html" class="btn btn-neutral float-right" title="Lorax" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to Lorax’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -244,7 +256,6 @@ upd-instroot and mk-images* scripts.</p>
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
|
|
@ -1,41 +1,48 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>livemedia-creator — Lorax 28.14.42 documentation</title>
|
||||
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>livemedia-creator — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="lorax-composer" href="lorax-composer.html" />
|
||||
<link rel="next" title="mkksiso" href="mkksiso.html" />
|
||||
<link rel="prev" title="Lorax" href="lorax.html" />
|
||||
</head>
|
||||
|
||||
|
|
@ -60,7 +67,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -77,6 +84,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -121,6 +129,7 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="#hacking">Hacking</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="mkksiso.html">mkksiso</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="product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -130,6 +139,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -164,18 +174,20 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>livemedia-creator</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="_sources/livemedia-creator.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
|
|
@ -189,7 +201,7 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="livemedia-creator">
|
||||
<section id="livemedia-creator">
|
||||
<h1>livemedia-creator<a class="headerlink" href="#livemedia-creator" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Authors</dt>
|
||||
|
|
@ -217,7 +229,7 @@ you have the anaconda-tui package installed.</p>
|
|||
<p><code class="docutils literal notranslate"><span class="pre">lmc</span></code> is an abbreviation for livemedia-creator.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">builder</span></code> is the system where livemedia-creator is being run</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">image</span></code> is the disk image being created by running livemedia-creator</p>
|
||||
<div class="section" id="livemedia-creator-cmdline-arguments">
|
||||
<section id="livemedia-creator-cmdline-arguments">
|
||||
<h2>livemedia-creator cmdline arguments<a class="headerlink" href="#livemedia-creator-cmdline-arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<p><p>Create Live Install Media</p>
|
||||
</p>
|
||||
|
|
@ -254,7 +266,7 @@ you have the anaconda-tui package installed.</p>
|
|||
<span class="p">[</span><span class="o">--</span><span class="n">timeout</span> <span class="n">TIMEOUT</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">V</span><span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="Named Arguments">
|
||||
<section id="Named Arguments">
|
||||
<h3>Named Arguments<a class="headerlink" href="#Named Arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--make-iso</kbd></dt>
|
||||
|
|
@ -385,8 +397,8 @@ you have the anaconda-tui package installed.</p>
|
|||
<dd><p>show program’s version number and exit</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="disk/fs image arguments">
|
||||
</section>
|
||||
<section id="disk/fs image arguments">
|
||||
<h3>disk/fs image arguments<a class="headerlink" href="#disk/fs image arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--disk-image</kbd></dt>
|
||||
|
|
@ -437,8 +449,8 @@ you have the anaconda-tui package installed.</p>
|
|||
<p>Default: []</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="appliance arguments">
|
||||
</section>
|
||||
<section id="appliance arguments">
|
||||
<h3>appliance arguments<a class="headerlink" href="#appliance arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--app-name</kbd></dt>
|
||||
|
|
@ -452,8 +464,8 @@ you have the anaconda-tui package installed.</p>
|
|||
<p>Default: “appliance.xml”</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="qemu arguments">
|
||||
</section>
|
||||
<section id="qemu arguments">
|
||||
<h3>qemu arguments<a class="headerlink" href="#qemu arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--ram</kbd></dt>
|
||||
|
|
@ -489,16 +501,16 @@ you have the anaconda-tui package installed.</p>
|
|||
<p>Default: “/dev/random”</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="dracut arguments">
|
||||
</section>
|
||||
<section id="dracut arguments">
|
||||
<h3>dracut arguments<a class="headerlink" href="#dracut arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--dracut-arg</kbd></dt>
|
||||
<dd><p>Argument to pass to dracut when rebuilding the initramfs. Pass this once for each argument. NOTE: this overrides the default. (default: )</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="pxe to live arguments">
|
||||
</section>
|
||||
<section id="pxe to live arguments">
|
||||
<h3>pxe to live arguments<a class="headerlink" href="#pxe to live arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--live-rootfs-size</kbd></dt>
|
||||
|
|
@ -510,8 +522,8 @@ you have the anaconda-tui package installed.</p>
|
|||
<p>Default: False</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="OCI arguments">
|
||||
</section>
|
||||
<section id="OCI arguments">
|
||||
<h3>OCI arguments<a class="headerlink" href="#OCI arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--oci-config</kbd></dt>
|
||||
|
|
@ -521,8 +533,8 @@ you have the anaconda-tui package installed.</p>
|
|||
<dd><p>runtime.json OCI configuration file</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="Vagrant arguments">
|
||||
</section>
|
||||
<section id="Vagrant arguments">
|
||||
<h3>Vagrant arguments<a class="headerlink" href="#Vagrant arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--vagrant-metadata</kbd></dt>
|
||||
|
|
@ -532,9 +544,9 @@ you have the anaconda-tui package installed.</p>
|
|||
<dd><p>optional vagrantfile</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="quickstart">
|
||||
</section>
|
||||
</section>
|
||||
<section id="quickstart">
|
||||
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Run this to create a bootable live iso:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">iso</span> \
|
||||
|
|
@ -551,8 +563,8 @@ you have the anaconda-tui package installed.</p>
|
|||
chosen, or you can use a specific port by passing it. eg. <code class="docutils literal notranslate"><span class="pre">--vnc</span> <span class="pre">vnc:127.0.0.1:5</span></code></p>
|
||||
<p>This is usually a good idea when testing changes to the kickstart. lmc tries
|
||||
to monitor the logs for fatal errors, but may not catch everything.</p>
|
||||
</div>
|
||||
<div class="section" id="how-iso-creation-works">
|
||||
</section>
|
||||
<section id="how-iso-creation-works">
|
||||
<h2>How ISO creation works<a class="headerlink" href="#how-iso-creation-works" title="Permalink to this headline">¶</a></h2>
|
||||
<p>There are 2 stages, the install stage which produces a disk or filesystem image
|
||||
as its output, and the boot media creation which uses the image as its input.
|
||||
|
|
@ -586,8 +598,8 @@ the kernel, initrd, the squashfs filesystem, etc. If you only want the
|
|||
boot.iso you can pass <code class="docutils literal notranslate"><span class="pre">--iso-only</span></code> and the other files will be removed. You
|
||||
can also name the iso by using <code class="docutils literal notranslate"><span class="pre">--iso-name</span> <span class="pre">my-live.iso</span></code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="kickstarts">
|
||||
</section>
|
||||
<section id="kickstarts">
|
||||
<h2>Kickstarts<a class="headerlink" href="#kickstarts" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The docs/ directory includes several example kickstarts, one to create a live
|
||||
desktop iso using GNOME, and another to create a minimal disk image. When
|
||||
|
|
@ -655,8 +667,8 @@ packages will get cached, so your kickstart url would look like:</p>
|
|||
</div></blockquote>
|
||||
<p>You can also add an update repo, but don’t name it updates. Add –proxy to it
|
||||
as well.</p>
|
||||
</div>
|
||||
<div class="section" id="anaconda-image-install-no-virt">
|
||||
</section>
|
||||
<section id="anaconda-image-install-no-virt">
|
||||
<h2>Anaconda image install (no-virt)<a class="headerlink" href="#anaconda-image-install-no-virt" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can create images without using qemu by passing <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code> on the
|
||||
cmdline. This will use Anaconda’s directory install feature to handle the
|
||||
|
|
@ -688,8 +700,8 @@ virt.</p>
|
|||
logged for debugging purposes and if there are SELinux denials they should
|
||||
be reported as a bug.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="ami-images">
|
||||
</section>
|
||||
<section id="ami-images">
|
||||
<h2>AMI Images<a class="headerlink" href="#ami-images" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Amazon EC2 images can be created by using the –make-ami switch and an appropriate
|
||||
kickstart file. All of the work to customize the image is handled by the kickstart.
|
||||
|
|
@ -699,8 +711,8 @@ that it would work with livemedia-creator.</p>
|
|||
<p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">livemedia-creator</span> <span class="pre">--make-ami</span> <span class="pre">--iso=/path/to/boot.iso</span> <span class="pre">--ks=./docs/rhel-livemedia-ec2.ks</span></code></p>
|
||||
<p>This will produce an ami-root.img file in the working directory.</p>
|
||||
<p>At this time I have not tested the image with EC2. Feedback would be welcome.</p>
|
||||
</div>
|
||||
<div class="section" id="appliance-creation">
|
||||
</section>
|
||||
<section id="appliance-creation">
|
||||
<h2>Appliance Creation<a class="headerlink" href="#appliance-creation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>livemedia-creator can now replace appliance-tools by using the –make-appliance
|
||||
switch. This will create the partitioned disk image and an XML file that can be
|
||||
|
|
@ -754,8 +766,8 @@ from <code class="docutils literal notranslate"><span class="pre">--releasever</
|
|||
<span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="nb">type</span><span class="o">=</span><span class="n">qcow2</span> <span class="o">--</span><span class="n">app</span><span class="o">-</span><span class="n">file</span><span class="o">=</span><span class="n">minimal</span><span class="o">-</span><span class="n">test</span><span class="o">.</span><span class="n">xml</span> <span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="n">name</span><span class="o">=</span><span class="n">minimal</span><span class="o">-</span><span class="n">test</span><span class="o">.</span><span class="n">img</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="filesystem-image-creation">
|
||||
</section>
|
||||
<section id="filesystem-image-creation">
|
||||
<h2>Filesystem Image Creation<a class="headerlink" href="#filesystem-image-creation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>livemedia-creator can be used to create un-partitined filesystem images using
|
||||
the <code class="docutils literal notranslate"><span class="pre">--make-fsimage</span></code> option. As of version 21.8 this works with both qemu and
|
||||
|
|
@ -765,8 +777,8 @@ no-virt modes of operation. Previously it was only available with no-virt.</p>
|
|||
<div><p><code class="docutils literal notranslate"><span class="pre">livemedia-creator</span> <span class="pre">--make-fsimage</span> <span class="pre">--iso=/path/to/boot.iso</span> <span class="pre">--ks=./docs/rhel-minimal.ks</span></code></p>
|
||||
</div></blockquote>
|
||||
<p>You can name the output image with <code class="docutils literal notranslate"><span class="pre">--image-name</span></code> and set a label on the filesystem with <code class="docutils literal notranslate"><span class="pre">--fs-label</span></code></p>
|
||||
</div>
|
||||
<div class="section" id="tar-file-creation">
|
||||
</section>
|
||||
<section id="tar-file-creation">
|
||||
<h2>TAR File Creation<a class="headerlink" href="#tar-file-creation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">--make-tar</span></code> command can be used to create a tar of the root filesystem. By
|
||||
default it is compressed using xz, but this can be changed using the
|
||||
|
|
@ -778,15 +790,15 @@ no-virt install methods.</p>
|
|||
<span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="n">name</span><span class="o">=</span><span class="n">rhel</span><span class="o">-</span><span class="n">root</span><span class="o">.</span><span class="n">tar</span><span class="o">.</span><span class="n">xz</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="live-image-for-pxe-boot">
|
||||
</section>
|
||||
<section id="live-image-for-pxe-boot">
|
||||
<h2>Live Image for PXE Boot<a class="headerlink" href="#live-image-for-pxe-boot" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">--make-pxe-live</span></code> command will produce squashfs image containing live root
|
||||
filesystem that can be used for pxe boot. Directory with results will contain
|
||||
the live image, kernel image, initrd image and template of pxe configuration
|
||||
for the images.</p>
|
||||
</div>
|
||||
<div class="section" id="atomic-live-image-for-pxe-boot">
|
||||
</section>
|
||||
<section id="atomic-live-image-for-pxe-boot">
|
||||
<h2>Atomic Live Image for PXE Boot<a class="headerlink" href="#atomic-live-image-for-pxe-boot" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">--make-ostree-live</span></code> command will produce the same result as <code class="docutils literal notranslate"><span class="pre">--make-pxe-live</span></code>
|
||||
for installations of Atomic Host. Example kickstart for such an installation
|
||||
|
|
@ -795,8 +807,8 @@ in docs/rhel-atomic-pxe-live.ks.</p>
|
|||
<p>The PXE images can also be created with <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code> by using the example
|
||||
kickstart in docs/rhel-atomic-pxe-live-novirt.ks. This also works inside the
|
||||
mock environment.</p>
|
||||
</div>
|
||||
<div class="section" id="using-mock-and-no-virt-to-create-images">
|
||||
</section>
|
||||
<section id="using-mock-and-no-virt-to-create-images">
|
||||
<h2>Using Mock and –no-virt to Create Images<a class="headerlink" href="#using-mock-and-no-virt-to-create-images" title="Permalink to this headline">¶</a></h2>
|
||||
<p>As of lorax version 22.2 you can use livemedia-creator and anaconda version
|
||||
22.15 inside of a mock chroot with –make-iso and –make-fsimage.</p>
|
||||
|
|
@ -847,8 +859,8 @@ group.</p>
|
|||
including anaconda logs and livemedia-creator logs. The new iso will be
|
||||
located at ~/results/try-1/images/boot.iso, and the ~/results/try-1/
|
||||
directory tree will also contain the vmlinuz, initrd, etc.</p>
|
||||
</div>
|
||||
<div class="section" id="using-mock-and-qemu-to-create-images">
|
||||
</section>
|
||||
<section id="using-mock-and-qemu-to-create-images">
|
||||
<h2>Using Mock and qemu to Create Images<a class="headerlink" href="#using-mock-and-qemu-to-create-images" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Version 25.0 of livemedia-creator switches to using qemu for virtualization.
|
||||
This allows creation of all image types, and use of the KVM on the host if
|
||||
|
|
@ -898,8 +910,8 @@ located at ~/results/try-1/images/boot.iso, and the ~/results/try-1/
|
|||
directory tree will also contain the vmlinuz, initrd, etc.</p>
|
||||
<p>This will run qemu without kvm support, which is going to be very slow. You can
|
||||
add <code class="docutils literal notranslate"><span class="pre">mknod</span> <span class="pre">/dev/kvm</span> <span class="pre">c</span> <span class="pre">10</span> <span class="pre">232;</span></code> to create the device node before running lmc.</p>
|
||||
</div>
|
||||
<div class="section" id="openstack-image-creation">
|
||||
</section>
|
||||
<section id="openstack-image-creation">
|
||||
<h2>OpenStack Image Creation<a class="headerlink" href="#openstack-image-creation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>OpenStack supports partitioned disk images so <code class="docutils literal notranslate"><span class="pre">--make-disk</span></code> can be used to
|
||||
create images for importing into glance, OpenStack’s image storage component.
|
||||
|
|
@ -923,8 +935,8 @@ cloud-utils-growpart will grow the image to fit the instance’s disk size.</p>
|
|||
</pre></div>
|
||||
</div>
|
||||
<p>If qcow2 wasn’t used then <code class="docutils literal notranslate"><span class="pre">--disk-format</span></code> should be set to raw.</p>
|
||||
</div>
|
||||
<div class="section" id="container-image-creation">
|
||||
</section>
|
||||
<section id="container-image-creation">
|
||||
<h2>Container Image Creation<a class="headerlink" href="#container-image-creation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Use lmc to create a tarfile as described in the <a class="reference internal" href="#tar-file-creation">TAR File Creation</a> section, but substitute the
|
||||
rhel-container.ks example kickstart which removes the requirement for core files and the kernel.</p>
|
||||
|
|
@ -936,8 +948,8 @@ rhel-container.ks example kickstart which removes the requirement for core files
|
|||
<blockquote>
|
||||
<div><p><code class="docutils literal notranslate"><span class="pre">podman</span> <span class="pre">run</span> <span class="pre">-i</span> <span class="pre">-t</span> <span class="pre">rhel-root</span> <span class="pre">/bin/bash</span></code></p>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
<div class="section" id="open-container-initiative-image-creation">
|
||||
</section>
|
||||
<section id="open-container-initiative-image-creation">
|
||||
<h2>Open Container Initiative Image Creation<a class="headerlink" href="#open-container-initiative-image-creation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The OCI is a new specification that is still being worked on. You can read more about it at
|
||||
<a class="reference external" href="https://www.opencontainers.org/">the Open Container Initiative website</a>. You can create
|
||||
|
|
@ -951,8 +963,8 @@ their specifications can be found <a class="reference external" href="https://gi
|
|||
output will be in the results directory with a default name of bundle.tar.xz</p>
|
||||
<p>This will work with <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code> and inside a mock since it doesn’t use any
|
||||
partitioned disk images.</p>
|
||||
</div>
|
||||
<div class="section" id="vagrant-image-creation">
|
||||
</section>
|
||||
<section id="vagrant-image-creation">
|
||||
<h2>Vagrant Image Creation<a class="headerlink" href="#vagrant-image-creation" title="Permalink to this headline">¶</a></h2>
|
||||
<p><a class="reference external" href="https://www.vagrantup.com/">Vagrant</a> images can be created using the following command:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">vagrant</span> <span class="o">--</span><span class="n">vagrant</span><span class="o">-</span><span class="n">metadata</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">metadata</span><span class="o">.</span><span class="n">json</span> \
|
||||
|
|
@ -970,8 +982,8 @@ the vagrant user with the default insecure SSH pubkey and a few useful
|
|||
utilities.</p>
|
||||
<p>This also works with <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code>, but will not work inside a mock due to its
|
||||
use of partitioned disk images and qcow2.</p>
|
||||
</div>
|
||||
<div class="section" id="creating-uefi-disk-images-with-virt">
|
||||
</section>
|
||||
<section id="creating-uefi-disk-images-with-virt">
|
||||
<h2>Creating UEFI disk images with virt<a class="headerlink" href="#creating-uefi-disk-images-with-virt" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Partitioned disk images can only be created for the same platform as the host system (BIOS or
|
||||
UEFI). You can use virt to create BIOS images on UEFI systems, and it is also possible
|
||||
|
|
@ -992,8 +1004,8 @@ firmware files.</p>
|
|||
<p class="admonition-title">Note</p>
|
||||
<p>The –virt-uefi method is currently only supported on the x86_64 architecture.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="debugging-problems">
|
||||
</section>
|
||||
<section id="debugging-problems">
|
||||
<h2>Debugging problems<a class="headerlink" href="#debugging-problems" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Sometimes an installation will get stuck. When using qemu the logs will
|
||||
be written to ./virt-install.log and most of the time any problems that happen
|
||||
|
|
@ -1020,44 +1032,44 @@ running the <code class="docutils literal notranslate"><span class="pre">anacond
|
|||
multi-threaded and it can sometimes become stuck and refuse to exit. When this
|
||||
happens you can usually clean up by first killing the anaconda process then
|
||||
running <code class="docutils literal notranslate"><span class="pre">anaconda-cleanup</span></code>.</p>
|
||||
</div>
|
||||
<div class="section" id="hacking">
|
||||
</section>
|
||||
<section id="hacking">
|
||||
<h2>Hacking<a class="headerlink" href="#hacking" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Development on this will take place as part of the lorax project, and on the
|
||||
anaconda-devel-list mailing list, and <a class="reference external" href="https://github.com/rhinstaller/lorax">on github</a></p>
|
||||
<p>Feedback, enhancements and bugs are welcome. You can use <a class="reference external" href="https://bugzilla.redhat.com/enter_bug.cgi?product=RedHatEnterpriseLinux8&component=lorax">bugzilla</a> to
|
||||
report bugs against the lorax component.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="lorax-composer.html" class="btn btn-neutral float-right" title="lorax-composer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="lorax.html" class="btn btn-neutral float-left" title="Lorax" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
<a href="mkksiso.html" class="btn btn-neutral float-right" title="mkksiso" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="lorax.html" class="btn btn-neutral float-left" title="Lorax" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -1066,7 +1078,6 @@ report bugs against the lorax component.</p>
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
|
|
@ -1,42 +1,49 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>lorax-composer — Lorax 28.14.42 documentation</title>
|
||||
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>lorax-composer — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="composer-cli" href="composer-cli.html" />
|
||||
<link rel="prev" title="livemedia-creator" href="livemedia-creator.html" />
|
||||
<link rel="prev" title="mkksiso" href="mkksiso.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
|
@ -60,7 +67,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -77,6 +84,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -89,6 +97,7 @@
|
|||
<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="mkksiso.html">mkksiso</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">lorax-composer</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#important-things-to-note">Important Things To Note</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
|
||||
|
|
@ -137,6 +146,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -171,18 +181,20 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>lorax-composer</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="_sources/lorax-composer.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
|
|
@ -196,21 +208,29 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="lorax-composer">
|
||||
<section id="lorax-composer">
|
||||
<h1>lorax-composer<a class="headerlink" href="#lorax-composer" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Authors</dt>
|
||||
<dd class="field-odd"><p>Brian C. Lane <<a class="reference external" href="mailto:bcl%40redhat.com">bcl<span>@</span>redhat<span>.</span>com</a>></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code> is an API server that allows you to build disk images using
|
||||
<p><code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code> is a WELDR API server that allows you to build disk images using
|
||||
<a class="reference internal" href="#blueprints">Blueprints</a> to describe the package versions to be installed into the image.
|
||||
It is compatible with the Weldr project’s bdcs-api REST protocol. More
|
||||
information on Weldr can be found <a class="reference external" href="http://www.weldr.io">on the Weldr blog</a>.</p>
|
||||
<p>Behind the scenes it uses <a class="reference external" href="livemedia-creator.html">livemedia-creator</a> and
|
||||
<a class="reference external" href="https://anaconda-installer.readthedocs.io/en/latest/">Anaconda</a> to handle the
|
||||
installation and configuration of the images.</p>
|
||||
<div class="section" id="important-things-to-note">
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code> is now deprecated. It is being replaced by the
|
||||
<code class="docutils literal notranslate"><span class="pre">osbuild-composer</span></code> WELDR API server which implements more features (eg.
|
||||
ostree, image uploads, etc.) You can still use <code class="docutils literal notranslate"><span class="pre">composer-cli</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">cockpit-composer</span></code> with <code class="docutils literal notranslate"><span class="pre">osbuild-composer</span></code>. See the documentation or
|
||||
the <a class="reference external" href="https://www.osbuild.org/">osbuild website</a> for more information.</p>
|
||||
</div>
|
||||
<section id="important-things-to-note">
|
||||
<h2>Important Things To Note<a class="headerlink" href="#important-things-to-note" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>As of version 30.7 SELinux can be set to Enforcing. The current state is
|
||||
|
|
@ -221,8 +241,8 @@ use one of the <a class="reference internal" href="#customizations">Customizatio
|
|||
package that creates a user, or use something like <cite>cloud-init</cite> to setup access at
|
||||
boot time.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="installation">
|
||||
</section>
|
||||
<section id="installation">
|
||||
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The best way to install <code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code> is to use <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">dnf</span> <span class="pre">install</span>
|
||||
<span class="pre">lorax-composer</span> <span class="pre">composer-cli</span></code>, this will setup the weldr user and install the
|
||||
|
|
@ -231,8 +251,8 @@ systemd socket activation service. You will then need to enable it with <code cl
|
|||
<span class="pre">lorax-composer.socket</span></code>. This will leave the server off until the first request
|
||||
is made. Systemd will then launch the server and it will remain running until
|
||||
the system is rebooted.</p>
|
||||
</div>
|
||||
<div class="section" id="quickstart">
|
||||
</section>
|
||||
<section id="quickstart">
|
||||
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h2>
|
||||
<ol class="arabic simple">
|
||||
<li><p>Create a <code class="docutils literal notranslate"><span class="pre">weldr</span></code> user and group by running <code class="docutils literal notranslate"><span class="pre">useradd</span> <span class="pre">weldr</span></code></p></li>
|
||||
|
|
@ -251,13 +271,13 @@ be created, and all the blueprints created with the <code class="docutils litera
|
|||
route will be stored. If there are blueprint <code class="docutils literal notranslate"><span class="pre">.toml</span></code> files in the top level
|
||||
of the directory they will be imported into the blueprint git storage when
|
||||
<code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code> starts.</p>
|
||||
</div>
|
||||
<div class="section" id="logs">
|
||||
</section>
|
||||
<section id="logs">
|
||||
<h2>Logs<a class="headerlink" href="#logs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Logs are stored under <code class="docutils literal notranslate"><span class="pre">/var/log/lorax-composer/</span></code> and include all console
|
||||
messages as well as extra debugging info and API requests.</p>
|
||||
</div>
|
||||
<div class="section" id="security">
|
||||
</section>
|
||||
<section id="security">
|
||||
<h2>Security<a class="headerlink" href="#security" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Some security related issues that you should be aware of before running <code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code>:</p>
|
||||
<ul class="simple">
|
||||
|
|
@ -268,8 +288,8 @@ messages as well as extra debugging info and API requests.</p>
|
|||
inject commands into a blueprint that would result in the kickstart executing
|
||||
arbitrary code on the host. Only authorized users should be allowed to build
|
||||
images using <code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code>.</p>
|
||||
</div>
|
||||
<div class="section" id="lorax-composer-cmdline-arguments">
|
||||
</section>
|
||||
<section id="lorax-composer-cmdline-arguments">
|
||||
<h2>lorax-composer cmdline arguments<a class="headerlink" href="#lorax-composer-cmdline-arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<p><p>Lorax Composer API Server</p>
|
||||
</p>
|
||||
|
|
@ -281,15 +301,15 @@ images using <code class="docutils literal notranslate"><span class="pre">lorax-
|
|||
<span class="n">BLUEPRINTS</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="Positional Arguments">
|
||||
<section id="Positional Arguments">
|
||||
<h3>Positional Arguments<a class="headerlink" href="#Positional Arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>BLUEPRINTS</kbd></dt>
|
||||
<dd><p>Path to the blueprints</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="Named Arguments">
|
||||
</section>
|
||||
<section id="Named Arguments">
|
||||
<h3>Named Arguments<a class="headerlink" href="#Named Arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--socket</kbd></dt>
|
||||
|
|
@ -338,9 +358,9 @@ images using <code class="docutils literal notranslate"><span class="pre">lorax-
|
|||
<p>Default: False</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="how-it-works">
|
||||
</section>
|
||||
</section>
|
||||
<section id="how-it-works">
|
||||
<h2>How it Works<a class="headerlink" href="#how-it-works" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The server runs as root, and as <code class="docutils literal notranslate"><span class="pre">weldr</span></code>. Communication with it is via a unix
|
||||
domain socket (<code class="docutils literal notranslate"><span class="pre">/run/weldr/api.socket</span></code> by default). The directory and socket
|
||||
|
|
@ -353,14 +373,14 @@ cmdline by passing it the <code class="docutils literal notranslate"><span class
|
|||
<p>It will then drop root privileges for the API thread and run as the <code class="docutils literal notranslate"><span class="pre">weldr</span></code>
|
||||
user. The queue and compose thread still runs as root because it needs to be
|
||||
able to mount/umount files and run Anaconda.</p>
|
||||
</div>
|
||||
<div class="section" id="composing-images">
|
||||
</section>
|
||||
<section id="composing-images">
|
||||
<h2>Composing Images<a class="headerlink" href="#composing-images" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <a class="reference external" href="https://github.com/weldr/welder-web/">welder-web</a> GUI project can be used to construct
|
||||
blueprints and create composes using a web browser.</p>
|
||||
<p>Or use the command line with <a class="reference external" href="composer-cli.html">composer-cli</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="blueprints">
|
||||
</section>
|
||||
<section id="blueprints">
|
||||
<h2>Blueprints<a class="headerlink" href="#blueprints" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Blueprints are simple text files in <a class="reference external" href="https://github.com/toml-lang/toml">TOML</a> format that describe
|
||||
which packages, and what versions, to install into the image. They can also define a limited set
|
||||
|
|
@ -385,7 +405,7 @@ automatically bump the PATCH level of the <code class="docutils literal notransl
|
|||
doesn’t match it will be used as is. eg. Uploading a blueprint with <code class="docutils literal notranslate"><span class="pre">version</span></code>
|
||||
set to <code class="docutils literal notranslate"><span class="pre">0.1.0</span></code> when the existing blueprint <code class="docutils literal notranslate"><span class="pre">version</span></code> is <code class="docutils literal notranslate"><span class="pre">0.0.1</span></code> will
|
||||
result in the new blueprint being stored as <code class="docutils literal notranslate"><span class="pre">version</span> <span class="pre">0.1.0</span></code>.</p>
|
||||
<div class="section" id="packages-and-modules">
|
||||
<section id="packages-and-modules">
|
||||
<h3>[[packages]] and [[modules]]<a class="headerlink" href="#packages-and-modules" title="Permalink to this headline">¶</a></h3>
|
||||
<p>These entries describe the package names and matching version glob to be installed into the image.</p>
|
||||
<p>The names must match the names exactly, and the versions can be an exact match
|
||||
|
|
@ -394,8 +414,8 @@ character matching.</p>
|
|||
<p>NOTE: As of lorax-composer-29.2-1 the versions are not used for depsolving,
|
||||
that is planned for a future release. And currently there are no differences
|
||||
between <code class="docutils literal notranslate"><span class="pre">packages</span></code> and <code class="docutils literal notranslate"><span class="pre">modules</span></code> in <code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code>.</p>
|
||||
</div>
|
||||
<div class="section" id="groups">
|
||||
</section>
|
||||
<section id="groups">
|
||||
<h3>[[groups]]<a class="headerlink" href="#groups" title="Permalink to this headline">¶</a></h3>
|
||||
<p>These 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
|
||||
|
|
@ -404,8 +424,8 @@ way of listing a group.</p>
|
|||
<p>Groups have three different ways of categorizing their packages: mandatory, default, and optional.
|
||||
For purposes of blueprints, mandatory and default packages will be installed. There is no mechanism
|
||||
for selecting optional packages.</p>
|
||||
</div>
|
||||
<div class="section" id="customizations">
|
||||
</section>
|
||||
<section id="customizations">
|
||||
<h3>Customizations<a class="headerlink" href="#customizations" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">[customizations]</span></code> section can be used to configure the hostname of the final image. eg.:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">customizations</span><span class="p">]</span>
|
||||
|
|
@ -413,7 +433,7 @@ for selecting optional packages.</p>
|
|||
</pre></div>
|
||||
</div>
|
||||
<p>This is optional and may be left out to use the defaults.</p>
|
||||
<div class="section" id="customizations-kernel">
|
||||
<section id="customizations-kernel">
|
||||
<h4>[customizations.kernel]<a class="headerlink" href="#customizations-kernel" title="Permalink to this headline">¶</a></h4>
|
||||
<p>This allows you to append arguments to the bootloader’s kernel commandline. This will not have any
|
||||
effect on <code class="docutils literal notranslate"><span class="pre">tar</span></code> or <code class="docutils literal notranslate"><span class="pre">ext4-filesystem</span></code> images since they do not include a bootloader.</p>
|
||||
|
|
@ -422,8 +442,8 @@ effect on <code class="docutils literal notranslate"><span class="pre">tar</span
|
|||
<span class="n">append</span> <span class="o">=</span> <span class="s2">"nosmt=force"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="customizations-sshkey">
|
||||
</section>
|
||||
<section id="customizations-sshkey">
|
||||
<h4>[[customizations.sshkey]]<a class="headerlink" href="#customizations-sshkey" title="Permalink to this headline">¶</a></h4>
|
||||
<p>Set an existing user’s ssh key in the final image:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">customizations</span><span class="o">.</span><span class="n">sshkey</span><span class="p">]]</span>
|
||||
|
|
@ -432,8 +452,8 @@ effect on <code class="docutils literal notranslate"><span class="pre">tar</span
|
|||
</pre></div>
|
||||
</div>
|
||||
<p>The key will be added to the user’s authorized_keys file.</p>
|
||||
</div>
|
||||
<div class="section" id="customizations-user">
|
||||
</section>
|
||||
<section id="customizations-user">
|
||||
<h4>[[customizations.user]]<a class="headerlink" href="#customizations-user" title="Permalink to this headline">¶</a></h4>
|
||||
<p>Add a user to the image, and/or set their ssh key.
|
||||
All fields for this section are optional except for the <code class="docutils literal notranslate"><span class="pre">name</span></code>, here is a complete example:</p>
|
||||
|
|
@ -451,8 +471,8 @@ All fields for this section are optional except for the <code class="docutils li
|
|||
</div>
|
||||
<p>If the password starts with <code class="docutils literal notranslate"><span class="pre">$6$</span></code>, <code class="docutils literal notranslate"><span class="pre">$5$</span></code>, or <code class="docutils literal notranslate"><span class="pre">$2b$</span></code> it will be stored as
|
||||
an encrypted password. Otherwise it will be treated as a plain text password.</p>
|
||||
</div>
|
||||
<div class="section" id="customizations-group">
|
||||
</section>
|
||||
<section id="customizations-group">
|
||||
<h4>[[customizations.group]]<a class="headerlink" href="#customizations-group" title="Permalink to this headline">¶</a></h4>
|
||||
<p>Add a group to the image. <code class="docutils literal notranslate"><span class="pre">name</span></code> is required and <code class="docutils literal notranslate"><span class="pre">gid</span></code> is optional:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[[</span><span class="n">customizations</span><span class="o">.</span><span class="n">group</span><span class="p">]]</span>
|
||||
|
|
@ -460,8 +480,8 @@ an encrypted password. Otherwise it will be treated as a plain text password.</p
|
|||
<span class="n">gid</span> <span class="o">=</span> <span class="mi">1130</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="customizations-timezone">
|
||||
</section>
|
||||
<section id="customizations-timezone">
|
||||
<h4>[customizations.timezone]<a class="headerlink" href="#customizations-timezone" title="Permalink to this headline">¶</a></h4>
|
||||
<p>Customizing the timezone and the NTP servers to use for the system:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">customizations</span><span class="o">.</span><span class="n">timezone</span><span class="p">]</span>
|
||||
|
|
@ -475,8 +495,8 @@ optional and will default to using the distribution defaults which are fine for
|
|||
<p>In some image types there are already NTP servers setup, eg. Google cloud image, and they
|
||||
cannot be overridden because they are required to boot in the selected environment. But the
|
||||
timezone will be updated to the one selected in the blueprint.</p>
|
||||
</div>
|
||||
<div class="section" id="customizations-locale">
|
||||
</section>
|
||||
<section id="customizations-locale">
|
||||
<h4>[customizations.locale]<a class="headerlink" href="#customizations-locale" title="Permalink to this headline">¶</a></h4>
|
||||
<p>Customize the locale settings for the system:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">customizations</span><span class="o">.</span><span class="n">locale</span><span class="p">]</span>
|
||||
|
|
@ -491,8 +511,8 @@ the command line.</p>
|
|||
<p>Multiple languages can be added. The first one becomes the
|
||||
primary, and the others are added as secondary. One or the other of <code class="docutils literal notranslate"><span class="pre">languages</span></code>
|
||||
or <code class="docutils literal notranslate"><span class="pre">keyboard</span></code> must be included (or both) in the section.</p>
|
||||
</div>
|
||||
<div class="section" id="customizations-firewall">
|
||||
</section>
|
||||
<section id="customizations-firewall">
|
||||
<h4>[customizations.firewall]<a class="headerlink" href="#customizations-firewall" title="Permalink to this headline">¶</a></h4>
|
||||
<p>By default the firewall blocks all access except for services that enable their ports explicitly,
|
||||
like <code class="docutils literal notranslate"><span class="pre">sshd</span></code>. This command can be used to open other ports or services. Ports are configured using
|
||||
|
|
@ -516,8 +536,8 @@ in a <code class="docutils literal notranslate"><span class="pre">customizations
|
|||
only want the default firewall setup this section can be omitted from the blueprint.</p>
|
||||
<p>NOTE: The <code class="docutils literal notranslate"><span class="pre">Google</span></code> and <code class="docutils literal notranslate"><span class="pre">OpenStack</span></code> templates explicitly disable the firewall for their environment.
|
||||
This cannot be overridden by the blueprint.</p>
|
||||
</div>
|
||||
<div class="section" id="customizations-services">
|
||||
</section>
|
||||
<section id="customizations-services">
|
||||
<h4>[customizations.services]<a class="headerlink" href="#customizations-services" title="Permalink to this headline">¶</a></h4>
|
||||
<p>This section can be used to control which services are enabled at boot time.
|
||||
Some image types already have services enabled or disabled in order for the
|
||||
|
|
@ -532,9 +552,9 @@ file accepted by <code class="docutils literal notranslate"><span class="pre">sy
|
|||
<span class="n">disabled</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"postfix"</span><span class="p">,</span> <span class="s2">"telnetd"</span><span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="repos-git">
|
||||
</section>
|
||||
</section>
|
||||
<section id="repos-git">
|
||||
<h3>[[repos.git]]<a class="headerlink" href="#repos-git" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">[[repos.git]]</span></code> entries are used to add files from a <cite>git repository<https://git-scm.com/></cite>
|
||||
repository to the created image. The repository is cloned, the specified <code class="docutils literal notranslate"><span class="pre">ref</span></code> is checked out
|
||||
|
|
@ -568,34 +588,34 @@ of a branch set it to <code class="docutils literal notranslate"><span class="pr
|
|||
<p>Note that the repository is cloned in full each time a build is started, so pointing to a
|
||||
repository with a large amount of history may take a while to clone and use a significant
|
||||
amount of disk space. The clone is temporary and is removed once the rpm is created.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="adding-output-types">
|
||||
</section>
|
||||
</section>
|
||||
<section id="adding-output-types">
|
||||
<h2>Adding Output Types<a class="headerlink" href="#adding-output-types" title="Permalink to this headline">¶</a></h2>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">livemedia-creator</span></code> supports a large number of output types, and only some of
|
||||
these are currently available via <code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code>. To add a new output type to
|
||||
lorax-composer a kickstart file needs to be added to <code class="docutils literal notranslate"><span class="pre">./share/composer/</span></code>. The
|
||||
name of the kickstart is what will be used by the <code class="docutils literal notranslate"><span class="pre">/compose/types</span></code> route, and the
|
||||
<code class="docutils literal notranslate"><span class="pre">compose_type</span></code> field of the POST to start a compose. It also needs to have
|
||||
code added to the <code class="xref py py-func docutils literal notranslate"><span class="pre">pylorax.api.compose.compose_args()</span></code> function. The
|
||||
code added to the <a class="reference internal" href="pylorax.api.html#pylorax.api.compose.compose_args" title="pylorax.api.compose.compose_args"><code class="xref py py-func docutils literal notranslate"><span class="pre">pylorax.api.compose.compose_args()</span></code></a> function. The
|
||||
<code class="docutils literal notranslate"><span class="pre">_MAP</span></code> entry in this function defines what lorax-composer will pass to
|
||||
<a class="reference internal" href="pylorax.html#pylorax.installer.novirt_install" title="pylorax.installer.novirt_install"><code class="xref py py-func docutils literal notranslate"><span class="pre">pylorax.installer.novirt_install()</span></code></a> when it runs the compose. When the
|
||||
compose is finished the output files need to be copied out of the build
|
||||
directory (<code class="docutils literal notranslate"><span class="pre">/var/lib/lorax/composer/results/<UUID>/compose/</span></code>),
|
||||
<code class="xref py py-func docutils literal notranslate"><span class="pre">pylorax.api.compose.move_compose_results()</span></code> handles this for each type.
|
||||
<a class="reference internal" href="pylorax.api.html#pylorax.api.compose.move_compose_results" title="pylorax.api.compose.move_compose_results"><code class="xref py py-func docutils literal notranslate"><span class="pre">pylorax.api.compose.move_compose_results()</span></code></a> handles this for each type.
|
||||
You should move them instead of copying to save space.</p>
|
||||
<p>If the new output type does not have support in livemedia-creator it should be
|
||||
added there first. This will make the output available to the widest number of
|
||||
users.</p>
|
||||
<div class="section" id="example-add-partitioned-disk-support">
|
||||
<section id="example-add-partitioned-disk-support">
|
||||
<h3>Example: Add partitioned disk support<a class="headerlink" href="#example-add-partitioned-disk-support" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Partitioned disk support is something that livemedia-creator already supports
|
||||
via the <code class="docutils literal notranslate"><span class="pre">--make-disk</span></code> cmdline argument. To add this to lorax-composer it
|
||||
needs 3 things:</p>
|
||||
<ul class="simple">
|
||||
<li><p>A <code class="docutils literal notranslate"><span class="pre">partitioned-disk.ks</span></code> file in <code class="docutils literal notranslate"><span class="pre">./share/composer/</span></code></p></li>
|
||||
<li><p>A new entry in the _MAP in <code class="xref py py-func docutils literal notranslate"><span class="pre">pylorax.api.compose.compose_args()</span></code></p></li>
|
||||
<li><p>Add a bit of code to <code class="xref py py-func docutils literal notranslate"><span class="pre">pylorax.api.compose.move_compose_results()</span></code> to move the disk image from
|
||||
<li><p>A new entry in the _MAP in <a class="reference internal" href="pylorax.api.html#pylorax.api.compose.compose_args" title="pylorax.api.compose.compose_args"><code class="xref py py-func docutils literal notranslate"><span class="pre">pylorax.api.compose.compose_args()</span></code></a></p></li>
|
||||
<li><p>Add a bit of code to <a class="reference internal" href="pylorax.api.html#pylorax.api.compose.move_compose_results" title="pylorax.api.compose.move_compose_results"><code class="xref py py-func docutils literal notranslate"><span class="pre">pylorax.api.compose.move_compose_results()</span></code></a> to move the disk image from
|
||||
the compose directory to the results directory.</p></li>
|
||||
</ul>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">partitioned-disk.ks</span></code> is pretty similar to the example minimal kickstart
|
||||
|
|
@ -612,9 +632,9 @@ the results directory, or it could do some post-processing on it. The end of
|
|||
the function should always clean up the <code class="docutils literal notranslate"><span class="pre">./compose/</span></code> directory, removing any
|
||||
unneeded extra files. This is especially true for the <code class="docutils literal notranslate"><span class="pre">live-iso</span></code> since it produces
|
||||
the contents of the iso as well as the boot.iso itself.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="package-sources">
|
||||
</section>
|
||||
</section>
|
||||
<section id="package-sources">
|
||||
<h2>Package Sources<a class="headerlink" href="#package-sources" title="Permalink to this headline">¶</a></h2>
|
||||
<p>By default lorax-composer uses the host’s configured repositories. It copies
|
||||
the <code class="docutils literal notranslate"><span class="pre">*.repo</span></code> files from <code class="docutils literal notranslate"><span class="pre">/etc/yum.repos.d/</span></code> into
|
||||
|
|
@ -657,7 +677,7 @@ it returns JSON but it can also return TOML if <code class="docutils literal not
|
|||
<p>The configured sources are used for all blueprint depsolve operations, and for composing images.
|
||||
When adding additional sources you must make sure that the packages in the source do not
|
||||
conflict with any other package sources, otherwise depsolving will fail.</p>
|
||||
<div class="section" id="dvd-iso-package-source">
|
||||
<section id="dvd-iso-package-source">
|
||||
<h3>DVD ISO Package Source<a class="headerlink" href="#dvd-iso-package-source" title="Permalink to this headline">¶</a></h3>
|
||||
<p>In some situations the system may want to <em>only</em> use a DVD iso as the package
|
||||
source, not the repos from the network. <code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code> and <code class="docutils literal notranslate"><span class="pre">anaconda</span></code>
|
||||
|
|
@ -686,38 +706,38 @@ type will not be available.</p></li>
|
|||
mounting the iso and creating a source file to point to it as described in the
|
||||
<a class="reference internal" href="#package-sources">Package Sources</a> documentation. In that case there is no need to remove the other
|
||||
sources from <code class="docutils literal notranslate"><span class="pre">/etc/yum.repos.d/</span></code> or clear the cached repos.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="composer-cli.html" class="btn btn-neutral float-right" title="composer-cli" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="livemedia-creator.html" class="btn btn-neutral float-left" title="livemedia-creator" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
<a href="composer-cli.html" class="btn btn-neutral float-right" title="composer-cli" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="mkksiso.html" class="btn btn-neutral float-left" title="mkksiso" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -726,7 +746,6 @@ sources from <code class="docutils literal notranslate"><span class="pre">/etc/y
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
|
|
@ -1,38 +1,45 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Lorax — Lorax 28.14.42 documentation</title>
|
||||
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>Lorax — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="livemedia-creator" href="livemedia-creator.html" />
|
||||
|
|
@ -60,7 +67,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -77,6 +84,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -114,6 +122,7 @@
|
|||
</ul>
|
||||
</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="mkksiso.html">mkksiso</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="product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -123,6 +132,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -157,18 +167,20 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>Lorax</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="_sources/lorax.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
|
|
@ -182,7 +194,7 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="lorax">
|
||||
<section id="lorax">
|
||||
<h1>Lorax<a class="headerlink" href="#lorax" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Authors</dt>
|
||||
|
|
@ -198,7 +210,7 @@ environment. It is best to run lorax from the same release as is being targeted
|
|||
because the templates may have release specific logic in them. eg. Use the
|
||||
rawhide version to build the boot.iso for rawhide, along with the rawhide
|
||||
repositories.</p>
|
||||
<div class="section" id="lorax-cmdline-arguments">
|
||||
<section id="lorax-cmdline-arguments">
|
||||
<h2>lorax cmdline arguments<a class="headerlink" href="#lorax-cmdline-arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<p><p>Create the Anaconda boot.iso</p>
|
||||
</p>
|
||||
|
|
@ -214,27 +226,28 @@ repositories.</p>
|
|||
<span class="p">[</span><span class="o">--</span><span class="n">add</span><span class="o">-</span><span class="n">arch</span><span class="o">-</span><span class="n">template</span><span class="o">-</span><span class="n">var</span> <span class="n">ADD_ARCH_TEMPLATE_VARS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">noverify</span><span class="p">]</span>
|
||||
<span class="p">[</span><span class="o">--</span><span class="n">sharedir</span> <span class="n">SHAREDIR</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">enablerepo</span> <span class="p">[</span><span class="n">repo</span><span class="p">]]</span>
|
||||
<span class="p">[</span><span class="o">--</span><span class="n">disablerepo</span> <span class="p">[</span><span class="n">repo</span><span class="p">]]</span> <span class="p">[</span><span class="o">--</span><span class="n">rootfs</span><span class="o">-</span><span class="n">size</span> <span class="n">ROOTFS_SIZE</span><span class="p">]</span>
|
||||
<span class="p">[</span><span class="o">--</span><span class="n">noverifyssl</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">skip</span><span class="o">-</span><span class="n">branding</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">dracut</span><span class="o">-</span><span class="n">arg</span> <span class="n">DRACUT_ARGS</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">V</span><span class="p">]</span>
|
||||
<span class="p">[</span><span class="o">--</span><span class="n">noverifyssl</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">skip</span><span class="o">-</span><span class="n">branding</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">squashfs</span><span class="o">-</span><span class="n">only</span><span class="p">]</span>
|
||||
<span class="p">[</span><span class="o">--</span><span class="n">dracut</span><span class="o">-</span><span class="n">arg</span> <span class="n">DRACUT_ARGS</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">V</span><span class="p">]</span>
|
||||
<span class="n">OUTPUTDIR</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div class="section" id="Positional Arguments">
|
||||
<section id="Positional Arguments">
|
||||
<h3>Positional Arguments<a class="headerlink" href="#Positional Arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>OUTPUTDIR</kbd></dt>
|
||||
<dd><p>Output directory</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="Named Arguments">
|
||||
</section>
|
||||
<section id="Named Arguments">
|
||||
<h3>Named Arguments<a class="headerlink" href="#Named Arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>-V</kbd></dt>
|
||||
<dd><p>show program’s version number and exit</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="required arguments">
|
||||
</section>
|
||||
<section id="required arguments">
|
||||
<h3>required arguments<a class="headerlink" href="#required arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>-p, --product</kbd></dt>
|
||||
|
|
@ -255,8 +268,8 @@ repositories.</p>
|
|||
<p>Default: []</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="Named Arguments_repeat1">
|
||||
</section>
|
||||
<section id="Named Arguments_repeat1">
|
||||
<h3>Named Arguments<a class="headerlink" href="#Named Arguments_repeat1" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>-m, --mirrorlist</kbd></dt>
|
||||
|
|
@ -367,18 +380,22 @@ repositories.</p>
|
|||
<dd><p>Disable automatic branding package selection. Use –installpkgs to add custom branding.</p>
|
||||
<p>Default: False</p>
|
||||
</dd>
|
||||
<dt><kbd>--squashfs-only</kbd></dt>
|
||||
<dd><p>Use a plain squashfs filesystem for the runtime.</p>
|
||||
<p>Default: False</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="dracut arguments">
|
||||
</section>
|
||||
<section id="dracut arguments">
|
||||
<h3>dracut arguments<a class="headerlink" href="#dracut arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="option-list">
|
||||
<dt><kbd>--dracut-arg</kbd></dt>
|
||||
<dd><p>Argument to pass to dracut when rebuilding the initramfs. Pass this once for each argument. NOTE: this overrides the default. (default: )</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="quickstart">
|
||||
</section>
|
||||
</section>
|
||||
<section id="quickstart">
|
||||
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Run this as root to create a boot.iso in <code class="docutils literal notranslate"><span class="pre">./results/</span></code>:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">dnf</span> <span class="n">install</span> <span class="n">lorax</span>
|
||||
|
|
@ -394,14 +411,14 @@ repositories.</p>
|
|||
override the ones in the distribution repositories.</p>
|
||||
<p>Under <code class="docutils literal notranslate"><span class="pre">./results/</span></code> will be the release tree files: .discinfo, .treeinfo, everything that
|
||||
goes onto the boot.iso, the pxeboot directory, and the boot.iso under <code class="docutils literal notranslate"><span class="pre">./images/</span></code>.</p>
|
||||
</div>
|
||||
<div class="section" id="branding">
|
||||
</section>
|
||||
<section id="branding">
|
||||
<h2>Branding<a class="headerlink" href="#branding" title="Permalink to this headline">¶</a></h2>
|
||||
<p>By default lorax will search for the first package that provides <code class="docutils literal notranslate"><span class="pre">system-release</span></code>
|
||||
that doesn’t start with <code class="docutils literal notranslate"><span class="pre">generic-</span></code> and will install it. It then selects a
|
||||
corresponding logo package by using the first part of the system-release package and
|
||||
appending <code class="docutils literal notranslate"><span class="pre">-logos</span></code> to it. eg. fedora-release and fedora-logos.</p>
|
||||
<div class="section" id="custom-branding">
|
||||
<section id="custom-branding">
|
||||
<h3>Custom Branding<a class="headerlink" href="#custom-branding" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If <code class="docutils literal notranslate"><span class="pre">--skip-branding</span></code> is passed to lorax it will skip selecting the
|
||||
<code class="docutils literal notranslate"><span class="pre">system-release</span></code>, and logos packages and leave it up to the user to pass any
|
||||
|
|
@ -412,16 +429,16 @@ and <code class="docutils literal notranslate"><span class="pre">fedora-logos</s
|
|||
<p>Note that this does not prevent something else in the dependency tree from
|
||||
causing these packages to be included. Using <code class="docutils literal notranslate"><span class="pre">--excludepkgs</span></code> may help if they
|
||||
are unexpectedly included.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="running-inside-of-mock">
|
||||
</section>
|
||||
</section>
|
||||
<section id="running-inside-of-mock">
|
||||
<h2>Running inside of mock<a class="headerlink" href="#running-inside-of-mock" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you are using lorax with mock v1.3.4 or later you will need to pass
|
||||
<code class="docutils literal notranslate"><span class="pre">--old-chroot</span></code> to mock. Mock now defaults to using systemd-nspawn which cannot
|
||||
create the needed loop device nodes. Passing <code class="docutils literal notranslate"><span class="pre">--old-chroot</span></code> will use the old
|
||||
system where <code class="docutils literal notranslate"><span class="pre">/dev/loop*</span></code> is setup for you.</p>
|
||||
</div>
|
||||
<div class="section" id="how-it-works">
|
||||
</section>
|
||||
<section id="how-it-works">
|
||||
<h2>How it works<a class="headerlink" href="#how-it-works" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Lorax uses <a class="reference external" href="https://github.com/rpm-software-management/dnf">dnf</a> to install
|
||||
packages into a temporary directory, sets up configuration files, it then
|
||||
|
|
@ -435,14 +452,14 @@ supports <code class="docutils literal notranslate"><span class="pre">%if/%endif
|
|||
<span class="pre">%></span></code> tags and variable substitution with <code class="docutils literal notranslate"><span class="pre">${}</span></code>. The default templates are
|
||||
shipped with lorax in <code class="docutils literal notranslate"><span class="pre">/usr/share/lorax/templates.d/99-generic/</span></code> and use the
|
||||
<code class="docutils literal notranslate"><span class="pre">.tmpl</span></code> extension.</p>
|
||||
<div class="section" id="runtime-install-tmpl">
|
||||
<section id="runtime-install-tmpl">
|
||||
<h3>runtime-install.tmpl<a class="headerlink" href="#runtime-install-tmpl" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">runtime-install.tmpl</span></code> template lists packages to be installed using the
|
||||
<code class="docutils literal notranslate"><span class="pre">installpkg</span></code> command. This template is fairly simple, installing common packages and
|
||||
architecture specific packages. It must end with the <code class="docutils literal notranslate"><span class="pre">run_pkg_transaction</span></code>
|
||||
command which tells dnf to download and install the packages.</p>
|
||||
</div>
|
||||
<div class="section" id="runtime-postinstall-tmpl">
|
||||
</section>
|
||||
<section id="runtime-postinstall-tmpl">
|
||||
<h3>runtime-postinstall.tmpl<a class="headerlink" href="#runtime-postinstall-tmpl" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">runtime-postinstall.tmpl</span></code> template is where the system configuration
|
||||
happens. The installer environment is similar to a normal running system, but
|
||||
|
|
@ -462,8 +479,8 @@ installation. A number of template commands are used here:</p>
|
|||
<li><p><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.symlink" title="pylorax.ltmpl.LoraxTemplateRunner.symlink"><code class="xref py py-func docutils literal notranslate"><span class="pre">symlink</span></code></a> creates a symlink</p></li>
|
||||
<li><p><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.systemctl" title="pylorax.ltmpl.LoraxTemplateRunner.systemctl"><code class="xref py py-func docutils literal notranslate"><span class="pre">systemctl</span></code></a> runs systemctl in the installroot</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="runtime-cleanup-tmpl">
|
||||
</section>
|
||||
<section id="runtime-cleanup-tmpl">
|
||||
<h3>runtime-cleanup.tmpl<a class="headerlink" href="#runtime-cleanup-tmpl" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">runtime-cleanup.tmpl</span></code> template is used to remove files that aren’t strictly needed
|
||||
by the installation environment. In addition to the <code class="docutils literal notranslate"><span class="pre">remove</span></code> template command it uses:</p>
|
||||
|
|
@ -477,15 +494,15 @@ remove everything except a select few.</p></li>
|
|||
<li><p><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.removekmod" title="pylorax.ltmpl.LoraxTemplateRunner.removekmod"><code class="xref py py-func docutils literal notranslate"><span class="pre">removekmod</span></code></a>
|
||||
Removes kernel modules</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="the-squashfs-filesystem">
|
||||
</section>
|
||||
<section id="the-squashfs-filesystem">
|
||||
<h3>The squashfs filesystem<a class="headerlink" href="#the-squashfs-filesystem" title="Permalink to this headline">¶</a></h3>
|
||||
<p>After <code class="docutils literal notranslate"><span class="pre">runtime-*.tmpl</span></code> templates have finished their work lorax creates an
|
||||
empty ext4 filesystem, copies the remaining files to it, and makes a squashfs
|
||||
filesystem of it. This file is the / of the boot.iso’s installer environment
|
||||
and is what is in the LiveOS/squashfs.img file on the iso.</p>
|
||||
</div>
|
||||
<div class="section" id="iso-creation">
|
||||
</section>
|
||||
<section id="iso-creation">
|
||||
<h3>iso creation<a class="headerlink" href="#iso-creation" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The iso creation is handled by another set of templates. The one used depends
|
||||
on the architecture that the iso is being created for. They are also stored in
|
||||
|
|
@ -495,9 +512,9 @@ configuration template files, configuration variable substitution, treeinfo
|
|||
metadata (via the <a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.treeinfo" title="pylorax.ltmpl.LoraxTemplateRunner.treeinfo"><code class="xref py py-func docutils literal notranslate"><span class="pre">treeinfo</span></code></a>
|
||||
template command). Kernel and initrd are copied from the installroot to their
|
||||
final locations and then mkisofs is run to create the boot.iso</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="custom-templates">
|
||||
</section>
|
||||
</section>
|
||||
<section id="custom-templates">
|
||||
<h2>Custom Templates<a class="headerlink" href="#custom-templates" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The default set of templates and configuration files from the lorax-generic-templates package
|
||||
are shipped in the <code class="docutils literal notranslate"><span class="pre">/usr/share/lorax/templates.d/99-generic/</span></code> directory. You can
|
||||
|
|
@ -505,37 +522,37 @@ make a copy of them and place them into another directory under <code class="doc
|
|||
and they will be used instead if their sort order is below all other directories. This
|
||||
allows multiple packages to ship lorax templates without conflict. You can (and probably
|
||||
should) select the specific template directory by passing <code class="docutils literal notranslate"><span class="pre">--sharedir</span></code> to lorax.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="livemedia-creator.html" class="btn btn-neutral float-right" title="livemedia-creator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="intro.html" class="btn btn-neutral float-left" title="Introduction to Lorax" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
<a href="livemedia-creator.html" class="btn btn-neutral float-right" title="livemedia-creator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="intro.html" class="btn btn-neutral float-left" title="Introduction to Lorax" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -544,7 +561,6 @@ should) select the specific template directory by passing <code class="docutils
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
|
|
@ -0,0 +1,366 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>mkksiso — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="lorax-composer" href="lorax-composer.html" />
|
||||
<link rel="prev" title="livemedia-creator" href="livemedia-creator.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Lorax
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="version">
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Lorax</a></li>
|
||||
<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 current"><a class="current reference internal" href="#">mkksiso</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#mkksiso-cmdline-arguments">mkksiso cmdline arguments</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#optional-arguments">Optional arguments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#positional-arguments">Positional arguments</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#create-a-kickstart-boot-iso-or-dvd">Create a kickstart boot.iso or DVD</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#adding-package-repos-to-a-boot-iso">Adding package repos to a boot.iso</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#create-a-liveimg-boot-iso">Create a liveimg boot.iso</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#how-it-works">How it works</a></li>
|
||||
</ul>
|
||||
</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="product-images.html">Product and Updates Images</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="modules.html">pylorax</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">Lorax</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>mkksiso</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/mkksiso.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="mkksiso">
|
||||
<h1>mkksiso<a class="headerlink" href="#mkksiso" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Authors</dt>
|
||||
<dd class="field-odd"><p>Brian C. Lane <<a class="reference external" href="mailto:bcl%40redhat.com">bcl<span>@</span>redhat<span>.</span>com</a>></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">mkksiso</span></code> is a tool for creating kickstart boot isos. In it’s simplest form
|
||||
you can add a kickstart to a boot.iso and the kickstart will be executed when
|
||||
the iso is booted. If the original iso was created with EFI and Mac support the
|
||||
kickstart boot.iso will include this support as well.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">mkksiso</span></code> needs to be run as root, it depends on mounting the original iso
|
||||
and you need to be root to be able to do that.</p>
|
||||
<section id="mkksiso-cmdline-arguments">
|
||||
<h2>mkksiso cmdline arguments<a class="headerlink" href="#mkksiso-cmdline-arguments" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Add a kickstart and files to an iso</p>
|
||||
<blockquote>
|
||||
<div><p><code class="docutils literal notranslate"><span class="pre">usage:</span> <span class="pre">mkksiso</span> <span class="pre">[-h]</span> <span class="pre">[-a</span> <span class="pre">ADD_PATHS]</span> <span class="pre">[-c</span> <span class="pre">CMDLINE]</span> <span class="pre">[--debug]</span> <span class="pre">ks</span> <span class="pre">input_iso</span> <span class="pre">output_iso</span></code></p>
|
||||
</div></blockquote>
|
||||
<section id="optional-arguments">
|
||||
<h3>Optional arguments<a class="headerlink" href="#optional-arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="option-list">
|
||||
<dt><kbd><span class="option">-h</span>, <span class="option">--help</span></kbd></dt>
|
||||
<dd><p>show this help message and exit</p>
|
||||
</dd>
|
||||
<dt><kbd><span class="option">-a <var>ADD_PATHS</var></span>, <span class="option">--add <var>ADD_PATHS</var></span></kbd></dt>
|
||||
<dd><p>File or directory to add to ISO (may be used multiple
|
||||
times)</p>
|
||||
</dd>
|
||||
<dt><kbd><span class="option">-c <var>CMDLINE</var></span>, <span class="option">--cmdline <var>CMDLINE</var></span></kbd></dt>
|
||||
<dd><p>Arguments to add to kernel cmdline</p>
|
||||
</dd>
|
||||
<dt><kbd><span class="option">--debug</span></kbd></dt>
|
||||
<dd><p>print debugging info</p>
|
||||
</dd>
|
||||
<dt><kbd><span class="option">-V <var>VOLID</var></span>, <span class="option">--volid <var>VOLID</var></span></kbd></dt>
|
||||
<dd><p>Set the ISO volume id, defaults to input’s</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
<section id="positional-arguments">
|
||||
<h3>Positional arguments<a class="headerlink" href="#positional-arguments" title="Permalink to this headline">¶</a></h3>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dt class="field-odd">ks</dt>
|
||||
<dd class="field-odd"><p>Kickstart to add to the ISO</p>
|
||||
</dd>
|
||||
<dt class="field-even">input_iso</dt>
|
||||
<dd class="field-even"><p>ISO to modify</p>
|
||||
</dd>
|
||||
<dt class="field-odd">output_iso</dt>
|
||||
<dd class="field-odd"><p>Full pathname of iso to be created</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</section>
|
||||
</section>
|
||||
<section id="create-a-kickstart-boot-iso-or-dvd">
|
||||
<h2>Create a kickstart boot.iso or DVD<a class="headerlink" href="#create-a-kickstart-boot-iso-or-dvd" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Create a kickstart like you normally would, kickstart documentation can be
|
||||
<a class="reference external" href="https://pykickstart.readthedocs.io/en/latest/">found here</a>, including the
|
||||
<code class="docutils literal notranslate"><span class="pre">url</span></code> and <code class="docutils literal notranslate"><span class="pre">repo</span></code> commands. If you are creating a DVD and only need the
|
||||
content on the DVD you can use the <code class="docutils literal notranslate"><span class="pre">cdrom</span></code> command to install without a
|
||||
network connection. Then run <code class="docutils literal notranslate"><span class="pre">mkksiso</span></code> like this:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkksiso</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">KICKSTART</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">ISO</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">NEW</span><span class="o">-</span><span class="n">ISO</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>This will create a new iso with the kickstart in the root directory, and the
|
||||
kernel cmdline will have <code class="docutils literal notranslate"><span class="pre">inst.ks=...</span></code> added to it so that it will be
|
||||
executed when the iso is booted (be careful not to boot on a system you don’t
|
||||
want to wipe out! There will be no prompting).</p>
|
||||
<p>By default the volume id of the iso is preserved. You can set a custom volid
|
||||
by passing <code class="docutils literal notranslate"><span class="pre">-V</span></code> and the string to set. The kernel cmdline will be changes, and the iso will have th custom volume id.
|
||||
eg.:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkksiso</span> <span class="o">-</span><span class="n">V</span> <span class="s2">"Test Only"</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">KICKSTART</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">ISO</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">NEW</span><span class="o">-</span><span class="n">ISO</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="adding-package-repos-to-a-boot-iso">
|
||||
<h2>Adding package repos to a boot.iso<a class="headerlink" href="#adding-package-repos-to-a-boot-iso" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can add repo directories to the iso using <code class="docutils literal notranslate"><span class="pre">--add</span> <span class="pre">/PATH/TO/REPO/</span></code>, make
|
||||
sure it contains the <code class="docutils literal notranslate"><span class="pre">repodata</span></code> directory by running <code class="docutils literal notranslate"><span class="pre">createrepo_c</span></code> on it
|
||||
first. In the kickstart you can refer to the directories (and files) on the iso
|
||||
using <code class="docutils literal notranslate"><span class="pre">file:///run/install/repo/DIRECTORY/</span></code>. You can then use these repos in
|
||||
the kickstart like this:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">repo</span> <span class="o">--</span><span class="n">name</span><span class="o">=</span><span class="n">extra</span><span class="o">-</span><span class="n">repo</span> <span class="o">--</span><span class="n">baseurl</span><span class="o">=</span><span class="n">file</span><span class="p">:</span><span class="o">///</span><span class="n">run</span><span class="o">/</span><span class="n">install</span><span class="o">/</span><span class="n">repo</span><span class="o">/</span><span class="n">extra</span><span class="o">-</span><span class="n">repo</span><span class="o">/</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Run <code class="docutils literal notranslate"><span class="pre">mkksiso</span></code> like so:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkksiso</span> <span class="o">--</span><span class="n">add</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">REPO</span><span class="o">/</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">KICKSTART</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">ISO</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">NEW</span><span class="o">-</span><span class="n">ISO</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="create-a-liveimg-boot-iso">
|
||||
<h2>Create a liveimg boot.iso<a class="headerlink" href="#create-a-liveimg-boot-iso" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can use the kickstart <a class="reference external" href="https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html#liveimg">liveimg command</a>,
|
||||
to install a pre-generated disk image or tar to the system the iso is booting
|
||||
on.</p>
|
||||
<p>Create a disk image or tar with <code class="docutils literal notranslate"><span class="pre">osbuild-composer</span></code> or <code class="docutils literal notranslate"><span class="pre">livemedia-creator</span></code>,
|
||||
make sure the image includes tools expected by <code class="docutils literal notranslate"><span class="pre">anaconda</span></code>, as well as the
|
||||
kernel and bootloader support. In <code class="docutils literal notranslate"><span class="pre">osbuild-composer</span></code> use the <code class="docutils literal notranslate"><span class="pre">tar</span></code> image
|
||||
type and make sure to include the <code class="docutils literal notranslate"><span class="pre">kernel</span></code>, <code class="docutils literal notranslate"><span class="pre">grub2</span></code>, and <code class="docutils literal notranslate"><span class="pre">grub2-tools</span></code>
|
||||
packages. If you plan to install it to a UEFI machine make sure to include
|
||||
<code class="docutils literal notranslate"><span class="pre">grub2-efi</span></code> and <code class="docutils literal notranslate"><span class="pre">efibootmgr</span></code> in the blueprint.</p>
|
||||
<p>Add the <code class="docutils literal notranslate"><span class="pre">root.tar.xz</span></code> file to the iso using <code class="docutils literal notranslate"><span class="pre">--add</span> <span class="pre">/PATH/TO/ROOT.TAR.XZ</span></code>,
|
||||
and in the kickstart reference it with the <code class="docutils literal notranslate"><span class="pre">liveimg</span></code> command like this:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">liveimg</span> <span class="o">--</span><span class="n">url</span><span class="o">=</span><span class="n">file</span><span class="p">:</span><span class="o">///</span><span class="n">run</span><span class="o">/</span><span class="n">install</span><span class="o">/</span><span class="n">repo</span><span class="o">/</span><span class="n">root</span><span class="o">.</span><span class="n">tar</span><span class="o">.</span><span class="n">xz</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>It is also a good idea to use the <code class="docutils literal notranslate"><span class="pre">--checksum</span></code> argument to <code class="docutils literal notranslate"><span class="pre">liveimg</span></code> to be
|
||||
sure the file hasn’t been corrupted:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkksiso</span> <span class="o">--</span><span class="n">add</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">root</span><span class="o">.</span><span class="n">tar</span><span class="o">.</span><span class="n">xz</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">KICKSTART</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">ISO</span> <span class="o">/</span><span class="n">PATH</span><span class="o">/</span><span class="n">TO</span><span class="o">/</span><span class="n">NEW</span><span class="o">-</span><span class="n">ISO</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>When this iso is booted it will execute the kickstart and install the liveimg
|
||||
contents to the system without any prompting.</p>
|
||||
</section>
|
||||
<section id="how-it-works">
|
||||
<h2>How it works<a class="headerlink" href="#how-it-works" title="Permalink to this headline">¶</a></h2>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">mkksiso</span></code> first examines the system to make sure the tools it needs are installed,
|
||||
it will work with <code class="docutils literal notranslate"><span class="pre">xorrisofs</span></code> or <code class="docutils literal notranslate"><span class="pre">mkisofs</span></code> installed. It mounts the source iso,
|
||||
and copies the directories that need to be modified to a temporary directory.</p>
|
||||
<p>It then modifies the boot configuration files to include the <code class="docutils literal notranslate"><span class="pre">inst.ks</span></code> command,
|
||||
and checks to see if the original iso supports EFI. If it does it regenerates the
|
||||
EFI boot images with the new configuration, and then runs the available iso creation
|
||||
tool to add the new files and directories to the new iso. If the architecture is
|
||||
<code class="docutils literal notranslate"><span class="pre">x86_64</span></code> it will also make sure the iso can be booted as an iso or from a USB
|
||||
stick (hybridiso).</p>
|
||||
<p>The last step is to update the iso checksums so that booting with test enabled
|
||||
will pass.</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="lorax-composer.html" class="btn btn-neutral float-right" title="lorax-composer" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="livemedia-creator.html" class="btn btn-neutral float-left" title="livemedia-creator" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,38 +1,45 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>pylorax — Lorax 28.14.42 documentation</title>
|
||||
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>pylorax — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="pylorax package" href="pylorax.html" />
|
||||
|
|
@ -60,7 +67,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -77,6 +84,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -89,6 +97,7 @@
|
|||
<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="mkksiso.html">mkksiso</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="product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -101,6 +110,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -135,18 +145,20 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>pylorax</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="_sources/modules.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
|
|
@ -160,7 +172,7 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="pylorax">
|
||||
<section id="pylorax">
|
||||
<h1>pylorax<a class="headerlink" href="#pylorax" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
|
|
@ -208,36 +220,36 @@
|
|||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="pylorax.html" class="btn btn-neutral float-right" title="pylorax package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="product-images.html" class="btn btn-neutral float-left" title="Product and Updates Images" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
<a href="pylorax.html" class="btn btn-neutral float-right" title="pylorax package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="product-images.html" class="btn btn-neutral float-left" title="Product and Updates Images" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -246,7 +258,6 @@
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -1,38 +1,45 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Product and Updates Images — Lorax 28.14.42 documentation</title>
|
||||
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>Product and Updates Images — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="pylorax" href="modules.html" />
|
||||
|
|
@ -60,7 +67,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -77,6 +84,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -89,6 +97,7 @@
|
|||
<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="mkksiso.html">mkksiso</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 current"><a class="current reference internal" href="#">Product and Updates Images</a></li>
|
||||
|
|
@ -98,6 +107,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -132,18 +142,20 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>Product and Updates Images</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
<a href="_sources/product-images.rst.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
|
|
@ -157,7 +169,7 @@
|
|||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<div class="section" id="product-and-updates-images">
|
||||
<section id="product-and-updates-images">
|
||||
<h1>Product and Updates Images<a class="headerlink" href="#product-and-updates-images" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Lorax now supports creation of product.img and updates.img as part of the build
|
||||
process. This is implemented using the installimg template command which will
|
||||
|
|
@ -179,36 +191,36 @@ you would put your custom class here:</p>
|
|||
<p>If the packages containing the product/updates files are not included as part
|
||||
of normal dependencies you can add specific packages with the <code class="docutils literal notranslate"><span class="pre">--installpkgs</span></code>
|
||||
command or the installpkgs paramater of <a class="reference internal" href="pylorax.html#pylorax.treebuilder.RuntimeBuilder" title="pylorax.treebuilder.RuntimeBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">pylorax.treebuilder.RuntimeBuilder</span></code></a></p>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
|
||||
<a href="modules.html" class="btn btn-neutral float-right" title="pylorax" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||||
|
||||
|
||||
<a href="composer-cli.html" class="btn btn-neutral float-left" title="composer-cli" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||||
|
||||
<a href="modules.html" class="btn btn-neutral float-right" title="pylorax" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="composer-cli.html" class="btn btn-neutral float-left" title="composer-cli" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
</div>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -217,7 +229,6 @@ command or the installpkgs paramater of <a class="reference internal" href="pylo
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
|
|
@ -1,38 +1,44 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<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.0" />
|
||||
|
||||
<title>Python Module Index — Lorax 28.14.42 documentation</title>
|
||||
<title>Python Module Index — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
|
|
@ -61,7 +67,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -78,6 +84,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -90,6 +97,7 @@
|
|||
<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="mkksiso.html">mkksiso</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="product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -99,6 +107,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -133,11 +142,13 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>Python Module Index</li>
|
||||
|
||||
|
|
@ -323,20 +334,25 @@
|
|||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -345,7 +361,6 @@
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -1,40 +1,47 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<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.0" />
|
||||
|
||||
<title>Search — Lorax 28.14.59 documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
|
||||
|
||||
<title>Search — Lorax 28.14.42 documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="#" />
|
||||
</head>
|
||||
|
|
@ -60,7 +67,7 @@
|
|||
|
||||
|
||||
<div class="version">
|
||||
28.14.42
|
||||
28.14.59
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -77,6 +84,7 @@
|
|||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
|
@ -89,6 +97,7 @@
|
|||
<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="mkksiso.html">mkksiso</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="product-images.html">Product and Updates Images</a></li>
|
||||
|
|
@ -98,6 +107,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
|
@ -132,19 +142,19 @@
|
|||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li>Search</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
|
@ -158,8 +168,7 @@
|
|||
<noscript>
|
||||
<div id="fallback" class="admonition warning">
|
||||
<p class="last">
|
||||
Please activate JavaScript to enable the search
|
||||
functionality.
|
||||
Please activate JavaScript to enable the search functionality.
|
||||
</p>
|
||||
</div>
|
||||
</noscript>
|
||||
|
|
@ -173,20 +182,25 @@
|
|||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2018-2019, Red Hat, Inc.
|
||||
© Copyright 2018-2019, Red Hat, Inc..
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -195,7 +209,6 @@
|
|||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -14,6 +14,7 @@ Contents:
|
|||
intro
|
||||
lorax
|
||||
livemedia-creator
|
||||
mkksiso
|
||||
lorax-composer
|
||||
composer-cli
|
||||
product-images
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -1,8 +1,5 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "COMPOSER-CLI" "1" "Apr 27, 2020" "28.14.42" "Lorax"
|
||||
.SH NAME
|
||||
composer-cli \- Composer Cmdline Utility Documentation
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
|
|
@ -30,18 +27,191 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "COMPOSER-CLI" "1" "Jun 29, 2021" "28.14.59" "Lorax"
|
||||
.SH NAME
|
||||
composer-cli \- Composer Cmdline Utility Documentation
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B Authors
|
||||
Brian C. Lane <\fI\%bcl@redhat.com\fP>
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBcomposer\-cli\fP is used to interact with the \fBlorax\-composer\fP API server, managing blueprints, exploring available packages, and building new images.
|
||||
\fBcomposer\-cli\fP is an interactive tool for use with a WELDR API server,
|
||||
managing blueprints, exploring available packages, and building new images.
|
||||
\fIlorax\-composer <lorax\-composer.html>\fP and \fIosbuild\-composer
|
||||
<https://osbuild.org>\fP both implement compatible servers.
|
||||
.sp
|
||||
It requires \fI\%lorax\-composer\fP to be installed on the
|
||||
local system, and the user running it needs to be a member of the \fBweldr\fP
|
||||
group. They do not need to be root, but all of the \fI\%security precautions\fP apply.
|
||||
It requires server to be installed on the local system, and the user running it
|
||||
needs to be a member of the \fBweldr\fP group. They do not need to be root, but
|
||||
all of the \fI\%security precautions\fP apply.
|
||||
.SH COMPOSER-CLI CMDLINE ARGUMENTS
|
||||
.sp
|
||||
Lorax Composer commandline tool
|
||||
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
usage: composer\-cli [\-h] [\-j] [\-s SOCKET] [\-\-log LOG] [\-a APIVER]
|
||||
[\-\-test TESTMODE] [\-V]
|
||||
...
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS Positional Arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B args
|
||||
.UNINDENT
|
||||
.SS Named Arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-j, \-\-json
|
||||
Output the raw JSON response instead of the normal output.
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B \-s, \-\-socket
|
||||
Path to the socket file to listen on
|
||||
.sp
|
||||
Default: "/run/weldr/api.socket"
|
||||
.TP
|
||||
.B \-\-log
|
||||
Path to logfile (./composer\-cli.log)
|
||||
.TP
|
||||
.B \-a, \-\-api
|
||||
API Version to use (overrides server API version)
|
||||
.TP
|
||||
.B \-\-test
|
||||
Pass test mode to compose. 1=Mock compose with fail. 2=Mock compose with finished.
|
||||
.sp
|
||||
Default: 0
|
||||
.TP
|
||||
.B \-V
|
||||
show program\(aqs version number and exit
|
||||
.sp
|
||||
Default: False
|
||||
.UNINDENT
|
||||
.sp
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B compose start [\-\-size XXXX] <BLUEPRINT> <TYPE> [<IMAGE\-NAME> <PROVIDER> <PROFILE> | <IMAGE\-NAME> <PROFILE.TOML>]
|
||||
Start a compose using the selected blueprint and output type. \-\-size is in MiB.
|
||||
NOTE: uploading and \-\-size are only supported by osbuild\-composer.
|
||||
.TP
|
||||
.B compose start\-ostree [\-\-size XXXX] [\-\-parent PARENT] [\-\-ref REF] [\-\-url url] <BLUEPRINT> <TYPE> [<IMAGE\-NAME> <PROFILE.TOML>]
|
||||
Start an ostree compose using the selected blueprint and output type. Optionally start an upload. This command
|
||||
is only supported by osbuild\-composer. \-\-size is in MiB.
|
||||
.TP
|
||||
.B compose types
|
||||
List the supported output types.
|
||||
.TP
|
||||
.B compose status
|
||||
List the status of all running and finished composes.
|
||||
.TP
|
||||
.B compose list [waiting|running|finished|failed]
|
||||
List basic information about composes.
|
||||
.TP
|
||||
.B compose log <UUID> [<SIZE>]
|
||||
Show the last SIZE kB of the compose log.
|
||||
.TP
|
||||
.B compose cancel <UUID>
|
||||
Cancel a running compose and delete any intermediate results.
|
||||
.TP
|
||||
.B compose delete <UUID,...>
|
||||
Delete the listed compose results.
|
||||
.TP
|
||||
.B compose info <UUID>
|
||||
Show detailed information on the compose.
|
||||
.TP
|
||||
.B compose metadata <UUID>
|
||||
Download the metadata use to create the compose to <uuid>\-metadata.tar
|
||||
.TP
|
||||
.B compose logs <UUID>
|
||||
Download the compose logs to <uuid>\-logs.tar
|
||||
.TP
|
||||
.B compose results <UUID>
|
||||
Download all of the compose results; metadata, logs, and image to <uuid>.tar
|
||||
.TP
|
||||
.B compose image <UUID>
|
||||
Download the output image from the compose. Filename depends on the type.
|
||||
.TP
|
||||
.B blueprints list
|
||||
List the names of the available blueprints.
|
||||
.TP
|
||||
.B blueprints show <BLUEPRINT,...>
|
||||
Display the blueprint in TOML format.
|
||||
.TP
|
||||
.B blueprints changes <BLUEPRINT,...>
|
||||
Display the changes for each blueprint.
|
||||
.TP
|
||||
.B blueprints diff <BLUEPRINT> <FROM\-COMMIT> <TO\-COMMIT>
|
||||
Display the differences between 2 versions of a blueprint.
|
||||
FROM\-COMMIT can be a commit hash or NEWEST
|
||||
TO\-COMMIT can be a commit hash, NEWEST, or WORKSPACE
|
||||
.TP
|
||||
.B blueprints save <BLUEPRINT,...>
|
||||
Save the blueprint to a file, <BLUEPRINT>.toml
|
||||
.TP
|
||||
.B blueprints delete <BLUEPRINT>
|
||||
Delete a blueprint from the server
|
||||
.TP
|
||||
.B blueprints depsolve <BLUEPRINT,...>
|
||||
Display the packages needed to install the blueprint.
|
||||
.TP
|
||||
.B blueprints push <BLUEPRINT>
|
||||
Push a blueprint TOML file to the server.
|
||||
.TP
|
||||
.B blueprints freeze <BLUEPRINT,...>
|
||||
Display the frozen blueprint\(aqs modules and packages.
|
||||
.TP
|
||||
.B blueprints freeze show <BLUEPRINT,...>
|
||||
Display the frozen blueprint in TOML format.
|
||||
.TP
|
||||
.B blueprints freeze save <BLUEPRINT,...>
|
||||
Save the frozen blueprint to a file, <blueprint\-name>.frozen.toml.
|
||||
.TP
|
||||
.B blueprints tag <BLUEPRINT>
|
||||
Tag the most recent blueprint commit as a release.
|
||||
.TP
|
||||
.B blueprints undo <BLUEPRINT> <COMMIT>
|
||||
Undo changes to a blueprint by reverting to the selected commit.
|
||||
.TP
|
||||
.B blueprints workspace <BLUEPRINT>
|
||||
Push the blueprint TOML to the temporary workspace storage.
|
||||
.TP
|
||||
.B modules list
|
||||
List the available modules.
|
||||
.TP
|
||||
.B projects list
|
||||
List the available projects.
|
||||
.TP
|
||||
.B projects info <PROJECT,...>
|
||||
Show details about the listed projects.
|
||||
.TP
|
||||
.B sources list
|
||||
List the available sources
|
||||
.TP
|
||||
.B sources info <SOURCE\-NAME,...>
|
||||
Details about the source.
|
||||
.TP
|
||||
.B sources add <SOURCE.TOML>
|
||||
Add a package source to the server.
|
||||
.TP
|
||||
.B sources change <SOURCE.TOML>
|
||||
Change an existing source
|
||||
.TP
|
||||
.B sources delete <SOURCE\-NAME>
|
||||
Delete a package source.
|
||||
.UNINDENT
|
||||
.sp
|
||||
status show Show API server status.
|
||||
.sp
|
||||
NOTE: uploading is only available as part of the compose command
|
||||
using the osbuild\-composer API server.
|
||||
|
||||
.SH EDIT A BLUEPRINT
|
||||
.sp
|
||||
Start out by listing the available blueprints using \fBcomposer\-cli blueprints
|
||||
|
|
@ -53,6 +223,8 @@ Edit the file (it will be saved with a .toml extension) and change the
|
|||
description, add a package or module to it. Send it back to the server by
|
||||
running \fBcomposer\-cli blueprints push http\-server.toml\fP\&. You can verify that it was
|
||||
saved by viewing the changelog \- \fBcomposer\-cli blueprints changes http\-server\fP\&.
|
||||
.sp
|
||||
The full blueprint documentation \fI\%is here\fP\&.
|
||||
.SH BUILD AN IMAGE
|
||||
.sp
|
||||
Build a \fBqcow2\fP disk image from this blueprint by running \fBcomposer\-cli
|
||||
|
|
@ -84,6 +256,88 @@ qemu\-kvm \-\-name test\-image \-m 1024 \-hda ./UUID\-disk.qcow2
|
|||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH IMAGE UPLOADS
|
||||
.sp
|
||||
\fBcomposer\-cli\fP can upload the images to a number of services, including AWS,
|
||||
OpenStack, and vSphere. The upload can be started when the build is finished
|
||||
by using \fBcomposer\-cli compose start ...\fP\&. In order to access the service you need
|
||||
to pass authentication details to composer\-cli using a TOML file.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
This is only supported when running the \fBosbuild\-composer\fP API server.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH PROVIDERS
|
||||
.sp
|
||||
Providers are where the images are uploaded to. You
|
||||
will need to gather some provider
|
||||
specific information in order to authenticate with it. Please refer to the \fBosbuild\-composer\fP
|
||||
documentation for the provider specific fields. You will then create a TOML file with the
|
||||
name of the provider and the settings, like this:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
provider = "aws"
|
||||
|
||||
[settings]
|
||||
aws_access_key = "AWS Access Key"
|
||||
aws_bucket = "AWS Bucket"
|
||||
aws_region = "AWS Region"
|
||||
aws_secret_key = "AWS Secret Key"
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Save this into an \fBaws\-credentials.toml\fP file and use it when running \fBstart\fP\&.
|
||||
.SS AWS
|
||||
.sp
|
||||
The access key and secret key can be created by going to the
|
||||
\fBIAM\->Users\->Security Credentials\fP section and creating a new access key. The
|
||||
secret key will only be shown when it is first created so make sure to record
|
||||
it in a secure place. The region should be the region that you want to use the
|
||||
AMI in, and the bucket can be an existing bucket, or a new one, following the
|
||||
normal AWS bucket naming rules. It will be created if it doesn\(aqt already exist.
|
||||
.sp
|
||||
When uploading the image it is first uploaded to the s3 bucket, and then
|
||||
converted to an AMI. If the conversion is successful the s3 object will be
|
||||
deleted. If it fails, re\-trying after correcting the problem will re\-use the
|
||||
object if you have not deleted it in the meantime, speeding up the process.
|
||||
.SH BUILD AN IMAGE AND UPLOAD RESULTS
|
||||
.sp
|
||||
With the settings stored in a TOML file:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
composer\-cli compose start example\-http\-server ami "http image" aws\-settings.toml
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
It will return the UUID of the image build. Once
|
||||
the build has finished successfully it will start the upload process.
|
||||
.SH DEBUGGING
|
||||
.sp
|
||||
There are a couple of arguments that can be helpful when debugging problems.
|
||||
These are only meant for debugging and should not be used to script access to
|
||||
the API. If you need to do that you can communicate with it directly in the
|
||||
language of your choice.
|
||||
.sp
|
||||
\fB\-\-json\fP will return the server\(aqs response as a nicely formatted json output
|
||||
instead of printing what the command would usually print.
|
||||
.sp
|
||||
\fB\-\-test=1\fP will cause a compose start to start creating an image, and then
|
||||
end with a failed state.
|
||||
.sp
|
||||
\fB\-\-test=2\fP will cause a compose to start and then end with a finished state,
|
||||
without actually composing anything.
|
||||
.SH AUTHOR
|
||||
Weldr Team
|
||||
.SH COPYRIGHT
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "LIVEMEDIA-CREATOR" "1" "Apr 27, 2020" "28.14.42" "Lorax"
|
||||
.SH NAME
|
||||
livemedia-creator \- Live Media Creator Documentation
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
|
|
@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "LIVEMEDIA-CREATOR" "1" "Jun 29, 2021" "28.14.59" "Lorax"
|
||||
.SH NAME
|
||||
livemedia-creator \- Live Media Creator Documentation
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B Authors
|
||||
|
|
@ -115,209 +115,209 @@ usage: livemedia\-creator [\-h]
|
|||
.SS Named Arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-make\-iso
|
||||
.B \-\-make\-iso
|
||||
Build a live iso
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-disk
|
||||
.B \-\-make\-disk
|
||||
Build a partitioned disk image
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-fsimage
|
||||
.B \-\-make\-fsimage
|
||||
Build a filesystem image
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-appliance
|
||||
.B \-\-make\-appliance
|
||||
Build an appliance image and XML description
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-ami
|
||||
.B \-\-make\-ami
|
||||
Build an ami image
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-tar
|
||||
.B \-\-make\-tar
|
||||
Build a tar of the root filesystem
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-tar\-disk
|
||||
.B \-\-make\-tar\-disk
|
||||
Build a tar of a partitioned disk image
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-pxe\-live
|
||||
.B \-\-make\-pxe\-live
|
||||
Build a live pxe boot squashfs image
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-ostree\-live
|
||||
.B \-\-make\-ostree\-live
|
||||
Build a live pxe boot squashfs image of Atomic Host
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-oci
|
||||
.B \-\-make\-oci
|
||||
Build an Open Container Initiative image
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-make\-vagrant
|
||||
.B \-\-make\-vagrant
|
||||
Build a Vagrant Box image
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-iso
|
||||
.B \-\-iso
|
||||
Anaconda installation .iso path to use for qemu
|
||||
.TP
|
||||
.B\-\-iso\-only
|
||||
.B \-\-iso\-only
|
||||
Remove all iso creation artifacts except the boot.iso, combine with \-\-iso\-name to rename the boot.iso
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-iso\-name
|
||||
.B \-\-iso\-name
|
||||
Name of output iso file for \-\-iso\-only. Default is boot.iso
|
||||
.TP
|
||||
.B\-\-ks
|
||||
.B \-\-ks
|
||||
Kickstart file defining the install.
|
||||
.TP
|
||||
.B\-\-image\-only
|
||||
.B \-\-image\-only
|
||||
Exit after creating fs/disk image.
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-no\-virt
|
||||
.B \-\-no\-virt
|
||||
Run anaconda directly on host instead of using qemu
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-proxy
|
||||
.B \-\-proxy
|
||||
proxy URL to use for the install
|
||||
.TP
|
||||
.B\-\-anaconda\-arg
|
||||
.B \-\-anaconda\-arg
|
||||
Additional argument to pass to anaconda (no\-virt mode). Pass once for each argument
|
||||
.TP
|
||||
.B\-\-armplatform
|
||||
.B \-\-armplatform
|
||||
the platform to use when creating images for ARM, i.e., highbank, mvebu, omap, tegra, etc.
|
||||
.TP
|
||||
.B\-\-location
|
||||
.B \-\-location
|
||||
location of iso directory tree with initrd.img and vmlinuz. Used to run qemu with a newer initrd than the iso.
|
||||
.TP
|
||||
.B\-\-logfile
|
||||
.B \-\-logfile
|
||||
Name and path for primary logfile, other logs will be created in the same directory.
|
||||
.sp
|
||||
Default: ./livemedia.log
|
||||
.TP
|
||||
.B\-\-lorax\-templates
|
||||
.B \-\-lorax\-templates
|
||||
Path to mako templates for lorax
|
||||
.TP
|
||||
.B\-\-tmp
|
||||
.B \-\-tmp
|
||||
Top level temporary directory
|
||||
.sp
|
||||
Default: /var/tmp
|
||||
.TP
|
||||
.B\-\-resultdir
|
||||
.B \-\-resultdir
|
||||
Directory to copy the resulting images and iso into. Defaults to the temporary working directory
|
||||
.TP
|
||||
.B\-\-macboot
|
||||
.B \-\-macboot
|
||||
Make the iso bootable on UEFI based Mac systems
|
||||
.sp
|
||||
Default: True
|
||||
.TP
|
||||
.B\-\-nomacboot
|
||||
.B \-\-nomacboot
|
||||
Do not create a Mac bootable iso
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-extra\-boot\-args
|
||||
.B \-\-extra\-boot\-args
|
||||
Extra arguments to add to the bootloader kernel cmdline in the templates
|
||||
.sp
|
||||
Default: ""
|
||||
.TP
|
||||
.B\-\-title
|
||||
.B \-\-title
|
||||
Substituted for @TITLE@ in bootloader config files
|
||||
.sp
|
||||
Default: "Linux Live Media"
|
||||
.TP
|
||||
.B\-\-project
|
||||
.B \-\-project
|
||||
substituted for @PROJECT@ in bootloader config files
|
||||
.sp
|
||||
Default: "Linux"
|
||||
.TP
|
||||
.B\-\-releasever
|
||||
.B \-\-releasever
|
||||
substituted for @VERSION@ in bootloader config files
|
||||
.sp
|
||||
Default: "8"
|
||||
.TP
|
||||
.B\-\-volid
|
||||
.B \-\-volid
|
||||
volume id
|
||||
.TP
|
||||
.B\-\-squashfs_args
|
||||
.B \-\-squashfs_args
|
||||
additional squashfs args
|
||||
.TP
|
||||
.B\-\-timeout
|
||||
.B \-\-timeout
|
||||
Cancel installer after X minutes
|
||||
.TP
|
||||
.B\-V
|
||||
.B \-V
|
||||
show program\(aqs version number and exit
|
||||
.UNINDENT
|
||||
.SS disk/fs image arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-disk\-image
|
||||
.B \-\-disk\-image
|
||||
Path to existing disk image to use for creating final image.
|
||||
.TP
|
||||
.B\-\-keep\-image
|
||||
.B \-\-keep\-image
|
||||
Keep raw disk image after .iso creation
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-fs\-image
|
||||
.B \-\-fs\-image
|
||||
Path to existing filesystem image to use for creating final image.
|
||||
.TP
|
||||
.B\-\-image\-name
|
||||
.B \-\-image\-name
|
||||
Name of output file to create. Used for tar, fs and disk image. Default is a random name.
|
||||
.TP
|
||||
.B\-\-tar\-disk\-name
|
||||
.B \-\-tar\-disk\-name
|
||||
Name of the archive member for make\-tar\-disk.
|
||||
.TP
|
||||
.B\-\-fs\-label
|
||||
.B \-\-fs\-label
|
||||
Label to set on fsimage, default is \(aqAnaconda\(aq
|
||||
.sp
|
||||
Default: "Anaconda"
|
||||
.TP
|
||||
.B\-\-image\-size\-align
|
||||
.B \-\-image\-size\-align
|
||||
Create a disk image with a size that is a multiple of this value in MiB.
|
||||
.sp
|
||||
Default: 0
|
||||
.TP
|
||||
.B\-\-image\-type
|
||||
.B \-\-image\-type
|
||||
Create an image with qemu\-img. See qemu\-img \-\-help for supported formats.
|
||||
.TP
|
||||
.B\-\-qemu\-arg
|
||||
.B \-\-qemu\-arg
|
||||
Arguments to pass to qemu\-img. Pass once for each argument, they will be used for ALL calls to qemu\-img.
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-qcow2
|
||||
.B \-\-qcow2
|
||||
Create qcow2 image instead of raw sparse image when making disk images.
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-qcow2\-arg
|
||||
.B \-\-qcow2\-arg
|
||||
Arguments to pass to qemu\-img. Pass once for each argument, they will be used for ALL calls to qemu\-img.
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-compression
|
||||
.B \-\-compression
|
||||
Compression binary for make\-tar. xz, lzma, gzip, and bzip2 are supported. xz is the default.
|
||||
.sp
|
||||
Default: "xz"
|
||||
.TP
|
||||
.B\-\-compress\-arg
|
||||
.B \-\-compress\-arg
|
||||
Arguments to pass to compression. Pass once for each argument
|
||||
.sp
|
||||
Default: []
|
||||
|
|
@ -325,13 +325,13 @@ Default: []
|
|||
.SS appliance arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-app\-name
|
||||
.B \-\-app\-name
|
||||
Name of appliance to pass to template
|
||||
.TP
|
||||
.B\-\-app\-template
|
||||
.B \-\-app\-template
|
||||
Path to template to use for appliance data.
|
||||
.TP
|
||||
.B\-\-app\-file
|
||||
.B \-\-app\-file
|
||||
Appliance template results file.
|
||||
.sp
|
||||
Default: "appliance.xml"
|
||||
|
|
@ -339,39 +339,39 @@ Default: "appliance.xml"
|
|||
.SS qemu arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-ram
|
||||
.B \-\-ram
|
||||
Memory to allocate for installer in megabytes.
|
||||
.sp
|
||||
Default: 1024
|
||||
.TP
|
||||
.B\-\-vcpus
|
||||
.B \-\-vcpus
|
||||
Passed to qemu \-smp command
|
||||
.TP
|
||||
.B\-\-vnc
|
||||
.B \-\-vnc
|
||||
Passed to qemu \-display command. eg. vnc=127.0.0.1:5, default is to choose the first unused vnc port.
|
||||
.TP
|
||||
.B\-\-arch
|
||||
.B \-\-arch
|
||||
System arch to build for. Used to select qemu\-system\-* command. Defaults to qemu\-system\-<arch>
|
||||
.TP
|
||||
.B\-\-kernel\-args
|
||||
.B \-\-kernel\-args
|
||||
Additional argument to pass to the installation kernel
|
||||
.TP
|
||||
.B\-\-ovmf\-path
|
||||
.B \-\-ovmf\-path
|
||||
Path to OVMF firmware
|
||||
.sp
|
||||
Default: "/usr/share/edk2/ovmf/"
|
||||
.TP
|
||||
.B\-\-virt\-uefi
|
||||
.B \-\-virt\-uefi
|
||||
Use OVMF firmware to boot the VM in UEFI mode
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-no\-kvm
|
||||
.B \-\-no\-kvm
|
||||
Skip using kvm with qemu even if it is available.
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-with\-rng
|
||||
.B \-\-with\-rng
|
||||
RNG device for QEMU (none for no RNG)
|
||||
.sp
|
||||
Default: "/dev/random"
|
||||
|
|
@ -379,18 +379,18 @@ Default: "/dev/random"
|
|||
.SS dracut arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-dracut\-arg
|
||||
.B \-\-dracut\-arg
|
||||
Argument to pass to dracut when rebuilding the initramfs. Pass this once for each argument. NOTE: this overrides the default. (default: )
|
||||
.UNINDENT
|
||||
.SS pxe to live arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-live\-rootfs\-size
|
||||
.B \-\-live\-rootfs\-size
|
||||
Size of root filesystem of live image in GiB
|
||||
.sp
|
||||
Default: 0
|
||||
.TP
|
||||
.B\-\-live\-rootfs\-keep\-size
|
||||
.B \-\-live\-rootfs\-keep\-size
|
||||
Keep the original size of root filesystem in live image
|
||||
.sp
|
||||
Default: False
|
||||
|
|
@ -398,19 +398,19 @@ Default: False
|
|||
.SS OCI arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-oci\-config
|
||||
.B \-\-oci\-config
|
||||
config.json OCI configuration file
|
||||
.TP
|
||||
.B\-\-oci\-runtime
|
||||
.B \-\-oci\-runtime
|
||||
runtime.json OCI configuration file
|
||||
.UNINDENT
|
||||
.SS Vagrant arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-vagrant\-metadata
|
||||
.B \-\-vagrant\-metadata
|
||||
optional metadata.json file
|
||||
.TP
|
||||
.B\-\-vagrantfile
|
||||
.B \-\-vagrantfile
|
||||
optional vagrantfile
|
||||
.UNINDENT
|
||||
.SH QUICKSTART
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "LORAX-COMPOSER" "1" "Apr 27, 2020" "28.14.42" "Lorax"
|
||||
.SH NAME
|
||||
lorax-composer \- Lorax Composer Documentation
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
|
|
@ -30,13 +27,16 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "LORAX-COMPOSER" "1" "Jun 29, 2021" "28.14.59" "Lorax"
|
||||
.SH NAME
|
||||
lorax-composer \- Lorax Composer Documentation
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B Authors
|
||||
Brian C. Lane <\fI\%bcl@redhat.com\fP>
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBlorax\-composer\fP is an API server that allows you to build disk images using
|
||||
\fBlorax\-composer\fP is a WELDR API server that allows you to build disk images using
|
||||
\fI\%Blueprints\fP to describe the package versions to be installed into the image.
|
||||
It is compatible with the Weldr project\(aqs bdcs\-api REST protocol. More
|
||||
information on Weldr can be found \fI\%on the Weldr blog\fP\&.
|
||||
|
|
@ -44,6 +44,17 @@ information on Weldr can be found \fI\%on the Weldr blog\fP\&.
|
|||
Behind the scenes it uses \fI\%livemedia\-creator\fP and
|
||||
\fI\%Anaconda\fP to handle the
|
||||
installation and configuration of the images.
|
||||
.sp
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBlorax\-composer\fP is now deprecated. It is being replaced by the
|
||||
\fBosbuild\-composer\fP WELDR API server which implements more features (eg.
|
||||
ostree, image uploads, etc.) You can still use \fBcomposer\-cli\fP and
|
||||
\fBcockpit\-composer\fP with \fBosbuild\-composer\fP\&. See the documentation or
|
||||
the \fI\%osbuild website\fP for more information.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH IMPORTANT THINGS TO NOTE
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
|
|
@ -128,62 +139,62 @@ usage: lorax\-composer [\-h] [\-\-socket SOCKET] [\-\-user USER] [\-\-group GROU
|
|||
.SS Positional Arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.BBLUEPRINTS
|
||||
.B BLUEPRINTS
|
||||
Path to the blueprints
|
||||
.UNINDENT
|
||||
.SS Named Arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-socket
|
||||
.B \-\-socket
|
||||
Path to the socket file to listen on
|
||||
.sp
|
||||
Default: "/run/weldr/api.socket"
|
||||
.TP
|
||||
.B\-\-user
|
||||
.B \-\-user
|
||||
User to use for reduced permissions
|
||||
.sp
|
||||
Default: "root"
|
||||
.TP
|
||||
.B\-\-group
|
||||
.B \-\-group
|
||||
Group to set ownership of the socket to
|
||||
.sp
|
||||
Default: "weldr"
|
||||
.TP
|
||||
.B\-\-log
|
||||
.B \-\-log
|
||||
Path to logfile (/var/log/lorax\-composer/composer.log)
|
||||
.sp
|
||||
Default: "/var/log/lorax\-composer/composer.log"
|
||||
.TP
|
||||
.B\-\-mockfiles
|
||||
.B \-\-mockfiles
|
||||
Path to JSON files used for /api/mock/ paths (/var/tmp/bdcs\-mockfiles/)
|
||||
.sp
|
||||
Default: "/var/tmp/bdcs\-mockfiles/"
|
||||
.TP
|
||||
.B\-\-sharedir
|
||||
.B \-\-sharedir
|
||||
Directory containing all the templates. Overrides config file sharedir
|
||||
.TP
|
||||
.B\-V
|
||||
.B \-V
|
||||
show program\(aqs version number and exit
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-c, \-\-config
|
||||
.B \-c, \-\-config
|
||||
Path to lorax\-composer configuration file.
|
||||
.sp
|
||||
Default: "/etc/lorax/composer.conf"
|
||||
.TP
|
||||
.B\-\-releasever
|
||||
.B \-\-releasever
|
||||
Release version to use for $releasever in dnf repository urls
|
||||
.TP
|
||||
.B\-\-tmp
|
||||
.B \-\-tmp
|
||||
Top level temporary directory
|
||||
.sp
|
||||
Default: "/var/tmp"
|
||||
.TP
|
||||
.B\-\-proxy
|
||||
.B \-\-proxy
|
||||
Set proxy for DNF, overrides configuration file setting.
|
||||
.TP
|
||||
.B\-\-no\-system\-repos
|
||||
.B \-\-no\-system\-repos
|
||||
Do not copy over system repos from /etc/yum.repos.d/ at startup
|
||||
.sp
|
||||
Default: False
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "LORAX" "1" "Apr 27, 2020" "28.14.42" "Lorax"
|
||||
.SH NAME
|
||||
lorax \- Lorax Documentation
|
||||
.
|
||||
.nr rst2man-indent-level 0
|
||||
.
|
||||
|
|
@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "LORAX" "1" "Jun 29, 2021" "28.14.59" "Lorax"
|
||||
.SH NAME
|
||||
lorax \- Lorax Documentation
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B Authors
|
||||
|
|
@ -67,7 +67,8 @@ usage: lorax [\-h] \-p PRODUCT \-v VERSION \-r RELEASE [\-s REPOSITORY]
|
|||
[\-\-add\-arch\-template\-var ADD_ARCH_TEMPLATE_VARS] [\-\-noverify]
|
||||
[\-\-sharedir SHAREDIR] [\-\-enablerepo [repo]]
|
||||
[\-\-disablerepo [repo]] [\-\-rootfs\-size ROOTFS_SIZE]
|
||||
[\-\-noverifyssl] [\-\-skip\-branding] [\-\-dracut\-arg DRACUT_ARGS] [\-V]
|
||||
[\-\-noverifyssl] [\-\-skip\-branding] [\-\-squashfs\-only]
|
||||
[\-\-dracut\-arg DRACUT_ARGS] [\-V]
|
||||
OUTPUTDIR
|
||||
.ft P
|
||||
.fi
|
||||
|
|
@ -76,33 +77,33 @@ usage: lorax [\-h] \-p PRODUCT \-v VERSION \-r RELEASE [\-s REPOSITORY]
|
|||
.SS Positional Arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.BOUTPUTDIR
|
||||
.B OUTPUTDIR
|
||||
Output directory
|
||||
.UNINDENT
|
||||
.SS Named Arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-V
|
||||
.B \-V
|
||||
show program\(aqs version number and exit
|
||||
.UNINDENT
|
||||
.SS required arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-p, \-\-product
|
||||
.B \-p, \-\-product
|
||||
product name
|
||||
.TP
|
||||
.B\-v, \-\-version
|
||||
.B \-v, \-\-version
|
||||
version identifier
|
||||
.TP
|
||||
.B\-r, \-\-release
|
||||
.B \-r, \-\-release
|
||||
release information
|
||||
.TP
|
||||
.B\-s, \-\-source
|
||||
.B \-s, \-\-source
|
||||
source repository (may be listed multiple times)
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-repo
|
||||
.B \-\-repo
|
||||
source dnf repository file
|
||||
.sp
|
||||
Default: []
|
||||
|
|
@ -110,139 +111,144 @@ Default: []
|
|||
.SS Named Arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-m, \-\-mirrorlist
|
||||
.B \-m, \-\-mirrorlist
|
||||
mirrorlist repository (may be listed multiple times)
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-t, \-\-variant
|
||||
.B \-t, \-\-variant
|
||||
variant name
|
||||
.sp
|
||||
Default: ""
|
||||
.TP
|
||||
.B\-b, \-\-bugurl
|
||||
.B \-b, \-\-bugurl
|
||||
bug reporting URL for the product
|
||||
.sp
|
||||
Default: "your distribution provided bug reporting tool"
|
||||
.TP
|
||||
.B\-\-isfinal
|
||||
.B \-\-isfinal
|
||||
Default: False
|
||||
.TP
|
||||
.B\-c, \-\-config
|
||||
.B \-c, \-\-config
|
||||
config file
|
||||
.sp
|
||||
Default: "/etc/lorax/lorax.conf"
|
||||
.TP
|
||||
.B\-\-proxy
|
||||
.B \-\-proxy
|
||||
repo proxy url:port
|
||||
.TP
|
||||
.B\-i, \-\-installpkgs
|
||||
.B \-i, \-\-installpkgs
|
||||
package glob to install before runtime\-install.tmpl runs. (may be listed multiple times)
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-e, \-\-excludepkgs
|
||||
.B \-e, \-\-excludepkgs
|
||||
package glob to remove before runtime\-install.tmpl runs. (may be listed multiple times)
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-buildarch
|
||||
.B \-\-buildarch
|
||||
build architecture
|
||||
.TP
|
||||
.B\-\-volid
|
||||
.B \-\-volid
|
||||
volume id
|
||||
.TP
|
||||
.B\-\-macboot
|
||||
.B \-\-macboot
|
||||
Make the iso bootable on UEFI based Mac systems
|
||||
.sp
|
||||
Default: True
|
||||
.TP
|
||||
.B\-\-nomacboot
|
||||
.B \-\-nomacboot
|
||||
Do not create a Mac bootable iso
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-noupgrade
|
||||
.B \-\-noupgrade
|
||||
Default: True
|
||||
.TP
|
||||
.B\-\-logfile
|
||||
.B \-\-logfile
|
||||
Path to logfile
|
||||
.sp
|
||||
Default: ./lorax.log
|
||||
.TP
|
||||
.B\-\-tmp
|
||||
.B \-\-tmp
|
||||
Top level temporary directory
|
||||
.sp
|
||||
Default: "/var/tmp/lorax"
|
||||
.TP
|
||||
.B\-\-cachedir
|
||||
.B \-\-cachedir
|
||||
DNF cache directory. Default is a temporary dir.
|
||||
.TP
|
||||
.B\-\-workdir
|
||||
.B \-\-workdir
|
||||
Work directory, overrides \-\-tmp. Default is a temporary dir under /var/tmp/lorax
|
||||
.TP
|
||||
.B\-\-force
|
||||
.B \-\-force
|
||||
Run even when the destination directory exists
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-add\-template
|
||||
.B \-\-add\-template
|
||||
Additional template for runtime image
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-add\-template\-var
|
||||
.B \-\-add\-template\-var
|
||||
Set variable for runtime image template
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-add\-arch\-template
|
||||
.B \-\-add\-arch\-template
|
||||
Additional template for architecture\-specific image
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-add\-arch\-template\-var
|
||||
.B \-\-add\-arch\-template\-var
|
||||
Set variable for architecture\-specific image
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-noverify
|
||||
.B \-\-noverify
|
||||
Do not verify the install root
|
||||
.sp
|
||||
Default: True
|
||||
.TP
|
||||
.B\-\-sharedir
|
||||
.B \-\-sharedir
|
||||
Directory containing all the templates. Overrides config file sharedir
|
||||
.TP
|
||||
.B\-\-enablerepo
|
||||
.B \-\-enablerepo
|
||||
Names of repos to enable
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-disablerepo
|
||||
.B \-\-disablerepo
|
||||
Names of repos to disable
|
||||
.sp
|
||||
Default: []
|
||||
.TP
|
||||
.B\-\-rootfs\-size
|
||||
.B \-\-rootfs\-size
|
||||
Size of root filesystem in GiB. Defaults to 3.
|
||||
.sp
|
||||
Default: 3
|
||||
.TP
|
||||
.B\-\-noverifyssl
|
||||
.B \-\-noverifyssl
|
||||
Do not verify SSL certificates
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B\-\-skip\-branding
|
||||
.B \-\-skip\-branding
|
||||
Disable automatic branding package selection. Use \-\-installpkgs to add custom branding.
|
||||
.sp
|
||||
Default: False
|
||||
.TP
|
||||
.B \-\-squashfs\-only
|
||||
Use a plain squashfs filesystem for the runtime.
|
||||
.sp
|
||||
Default: False
|
||||
.UNINDENT
|
||||
.SS dracut arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B\-\-dracut\-arg
|
||||
.B \-\-dracut\-arg
|
||||
Argument to pass to dracut when rebuilding the initramfs. Pass this once for each argument. NOTE: this overrides the default. (default: )
|
||||
.UNINDENT
|
||||
.SH QUICKSTART
|
||||
|
|
|
|||
Loading…
Reference in New Issue