[live-images] Add documentation

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ář <lsedlar@redhat.com>
This commit is contained in:
Lubomír Sedlář 2016-01-18 14:24:25 +01:00
parent 9059852ab5
commit b16699ddfc
1 changed files with 23 additions and 0 deletions

View File

@ -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
====================