diff --git a/docs/source/plugins.rst b/docs/source/plugins.rst index 1ec332f0..4e4d9995 100644 --- a/docs/source/plugins.rst +++ b/docs/source/plugins.rst @@ -226,3 +226,41 @@ sent on the bus (e.g. if the amqps server is offline). Admins should consider the balance between the ``batch_size`` and ``extra_limit`` options, as both can affect the total amount of data that the plugin could attempt to send during a single call. + + +Kiwi images +=========== + +**This is just a tech-preview. API/usage can drastically change in upcoming +releases** + +Plugin for creating images via `kiwi `_ +project. + +All three parts (cli/hub/builder) needs to be installed. There is currently no +configuration except allowing the plugins. + +Builders have to be part of ``image`` channel and don't need to have any +specific library installed (kiwi invocation/usage is only in buildroots not on +builder itself). + +Buildtag needs to be configured by adding special group ``kiwi`` which should +contain at least ``kiwi-cli``, potentially ``jing`` for better description files +validation and any ``kiwi-systemdeps-*`` packages for requested image types. So, +most simple configuration will look like: + +.. code-block:: shell + + $ koji add-group kiwi-build-tag kiwi + $ koji add-group-pkg kiwi-build-tag kiwi-cli + +Calling the build itself is a matter of simple CLI call: + +.. code-block: shell + + $ koji kiwi-build kiwi-target git+https://my.git/image-descriptions#master my_image_path + +Selecting other than default kiwi profile can be done by ``--kiwi-profile`` +option. Similarly to other image tasks, alternative architecture failures can be +ignored for successful build by ``--can-fail`` option. ``--arch`` can be used to +limit build tag architectures.