From 119861a989291e78860eef383386ab43335839f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0abata?= Date: Tue, 21 Jun 2016 15:11:54 +0200 Subject: [PATCH] Update README, describing what the orchestrator is MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Petr Šabata --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index f0bc8b0a..50e4f4df 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,20 @@ The module build orchestrator for Modularity ============================================ +The orchestrator coordinates module builds and is responsible for a number of +tasks: + +- Providing an interface for module client-side tooling via which module build + submission and build state queries are possible. +- Verifying the input data (modulemd, RPM SPEC files and others) is available + and correct. +- Preparing the build environment in the supported build systems, such as koji. +- Scheduling and building of the module components and tracking the build + state. +- Emitting bus messages about all state changes so that other infrastructure + services can pick up the work. + +Client-side API +--------------- + TBD