From ef39068127e6cac53ed9db0c0dc9ea2c2b6bfa74 Mon Sep 17 00:00:00 2001 From: mprahl Date: Aug 23 2019 18:02:46 +0000 Subject: Reword the gating documentation This commit fixes a few typos and adds a link to Greenwave. --- diff --git a/docs/GATING.rst b/docs/GATING.rst index e25479f..0a61317 100644 --- a/docs/GATING.rst +++ b/docs/GATING.rst @@ -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 `_. -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.