Skip to content

Commit e52d9d7

Browse files
committed
docs(managing_deis): add dependencies for each component
Clearly list the dependencies of each component, along with other components which depend on it. closes #1241
1 parent 32fc59f commit e52d9d7

7 files changed

Lines changed: 62 additions & 0 deletions

File tree

docs/managing_deis/builder_settings.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Customizing builder
77
=========================
88
The following settings are tunable for the :ref:`builder` component. Values are stored in etcd.
99

10+
Dependencies
11+
------------
12+
Requires: :ref:`controller <controller_settings>`, :ref:`registry <registry_settings>`
13+
14+
Required by: :ref:`router <router_settings>`
15+
16+
Considerations: must live on the same host as controller (see `#985`_)
17+
1018
Settings set by builder
1119
-----------------------
1220
The following etcd keys are set by the builder component, typically in its /bin/boot script.
@@ -54,3 +62,4 @@ Be sure that your custom image functions in the same way as the `stock builder i
5462
Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
5563

5664
.. _`stock builder image`: https://github.com/deis/deis/tree/master/builder
65+
.. _`#985`: https://github.com/deis/deis/issues/985

docs/managing_deis/cache_settings.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Customizing cache
77
=========================
88
The following settings are tunable for the :ref:`cache` component. Values are stored in etcd.
99

10+
Dependencies
11+
------------
12+
Requires: none
13+
14+
Required by: :ref:`controller <controller_settings>`, :ref:`registry <registry_settings>`
15+
16+
Considerations: none
17+
1018
Settings set by cache
1119
---------------------
1220
The following etcd keys are set by the cache component, typically in its /bin/boot script.

docs/managing_deis/controller_settings.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Customizing controller
77
=========================
88
The following settings are tunable for the :ref:`controller` component.
99

10+
Dependencies
11+
------------
12+
Requires: :ref:`controller <controller_settings>`, :ref:`cache <cache_settings>`, :ref:`database <database_settings>`, :ref:`registry <registry_settings>`
13+
14+
Required by: :ref:`router <router_settings>`
15+
16+
Considerations: must live on the same host as both builder and logger (see `#985`_)
17+
1018
Settings set by controller
1119
--------------------------
1220
The following etcd keys are set by the controller component, typically in its /bin/boot script.
@@ -40,6 +48,9 @@ setting description
4048
/deis/database/name database name (set by database)
4149
/deis/database/user database user (set by database)
4250
/deis/database/password database password (set by database)
51+
/deis/registry/host host of the registry component (set by registry)
52+
/deis/registry/port port of the registry component (set by registry)
53+
/deis/registry/protocol protocol of the registry component (set by registry)
4354
==================================== ======================================================
4455

4556
Using a custom controller image
@@ -62,3 +73,4 @@ Be sure that your custom image functions in the same way as the `stock controlle
6273
Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
6374

6475
.. _`stock controller image`: https://github.com/deis/deis/tree/master/controller
76+
.. _`#985`: https://github.com/deis/deis/issues/985

docs/managing_deis/database_settings.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Customizing database
77
=========================
88
The following settings are tunable for the :ref:`database` component.
99

10+
Dependencies
11+
------------
12+
Requires: none
13+
14+
Required by: :ref:`controller <controller_settings>`
15+
16+
Considerations: none
17+
1018
Settings set by database
1119
------------------------
1220
The following etcd keys are set by the database component, typically in its /bin/boot script.

docs/managing_deis/logger_settings.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Customizing logger
77
=========================
88
The following settings are tunable for the :ref:`logger` component.
99

10+
Dependencies
11+
------------
12+
Requires: none
13+
14+
Required by: :ref:`controller <controller_settings>`
15+
16+
Considerations: must live on the same host as controller (see `#985`_)
17+
1018
Settings set by logger
1119
------------------------
1220
The following etcd keys are set by the database component, typically in its /bin/boot script.
@@ -42,3 +50,4 @@ Be sure that your custom image functions in the same way as the `stock logger im
4250
Deis. Specifically, ensure that it sets and reads appropriate etcd keys.
4351

4452
.. _`stock logger image`: https://github.com/deis/deis/tree/master/logger
53+
.. _`#985`: https://github.com/deis/deis/issues/985

docs/managing_deis/registry_settings.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Customizing registry
77
=========================
88
The following settings are tunable for the :ref:`registry` component.
99

10+
Dependencies
11+
------------
12+
Requires: :ref:`cache <cache_settings>`
13+
14+
Required by: :ref:`builder <builder_settings>`, :ref:`controller <controller_settings>`
15+
16+
Considerations: none
17+
1018
Settings set by registry
1119
--------------------------
1220
The following etcd keys are set by the registry component, typically in its /bin/boot script.

docs/managing_deis/router_settings.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ Customizing router
77
=========================
88
The following settings are tunable for the :ref:`router` component.
99

10+
Dependencies
11+
------------
12+
Requires: :ref:`builder <builder_settings>`, :ref:`controller <controller_settings>`
13+
14+
Required by: none
15+
16+
Considerations: none
17+
1018
Settings set by router
1119
--------------------------
1220
The following etcd keys are set by the router component, typically in its /bin/boot script.

0 commit comments

Comments
 (0)