[Docs] Move network architecture into reference

Move all the design considerations into reference.

Change-Id: I5e5b4e85140b73871f2ba6a4d5264cb21de9f337
This commit is contained in:
Jean-Philippe Evrard 2018-02-21 08:53:00 +00:00
parent d27e329a5a
commit 99ca16e85e
13 changed files with 34 additions and 21 deletions

View File

@ -6,8 +6,6 @@ Appendices
:maxdepth: 2 :maxdepth: 2
app-custom-layouts.rst app-custom-layouts.rst
app-security.rst
app-networking.rst
app-limited-connectivity.rst app-limited-connectivity.rst
app-advanced-config-sslcertificates.rst app-advanced-config-sslcertificates.rst
app-resources.rst app-resources.rst

View File

@ -9,7 +9,9 @@ hosts requires manual configuration because it varies from one use case to
another. This section describes the network configuration that must be another. This section describes the network configuration that must be
implemented on all target hosts. implemented on all target hosts.
For more information about how networking works, see :ref:`network-appendix`. For more information about how networking works, see the
:dev_docs:`OpenStack-Ansible Reference Architecture, section Container
Networking <reference/architecture/index.html>`.
Host network bridges Host network bridges
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~

View File

@ -1,8 +1,8 @@
.. _network-appendix: .. _container-networking:
================================ ====================
Appendix G: Container networking Container networking
================================ ====================
OpenStack-Ansible deploys Linux containers (LXC) and uses Linux OpenStack-Ansible deploys Linux containers (LXC) and uses Linux
bridging between the container and the host interfaces to ensure that bridging between the container and the host interfaces to ensure that
@ -53,7 +53,7 @@ namespaces.
The following image demonstrates how the container network interfaces are The following image demonstrates how the container network interfaces are
connected to the host's bridges and physical network interfaces: connected to the host's bridges and physical network interfaces:
.. image:: figures/networkcomponents.png .. image:: ../figures/networkcomponents.png
Network diagrams Network diagrams
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@ -64,7 +64,7 @@ Hosts with services running in containers
The following diagram shows how all of the interfaces and bridges interconnect The following diagram shows how all of the interfaces and bridges interconnect
to provide network connectivity to the OpenStack deployment: to provide network connectivity to the OpenStack deployment:
.. image:: figures/networkarch-container-external.png .. image:: ../figures/networkarch-container-external.png
The interface ``lxcbr0`` provides connectivity for the containers to the The interface ``lxcbr0`` provides connectivity for the containers to the
outside world, thanks to dnsmasq (dhcp/dns) + NAT. outside world, thanks to dnsmasq (dhcp/dns) + NAT.
@ -84,7 +84,7 @@ OpenStack-Ansible deploys the Compute service on the physical host rather than
in a container. The following diagram shows how to use bridges for in a container. The following diagram shows how to use bridges for
network connectivity: network connectivity:
.. image:: figures/networkarch-bare-external.png .. image:: ../figures/networkarch-bare-external.png
Neutron traffic Neutron traffic
--------------- ---------------
@ -96,12 +96,12 @@ networking-agents container. The diagram shows how DHCP agents provide
information (IP addresses and DNS servers) to the instances, and how routing information (IP addresses and DNS servers) to the instances, and how routing
works on the image. works on the image.
.. image:: figures/networking-neutronagents.png .. image:: ../figures/networking-neutronagents.png
The following diagram shows how virtual machines connect to the ``br-vlan`` and The following diagram shows how virtual machines connect to the ``br-vlan`` and
``br-vxlan`` bridges and send traffic to the network outside the host: ``br-vxlan`` bridges and send traffic to the network outside the host:
.. image:: figures/networking-compute.png .. image:: ../figures/networking-compute.png
.. _openstack-user-config-reference: .. _openstack-user-config-reference:
@ -112,7 +112,7 @@ The ``openstack_user_config.yml.example`` file is heavily commented with the
details of how to do more advanced container networking configuration. The details of how to do more advanced container networking configuration. The
contents of the file are shown here for reference. contents of the file are shown here for reference.
.. literalinclude:: ../../etc/openstack_deploy/openstack_user_config.yml.example .. literalinclude:: ../../../../etc/openstack_deploy/openstack_user_config.yml.example
:language: yaml :language: yaml
:start-after: under the License. :start-after: under the License.

View File

@ -0,0 +1,15 @@
============
Architecture
============
Many operational requirements have been taken into consideration for
the design of the OpenStack-Ansible project.
In this chapter, you can find details about `why` OpenStack-Ansible
was architected in this way.
.. toctree::
:maxdepth: 1
security.rst
container-networking.rst

View File

@ -1,15 +1,11 @@
==================== Security
Appendix F: Security ========
====================
Security is one of the top priorities within OpenStack-Ansible (OSA), and many Security is one of the top priorities within OpenStack-Ansible (OSA), and many
security enhancements for OpenStack clouds are available in deployments by security enhancements for OpenStack clouds are available in deployments by
default. This appendix provides a detailed overview of the most important default. This section provides a detailed overview of the most important
security enhancements. security enhancements.
For more information about configuring security, see
:deploy_guide:`Appendix H <app-advanced-config-options.html>`.
.. note:: .. note::
Every deployer has different security requirements. Every deployer has different security requirements.
@ -33,7 +29,8 @@ certificates, keys, and CA certificates.
To learn more about how to customize the deployment of encrypted To learn more about how to customize the deployment of encrypted
communications, see communications, see
:deploy_guide:`Securing services with SSL certificates <app-advanced-config-sslcertificates.html>`. :deploy_guide:`Securing services with SSL
certificates <app-advanced-config-sslcertificates.html>`.
Host security hardening Host security hardening
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~

View File

Before

Width:  |  Height:  |  Size: 104 KiB

After

Width:  |  Height:  |  Size: 104 KiB

View File

Before

Width:  |  Height:  |  Size: 107 KiB

After

Width:  |  Height:  |  Size: 107 KiB

View File

Before

Width:  |  Height:  |  Size: 180 KiB

After

Width:  |  Height:  |  Size: 180 KiB

View File

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

View File

Before

Width:  |  Height:  |  Size: 114 KiB

After

Width:  |  Height:  |  Size: 114 KiB

View File

Before

Width:  |  Height:  |  Size: 134 KiB

After

Width:  |  Height:  |  Size: 134 KiB

View File

@ -25,5 +25,6 @@ see the :dev_docs:`Contributors Guide <contributor/index.html>`.
conventions.rst conventions.rst
inventory/inventory.rst inventory/inventory.rst
configuration/advanced-config.rst configuration/advanced-config.rst
architecture/index.rst
commands/reference.rst commands/reference.rst
upgrades/reference.rst upgrades/reference.rst