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

Add preliminary module scratch build details to documentation.

Browse Source 
Signed-off-by: Merlin Mathesius <mmathesi@redhat.com>
This commit is contained in:
Merlin Mathesius
2019-02-07 14:12:05 -06:00
parent 838feb4ecd
commit 7794950802
1 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/HOW_MBS_BUILDS_MODULES.rst
View File

@@ -11,13 +11,27 @@ User submits module build request
There is the MBS frontend, which provides a REST API (See ``views.py``). A user sends a POST request
with JSON describing the module to build. There is mainly the URL to the git repository (called
``scmurl``) and branch name (called ``branch``). The ``scmurl`` points to the git repository containing
the modulemd file defining the module.
``scmurl`` |---| which points to the git repository containing the modulemd file defining the module)
and branch name (called ``branch``).
This JSON data is handled by ``views.SCMHandler``, which validates the JSON and calls
``utils.submit.submit_module_build_from_scm(...)`` method. This goes down to
``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``
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
``utils.submit.submit_module_build_from_yaml(...)`` method which also goes down
to ``submit_module_build(...)``.
If module scratch builds are allowed (MBS setting ``MODULE_ALLOW_SCRATCH`` is
``True``), the user can also upload one or more source RPMs uploaded 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.
Module Stream Expansion (MSE)
-----------------------------
@@ -183,3 +197,6 @@ The "done" state message is handled in the ``scheduler.handlers.modules.done(...
This method imports the module build into Koji using the ``KojiContentGenerator`` class.
The module build in Koji points to the Koji tag with the module's components and also contains the
final modulemd files generated for earch architecture the module is built for.
.. |---| unicode:: U+2014 .. em dash, trimming surrounding whitespace
:trim: