[Docs] Move more examples to user guide

This moves the following use cases into the user guides:
- Prod example
- L3 routed example

Change-Id: I30c3d70701eaece4b3ec57a96be270ad01a28bad
This commit is contained in:
Jean-Philippe Evrard
2018-02-20 15:29:45 +00:00
parent 1d47028911
commit 73c45a8108
6 changed files with 21 additions and 26 deletions

View File

@@ -5,8 +5,6 @@ Appendices
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
app-config-prod.rst
app-config-pod.rst
app-config-prod-ceph.rst app-config-prod-ceph.rst
app-custom-layouts.rst app-custom-layouts.rst
app-security.rst app-security.rst

View File

Before

Width:  |  Height:  |  Size: 213 KiB

After

Width:  |  Height:  |  Size: 213 KiB

View File

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 41 KiB

View File

@@ -24,3 +24,5 @@ For in-depth technical information, see the
aio/quickstart.rst aio/quickstart.rst
test/example.rst test/example.rst
prod/example.rst
l3pods/example.rst

View File

@@ -1,13 +1,10 @@
.. _pod-environment-config: .. _pod-environment-config:
============================================================ ==========================
Appendix C: Example layer 3 routed environment configuration Routed environment example
============================================================ ==========================
Introduction This section describes an example production environment for a working
~~~~~~~~~~~~
This appendix describes an example production environment for a working
OpenStack-Ansible (OSA) deployment with high availability services where OpenStack-Ansible (OSA) deployment with high availability services where
provider networks and connectivity between physical machines are routed provider networks and connectivity between physical machines are routed
(layer 3). (layer 3).
@@ -27,7 +24,7 @@ This example environment has the following characteristics:
Tunnel, and Storage Networks of each pod. The gateway address is the first Tunnel, and Storage Networks of each pod. The gateway address is the first
usable address within each network's subnet. usable address within each network's subnet.
.. image:: figures/arch-layout-production.png .. image:: ../figures/arch-layout-production.png
:width: 100% :width: 100%
Network configuration Network configuration
@@ -105,7 +102,7 @@ following is the ``/etc/network/interfaces`` file for ``infra1``.
configuration files are replaced with the appropriate name. The same configuration files are replaced with the appropriate name. The same
applies to additional network interfaces. applies to additional network interfaces.
.. literalinclude:: ../../etc/network/interfaces.d/openstack_interface.cfg.pod.example .. literalinclude:: ../../../../etc/network/interfaces.d/openstack_interface.cfg.pod.example
Deployment configuration Deployment configuration
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -130,7 +127,7 @@ pods.
The following configuration describes the layout for this environment. The following configuration describes the layout for this environment.
.. literalinclude:: ../../etc/openstack_deploy/openstack_user_config.yml.pod.example .. literalinclude:: ../../../../etc/openstack_deploy/openstack_user_config.yml.pod.example
Environment customizations Environment customizations
-------------------------- --------------------------
@@ -144,7 +141,7 @@ For this environment, the ``cinder-volume`` runs in a container on the
infrastructure hosts. To achieve this, implement infrastructure hosts. To achieve this, implement
``/etc/openstack_deploy/env.d/cinder.yml`` with the following content: ``/etc/openstack_deploy/env.d/cinder.yml`` with the following content:
.. literalinclude:: ../../etc/openstack_deploy/env.d/cinder-volume.yml.container.example .. literalinclude:: ../../../../etc/openstack_deploy/env.d/cinder-volume.yml.container.example
User variables User variables
-------------- --------------
@@ -156,4 +153,4 @@ For this environment, implement the load balancer on the infrastructure
hosts. Ensure that keepalived is also configured with HAProxy in hosts. Ensure that keepalived is also configured with HAProxy in
``/etc/openstack_deploy/user_variables.yml`` with the following content. ``/etc/openstack_deploy/user_variables.yml`` with the following content.
.. literalinclude:: ../../etc/openstack_deploy/user_variables.yml.prod.example .. literalinclude:: ../../../../etc/openstack_deploy/user_variables.yml.prod.example

View File

@@ -1,13 +1,10 @@
.. _production-environment-config: .. _production-environment-config:
======================================================== ======================
Appendix B: Example production environment configuration Production environment
======================================================== ======================
Introduction This is an example production environment for a working
~~~~~~~~~~~~
This appendix describes an example production environment for a working
OpenStack-Ansible (OSA) deployment with high availability services. OpenStack-Ansible (OSA) deployment with high availability services.
This example environment has the following characteristics: This example environment has the following characteristics:
@@ -24,8 +21,9 @@ This example environment has the following characteristics:
* Internet access via the router address 172.29.236.1 on the * Internet access via the router address 172.29.236.1 on the
Management Network Management Network
.. image:: figures/arch-layout-production.png .. image:: ../figures/arch-layout-production.png
:width: 100% :width: 100%
:alt: Production environment host layout
Network configuration Network configuration
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
@@ -84,7 +82,7 @@ following is the ``/etc/network/interfaces`` file for ``infra1``.
configuration files are replaced with the appropriate name. The same configuration files are replaced with the appropriate name. The same
applies to additional network interfaces. applies to additional network interfaces.
.. literalinclude:: ../../etc/network/interfaces.d/openstack_interface.cfg.prod.example .. literalinclude:: ../../../../etc/network/interfaces.d/openstack_interface.cfg.prod.example
Deployment configuration Deployment configuration
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -97,7 +95,7 @@ environment layout.
The following configuration describes the layout for this environment. The following configuration describes the layout for this environment.
.. literalinclude:: ../../etc/openstack_deploy/openstack_user_config.yml.prod.example .. literalinclude:: ../../../../etc/openstack_deploy/openstack_user_config.yml.prod.example
Environment customizations Environment customizations
-------------------------- --------------------------
@@ -111,7 +109,7 @@ For this environment, the ``cinder-volume`` runs in a container on the
infrastructure hosts. To achieve this, implement infrastructure hosts. To achieve this, implement
``/etc/openstack_deploy/env.d/cinder.yml`` with the following content: ``/etc/openstack_deploy/env.d/cinder.yml`` with the following content:
.. literalinclude:: ../../etc/openstack_deploy/env.d/cinder-volume.yml.container.example .. literalinclude:: ../../../../etc/openstack_deploy/env.d/cinder-volume.yml.container.example
User variables User variables
-------------- --------------
@@ -123,4 +121,4 @@ For this environment, implement the load balancer on the infrastructure
hosts. Ensure that keepalived is also configured with HAProxy in hosts. Ensure that keepalived is also configured with HAProxy in
``/etc/openstack_deploy/user_variables.yml`` with the following content. ``/etc/openstack_deploy/user_variables.yml`` with the following content.
.. literalinclude:: ../../etc/openstack_deploy/user_variables.yml.prod.example .. literalinclude:: ../../../../etc/openstack_deploy/user_variables.yml.prod.example