From b16699ddfcce2da320cd5906a71ee890f14c5e45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lubom=C3=ADr=20Sedl=C3=A1=C5=99?= Date: Mon, 18 Jan 2016 14:24:25 +0100 Subject: [PATCH] [live-images] Add documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add basic documentation for live-images phases. So far, there are no examples, just a listing of accepted options. Signed-off-by: Lubomír Sedlář --- doc/configuration.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/configuration.rst b/doc/configuration.rst index a9960f76..1bc4bd1d 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -607,6 +607,29 @@ Example }), ] + +Live Images Settings +==================== + +**live_target** + (*str*) -- Koji build target for which to build the images. This gets + passed to ``koji spin-livecd``. + +**live_images** + (*list*) -- Configuration for the particular image. The elements of the + list should be tuples ``(variant_uid_regex, {arch|*: config})``. The config + should be a dict with these keys: + + * ``kickstart`` (*str|dict*) + * ``name`` (*str*) + * ``version`` (*str*) + * ``additional_repos`` (*list*) -- external repos specified by URL + * ``repos_from`` (*list*) -- repos from other variants + * ``specfile`` (*str*) -- for images wrapped in RPM + * ``scratch`` (*bool*) -- only RPM-wrapped images can use scratch builds, + but by default this is turned off + + Image Build Settings ====================