From ca2e0298ad8fec53f643dc8bd63f60d5c396ed91 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Sat, 21 May 2016 19:51:35 +0900 Subject: [PATCH] [ha-guide] consolidate service names Change-Id: I12c56383775c2d679286ef2deae93836b407aa35 Implements: blueprint improve-ha-guide --- ...eystone.rst => controller-ha-identity.rst} | 27 +++++++++---------- .../source/controller-ha-telemetry.rst | 11 ++++---- doc/ha-guide/source/controller-ha.rst | 2 +- doc/ha-guide/source/index.rst | 2 +- doc/ha-guide/source/networking-ha-dhcp.rst | 10 +++---- doc/ha-guide/source/networking-ha-l3.rst | 11 +++----- doc/ha-guide/source/networking-ha-lbaas.rst | 10 +++---- .../source/networking-ha-metadata.rst | 10 +++---- doc/ha-guide/source/networking-ha.rst | 20 +++++++------- ...age-ha-cinder.rst => storage-ha-block.rst} | 15 +++++------ ...manila.rst => storage-ha-file-systems.rst} | 15 +++++------ ...age-ha-glance.rst => storage-ha-image.rst} | 6 ++--- doc/ha-guide/source/storage-ha.rst | 8 +++--- 13 files changed, 59 insertions(+), 88 deletions(-) rename doc/ha-guide/source/{controller-ha-keystone.rst => controller-ha-identity.rst} (88%) rename doc/ha-guide/source/{storage-ha-cinder.rst => storage-ha-block.rst} (97%) rename doc/ha-guide/source/{storage-ha-manila.rst => storage-ha-file-systems.rst} (93%) rename doc/ha-guide/source/{storage-ha-glance.rst => storage-ha-image.rst} (97%) diff --git a/doc/ha-guide/source/controller-ha-keystone.rst b/doc/ha-guide/source/controller-ha-identity.rst similarity index 88% rename from doc/ha-guide/source/controller-ha-keystone.rst rename to doc/ha-guide/source/controller-ha-identity.rst index 5e239e989b..295a835e6d 100644 --- a/doc/ha-guide/source/controller-ha-keystone.rst +++ b/doc/ha-guide/source/controller-ha-identity.rst @@ -1,23 +1,20 @@ +============================= +Highly available Identity API +============================= -============================ -Identity services (keystone) -============================ - -OpenStack Identity (keystone) -is the Identity service in OpenStack that is used by many services. You should be familiar with -`OpenStack identity concepts -`_ -before proceeding. +`OpenStack Identity service +`_ +before proceeding, which is used by many services. Making the OpenStack Identity service highly available in active / passive mode involves: -- :ref:`keystone-pacemaker` -- :ref:`keystone-config-identity` -- :ref:`keystone-services-config` +- :ref:`identity-pacemaker` +- :ref:`identity-config-identity` +- :ref:`identity-services-config` -.. _keystone-pacemaker: +.. _identity-pacemaker: Add OpenStack Identity resource to Pacemaker ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -66,7 +63,7 @@ Add OpenStack Identity resource to Pacemaker Pacemaker then starts the OpenStack Identity service and its dependent resources on one of your nodes. -.. _keystone-config-identity: +.. _identity-config-identity: Configure OpenStack Identity service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -97,7 +94,7 @@ Configure OpenStack Identity service ... -.. _keystone-services-config: +.. _identity-services-config: Configure OpenStack services to use the highly available OpenStack Identity ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/ha-guide/source/controller-ha-telemetry.rst b/doc/ha-guide/source/controller-ha-telemetry.rst index 51de7b259d..ab047cedda 100644 --- a/doc/ha-guide/source/controller-ha-telemetry.rst +++ b/doc/ha-guide/source/controller-ha-telemetry.rst @@ -1,9 +1,10 @@ +============================== +Highly available Telemetry API +============================== -========= -Telemetry -========= - -[TODO (Add Telemetry overview)] +`Telemetry service +_ +provides data collection service and alarming service. Telemetry central agent ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/ha-guide/source/controller-ha.rst b/doc/ha-guide/source/controller-ha.rst index 7ba0d48590..5e58cef3ce 100644 --- a/doc/ha-guide/source/controller-ha.rst +++ b/doc/ha-guide/source/controller-ha.rst @@ -15,6 +15,6 @@ and must talk to all other services. controller-ha-galera.rst controller-ha-memcached.rst controller-ha-rabbitmq.rst - controller-ha-keystone.rst + controller-ha-identity.rst controller-ha-telemetry.rst diff --git a/doc/ha-guide/source/index.rst b/doc/ha-guide/source/index.rst index 8752640459..3344c070c1 100644 --- a/doc/ha-guide/source/index.rst +++ b/doc/ha-guide/source/index.rst @@ -27,8 +27,8 @@ Contents intro-ha.rst hardware-ha.rst install-ha.rst - networking-ha.rst controller-ha.rst + networking-ha.rst storage-ha.rst compute-node-ha.rst noncore-ha.rst diff --git a/doc/ha-guide/source/networking-ha-dhcp.rst b/doc/ha-guide/source/networking-ha-dhcp.rst index ad37dab146..fd306b0ba9 100644 --- a/doc/ha-guide/source/networking-ha-dhcp.rst +++ b/doc/ha-guide/source/networking-ha-dhcp.rst @@ -1,9 +1,6 @@ - -.. _dhcp-agent: - -====================== -Run neutron DHCP agent -====================== +========================= +Run Networking DHCP agent +========================= The OpenStack Networking service has a scheduler that lets you run multiple agents across nodes; @@ -14,4 +11,3 @@ in the :file:`/etc/neutron/neutron.conf` file. By default this is set to 1. To achieve high availability, assign more than one DHCP agent per network. - diff --git a/doc/ha-guide/source/networking-ha-l3.rst b/doc/ha-guide/source/networking-ha-l3.rst index 511e25cfb6..495efbda96 100644 --- a/doc/ha-guide/source/networking-ha-l3.rst +++ b/doc/ha-guide/source/networking-ha-l3.rst @@ -1,9 +1,6 @@ - -.. _neutron-l3: - -==================== -Run neutron L3 agent -==================== +======================= +Run Networking L3 agent +======================= The neutron L3 agent is scalable, due to the scheduler that supports Virtual Router Redundancy Protocol (VRRP) @@ -33,5 +30,3 @@ to set the following values: - Minimum number of network nodes to use for the HA router. A new router can be created only if this number of network nodes are available. - - diff --git a/doc/ha-guide/source/networking-ha-lbaas.rst b/doc/ha-guide/source/networking-ha-lbaas.rst index e0a6a23741..311429adf0 100644 --- a/doc/ha-guide/source/networking-ha-lbaas.rst +++ b/doc/ha-guide/source/networking-ha-lbaas.rst @@ -1,9 +1,6 @@ - -.. _neutron-lbaas: - -======================= -Run neutron LBaaS agent -======================= +========================== +Run Networking LBaaS agent +========================== Currently, no native feature is provided to make the LBaaS agent highly available @@ -14,4 +11,3 @@ Unfortunately, this is not yet implemented in the LBaaS HAProxy plug-in. [TODO: update this section.] - diff --git a/doc/ha-guide/source/networking-ha-metadata.rst b/doc/ha-guide/source/networking-ha-metadata.rst index fa4f10d4a7..78a696f31b 100644 --- a/doc/ha-guide/source/networking-ha-metadata.rst +++ b/doc/ha-guide/source/networking-ha-metadata.rst @@ -1,9 +1,6 @@ - -.. _neutron-metadata: - -========================== -Run neutron metadata agent -========================== +============================= +Run Networking metadata agent +============================= No native feature is available to make this service highly available. @@ -15,4 +12,3 @@ in failover mode with Pacemaker. Can this service now be made HA in active/active mode or do we need to pull in the instructions to run this service in active/passive mode?] - diff --git a/doc/ha-guide/source/networking-ha.rst b/doc/ha-guide/source/networking-ha.rst index b53d943278..f038592bf4 100644 --- a/doc/ha-guide/source/networking-ha.rst +++ b/doc/ha-guide/source/networking-ha.rst @@ -1,11 +1,10 @@ - -======================= -OpenStack network nodes -======================= +========================================= +Networking services for high availability +========================================= Configure networking on each node. The -`Networking `_ +`Networking `_ section of the *Install Guide* includes basic information about configuring networking. @@ -33,16 +32,16 @@ are related.] OpenStack network nodes contain: -- :ref:`Neutron DHCP agent` -- Neutron L2 agent. +- :doc:`Networking DHCP agent` +- Networking L2 agent. Note that the L2 agent cannot be distributed and highly available. Instead, it must be installed on each data forwarding node to control the virtual network drivers such as Open vSwitch or Linux Bridge. One L2 agent runs per node and controls its virtual interfaces. -- :ref:`Neutron L3 agent` -- :ref:`Neutron metadata agent` -- :ref:`Neutron LBaaS` (Load Balancing as a Service) agent +- :doc:`Neutron L3 agent` +- :doc:`Neutron metadata agent` +- :doc:`Neutron LBaaS agent` .. note:: @@ -57,4 +56,3 @@ OpenStack network nodes contain: networking-ha-l3.rst networking-ha-metadata.rst networking-ha-lbaas.rst - diff --git a/doc/ha-guide/source/storage-ha-cinder.rst b/doc/ha-guide/source/storage-ha-block.rst similarity index 97% rename from doc/ha-guide/source/storage-ha-cinder.rst rename to doc/ha-guide/source/storage-ha-block.rst index 545ee9e67a..6742814684 100644 --- a/doc/ha-guide/source/storage-ha-cinder.rst +++ b/doc/ha-guide/source/storage-ha-block.rst @@ -1,6 +1,3 @@ -.. highlight: ini - :linenothreshold: 5 - ================================== Highly available Block Storage API ================================== @@ -16,9 +13,9 @@ also has volume snapshots capability for backing up the volumes. Making this Block Storage API service highly available in active/passive mode involves: -- :ref:`ha-cinder-pacemaker` -- :ref:`ha-cinder-configure` -- :ref:`ha-cinder-services` +- :ref:`ha-blockstorage-pacemaker` +- :ref:`ha-blockstorage-configure` +- :ref:`ha-blockstorage-services` In theory, you can run the Block Storage service as active/active. However, because of sufficient concerns, it is recommended running @@ -67,7 +64,7 @@ and there is a for addressing them upstream. -.. _ha-cinder-pacemaker: +.. _ha-blockstorage-pacemaker: Add Block Storage API resource to Pacemaker ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -133,7 +130,7 @@ by entering :command:`commit` from the :command:`crm configure` menu. Pacemaker then starts the Block Storage API service and its dependent resources on one of your nodes. -.. _ha-cinder-configure: +.. _ha-blockstorage-configure: Configure Block Storage API service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -212,7 +209,7 @@ be filled in for you, resulting in a shorter configuration file: Replace ``CINDER_DBPASS`` with the password you chose for the Block Storage database. -.. _ha-cinder-services: +.. _ha-blockstorage-services: Configure OpenStack services to use highly available Block Storage API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/ha-guide/source/storage-ha-manila.rst b/doc/ha-guide/source/storage-ha-file-systems.rst similarity index 93% rename from doc/ha-guide/source/storage-ha-manila.rst rename to doc/ha-guide/source/storage-ha-file-systems.rst index a07e07c2f6..421b79bb42 100644 --- a/doc/ha-guide/source/storage-ha-manila.rst +++ b/doc/ha-guide/source/storage-ha-file-systems.rst @@ -1,6 +1,3 @@ -.. highlight: ini - :linenothreshold: 5 - ======================================== Highly available Shared File Systems API ======================================== @@ -8,11 +5,11 @@ Highly available Shared File Systems API Making the Shared File Systems (manila) API service highly available in active/passive mode involves: -- :ref:`ha-manila-pacemaker` -- :ref:`ha-manila-configure` -- :ref:`ha-manila-services` +- :ref:`ha-sharedfilesystems-pacemaker` +- :ref:`ha-sharedfilesystems-configure` +- :ref:`ha-sharedfilesystems-services` -.. _ha-manila-pacemaker: +.. _ha-sharedfilesystems-pacemaker: Add Shared File Systems API resource to Pacemaker ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -53,7 +50,7 @@ from the :command:`crm configure` menu. Pacemaker then starts the Shared File Systems API service and its dependent resources on one of your nodes. -.. _ha-manila-configure: +.. _ha-sharedfilesystems-configure: Configure Shared File Systems API service ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -74,7 +71,7 @@ Edit the :file:`/etc/manila/manila.conf` file: rabbit_host = 10.0.0.11 -.. _ha-manila-services: +.. _ha-sharedfilesystems-services: Configure OpenStack services to use HA Shared File Systems API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/ha-guide/source/storage-ha-glance.rst b/doc/ha-guide/source/storage-ha-image.rst similarity index 97% rename from doc/ha-guide/source/storage-ha-glance.rst rename to doc/ha-guide/source/storage-ha-image.rst index f3bc93e578..6ce3b9f8e2 100644 --- a/doc/ha-guide/source/storage-ha-glance.rst +++ b/doc/ha-guide/source/storage-ha-image.rst @@ -1,6 +1,6 @@ -==================================== -Highly available OpenStack Image API -==================================== +========================== +Highly available Image API +========================== The OpenStack Image service offers a service for discovering, registering, and retrieving virtual machine images. diff --git a/doc/ha-guide/source/storage-ha.rst b/doc/ha-guide/source/storage-ha.rst index c853277ce1..06117da386 100644 --- a/doc/ha-guide/source/storage-ha.rst +++ b/doc/ha-guide/source/storage-ha.rst @@ -5,9 +5,7 @@ Configuring Storage for high availability .. toctree:: :maxdepth: 2 - storage-ha-cinder.rst - storage-ha-glance.rst - storage-ha-manila.rst + storage-ha-image.rst + storage-ha-block.rst + storage-ha-file-systems.rst storage-ha-backend.rst - -