From 5e4bdbfb01d21b54e22d040871f4c6b9694c8d61 Mon Sep 17 00:00:00 2001 From: "Brian C. Lane" Date: Thu, 1 Oct 2020 11:59:45 -0700 Subject: [PATCH] docs: Update docs for lorax-composer removal --- docs/composer-cli.rst | 16 +++++++-------- docs/index.rst | 1 - docs/lifted.rst | 46 ------------------------------------------- docs/mkksiso.rst | 7 ++++--- 4 files changed, 11 insertions(+), 59 deletions(-) delete mode 100644 docs/lifted.rst diff --git a/docs/composer-cli.rst b/docs/composer-cli.rst index 83612e1d..f63bd023 100644 --- a/docs/composer-cli.rst +++ b/docs/composer-cli.rst @@ -5,14 +5,12 @@ composer-cli Brian C. Lane ``composer-cli`` is an interactive tool for use with a WELDR API server, -managing blueprints, exploring available packages, and building new images. -`lorax-composer ` and `osbuild-composer -` both implement compatible servers. +managing blueprints, exploring available packages, and building new images. As +of Fedora 34, `osbuild-composer ` 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 `_ -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 diff --git a/docs/index.rst b/docs/index.rst index aae0436e..bc957e95 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,6 @@ Contents: intro lorax livemedia-creator - lorax-composer composer-cli mkksiso product-images diff --git a/docs/lifted.rst b/docs/lifted.rst deleted file mode 100644 index a9c4b004..00000000 --- a/docs/lifted.rst +++ /dev/null @@ -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: diff --git a/docs/mkksiso.rst b/docs/mkksiso.rst index ad486002..f1222739 100644 --- a/docs/mkksiso.rst +++ b/docs/mkksiso.rst @@ -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``,