almalinux
/
lorax
14
0
Fork 0
Code Issues Pull Requests Releases Activity

docs: Update docs for lorax-composer removal

This commit is contained in:
Brian C. Lane 2020-10-01 11:59:45 -07:00
parent 0eda7829a8
commit 5e4bdbfb01
4 changed files with 11 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/composer-cli.rst
View File

@ -5,14 +5,12 @@ composer-cli
Brian C. Lane <bcl@redhat.com>
``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.
managing blueprints, exploring available packages, and building new images. As
of Fedora 34, `osbuild-composer <https://osbuild.org>` is the recommended
server.
It requires the 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.
running it needs to be a member of the ``weldr`` group.
composer-cli cmdline arguments
------------------------------
@ -79,9 +77,9 @@ with ``composer-cli upload start ...``. In order to access the service you need
to pass authentication details to composer-cli using a TOML file, or reference
a previously saved profile.
``lorax-composer`` and ``osbuild-composer`` handle this differently, with
``osbuild-composer`` you can currently only specify upload targets during the
compose process.
.. note::
With ``osbuild-composer`` you can only specify upload targets during
the compose process.
Providers

1
docs/index.rst
View File

@ -14,7 +14,6 @@ Contents:
intro
lorax
livemedia-creator
lorax-composer
composer-cli
mkksiso
product-images

46
docs/lifted.rst
View File

@ -1,46 +0,0 @@
lifted package
==============
Submodules
----------
lifted.config module
--------------------
.. automodule:: lifted.config
:members:
:undoc-members:
:show-inheritance:
lifted.providers module
-----------------------
.. automodule:: lifted.providers
:members:
:undoc-members:
:show-inheritance:
lifted.queue module
-------------------
.. automodule:: lifted.queue
:members:
:undoc-members:
:show-inheritance:
lifted.upload module
--------------------
.. automodule:: lifted.upload
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: lifted
:members:
:undoc-members:
:show-inheritance:

7
docs/mkksiso.rst
View File

@ -90,10 +90,11 @@ You can use the kickstart `liveimg command
to install a pre-generated disk image or tar to the system the iso is booting
on.
Create a disk image or tar with ``lorax-composer`` or ``livemedia-creator``,
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 ``lorax-composer`` use the ``liveimg-tar``
image type. If you plan to install it to a UEFI machine make sure to include
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``,