From f899ee2e0e42d3e106c9e1c916aff0c92f486a48 Mon Sep 17 00:00:00 2001
From: Jesse Pretorius <jesse.pretorius@rackspace.co.uk>
Date: Mon, 6 Mar 2017 16:25:25 +0000
Subject: [PATCH] Add openstack_user_config reference to Networking Appendix

In order to expose the contents of the example file in the
documentation, and therefore to search indexing, the contents
of the file are literally included in the Networking Appendix.

Change-Id: I98374e71a578ddbb5704b0177c59b55016ea85c0
---
 deploy-guide/source/app-networking.rst          | 17 +++++++++++++++--
 deploy-guide/source/configure.rst               |  1 +
 .../source/targethosts-networkconfig.rst        |  3 +++
 3 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/deploy-guide/source/app-networking.rst b/deploy-guide/source/app-networking.rst
index 3a9d6f43ef..83e8bbcd23 100644
--- a/deploy-guide/source/app-networking.rst
+++ b/deploy-guide/source/app-networking.rst
@@ -73,8 +73,8 @@ outside world, thanks to dnsmasq (dhcp/dns) + NAT.
 
    If you require additional network configuration for your container interfaces
    (like changing the routes on eth1 for routes on the management network),
-   please adapt your ``openstack_user_config.yml`` file, with the help of the
-   heavily documented ``openstack_user_config.yml.example`` file.
+   please adapt your ``openstack_user_config.yml`` file.
+   See :ref:`openstack-user-config-reference` for more details.
 
 
 Services running "on metal" (deploying directly on the physical hosts)
@@ -103,3 +103,16 @@ The following diagram shows how virtual machines connect to the ``br-vlan`` and
 
 .. image:: figures/networking-compute.png
 
+.. _openstack-user-config-reference:
+
+Reference for openstack_user_config settings
+--------------------------------------------
+
+The ``openstack_user_config.yml.example`` file is heavily commented with the
+details of how to do more advanced container networking configuration. The
+contents of the file are shown here for reference.
+
+.. literalinclude:: ../../etc/openstack_deploy/openstack_user_config.yml.example
+   :language: yaml
+   :start-after: under the License.
+
diff --git a/deploy-guide/source/configure.rst b/deploy-guide/source/configure.rst
index 4c8306b1a1..f36ad3bb0c 100644
--- a/deploy-guide/source/configure.rst
+++ b/deploy-guide/source/configure.rst
@@ -40,6 +40,7 @@ host.
    .. note::
 
       The file is heavily commented with details about the various options.
+      See :ref:`openstack-user-config-reference` 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
diff --git a/deploy-guide/source/targethosts-networkconfig.rst b/deploy-guide/source/targethosts-networkconfig.rst
index e1446606f9..e7c5804706 100644
--- a/deploy-guide/source/targethosts-networkconfig.rst
+++ b/deploy-guide/source/targethosts-networkconfig.rst
@@ -22,5 +22,8 @@ The following table shows bridges that are to be configured on hosts.
 |             | On every compute node | Never                               |
 +-------------+-----------------------+-------------------------------------+
 
+For a detailed reference of how the host and container networking is
+implemented, refer to :ref:`network-appendix`.
+
 For use case examples, refer to :ref:`test-environment-config` and
 :ref:`production-environment-config`.