Skip to content

Commit 2f49bef

Browse files
committed
Merge pull request #614 from opdemand/architecture-docs
update Deis' architecture docs
2 parents 943b344 + 72363e7 commit 2f49bef

1 file changed

Lines changed: 21 additions & 15 deletions

File tree

docs/gettingstarted/architecture.rst

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,46 +7,47 @@
77
Architecture
88
============
99

10-
Deis consists of 8 modules that combine to create a distributed PaaS.
11-
Each Deis module is deployed as one or more `Docker`_ containers.
10+
Deis consists of 9 modules that combine to create a distributed PaaS.
11+
Each Deis module is deployed as a :ref:`Container`.
1212

1313
.. _controller:
1414

1515
Controller
1616
----------
17-
The controller module is the "brains" of the Deis platform, in charge of:
1817

19-
* Processing client API calls
20-
* Managing nodes that host containers and provide services
21-
* Managing containers that perform work
22-
* Managing proxies that route traffic to containers
23-
* Managing users, providers, flavors, keys and other base configuration
24-
25-
The controller module includes:
26-
27-
* `Django`_ for processing API calls
28-
* `Celery`_ for managing task queues
18+
See :ref:`Controller`.
2919

3020
.. _database:
3121

3222
Database
3323
--------
24+
3425
The database module uses `PostgreSQL`_ to store durable platform state.
3526

27+
.. _discovery:
28+
29+
Discovery
30+
---------
31+
32+
The discovery module uses `etcd`_ for shared configuration and service discovery across
33+
the cluster.
34+
3635
.. _cache:
3736

3837
Cache
3938
-----
39+
4040
The cache module uses `Redis`_ to:
4141

42-
* Store work queue data for Celery
43-
* Cache sessions and synchronize locks for Django
42+
* Store work queue data for `Celery`_
43+
* Cache sessions and synchronize locks for `Django`_
4444
* Store recent log data for the :ref:`Controller`
4545

4646
.. _builder:
4747

4848
Builder
4949
-------
50+
5051
The builder module uses a `Git`_ server to process :ref:`Application` builds.
5152
The builder:
5253

@@ -65,6 +66,7 @@ is deployed across the platform automatically.
6566

6667
Registry
6768
--------
69+
6870
The registry module hosts `Docker`_ images on behalf of the platform.
6971
Image data is typically stored on a storage service like
7072
`Amazon S3`_ or `OpenStack Storage`_.
@@ -73,6 +75,7 @@ Image data is typically stored on a storage service like
7375

7476
Log Server
7577
----------
78+
7679
The log server module uses `rsyslog`_ to aggregate log data from
7780
across the platform.
7881
This data can then be queried by the :ref:`Controller`.
@@ -81,17 +84,20 @@ This data can then be queried by the :ref:`Controller`.
8184

8285
Runtime
8386
-------
87+
8488
The runtime module uses `Docker`_ to run containers for deployed applications.
8589

8690
.. _proxy:
8791

8892
Proxy
8993
-----
94+
9095
The proxy module uses `Nginx`_ to route traffic to application containers.
9196

9297
.. _`Django`: https://www.djangoproject.com/
9398
.. _`Celery`: http://www.celeryproject.org/
9499
.. _`PostgreSQL`: http://www.postgresql.org/
100+
.. _`etcd`: https://github.com/coreos/etcd
95101
.. _`Redis`: http://redis.io/
96102
.. _`Git`: http://git-scm.com/
97103
.. _`Docker`: http://docker.io/

0 commit comments

Comments
 (0)