[Docs] Include test scenario as a new user story
This moves the appendix of the deploy guide into our user stories. Change-Id: I0c0985987fba4610f825a36619aa2b043a730613
This commit is contained in:
parent
dc8d6256ce
commit
3d76d5e2e2
@ -5,7 +5,6 @@ Appendices
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
app-config-test.rst
|
||||
app-config-prod.rst
|
||||
app-config-pod.rst
|
||||
app-config-prod-ceph.rst
|
||||
|
@ -39,8 +39,9 @@ host.
|
||||
|
||||
.. note::
|
||||
|
||||
The file is heavily commented with details about the various options.
|
||||
See :ref:`openstack-user-config-reference` for more details.
|
||||
This file is heavily commented with details about the various options.
|
||||
See our :dev_docs:`User Guide <user/index.html>` and
|
||||
:dev_docs:`Reference Guide <reference/index.html>` for more details.
|
||||
|
||||
The configuration in the ``openstack_user_config.yml`` file defines which hosts
|
||||
run the containers and services deployed by OpenStack-Ansible. For
|
||||
@ -55,16 +56,12 @@ individually in the example file as they are contained in the os-infra hosts.
|
||||
You can specify image-hosts or dashboard-hosts if you want to scale out in a
|
||||
specific manner.
|
||||
|
||||
For examples, please see :ref:`test-environment-config`,
|
||||
:ref:`production-environment-config`, and :ref:`pod-environment-config`
|
||||
For examples, please see our :dev_docs:`User Guides <user/index.html>`
|
||||
|
||||
For details about how the inventory is generated from the environment
|
||||
configuration, see
|
||||
`developer-inventory <https://docs.openstack.org/openstack-ansible/latest/reference/index.html>`_.
|
||||
|
||||
For details about how variable precedence works, and how to override
|
||||
group vars, see
|
||||
`developer-inventory-and-vars <https://docs.openstack.org/openstack-ansible/latest/contributor/inventory-and-vars.html>`_.
|
||||
For details about how the inventory is generated, from the environment
|
||||
configuration and the variable precedence, see our
|
||||
:dev_docs:`Reference Guide <reference/index.html>` under the inventory
|
||||
section.
|
||||
|
||||
Installing additional services
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
@ -23,7 +23,9 @@ The following table shows bridges that are to be configured on hosts.
|
||||
+-------------+-----------------------+-------------------------------------+
|
||||
|
||||
For a detailed reference of how the host and container networking is
|
||||
implemented, refer to :ref:`network-appendix`.
|
||||
implemented, refer to
|
||||
:dev_docs:`OpenStack-Ansible Reference Architecture, section Container
|
||||
Networking <reference/architecture/index.html>`.
|
||||
|
||||
For use case examples, refer to :ref:`test-environment-config` and
|
||||
:ref:`production-environment-config`.
|
||||
For use case examples, refer to
|
||||
:dev_docs:`User Guides <user/index.html>`.
|
||||
|
Before Width: | Height: | Size: 215 KiB After Width: | Height: | Size: 215 KiB |
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
@ -23,3 +23,4 @@ For in-depth technical information, see the
|
||||
:maxdepth: 1
|
||||
|
||||
aio/quickstart.rst
|
||||
test/example.rst
|
||||
|
@ -1,13 +1,8 @@
|
||||
.. _test-environment-config:
|
||||
========================
|
||||
Test environment example
|
||||
========================
|
||||
|
||||
==================================================
|
||||
Appendix A: Example test environment configuration
|
||||
==================================================
|
||||
|
||||
Introduction
|
||||
~~~~~~~~~~~~
|
||||
|
||||
This appendix describes an example test environment for a working
|
||||
Here is an example test environment for a working
|
||||
OpenStack-Ansible (OSA) deployment with a small number of servers.
|
||||
|
||||
This example environment has the following characteristics:
|
||||
@ -20,7 +15,7 @@ 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-test.png
|
||||
.. image:: ../figures/arch-layout-test.png
|
||||
:width: 100%
|
||||
:alt: Test environment host layout
|
||||
|
||||
@ -71,7 +66,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.test.example
|
||||
.. literalinclude:: ../../../../etc/network/interfaces.d/openstack_interface.cfg.test.example
|
||||
|
||||
Deployment configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@ -84,7 +79,7 @@ environment layout.
|
||||
|
||||
The following configuration describes the layout for this environment.
|
||||
|
||||
.. literalinclude:: ../../etc/openstack_deploy/openstack_user_config.yml.test.example
|
||||
.. literalinclude:: ../../../../etc/openstack_deploy/openstack_user_config.yml.test.example
|
||||
|
||||
Environment customizations
|
||||
--------------------------
|
||||
@ -103,10 +98,10 @@ User variables
|
||||
The ``/etc/openstack_deploy/user_variables.yml`` file defines the global
|
||||
overrides for the default variables.
|
||||
|
||||
For this environment, you are using the same IP address for the internal
|
||||
and external endpoints. You will need to ensure that the internal and public
|
||||
For this environment, if you want to use the same IP address for the internal
|
||||
and external endpoints, you will need to ensure that the internal and public
|
||||
OpenStack endpoints are served with the same protocol. This is done with
|
||||
the following content:
|
||||
|
||||
.. literalinclude:: ../../etc/openstack_deploy/user_variables.yml.test.example
|
||||
.. literalinclude:: ../../../../etc/openstack_deploy/user_variables.yml.test.example
|
||||
|
Loading…
Reference in New Issue
Block a user