openstack/openstack-ansible
Code Issues Proposed changes

Merge "Docs: Installation section - cleanup"

Browse Source
This commit is contained in:
Jenkins 2016-05-03 10:53:48 +00:00 committed by Gerrit Code Review
commit 4c393d8b01
3 changed files with 32 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,7 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
===============================
Chapter 5. Foundation playbooks
-------------------------------
===============================
**Figure 5.1. Installation work flow**
@ -22,14 +23,16 @@ operations:
Running the foundation playbook
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. seealso:: Before continuing, the configuration files may be validated using the
.. seealso::
Before continuing, validate the configuration files using the
guidance in "`Checking the integrity of your configuration files`_".
.. _Checking the integrity of your configuration files: ../install-guide/configure-configurationintegrity.html
#. Change to the ``/opt/openstack-ansible/playbooks`` directory.
#. Run the host setup playbook, which runs a series of sub-playbooks:
#. Run the host setup playbook:
.. code-block:: shell-session
@ -48,10 +51,9 @@ Running the foundation playbook
.. note::
If you plan to run haproxy on multiple hosts, you'll need keepalived
to make haproxy highly-available. The keepalived role should have
been downloaded during the bootstrap-ansible stage. If not, you should
rerun the following command before running the haproxy playbook:
To run HAProxy on multiple hosts, use ``keepalived`` to make HAProxy highly
available. The keepalived role downloads during the ``bootstrap-ansible`` stage.
If not, re-run the following command before running the HAProxy playbook:
.. code-block:: shell-session
@ -63,7 +65,7 @@ Running the foundation playbook
# ansible-galaxy install -r ../ansible-role-requirements.yml
Run the playbook to deploy haproxy:
Run the playbook to deploy HAProxy:
.. code-block:: shell-session

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

@ -1,7 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
===================================
Chapter 6. Infrastructure playbooks
-----------------------------------
===================================
**Figure 6.1. Installation workflow**
@ -34,8 +35,7 @@ Running the infrastructure playbook
#. Change to the ``/opt/openstack-ansible/playbooks`` directory.
#. Run the infrastructure setup playbook, which runs a series of
sub-playbooks:
#. Run the infrastructure setup playbook:
.. code-block:: shell-session
@ -62,7 +62,7 @@ Verify the database cluster
# ansible galera_container -m shell -a "mysql \
-h localhost -e 'show status like \"%wsrep_cluster_%\";'"
The results should look something like:
Example output:
.. code-block:: shell-session
@ -87,8 +87,8 @@ Verify the database cluster
wsrep_cluster_state_uuid 338b06b0-2948-11e4-9d06-bef42f6c52f1
wsrep_cluster_status Primary
The ``wsrep_cluster_size`` field should indicate the number of nodes
in the cluster and the ``wsrep_cluster_status`` field should indicate
The ``wsrep_cluster_size`` field indicates the number of nodes
in the cluster and the ``wsrep_cluster_status`` field indicates
primary.
--------------

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

@ -1,7 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide
==============================
Chapter 7. OpenStack playbooks
------------------------------
==============================
**Figure 7.1. Installation work flow**
@ -12,7 +13,7 @@ performs the following operations:
- Install common components
- Create utility container that provides utilities to interact with
- Create a utility container that provides utilities to interact with
services in other containers
- Install Identity (keystone)
@ -38,18 +39,17 @@ Running the OpenStack playbook
#. Change to the ``/opt/openstack-ansible/playbooks`` directory.
#. Run the OpenStack setup playbook, which runs a series of
sub-playbooks:
#. Run the OpenStack setup playbook:
.. code-block:: shell-session
# openstack-ansible setup-openstack.yml
The openstack-common.yml sub-playbook builds all OpenStack services
The ``openstack-common.yml`` sub-playbook builds all OpenStack services
from source and takes up to 30 minutes to complete. As the playbook
progresses, the quantity of containers in the "polling" state will
approach zero. If any operations take longer than 30 minutes to
complete, the playbook will terminate with an error.
progresses, the quantity of containers in the polling state
approaches zero. If any operations take longer than 30 minutes to
complete, the playbook terminates with an error.
.. code-block:: shell-session
@ -80,10 +80,10 @@ Running the OpenStack playbook
<job 802849856578.7322> polling, 1675s remaining
<job 802849856578.7319> polling, 1675s remaining
Setting up the compute hosts will take up to another 30 minutes to
Setting up the compute hosts takes up to another 30 minutes to
complete, particularly in environments with many compute hosts. If
any operations take longer than 30 minutes to complete, the playbook
will terminate with an error.
terminates with an error.
.. code-block:: shell-session
@ -112,16 +112,14 @@ Utility container
~~~~~~~~~~~~~~~~~
The utility container provides a space where miscellaneous tools and
other software can be installed. Tools and objects can be placed in a
software are installed. Tools and objects are placed in a
utility container if they do not require a dedicated container or if it
is impractical to create a new container for a single tool or object.
Utility containers can also be used when tools cannot be installed
Utility containers are also used when tools cannot be installed
directly onto a host.
For example, the tempest playbooks are installed on the utility
container since tempest testing does not need a container of its own.
For another example of using the utility container, see "Verifying
OpenStack operation".
Verifying OpenStack operation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -187,8 +185,10 @@ configuration and testing.
``keystone_auth_admin_password`` option in the
``/etc/openstack_deploy/user_variables.yml`` file.
Uploading public images using the dashboard or CLI can only be performed
by users with administrator privileges.
.. note::
Only users with administrator privileges can upload public images
using the dashboard or CLI.
--------------