From d1fe08b4a73e722486d77a3054b3d19e39d5f4c5 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Sat, 21 May 2016 15:03:32 +0900 Subject: [PATCH] [ha-guide] Reorganize basic services content To sync with installation guides. Change-Id: Ia4df2bdb1f058bb3d8bcf035160463134d115384 Implements: blueprint improve-ha-guide --- doc/ha-guide/source/controller-ha.rst | 4 ---- ...are-ha-basic.rst => environment-hardware.rst} | 16 +++++++++++----- ...a-memcached.rst => environment-memcached.rst} | 1 - .../{install-ha-ntp.rst => environment-ntp.rst} | 0 ...ha-os.rst => environment-operatingsystem.rst} | 0 doc/ha-guide/source/environment.rst | 14 ++++++++++++++ doc/ha-guide/source/hardware-ha.rst | 15 --------------- doc/ha-guide/source/index.rst | 4 ++-- doc/ha-guide/source/install-ha.rst | 12 ------------ ...-config.rst => shared-database-configure.rst} | 1 + ...a-install.rst => shared-database-install.rst} | 3 ++- ...era-manage.rst => shared-database-manage.rst} | 3 ++- ...troller-ha-galera.rst => shared-database.rst} | 11 ++++++----- ...ller-ha-rabbitmq.rst => shared-messaging.rst} | 6 +++--- doc/ha-guide/source/shared-services.rst | 12 ++++++++++++ 15 files changed, 53 insertions(+), 49 deletions(-) rename doc/ha-guide/source/{hardware-ha-basic.rst => environment-hardware.rst} (72%) rename doc/ha-guide/source/{install-ha-memcached.rst => environment-memcached.rst} (99%) rename doc/ha-guide/source/{install-ha-ntp.rst => environment-ntp.rst} (100%) rename doc/ha-guide/source/{install-ha-os.rst => environment-operatingsystem.rst} (100%) create mode 100644 doc/ha-guide/source/environment.rst delete mode 100644 doc/ha-guide/source/hardware-ha.rst delete mode 100644 doc/ha-guide/source/install-ha.rst rename doc/ha-guide/source/{controller-ha-galera-config.rst => shared-database-configure.rst} (99%) rename doc/ha-guide/source/{controller-ha-galera-install.rst => shared-database-install.rst} (99%) rename doc/ha-guide/source/{controller-ha-galera-manage.rst => shared-database-manage.rst} (99%) rename doc/ha-guide/source/{controller-ha-galera.rst => shared-database.rst} (84%) rename doc/ha-guide/source/{controller-ha-rabbitmq.rst => shared-messaging.rst} (98%) create mode 100644 doc/ha-guide/source/shared-services.rst diff --git a/doc/ha-guide/source/controller-ha.rst b/doc/ha-guide/source/controller-ha.rst index 5e58cef3ce..41e68668d8 100644 --- a/doc/ha-guide/source/controller-ha.rst +++ b/doc/ha-guide/source/controller-ha.rst @@ -1,4 +1,3 @@ - ================================================ Configuring the controller for high availability ================================================ @@ -12,9 +11,6 @@ and must talk to all other services. controller-ha-pacemaker.rst controller-ha-vip.rst controller-ha-haproxy.rst - controller-ha-galera.rst controller-ha-memcached.rst - controller-ha-rabbitmq.rst controller-ha-identity.rst controller-ha-telemetry.rst - diff --git a/doc/ha-guide/source/hardware-ha-basic.rst b/doc/ha-guide/source/environment-hardware.rst similarity index 72% rename from doc/ha-guide/source/hardware-ha-basic.rst rename to doc/ha-guide/source/environment-hardware.rst index 31669dc674..ce9c7687c6 100644 --- a/doc/ha-guide/source/hardware-ha-basic.rst +++ b/doc/ha-guide/source/environment-hardware.rst @@ -1,12 +1,19 @@ +============================================= +Hardware considerations for high availability +============================================= + +[TODO: Provide a minimal architecture example for HA, +expanded on that given in +http://docs.openstack.org/mitaka/install-guide-ubuntu/environment.html +for easy comparison] -============== Hardware setup -============== +~~~~~~~~~~~~~~ The standard hardware requirements: -- `Provider networks `_ -- `Self-service networks `_ +- `Provider networks `_ +- `Self-service networks `_ However, OpenStack does not require a significant amount of resources and the following minimum requirements should support @@ -44,4 +51,3 @@ for hardware acceleration of nested VMs. When installing highly-available OpenStack on VMs, be sure that your hypervisor permits promiscuous mode and disables MAC address filtering on the external network. - diff --git a/doc/ha-guide/source/install-ha-memcached.rst b/doc/ha-guide/source/environment-memcached.rst similarity index 99% rename from doc/ha-guide/source/install-ha-memcached.rst rename to doc/ha-guide/source/environment-memcached.rst index a0d65bacc8..e286aa3771 100644 --- a/doc/ha-guide/source/install-ha-memcached.rst +++ b/doc/ha-guide/source/environment-memcached.rst @@ -1,4 +1,3 @@ - ================= Install memcached ================= diff --git a/doc/ha-guide/source/install-ha-ntp.rst b/doc/ha-guide/source/environment-ntp.rst similarity index 100% rename from doc/ha-guide/source/install-ha-ntp.rst rename to doc/ha-guide/source/environment-ntp.rst diff --git a/doc/ha-guide/source/install-ha-os.rst b/doc/ha-guide/source/environment-operatingsystem.rst similarity index 100% rename from doc/ha-guide/source/install-ha-os.rst rename to doc/ha-guide/source/environment-operatingsystem.rst diff --git a/doc/ha-guide/source/environment.rst b/doc/ha-guide/source/environment.rst new file mode 100644 index 0000000000..5be3456f73 --- /dev/null +++ b/doc/ha-guide/source/environment.rst @@ -0,0 +1,14 @@ +======================================= +Basic environment for high availability +======================================= + +This chapter describes the basic environment for high availability, +such as hardware, operating system, common services. + +.. toctree:: + :maxdepth: 2 + + environment-hardware.rst + environment-operatingsystem.rst + environment-ntp.rst + environment-memcached.rst diff --git a/doc/ha-guide/source/hardware-ha.rst b/doc/ha-guide/source/hardware-ha.rst deleted file mode 100644 index 91c03fc8f6..0000000000 --- a/doc/ha-guide/source/hardware-ha.rst +++ /dev/null @@ -1,15 +0,0 @@ - -============================================= -Hardware considerations for high availability -============================================= - -[TODO: Provide a minimal architecture example for HA, -expanded on that given in -http://docs.openstack.org/liberty/install-guide-ubuntu/environment.html -for easy comparison] - - -.. toctree:: - :maxdepth: 2 - - hardware-ha-basic.rst diff --git a/doc/ha-guide/source/index.rst b/doc/ha-guide/source/index.rst index 708ccad7c9..95ad5236cd 100644 --- a/doc/ha-guide/source/index.rst +++ b/doc/ha-guide/source/index.rst @@ -25,8 +25,8 @@ Contents common/conventions.rst intro-ha.rst - hardware-ha.rst - install-ha.rst + environment.rst + shared-services.rst controller-ha.rst networking-ha.rst storage-ha.rst diff --git a/doc/ha-guide/source/install-ha.rst b/doc/ha-guide/source/install-ha.rst deleted file mode 100644 index 7fcfdb6dcb..0000000000 --- a/doc/ha-guide/source/install-ha.rst +++ /dev/null @@ -1,12 +0,0 @@ -===================================== -Installing high availability packages -===================================== - -[TODO -- write intro to this section] - -.. toctree:: - :maxdepth: 2 - - install-ha-os.rst - install-ha-memcached.rst - install-ha-ntp.rst diff --git a/doc/ha-guide/source/controller-ha-galera-config.rst b/doc/ha-guide/source/shared-database-configure.rst similarity index 99% rename from doc/ha-guide/source/controller-ha-galera-config.rst rename to doc/ha-guide/source/shared-database-configure.rst index 8b8ae5b481..2d4f18b9de 100644 --- a/doc/ha-guide/source/controller-ha-galera-config.rst +++ b/doc/ha-guide/source/shared-database-configure.rst @@ -1,3 +1,4 @@ +============== Configuration ============== diff --git a/doc/ha-guide/source/controller-ha-galera-install.rst b/doc/ha-guide/source/shared-database-install.rst similarity index 99% rename from doc/ha-guide/source/controller-ha-galera-install.rst rename to doc/ha-guide/source/shared-database-install.rst index 8c23fe4b7d..936a9ccbb3 100644 --- a/doc/ha-guide/source/controller-ha-galera-install.rst +++ b/doc/ha-guide/source/shared-database-install.rst @@ -1,5 +1,6 @@ +============ Installation -============= +============ Using Galera Cluster requires that you install two packages. The first is the database server, which must include the wsrep API patch. The second diff --git a/doc/ha-guide/source/controller-ha-galera-manage.rst b/doc/ha-guide/source/shared-database-manage.rst similarity index 99% rename from doc/ha-guide/source/controller-ha-galera-manage.rst rename to doc/ha-guide/source/shared-database-manage.rst index 705ab6ace5..48b6d76117 100644 --- a/doc/ha-guide/source/controller-ha-galera-manage.rst +++ b/doc/ha-guide/source/shared-database-manage.rst @@ -1,5 +1,6 @@ +========== Management -=========== +========== When you finish the installation and configuration process on each cluster node in your OpenStack database, you can initialize Galera Cluster. diff --git a/doc/ha-guide/source/controller-ha-galera.rst b/doc/ha-guide/source/shared-database.rst similarity index 84% rename from doc/ha-guide/source/controller-ha-galera.rst rename to doc/ha-guide/source/shared-database.rst index e294839c13..db3ec78deb 100644 --- a/doc/ha-guide/source/controller-ha-galera.rst +++ b/doc/ha-guide/source/shared-database.rst @@ -1,5 +1,6 @@ -Database (Galera Cluster) -========================== +=============================================== +Database (Galera Cluster) for high availability +=============================================== The first step is to install the database that sits at the heart of the cluster. To implement high availability, run an instance of the database on @@ -28,6 +29,6 @@ replication system. .. toctree:: :maxdepth: 2 - controller-ha-galera-install - controller-ha-galera-config - controller-ha-galera-manage + shared-database-install.rst + shared-database-configure.rst + shared-database-manage.rst diff --git a/doc/ha-guide/source/controller-ha-rabbitmq.rst b/doc/ha-guide/source/shared-messaging.rst similarity index 98% rename from doc/ha-guide/source/controller-ha-rabbitmq.rst rename to doc/ha-guide/source/shared-messaging.rst index 02909b56d3..9badad2825 100644 --- a/doc/ha-guide/source/controller-ha-rabbitmq.rst +++ b/doc/ha-guide/source/shared-messaging.rst @@ -1,6 +1,6 @@ -======== -RabbitMQ -======== +======================================= +Messaging service for high availability +======================================= An AMQP (Advanced Message Queuing Protocol) compliant message bus is required for most OpenStack components in order to coordinate the diff --git a/doc/ha-guide/source/shared-services.rst b/doc/ha-guide/source/shared-services.rst new file mode 100644 index 0000000000..0a1c79df02 --- /dev/null +++ b/doc/ha-guide/source/shared-services.rst @@ -0,0 +1,12 @@ +===================================== +Shared services for high availability +===================================== + +This chapter describes the shared services for high availability, +such as database, messaging service. + +.. toctree:: + :maxdepth: 2 + + shared-database.rst + shared-messaging.rst