Update runroot_method documentation.

Signed-off-by: Jan Kaluza <jkaluza@redhat.com>
This commit is contained in:
Jan Kaluza 2020-01-06 07:45:16 +01:00
parent 794d151bef
commit 3750d6795f

View File

@ -861,9 +861,15 @@ Options
to set up your Koji client profile. In the examples, the profile name is to set up your Koji client profile. In the examples, the profile name is
"koji", which points to Fedora's koji.fedoraproject.org. "koji", which points to Fedora's koji.fedoraproject.org.
**global_runroot_method**
(*str*) -- global runroot method to use. If ``runroot_method`` is set
per Pungi phase using a dictionary, this option defines the default
runroot method for phases not mentioned in the ``runroot_method``
dictionary.
**runroot_method** **runroot_method**
(*str*) -- Runroot method to use. It can further specify the runroot method (*str*|*dict*) -- Runroot method to use. It can further specify
in case the ``runroot`` is set to True. the runroot method in case the ``runroot`` is set to True.
Available methods are: Available methods are:
* ``local`` -- runroot tasks are run locally * ``local`` -- runroot tasks are run locally
@ -873,6 +879,19 @@ Options
user under which Pungi runs must be configured to login as ``runroot_ssh_username`` user under which Pungi runs must be configured to login as ``runroot_ssh_username``
using the SSH key. using the SSH key.
The runroot method can also be set per Pungi phase using the dictionary
with phase name as key and runroot method as value. The default runroot
method is in this case defined by the ``global_runroot_method`` option.
Example
-------
::
global_runroot_method = "koji"
runroot_method = {
"createiso": "local"
}
**runroot_channel** **runroot_channel**
(*str*) -- name of koji channel (*str*) -- name of koji channel