modules/fm-orchestrator
1
0
Fork 0
mirror of https://pagure.io/fm-orchestrator.git synced 2026-04-03 10:48:03 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add/improve documentation for scratch module build requests,

Browse Source 
particularly for the new 'modulemd' and 'module_name' parameters.

Signed-off-by: Merlin Mathesius <mmathesi@redhat.com>
This commit is contained in:
Merlin Mathesius
2019-03-15 15:52:23 -05:00
committed by mprahl
parent aaf9eaa6ec
commit 7b7b07211e
2 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.rst
View File

@@ -107,9 +107,15 @@ Options:
existing requires on the modulemd. The expected format is ``{'platform': ['f28', 'f29']}``.
- ``scratch`` - a boolean indicating if a scratch module build should be performed.
Only allowed to be ``True`` if the MBS setting ``MODULES_ALLOW_SCRATCH`` is ``True``.
- ``yaml`` - a string of the input file when submitting a YAML file directly in a
``multipart/form-data`` request. The MBS setting ``YAML_SUBMIT_ALLOWED`` must be set to ``True``
for this to be allowed.
- ``yaml`` - a string of the input file when submitting a YAML modulemd file directly in a
``multipart/form-data`` request. Only allowed if ``scratch`` is ``True`` or if the MBS
setting ``YAML_SUBMIT_ALLOWED`` is ``True``. The basename of the file will be used as
the module name.
- ``modulemd`` - a string for submitting a YAML modulemd file as a parameter in the JSON data as
an alternative to sending it in a ``multipart/form-data`` request. Only allowed if
``scratch`` is ``True`` or if the MBS setting ``YAML_SUBMIT_ALLOWED`` is ``True``.
- ``module_name`` - a string to use as the module name if a scratch build is requested and the
YAML modulemd is submitted using the ``modulemd`` parameter.
- ``srpms`` - an optional list of Koji upload URLs of SRPMs to include in a module scratch build.
Only allowed if ``scratch`` is ``True``.
- ``rebuild_strategy`` - a string of the desired rebuild strategy (affects what components get

7
docs/HOW_MBS_BUILDS_MODULES.rst
View File

@@ -19,7 +19,8 @@ This JSON data is handled by ``views.SCMHandler``, which validates the JSON and
``submit_module_build(...)``.
Alternatively, if submitting a YAML modulemd file is allowed (MBS setting
``YAML_SUBMIT_ALLOWED`` is ``True``), the user can send a ``multipart/form-data``
``YAML_SUBMIT_ALLOWED`` is ``True``), the user can include it in the JSON data
(called ``modulemd`` and ``module_name``) or send a ``multipart/form-data``
POST request directly including the contents of a YAML modulemd file
(called ``yaml``). In this case, the JSON data and YAML file are handled by
``views.YAMLFileHandler``, which validates the data and calls the
@@ -27,7 +28,9 @@ POST request directly including the contents of a YAML modulemd file
to ``submit_module_build(...)``.
If module scratch builds are allowed (MBS setting ``MODULES_ALLOW_SCRATCH`` is
``True``), the user can also upload one or more source RPMs uploaded to Koji
``True``), the user can request a scratch module build (called ``scratch``).
With a scratch build request, the user can include a YAML modulemd file
(see above) and also upload one or more source RPMs to Koji
via calls to Koji's ``session.uploadWrapper(..)``, and supply the list of
upload links to MBS (called ``srpms``). Such custom SRPMs will be used to
override the git repository source for corresponding components.