Docs: add very simple architecture diagram
Change-Id: Ib0552cafd80c8a602c984cf6ca9f7f4ca8e687fe
This commit is contained in:
parent
4475c208b9
commit
e86abe1ee0
|
@ -8,6 +8,7 @@ openssl [test]
|
||||||
zookeeperd [platform:dpkg]
|
zookeeperd [platform:dpkg]
|
||||||
build-essential [platform:dpkg]
|
build-essential [platform:dpkg]
|
||||||
gcc [platform:rpm]
|
gcc [platform:rpm]
|
||||||
|
graphviz [test]
|
||||||
libssl-dev [platform:dpkg]
|
libssl-dev [platform:dpkg]
|
||||||
openssl-devel [platform:rpm]
|
openssl-devel [platform:rpm]
|
||||||
libffi-dev [platform:dpkg]
|
libffi-dev [platform:dpkg]
|
||||||
|
|
|
@ -6,11 +6,37 @@ Components
|
||||||
==========
|
==========
|
||||||
|
|
||||||
Zuul is a distributed system consisting of several components, each of
|
Zuul is a distributed system consisting of several components, each of
|
||||||
which is described below. All Zuul processes read the
|
which is described below.
|
||||||
``/etc/zuul/zuul.conf`` file (an alternate location may be supplied on
|
|
||||||
the command line) which uses an INI file syntax. Each component may
|
|
||||||
have its own configuration file, though you may find it simpler to use
|
.. graphviz::
|
||||||
the same file for all components.
|
:align: center
|
||||||
|
|
||||||
|
graph {
|
||||||
|
node [shape=box]
|
||||||
|
Gearman [shape=ellipse]
|
||||||
|
Gerrit [fontcolor=grey]
|
||||||
|
Zookeeper [shape=ellipse]
|
||||||
|
Nodepool
|
||||||
|
GitHub [fontcolor=grey]
|
||||||
|
|
||||||
|
Merger -- Gearman
|
||||||
|
Executor -- Gearman
|
||||||
|
Web -- Gearman
|
||||||
|
|
||||||
|
Gearman -- Scheduler;
|
||||||
|
Scheduler -- Gerrit;
|
||||||
|
Scheduler -- Zookeeper;
|
||||||
|
Zookeeper -- Nodepool;
|
||||||
|
Scheduler -- GitHub;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
All Zuul processes read the ``/etc/zuul/zuul.conf`` file (an alternate
|
||||||
|
location may be supplied on the command line) which uses an INI file
|
||||||
|
syntax. Each component may have its own configuration file, though
|
||||||
|
you may find it simpler to use the same file for all components.
|
||||||
|
|
||||||
An example ``zuul.conf``:
|
An example ``zuul.conf``:
|
||||||
|
|
||||||
|
|
|
@ -27,6 +27,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
|
'sphinx.ext.graphviz',
|
||||||
'sphinxcontrib.blockdiag',
|
'sphinxcontrib.blockdiag',
|
||||||
'sphinxcontrib.programoutput',
|
'sphinxcontrib.programoutput',
|
||||||
'zuul.sphinx.zuul',
|
'zuul.sphinx.zuul',
|
||||||
|
|
Loading…
Reference in New Issue