Merge "[config-ref] add common configuration links"

2016-07-05 07:12:08 +00:00 · 2016-07-05 07:12:08 +00:00 · 0b332f739c
commit 0b332f739c
parent 7502b725cd 74ba269f44
14 changed files with 80 additions and 0 deletions
--- a/doc/config-reference/source/bare-metal.rst
+++ b/doc/config-reference/source/bare-metal.rst
@ -6,6 +6,12 @@ The Bare Metal service is capable of managing and provisioning physical
 machines. The configuration file of this module is
 ``/etc/ironic/ironic.conf``.

+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
+
 The following tables provide a comprehensive list of the Bare Metal
 service configuration options.

--- a/doc/config-reference/source/block-storage.rst
+++ b/doc/config-reference/source/block-storage.rst
@ -16,5 +16,11 @@ Block Storage service
   block-storage/volume-misc.rst
   tables/conf-changes/cinder.rst

+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
+
 The Block Storage service works with many different storage
 drivers that you can configure by using these instructions.
--- a/doc/config-reference/source/compute.rst
+++ b/doc/config-reference/source/compute.rst
@ -28,6 +28,12 @@ which is the main part of an IaaS system.
 You can use OpenStack Compute to host and manage cloud computing systems.
 This section describes the Compute service configuration options.

+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
+
 To configure your Compute installation,
 you must define configuration options in these files:

--- a/doc/config-reference/source/config-overview.rst
+++ b/doc/config-reference/source/config-overview.rst
@ -30,3 +30,7 @@ options for the following OpenStack components:
 * Orchestration service
 * Shared File Systems service
 * Telemetry service
+
+Also, OpenStack uses many shared service and libraries,
+such as database connections and RPC messaging,
+whose configuration options are described at :doc:`common-configurations`.
--- a/doc/config-reference/source/dashboard.rst
+++ b/doc/config-reference/source/dashboard.rst
@ -13,3 +13,9 @@ Dashboard

 This chapter describes how to configure the Dashboard with
 Apache web server.
+
+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
--- a/doc/config-reference/source/data-processing-service.rst
+++ b/doc/config-reference/source/data-processing-service.rst
@ -9,6 +9,12 @@ Data Processing service
 The Data Processing service (sahara) provides a scalable data-processing stack
 and associated management interfaces.

+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
+
 The following tables provide a comprehensive list of the Data Processing
 service configuration options:

--- a/doc/config-reference/source/identity.rst
+++ b/doc/config-reference/source/identity.rst
@ -16,3 +16,9 @@ installation prerequisites and step-by-step walkthroughs, see the OpenStack
 Installation Guide for your distribution (`docs.openstack.org
 <http://docs.openstack.org>`__) and `OpenStack Administrator Guide
 <http://docs.openstack.org/admin-guide/>`__.
+
+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
--- a/doc/config-reference/source/image-service.rst
+++ b/doc/config-reference/source/image-service.rst
@ -16,6 +16,12 @@ maintain a catalog of available images. By default, Compute is configured to
 use the Image service (glance), which is currently the only supported image
 service.

+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
+
 To customize the Compute service, use the configuration option settings
 documented in :ref:`nova-glance`.

--- a/doc/config-reference/source/messaging.rst
+++ b/doc/config-reference/source/messaging.rst
@ -88,3 +88,9 @@ options in these files:
  v2. Resides in the ``/etc/zaqar`` directory. If there is a file
  ``policy.json`` in ``~/.zaqar`` directory, it is used instead of the one in
  ``/etc/zaqar`` directory. See :doc:`../policy-json-file`.
+
+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
--- a/doc/config-reference/source/networking.rst
+++ b/doc/config-reference/source/networking.rst
@ -18,3 +18,9 @@ For installation prerequisites, steps, and use cases, see the OpenStack
 Installation Guide for your distribution
 (`docs.openstack.org <http://docs.openstack.org>`__) and the
 `OpenStack Administrator Guide <http://docs.openstack.org/admin-guide/>`__.
+
+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
--- a/doc/config-reference/source/object-storage.rst
+++ b/doc/config-reference/source/object-storage.rst
@ -13,3 +13,9 @@ Object Storage service
   object-storage/listendpoints.rst
   object-storage/logs.rst
   tables/conf-changes/swift.rst
+
+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
--- a/doc/config-reference/source/orchestration.rst
+++ b/doc/config-reference/source/orchestration.rst
@ -18,6 +18,12 @@ configured in the ``/etc/heat/heat.conf`` file.
 To install Orchestration, see the OpenStack Installation Guide for your
 distribution (`docs.openstack.org <http://docs.openstack.org>`__).

+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
+
 The following tables provide a comprehensive list of the Orchestration
 configuration options:

--- a/doc/config-reference/source/shared-file-systems.rst
+++ b/doc/config-reference/source/shared-file-systems.rst
@ -15,3 +15,8 @@ Shared File Systems service
 The Shared File Systems service works with many different drivers that
 you can configure by using these instructions.

+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.
--- a/doc/config-reference/source/telemetry.rst
+++ b/doc/config-reference/source/telemetry.rst
@ -18,3 +18,8 @@ various agents and services are configured in the
 To install Telemetry, see the OpenStack Installation Guide for your
 distribution (`docs.openstack.org <http://docs.openstack.org>`__).

+.. note::
+
+   The common configurations for shared service and libraries,
+   such as database connections and RPC messaging,
+   are described at :doc:`common-configurations`.