From a44d075bcbcb7453f567eb18045d72082042286d Mon Sep 17 00:00:00 2001 From: Robb Romans Date: Mon, 16 May 2016 17:14:45 -0500 Subject: [PATCH] Docs: Fix bulleted lists and spacing Minor changes to improve the wording in a few bulleted lists. Clean up some spacing and a couple links. Change-Id: I74831a07188106270362ceaf5bb2b9ecbb3f6af2 --- .../install-guide/install-foundation.rst | 12 ++-- .../install-guide/install-infrastructure.rst | 68 +++++++++---------- .../install-guide/install-openstack.rst | 68 +++++++++---------- 3 files changed, 74 insertions(+), 74 deletions(-) diff --git a/doc/source/install-guide/install-foundation.rst b/doc/source/install-guide/install-foundation.rst index 14c501b1e5..779f824ec0 100644 --- a/doc/source/install-guide/install-foundation.rst +++ b/doc/source/install-guide/install-foundation.rst @@ -12,21 +12,21 @@ The main Ansible foundation playbook prepares the target hosts for infrastructure and OpenStack services and performs the following operations: -- Perform deployment host initial setup +- Performs deployment host initial setup -- Build containers on target hosts +- Builds containers on target hosts -- Restart containers on target hosts +- Restarts containers on target hosts -- Install common components into containers on target hosts +- Installs common components into containers on target hosts Running the foundation playbook ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. seealso:: +.. note:: Before continuing, validate the configuration files using the - guidance in "`Checking the integrity of your configuration files`_". + guidance in `Checking the integrity of your configuration files`_. .. _Checking the integrity of your configuration files: ../install-guide/configure-configurationintegrity.html diff --git a/doc/source/install-guide/install-infrastructure.rst b/doc/source/install-guide/install-infrastructure.rst index 3a0b44e7cc..75d0527d3b 100644 --- a/doc/source/install-guide/install-infrastructure.rst +++ b/doc/source/install-guide/install-infrastructure.rst @@ -11,25 +11,25 @@ Chapter 6. Infrastructure playbooks The main Ansible infrastructure playbook installs infrastructure services and performs the following operations: -- Install Memcached +- Installs Memcached -- Install the repository server +- Installs the repository server -- Install Galera +- Installs Galera -- Install RabbitMQ +- Installs RabbitMQ -- Install Rsyslog +- Installs Rsyslog -- Configure Rsyslog +- Configures Rsyslog Running the infrastructure playbook ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. seealso:: +.. note:: - Before continuing, the configuration files may be validated using the - guidance in "`Checking the integrity of your configuration files`_". + 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 @@ -39,53 +39,53 @@ Running the infrastructure playbook .. code-block:: shell-session - # openstack-ansible setup-infrastructure.yml + # openstack-ansible setup-infrastructure.yml Confirm satisfactory completion with zero items unreachable or failed: .. code-block:: shell-session - PLAY RECAP ******************************************************************** - ... - deployment_host : ok=27 changed=0 unreachable=0 failed=0 + PLAY RECAP ******************************************************************** + ... + deployment_host : ok=27 changed=0 unreachable=0 failed=0 Verify the database cluster ~~~~~~~~~~~~~~~~~~~~~~~~~~~ #. Change to the ``/opt/openstack-ansible/playbooks`` directory. -#. Execute the following to show the current cluster state: +#. Execute the following command to show the current cluster state: .. code-block:: shell-session - # ansible galera_container -m shell -a "mysql \ - -h localhost -e 'show status like \"%wsrep_cluster_%\";'" + # ansible galera_container -m shell -a "mysql \ + -h localhost -e 'show status like \"%wsrep_cluster_%\";'" Example output: .. code-block:: shell-session - node3_galera_container-3ea2cbd3 | success | rc=0 >> - Variable_name Value - wsrep_cluster_conf_id 17 - wsrep_cluster_size 3 - wsrep_cluster_state_uuid 338b06b0-2948-11e4-9d06-bef42f6c52f1 - wsrep_cluster_status Primary + node3_galera_container-3ea2cbd3 | success | rc=0 >> + Variable_name Value + wsrep_cluster_conf_id 17 + wsrep_cluster_size 3 + wsrep_cluster_state_uuid 338b06b0-2948-11e4-9d06-bef42f6c52f1 + wsrep_cluster_status Primary - node2_galera_container-49a47d25 | success | rc=0 >> - Variable_name Value - wsrep_cluster_conf_id 17 - wsrep_cluster_size 3 - wsrep_cluster_state_uuid 338b06b0-2948-11e4-9d06-bef42f6c52f1 - wsrep_cluster_status Primary + node2_galera_container-49a47d25 | success | rc=0 >> + Variable_name Value + wsrep_cluster_conf_id 17 + wsrep_cluster_size 3 + wsrep_cluster_state_uuid 338b06b0-2948-11e4-9d06-bef42f6c52f1 + wsrep_cluster_status Primary - node4_galera_container-76275635 | success | rc=0 >> - Variable_name Value - wsrep_cluster_conf_id 17 - wsrep_cluster_size 3 - wsrep_cluster_state_uuid 338b06b0-2948-11e4-9d06-bef42f6c52f1 - wsrep_cluster_status Primary + node4_galera_container-76275635 | success | rc=0 >> + Variable_name Value + wsrep_cluster_conf_id 17 + wsrep_cluster_size 3 + wsrep_cluster_state_uuid 338b06b0-2948-11e4-9d06-bef42f6c52f1 + wsrep_cluster_status Primary The ``wsrep_cluster_size`` field indicates the number of nodes in the cluster and the ``wsrep_cluster_status`` field indicates diff --git a/doc/source/install-guide/install-openstack.rst b/doc/source/install-guide/install-openstack.rst index ae1828d217..7507febf5d 100644 --- a/doc/source/install-guide/install-openstack.rst +++ b/doc/source/install-guide/install-openstack.rst @@ -11,25 +11,25 @@ Chapter 7. OpenStack playbooks The ``setup-openstack.yml`` playbook installs OpenStack services and performs the following operations: -- Install Identity (keystone) +- Installs Identity (keystone) -- Install the Image service (glance) +- Installs the Image service (glance) -- Install Block Storage (cinder) +- Installs Block Storage (cinder) -- Install Compute (nova) +- Installs Compute (nova) -- Install Networking (neutron) +- Installs Networking (neutron) -- Install Orchestration (heat) +- Installs Orchestration (heat) -- Install Dashboard (horizon) +- Installs Dashboard (horizon) -- Install Telemetry (ceilometer and aodh) +- Installs Telemetry (ceilometer and aodh) -- Install Object Storage (swift) +- Installs Object Storage (swift) -- Install Ironic +- Installs Ironic Running the OpenStack playbook ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -40,7 +40,7 @@ Running the OpenStack playbook .. code-block:: shell-session - # openstack-ansible setup-openstack.yml + # openstack-ansible setup-openstack.yml Confirm satisfactory completion with zero items unreachable or failed. @@ -72,44 +72,44 @@ configuration and testing. .. code-block:: shell-session - # lxc-ls | grep utility - infra1_utility_container-161a4084 + # lxc-ls | grep utility + infra1_utility_container-161a4084 #. Access the utility container: .. code-block:: shell-session - # lxc-attach -n infra1_utility_container-161a4084 + # lxc-attach -n infra1_utility_container-161a4084 #. Source the ``admin`` tenant credentials: .. code-block:: shell-session - # source /root/openrc + # source /root/openrc #. Run an OpenStack command that uses one or more APIs. For example: .. code-block:: shell-session - # openstack user list - +----------------------------------+--------------------+ - | ID | Name | - +----------------------------------+--------------------+ - | 08fe5eeeae314d578bba0e47e7884f3a | alt_demo | - | 0aa10040555e47c09a30d2240e474467 | dispersion | - | 10d028f9e47b4d1c868410c977abc3df | glance | - | 249f9ad93c024f739a17ca30a96ff8ee | demo | - | 39c07b47ee8a47bc9f9214dca4435461 | swift | - | 3e88edbf46534173bc4fd8895fa4c364 | cinder | - | 41bef7daf95a4e72af0986ec0583c5f4 | neutron | - | 4f89276ee4304a3d825d07b5de0f4306 | admin | - | 943a97a249894e72887aae9976ca8a5e | nova | - | ab4f0be01dd04170965677e53833e3c3 | stack_domain_admin | - | ac74be67a0564722b847f54357c10b29 | heat | - | b6b1d5e76bc543cda645fa8e778dff01 | ceilometer | - | dc001a09283a404191ff48eb41f0ffc4 | aodh | - | e59e4379730b41209f036bbeac51b181 | keystone | - +----------------------------------+--------------------+ + # openstack user list + +----------------------------------+--------------------+ + | ID | Name | + +----------------------------------+--------------------+ + | 08fe5eeeae314d578bba0e47e7884f3a | alt_demo | + | 0aa10040555e47c09a30d2240e474467 | dispersion | + | 10d028f9e47b4d1c868410c977abc3df | glance | + | 249f9ad93c024f739a17ca30a96ff8ee | demo | + | 39c07b47ee8a47bc9f9214dca4435461 | swift | + | 3e88edbf46534173bc4fd8895fa4c364 | cinder | + | 41bef7daf95a4e72af0986ec0583c5f4 | neutron | + | 4f89276ee4304a3d825d07b5de0f4306 | admin | + | 943a97a249894e72887aae9976ca8a5e | nova | + | ab4f0be01dd04170965677e53833e3c3 | stack_domain_admin | + | ac74be67a0564722b847f54357c10b29 | heat | + | b6b1d5e76bc543cda645fa8e778dff01 | ceilometer | + | dc001a09283a404191ff48eb41f0ffc4 | aodh | + | e59e4379730b41209f036bbeac51b181 | keystone | + +----------------------------------+--------------------+ **Procedure 8.2. Verifying the dashboard**