diff options
| author | Ryan Hallisey <rhallise@redhat.com> | 2016-07-27 12:09:07 -0400 |
|---|---|---|
| committer | Ryan Hallisey <rhallise@redhat.com> | 2016-08-17 06:28:29 -0400 |
| commit | aa517c4bf965f06dc9bcb20220d675ff6e77e94c (patch) | |
| tree | e0b53a8b416d7c6302e19153ddd311aec811d573 /doc | |
| parent | b7d1d98668536fc33a0803b7f6abc0f3783484eb (diff) | |
| download | kolla-aa517c4bf965f06dc9bcb20220d675ff6e77e94c.tar.gz kolla-aa517c4bf965f06dc9bcb20220d675ff6e77e94c.zip | |
Build a more organized doc structure
Use directories to further organize the path a user would
take through the docs.
Change-Id: I8e3885c7ac3a72eaadbf547efedf0de477aa0a9f
Partially-implements: blueprint documentation-rework
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/deployment-philosophy/deployment-philosophy.rst | 40 | ||||
| -rw-r--r-- | doc/deployment-philosophy/templating-and-customization.rst | 0 | ||||
| -rw-r--r-- | doc/deployment-philosophy/templating.rst (renamed from doc/deployment-philosophy.rst) | 26 | ||||
| -rw-r--r-- | doc/index.rst | 4 |
4 files changed, 46 insertions, 24 deletions
diff --git a/doc/deployment-philosophy/deployment-philosophy.rst b/doc/deployment-philosophy/deployment-philosophy.rst new file mode 100644 index 000000000..00cbfea26 --- /dev/null +++ b/doc/deployment-philosophy/deployment-philosophy.rst @@ -0,0 +1,40 @@ +.. _deployment-philosophy: + +============================= +Kolla's Deployment Philosophy +============================= + +Overview +======== + +Kolla has an objective to replace the inflexible, painful, resource-intensive +deployment process of OpenStack with a flexible, painless, inexpensive +deployment process. Often to deploy OpenStack at the 100+ node scale small +businesses may require means building a team of OpenStack professionals to +maintain and manage the OpenStack deployment. Finding people experienced in +OpenStack deployment is very difficult and expensive, resulting in a big +barrier for OpenStack adoption. Kolla seeks to remedy this set of problems by +simplifying the deployment process but enabling flexible deployment models. + +Kolla is a highly opinionated deployment tool out of the box. This permits +Kolla to be deployable with the simple configuration of three key/value pairs. +As an operator's experience with OpenStack grows and the desire to customize +OpenStack services increases, Kolla offers full capability to override every +OpenStack service configuration option in the deployment. + +Templating and Customization Philosophy +======================================= + +To read up on the Kolla communities template philosphy go to the +:doc:`templating` doc. + +Architecture +============ + +#TODO: Link an image showing the architecture + + +.. toctree:: + :hidden: + + templating diff --git a/doc/deployment-philosophy/templating-and-customization.rst b/doc/deployment-philosophy/templating-and-customization.rst new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/doc/deployment-philosophy/templating-and-customization.rst diff --git a/doc/deployment-philosophy.rst b/doc/deployment-philosophy/templating.rst index 6711d34f0..c0511c7a2 100644 --- a/doc/deployment-philosophy.rst +++ b/doc/deployment-philosophy/templating.rst @@ -1,26 +1,8 @@ -.. _deployment-philosophy: +.. _templating: -============================= -Kolla's Deployment Philosophy -============================= - -Overview -======== - -Kolla has an objective to replace the inflexible, painful, resource-intensive -deployment process of OpenStack with a flexible, painless, inexpensive -deployment process. Often to deploy OpenStack at the 100+ node scale small -businesses may require means building a team of OpenStack professionals to -maintain and manage the OpenStack deployment. Finding people experienced in -OpenStack deployment is very difficult and expensive, resulting in a big -barrier for OpenStack adoption. Kolla seeks to remedy this set of problems by -simplifying the deployment process while enabling flexible deployment models. - -Kolla is a highly opinionated deployment tool out of the box. This permits -Kolla to be deployable with the simple configuration of three key/value pairs. -As an operator's experience with OpenStack grows and the desire to customize -OpenStack services increases, Kolla offers full capability to override every -OpenStack service configuration option in the deployment. +================ +Kolla Templating +================ Why not Template Customization? =============================== diff --git a/doc/index.rst b/doc/index.rst index a5d50bc6c..4b331e060 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -34,9 +34,9 @@ Kolla Overview ============== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - deployment-philosophy + deployment-philosophy/deployment-philosophy quickstart multinode image-building |
