openstack/openstack-ansible
Code Issues Proposed changes

Fix Install Guide's TOC

Browse Source 
Currently, the Install Guide's Table of Contents starts at Chapter 2.
This commit updates the necessary documents to re-order starting with
Chapter 1.  Additionally, we fix a broken link in
ops-addcomputehost.rst.

Change-Id: I243c06f7d2d6fd1519667310a1886c949abc40c9
This commit is contained in:
Matt Thompson 2015-10-21 12:15:06 +01:00
parent 546a1cce42
commit 74254b1614
14 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/install-guide/configure.rst
View File

@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
Chapter 5. Deployment configuration Chapter 4. Deployment configuration
----------------------------------- -----------------------------------
.. toctree:: .. toctree::
@ -25,7 +25,7 @@ Chapter 5. Deployment configuration
configure-federation.rst configure-federation.rst
**Figure 5.1. Installation work flow** **Figure 4.1. Installation work flow**
.. image:: figures/workflow-configdeployment.png .. image:: figures/workflow-configdeployment.png

6
doc/source/install-guide/deploymenthost.rst
View File

@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
Chapter 3. Deployment host Chapter 2. Deployment host
-------------------------- --------------------------
.. toctree:: .. toctree::
@ -11,7 +11,7 @@ Chapter 3. Deployment host
deploymenthost-sshkeys.rst deploymenthost-sshkeys.rst
**Figure 3.1. Installation work flow** **Figure 2.1. Installation work flow**
.. image:: figures/workflow-deploymenthost.png .. image:: figures/workflow-deploymenthost.png
@ -19,7 +19,7 @@ The OSA installation process recommends one deployment host. The
deployment host contains Ansible and orchestrates the OSA installation deployment host contains Ansible and orchestrates the OSA installation
on the target hosts. One of the target hosts, preferably one of the on the target hosts. One of the target hosts, preferably one of the
infrastructure variants, can be used as the deployment host. To use a infrastructure variants, can be used as the deployment host. To use a
deployment host as a target host, follow the steps in `Chapter 4, deployment host as a target host, follow the steps in `Chapter 3,
*Target hosts* <targethosts.html>`_ on the deployment host. This *Target hosts* <targethosts.html>`_ on the deployment host. This
guide assumes separate deployment and target hosts. guide assumes separate deployment and target hosts.

4
doc/source/install-guide/install-foundation.rst
View File

@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
Chapter 6. Foundation playbooks Chapter 5. Foundation playbooks
------------------------------- -------------------------------
.. toctree:: .. toctree::
@ -8,7 +8,7 @@ Chapter 6. Foundation playbooks
install-foundation-run.rst install-foundation-run.rst
**Figure 6.1. Installation work flow** **Figure 5.1. Installation work flow**
.. image:: figures/workflow-foundationplaybooks.png .. image:: figures/workflow-foundationplaybooks.png

4
doc/source/install-guide/install-infrastructure.rst
View File

@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
Chapter 7. Infrastructure playbooks Chapter 6. Infrastructure playbooks
----------------------------------- -----------------------------------
.. toctree:: .. toctree::
@ -9,7 +9,7 @@ Chapter 7. Infrastructure playbooks
install-infrastructure-verify.rst install-infrastructure-verify.rst
**Figure 7.1. Installation workflow** **Figure 6.1. Installation workflow**
.. image:: figures/workflow-infraplaybooks.png .. image:: figures/workflow-infraplaybooks.png

4
doc/source/install-guide/install-openstack.rst
View File

@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
Chapter 8. OpenStack playbooks Chapter 7. OpenStack playbooks
------------------------------ ------------------------------
.. toctree:: .. toctree::
@ -10,7 +10,7 @@ Chapter 8. OpenStack playbooks
install-openstack-verify.rst install-openstack-verify.rst
**Figure 8.1. Installation work flow** **Figure 7.1. Installation work flow**
.. image:: figures/workflow-openstackplaybooks.png .. image:: figures/workflow-openstackplaybooks.png

4
doc/source/install-guide/ops-addcomputehost.rst
View File

@ -6,8 +6,8 @@ Adding a compute host
Use the following procedure to add a compute host to an operational Use the following procedure to add a compute host to an operational
cluster. cluster.
#. Configure the host as a target host. See `Chapter 4, *Target #. Configure the host as a target host. See `Chapter 3, *Target
hosts* <ch-hosts-target.html>`_ for more information. hosts* <targethosts.html>`_ for more information.
#. Edit the ``/etc/openstack_deploy/openstack_user_config.yml`` file and #. Edit the ``/etc/openstack_deploy/openstack_user_config.yml`` file and
add the host to the ``compute_hosts`` stanza. add the host to the ``compute_hosts`` stanza.

2
doc/source/install-guide/ops.rst
View File

@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
Chapter 9. Operations Chapter 8. Operations
--------------------- ---------------------
.. toctree:: .. toctree::

2
doc/source/install-guide/overview-hostlayout.rst
View File

@ -76,7 +76,7 @@ Compute target hosts contain the following services:
- Block Storage volumes - Block Storage volumes
**Figure 2.1. Host Layout Overview** **Figure 1.1. Host Layout Overview**
.. image:: figures/environment-overview.png .. image:: figures/environment-overview.png

12
doc/source/install-guide/overview-hostnetworking.rst
View File

@ -28,12 +28,12 @@ random names for ``veth`` pairs.
The relationship between physical interfaces, logical interfaces, The relationship between physical interfaces, logical interfaces,
bridges, and virtual interfaces within containers is shown in bridges, and virtual interfaces within containers is shown in
`Figure 2.2, "Network `Figure 1.2, "Network
components" <overview-hostnetworking.html#fig_overview_networkcomponents>`_. components" <overview-hostnetworking.html#fig_overview_networkcomponents>`_.
   
**Figure 2.2. Network components** **Figure 1.2. Network components**
.. image:: figures/networkcomponents.png .. image:: figures/networkcomponents.png
@ -92,19 +92,19 @@ Target hosts can contain the following network bridges:
container. Does not contain an IP address because it only handles container. Does not contain an IP address because it only handles
layer 2 connectivity. layer 2 connectivity.
`Figure 2.3, "Container network `Figure 1.3, "Container network
architecture" <overview-hostnetworking.html#fig_overview_networkarch-container>`_ architecture" <overview-hostnetworking.html#fig_overview_networkarch-container>`_
provides a visual representation of network components for services in provides a visual representation of network components for services in
containers. containers.
   
**Figure 2.3. Container network architecture** **Figure 1.3. Container network architecture**
.. image:: figures/networkarch-container-external.png .. image:: figures/networkarch-container-external.png
By default, OSA installs the Compute service in a bare metal By default, OSA installs the Compute service in a bare metal
environment rather than within a container. `Figure 2.4, "Bare/Metal environment rather than within a container. `Figure 1.4, "Bare/Metal
network network
architecture" <overview-hostnetworking.html#fig_overview_networkarch-bare>`_ architecture" <overview-hostnetworking.html#fig_overview_networkarch-bare>`_
provides a visual representation of the unique layout of network provides a visual representation of the unique layout of network
@ -112,7 +112,7 @@ components on a Compute host.
   
**Figure 2.4. Bare/Metal network architecture** **Figure 1.4. Bare/Metal network architecture**
.. image:: figures/networkarch-bare-external.png .. image:: figures/networkarch-bare-external.png

8
doc/source/install-guide/overview-neutron.rst
View File

@ -5,25 +5,25 @@ OpenStack Networking
OpenStack Networking (neutron) is configured to use a DHCP agent, L3 OpenStack Networking (neutron) is configured to use a DHCP agent, L3
Agent and Linux Bridge agent within a networking agents container. Agent and Linux Bridge agent within a networking agents container.
`Figure 2.5, "Networking agents `Figure 1.5, "Networking agents
containers" <overview-neutron.html#fig_overview_neutron-agents>`_ containers" <overview-neutron.html#fig_overview_neutron-agents>`_
shows the interaction of these agents, network components, and shows the interaction of these agents, network components, and
connection to a physical network. connection to a physical network.
   
**Figure 2.5. Networking agents containers** **Figure 1.5. Networking agents containers**
.. image:: figures/networking-neutronagents.png .. image:: figures/networking-neutronagents.png
The Compute service uses the KVM hypervisor. `Figure 2.6, "Compute The Compute service uses the KVM hypervisor. `Figure 1.6, "Compute
hosts" <overview-neutron.html#fig_overview_neutron-compute>`_ shows hosts" <overview-neutron.html#fig_overview_neutron-compute>`_ shows
the interaction of instances, Linux Bridge agent, network components, the interaction of instances, Linux Bridge agent, network components,
and connection to a physical network. and connection to a physical network.
   
**Figure 2.6. Compute hosts** **Figure 1.6. Compute hosts**
.. image:: figures/networking-compute.png .. image:: figures/networking-compute.png

2
doc/source/install-guide/overview-workflow.rst
View File

@ -6,7 +6,7 @@ Installation workflow
This diagram shows the general workflow associated with OSA This diagram shows the general workflow associated with OSA
installation. installation.
**Figure 2.7. Installation workflow** **Figure 1.7. Installation workflow**
.. image:: figures/workflow-overview.png .. image:: figures/workflow-overview.png

2
doc/source/install-guide/overview.rst
View File

@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
Chapter 2. Overview Chapter 1. Overview
------------------- -------------------
.. toctree:: .. toctree::

8
doc/source/install-guide/targethosts-networkexample.rst
View File

@ -4,10 +4,10 @@ Configuring the network on a target host
---------------------------------------- ----------------------------------------
This example uses the following parameters to configure networking on a This example uses the following parameters to configure networking on a
single target host. See `Figure 4.2, "Target hosts for infrastructure, single target host. See `Figure 3.2, "Target hosts for infrastructure,
networking, and storage networking, and storage
services" <targethosts-networkexample.html#fig_hosts-target-network-containerexample>`_ services" <targethosts-networkexample.html#fig_hosts-target-network-containerexample>`_
and `Figure 4.3, "Target hosts for Compute and `Figure 3.3, "Target hosts for Compute
service" <targethosts-networkexample.html#fig_hosts-target-network-bareexample>`_ service" <targethosts-networkexample.html#fig_hosts-target-network-bareexample>`_
for a visual representation of these parameters in the architecture. for a visual representation of these parameters in the architecture.
@ -47,12 +47,12 @@ for a visual representation of these parameters in the architecture.
   
**Figure 4.2. Target hosts for infrastructure, networking, and storage **Figure 3.2. Target hosts for infrastructure, networking, and storage
services** services**
.. image:: figures/networkarch-container-external-example.png .. image:: figures/networkarch-container-external-example.png
**Figure 4.3. Target hosts for Compute service** **Figure 3.3. Target hosts for Compute service**
.. image:: figures/networkarch-bare-external-example.png .. image:: figures/networkarch-bare-external-example.png

4
doc/source/install-guide/targethosts.rst
View File

@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
Chapter 4. Target hosts Chapter 3. Target hosts
----------------------- -----------------------
.. toctree:: .. toctree::
@ -14,7 +14,7 @@ Chapter 4. Target hosts
targethosts-networkexample.rst targethosts-networkexample.rst
**Figure 4.1. Installation workflow** **Figure 3.1. Installation workflow**
.. image:: figures/workflow-targethosts.png .. image:: figures/workflow-targethosts.png