Skip to content

Commit

Permalink
Fix Install Guide's TOC
Browse files Browse the repository at this point in the history
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
  • Loading branch information
mattt416 committed Oct 21, 2015
1 parent 546a1cc commit 74254b1
Show file tree
Hide file tree
Showing 14 changed files with 33 additions and 33 deletions.
4 changes: 2 additions & 2 deletions doc/source/install-guide/configure.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide

Chapter 5. Deployment configuration
Chapter 4. Deployment configuration
-----------------------------------

.. toctree::
Expand All @@ -25,7 +25,7 @@ Chapter 5. Deployment configuration
configure-federation.rst


**Figure 5.1. Installation work flow**
**Figure 4.1. Installation work flow**

.. image:: figures/workflow-configdeployment.png

Expand Down
6 changes: 3 additions & 3 deletions doc/source/install-guide/deploymenthost.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide

Chapter 3. Deployment host
Chapter 2. Deployment host
--------------------------

.. toctree::
Expand All @@ -11,15 +11,15 @@ Chapter 3. Deployment host
deploymenthost-sshkeys.rst


**Figure 3.1. Installation work flow**
**Figure 2.1. Installation work flow**

.. image:: figures/workflow-deploymenthost.png

The OSA installation process recommends one deployment host. The
deployment host contains Ansible and orchestrates the OSA installation
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
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
guide assumes separate deployment and target hosts.

Expand Down
4 changes: 2 additions & 2 deletions doc/source/install-guide/install-foundation.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide

Chapter 6. Foundation playbooks
Chapter 5. Foundation playbooks
-------------------------------

.. toctree::

install-foundation-run.rst


**Figure 6.1. Installation work flow**
**Figure 5.1. Installation work flow**

.. image:: figures/workflow-foundationplaybooks.png

Expand Down
4 changes: 2 additions & 2 deletions doc/source/install-guide/install-infrastructure.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide

Chapter 7. Infrastructure playbooks
Chapter 6. Infrastructure playbooks
-----------------------------------

.. toctree::
Expand All @@ -9,7 +9,7 @@ Chapter 7. Infrastructure playbooks
install-infrastructure-verify.rst


**Figure 7.1. Installation workflow**
**Figure 6.1. Installation workflow**

.. image:: figures/workflow-infraplaybooks.png

Expand Down
4 changes: 2 additions & 2 deletions doc/source/install-guide/install-openstack.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide

Chapter 8. OpenStack playbooks
Chapter 7. OpenStack playbooks
------------------------------

.. toctree::
Expand All @@ -10,7 +10,7 @@ Chapter 8. OpenStack playbooks
install-openstack-verify.rst


**Figure 8.1. Installation work flow**
**Figure 7.1. Installation work flow**

.. image:: figures/workflow-openstackplaybooks.png

Expand Down
4 changes: 2 additions & 2 deletions doc/source/install-guide/ops-addcomputehost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Adding a compute host
Use the following procedure to add a compute host to an operational
cluster.

#. Configure the host as a target host. See `Chapter 4, *Target
hosts* <ch-hosts-target.html>`_ for more information.
#. Configure the host as a target host. See `Chapter 3, *Target
hosts* <targethosts.html>`_ for more information.

#. Edit the ``/etc/openstack_deploy/openstack_user_config.yml`` file and
add the host to the ``compute_hosts`` stanza.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/install-guide/ops.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide

Chapter 9. Operations
Chapter 8. Operations
---------------------

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion doc/source/install-guide/overview-hostlayout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Compute target hosts contain the following services:
- Block Storage volumes


**Figure 2.1. Host Layout Overview**
**Figure 1.1. Host Layout Overview**

.. image:: figures/environment-overview.png

Expand Down
12 changes: 6 additions & 6 deletions doc/source/install-guide/overview-hostnetworking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ random names for ``veth`` pairs.

The relationship between physical interfaces, logical interfaces,
bridges, and virtual interfaces within containers is shown in
`Figure 2.2, "Network
`Figure 1.2, "Network
components" <overview-hostnetworking.html#fig_overview_networkcomponents>`_.



**Figure 2.2. Network components**
**Figure 1.2. Network components**

.. image:: figures/networkcomponents.png

Expand Down Expand Up @@ -92,27 +92,27 @@ Target hosts can contain the following network bridges:
container. Does not contain an IP address because it only handles
layer 2 connectivity.

`Figure 2.3, "Container network
`Figure 1.3, "Container network
architecture" <overview-hostnetworking.html#fig_overview_networkarch-container>`_
provides a visual representation of network components for services in
containers.



**Figure 2.3. Container network architecture**
**Figure 1.3. Container network architecture**

.. image:: figures/networkarch-container-external.png

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
architecture" <overview-hostnetworking.html#fig_overview_networkarch-bare>`_
provides a visual representation of the unique layout of network
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

Expand Down
8 changes: 4 additions & 4 deletions doc/source/install-guide/overview-neutron.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@ OpenStack Networking

OpenStack Networking (neutron) is configured to use a DHCP agent, L3
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>`_
shows the interaction of these agents, network components, and
connection to a physical network.



**Figure 2.5. Networking agents containers**
**Figure 1.5. Networking agents containers**

.. 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
the interaction of instances, Linux Bridge agent, network components,
and connection to a physical network.



**Figure 2.6. Compute hosts**
**Figure 1.6. Compute hosts**

.. image:: figures/networking-compute.png

Expand Down
2 changes: 1 addition & 1 deletion doc/source/install-guide/overview-workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Installation workflow
This diagram shows the general workflow associated with OSA
installation.

**Figure 2.7. Installation workflow**
**Figure 1.7. Installation workflow**

.. image:: figures/workflow-overview.png

Expand Down
2 changes: 1 addition & 1 deletion doc/source/install-guide/overview.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide

Chapter 2. Overview
Chapter 1. Overview
-------------------

.. toctree::
Expand Down
8 changes: 4 additions & 4 deletions doc/source/install-guide/targethosts-networkexample.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Configuring the network on a target host
----------------------------------------

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
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>`_
for a visual representation of these parameters in the architecture.

Expand Down Expand Up @@ -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**

.. 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

Expand Down
4 changes: 2 additions & 2 deletions doc/source/install-guide/targethosts.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide

Chapter 4. Target hosts
Chapter 3. Target hosts
-----------------------

.. toctree::
Expand All @@ -14,7 +14,7 @@ Chapter 4. Target hosts
targethosts-networkexample.rst


**Figure 4.1. Installation workflow**
**Figure 3.1. Installation workflow**

.. image:: figures/workflow-targethosts.png

Expand Down

0 comments on commit 74254b1

Please sign in to comment.