From 73c45a810847d7c852b7198ea54b105755579a15 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Evrard Date: Tue, 20 Feb 2018 15:29:45 +0000 Subject: [PATCH] [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 --- deploy-guide/source/app.rst | 2 -- .../user}/figures/arch-layout-production.png | Bin .../user}/figures/arch-layout-production.svg | 0 doc/source/user/index.rst | 2 ++ .../source/user/l3pods/example.rst | 21 +++++++---------- .../source/user/prod/example.rst | 22 ++++++++---------- 6 files changed, 21 insertions(+), 26 deletions(-) rename {deploy-guide/source => doc/source/user}/figures/arch-layout-production.png (100%) rename {deploy-guide/source => doc/source/user}/figures/arch-layout-production.svg (100%) rename deploy-guide/source/app-config-pod.rst => doc/source/user/l3pods/example.rst (90%) rename deploy-guide/source/app-config-prod.rst => doc/source/user/prod/example.rst (86%) diff --git a/deploy-guide/source/app.rst b/deploy-guide/source/app.rst index 80f3e6f6ea..36249563d7 100644 --- a/deploy-guide/source/app.rst +++ b/deploy-guide/source/app.rst @@ -5,8 +5,6 @@ Appendices .. toctree:: :maxdepth: 2 - app-config-prod.rst - app-config-pod.rst app-config-prod-ceph.rst app-custom-layouts.rst app-security.rst diff --git a/deploy-guide/source/figures/arch-layout-production.png b/doc/source/user/figures/arch-layout-production.png similarity index 100% rename from deploy-guide/source/figures/arch-layout-production.png rename to doc/source/user/figures/arch-layout-production.png diff --git a/deploy-guide/source/figures/arch-layout-production.svg b/doc/source/user/figures/arch-layout-production.svg similarity index 100% rename from deploy-guide/source/figures/arch-layout-production.svg rename to doc/source/user/figures/arch-layout-production.svg diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 0753ce1055..b32282b217 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -24,3 +24,5 @@ For in-depth technical information, see the aio/quickstart.rst test/example.rst + prod/example.rst + l3pods/example.rst diff --git a/deploy-guide/source/app-config-pod.rst b/doc/source/user/l3pods/example.rst similarity index 90% rename from deploy-guide/source/app-config-pod.rst rename to doc/source/user/l3pods/example.rst index 8abd16cf86..2e0f3cedf7 100644 --- a/deploy-guide/source/app-config-pod.rst +++ b/doc/source/user/l3pods/example.rst @@ -1,13 +1,10 @@ .. _pod-environment-config: -============================================================ -Appendix C: Example layer 3 routed environment configuration -============================================================ +========================== +Routed environment example +========================== -Introduction -~~~~~~~~~~~~ - -This appendix describes an example production environment for a working +This section describes an example production environment for a working OpenStack-Ansible (OSA) deployment with high availability services where provider networks and connectivity between physical machines are routed (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 usable address within each network's subnet. -.. image:: figures/arch-layout-production.png +.. image:: ../figures/arch-layout-production.png :width: 100% 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 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 ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -130,7 +127,7 @@ pods. 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 -------------------------- @@ -144,7 +141,7 @@ For this environment, the ``cinder-volume`` runs in a container on the infrastructure hosts. To achieve this, implement ``/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 -------------- @@ -156,4 +153,4 @@ For this environment, implement the load balancer on the infrastructure hosts. Ensure that keepalived is also configured with HAProxy in ``/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 diff --git a/deploy-guide/source/app-config-prod.rst b/doc/source/user/prod/example.rst similarity index 86% rename from deploy-guide/source/app-config-prod.rst rename to doc/source/user/prod/example.rst index 5eb105102f..b0ce936f45 100644 --- a/deploy-guide/source/app-config-prod.rst +++ b/doc/source/user/prod/example.rst @@ -1,13 +1,10 @@ .. _production-environment-config: -======================================================== -Appendix B: Example production environment configuration -======================================================== +====================== +Production environment +====================== -Introduction -~~~~~~~~~~~~ - -This appendix describes an example production environment for a working +This is an example production environment for a working OpenStack-Ansible (OSA) deployment with high availability services. 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 Management Network -.. image:: figures/arch-layout-production.png +.. image:: ../figures/arch-layout-production.png :width: 100% + :alt: Production environment host layout 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 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 ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -97,7 +95,7 @@ environment layout. 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 -------------------------- @@ -111,7 +109,7 @@ For this environment, the ``cinder-volume`` runs in a container on the infrastructure hosts. To achieve this, implement ``/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 -------------- @@ -123,4 +121,4 @@ For this environment, implement the load balancer on the infrastructure hosts. Ensure that keepalived is also configured with HAProxy in ``/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