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

Reword the gating documentation

Browse Source 
This commit fixes a few typos and adds a link to Greenwave.
This commit is contained in:
mprahl
2019-08-23 10:40:09 -04:00
parent cf334b3261
commit ef39068127
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/GATING.rst
View File

@@ -1,20 +1,20 @@
Modules gating using Greenwave
==============================
Every successfully built module is moved to ``done`` state. Modules in this state cannot
be used as a build-dependency for other modules. They need to be moved to ``ready`` state.
Every successfully built module is moved to the ``done`` state. Modules in this state cannot
be used as a build dependency for other modules. They need to be moved to the ``ready`` state.
By default, MBS moves the module from ``done`` state to ``ready`` state automatically,
but MBS can also be configured to gate move from ``done`` to ``ready`` state according
to Greenwave service.
By default, MBS moves the module from the ``done`` state to the ``ready`` state automatically,
but MBS can also be configured to gate the ``done`` to ``ready`` state transition using
`Greenwave <https://pagure.io/docs/greenwave/>`_.
When Greenwave integration is configured, then following additional MBS features are enabled:
When Greenwave integration is configured, the following additional MBS features are enabled:
- When the module is moved to ``done`` state, Greenwave is queried to find out whether to module
can be moved to ``ready`` state instantly.
- If the module cannot be moved to ``ready`` state yet, MBS keeps the module build in the
- When the module is moved to the ``done`` state, Greenwave is queried to find out whether
the module can be moved to the ``ready`` state instantly.
- If the module cannot be moved to the ``ready`` state yet, MBS keeps the module build in the
``done`` state and waits for a message from Greenwave. If this message says that all the
tests defined by Greenwave policy have passed, then the module build is moved to ``ready``
tests defined by Greenwave policy have passed, then the module build is moved to the ``ready``
state.
- MBS also queries Greenwave periodically to find out the current gating status for modules
in the ``done`` state. This is useful in case when message from Greenwave has been lost.
in the ``done`` state. This is useful in case a message from Greenwave was missed.