Skip to content
This repository has been archived by the owner on Nov 30, 2021. It is now read-only.

Commit

Permalink
docs(managing_deis): add dependencies for each component
Browse files Browse the repository at this point in the history
Clearly list the dependencies of each component, along with other
components which depend on it.

closes #1241
  • Loading branch information
carmstrong committed Jul 2, 2014
1 parent 32fc59f commit e52d9d7
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/managing_deis/builder_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Customizing builder
=========================
The following settings are tunable for the :ref:`builder` component. Values are stored in etcd.

Dependencies
------------
Requires: :ref:`controller <controller_settings>`, :ref:`registry <registry_settings>`

Required by: :ref:`router <router_settings>`

Considerations: must live on the same host as controller (see `#985`_)

Settings set by builder
-----------------------
The following etcd keys are set by the builder component, typically in its /bin/boot script.
Expand Down Expand Up @@ -54,3 +62,4 @@ Be sure that your custom image functions in the same way as the `stock builder i
Deis. Specifically, ensure that it sets and reads appropriate etcd keys.

.. _`stock builder image`: https://github.com/deis/deis/tree/master/builder
.. _`#985`: https://github.com/deis/deis/issues/985
8 changes: 8 additions & 0 deletions docs/managing_deis/cache_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Customizing cache
=========================
The following settings are tunable for the :ref:`cache` component. Values are stored in etcd.

Dependencies
------------
Requires: none

Required by: :ref:`controller <controller_settings>`, :ref:`registry <registry_settings>`

Considerations: none

Settings set by cache
---------------------
The following etcd keys are set by the cache component, typically in its /bin/boot script.
Expand Down
12 changes: 12 additions & 0 deletions docs/managing_deis/controller_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Customizing controller
=========================
The following settings are tunable for the :ref:`controller` component.

Dependencies
------------
Requires: :ref:`controller <controller_settings>`, :ref:`cache <cache_settings>`, :ref:`database <database_settings>`, :ref:`registry <registry_settings>`

Required by: :ref:`router <router_settings>`

Considerations: must live on the same host as both builder and logger (see `#985`_)

Settings set by controller
--------------------------
The following etcd keys are set by the controller component, typically in its /bin/boot script.
Expand Down Expand Up @@ -40,6 +48,9 @@ setting description
/deis/database/name database name (set by database)
/deis/database/user database user (set by database)
/deis/database/password database password (set by database)
/deis/registry/host host of the registry component (set by registry)
/deis/registry/port port of the registry component (set by registry)
/deis/registry/protocol protocol of the registry component (set by registry)
==================================== ======================================================

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

.. _`stock controller image`: https://github.com/deis/deis/tree/master/controller
.. _`#985`: https://github.com/deis/deis/issues/985
8 changes: 8 additions & 0 deletions docs/managing_deis/database_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Customizing database
=========================
The following settings are tunable for the :ref:`database` component.

Dependencies
------------
Requires: none

Required by: :ref:`controller <controller_settings>`

Considerations: none

Settings set by database
------------------------
The following etcd keys are set by the database component, typically in its /bin/boot script.
Expand Down
9 changes: 9 additions & 0 deletions docs/managing_deis/logger_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Customizing logger
=========================
The following settings are tunable for the :ref:`logger` component.

Dependencies
------------
Requires: none

Required by: :ref:`controller <controller_settings>`

Considerations: must live on the same host as controller (see `#985`_)

Settings set by logger
------------------------
The following etcd keys are set by the database component, typically in its /bin/boot script.
Expand Down Expand Up @@ -42,3 +50,4 @@ Be sure that your custom image functions in the same way as the `stock logger im
Deis. Specifically, ensure that it sets and reads appropriate etcd keys.

.. _`stock logger image`: https://github.com/deis/deis/tree/master/logger
.. _`#985`: https://github.com/deis/deis/issues/985
8 changes: 8 additions & 0 deletions docs/managing_deis/registry_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Customizing registry
=========================
The following settings are tunable for the :ref:`registry` component.

Dependencies
------------
Requires: :ref:`cache <cache_settings>`

Required by: :ref:`builder <builder_settings>`, :ref:`controller <controller_settings>`

Considerations: none

Settings set by registry
--------------------------
The following etcd keys are set by the registry component, typically in its /bin/boot script.
Expand Down
8 changes: 8 additions & 0 deletions docs/managing_deis/router_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Customizing router
=========================
The following settings are tunable for the :ref:`router` component.

Dependencies
------------
Requires: :ref:`builder <builder_settings>`, :ref:`controller <controller_settings>`

Required by: none

Considerations: none

Settings set by router
--------------------------
The following etcd keys are set by the router component, typically in its /bin/boot script.
Expand Down

0 comments on commit e52d9d7

Please sign in to comment.