add configuration instructions from admin guide and dev docs7.0.4

- move cinder and keystone configuration instructions from admin
guide to install guide so we have all meter enabling steps in
same place.
- move heat and neutron config to install guide.

Change-Id: Ibc8096e3fb6c95886c3bddafb927600fe506415d
(cherry picked from commit 9105e194c73628202715e9d24f59a69a5392a71e)

13 files changed, 221 insertions, 99 deletions

diff --git a/doc/source/install/manual.rst b/doc/source/install/manual.rst
index 9c2f83bb..967b712d 100644
--- a/doc/source/install/manual.rst
+++ b/doc/source/install/manual.rst
@@ -444,84 +444,7 @@ Installing the API Server
 Enabling Service Notifications
 ==============================
 
-Cinder
-------
+See the `install guide`_ for instructions on how to enable meters for specific
+OpenStack services.
 
-Edit ``cinder.conf`` to include::
-
-  [oslo_messaging_notifications]
-  driver = messagingv2
-
-Glance
-------
-
-Edit ``glance.conf`` to include::
-
-  [oslo_messaging_notifications]
-  driver = messagingv2
-
-Heat
-----
-
-Configure the driver in ``heat.conf``::
-
-  [oslo_messaging_notifications]
-  driver=messagingv2
-
-Neutron
-------
-
-Edit ``neutron.conf`` to include::
-
-  [oslo_messaging_notifications]
-  driver = messagingv2
-
-Nova
-----
-
-Edit ``nova.conf`` to include::
-
-  [DEFAULT]
-  instance_usage_audit=True
-  instance_usage_audit_period=hour
-  notify_on_state_change=vm_and_task_state
-
-  [oslo_messaging_notifications]
-  driver=messagingv2
-
-
-Sahara
-------
-
-Configure the driver in ``sahara.conf``::
-
-  [DEFAULT]
-  enable_notifications=true
-
-  [oslo_messaging_notifications]
-  driver=messagingv2
-
-
-Swift
------
-
-Edit ``proxy-server.conf`` to include::
-
-  [filter:ceilometer]
-  topic = notifications
-  driver = messaging
-  url = rabbit://stackrabbit:openstack1@10.0.2.15:5672/
-  control_exchange = swift
-  paste.filter_factory = ceilometermiddleware.swift:filter_factory
-  set log_level = WARN
-
-and edit [pipeline:main] to include the ceilometer middleware before the application::
-
-  [pipeline:main]
-  pipeline = catch_errors ... ... ceilometer proxy-server
-
-
-Also, you need to configure messaging related options correctly as written above
-for other parts of installation guide. Refer to :doc:`/configuration` for
-details about any other options you might want to modify before starting the
-service.
+.. _`install guide`: https://docs.openstack.org/project-install-guide/telemetry/draft/install-controller.html
diff --git a/install-guide/source/cinder/install-cinder-config-common.inc b/install-guide/source/cinder/install-cinder-config-common.inc
new file mode 100644
index 00000000..2cd492de
--- /dev/null
+++ b/install-guide/source/cinder/install-cinder-config-common.inc
@@ -0,0 +1,16 @@
+* Enable periodic usage statistics relating to block storage. To use it, you
+  must run this command in the following format:
+
+  .. code-block:: console
+
+     $ cinder-volume-usage-audit  --start_time='YYYY-MM-DD HH:MM:SS' \
+       --end_time='YYYY-MM-DD HH:MM:SS' --send_actions
+
+  This script outputs what volumes or snapshots were created, deleted, or
+  exists in a given period of time and some information about these
+  volumes or snapshots.
+
+  Using this script via cron you can get notifications periodically, for
+  example, every 5 minutes::
+
+       */5 * * * * /path/to/cinder-volume-usage-audit --send_actions
diff --git a/install-guide/source/cinder/install-cinder-obs.rst b/install-guide/source/cinder/install-cinder-obs.rst
index 3e7557f3..757522b6 100644
--- a/install-guide/source/cinder/install-cinder-obs.rst
+++ b/install-guide/source/cinder/install-cinder-obs.rst
@@ -22,6 +22,8 @@ following actions:
      ...
      driver = messagingv2
 
+.. include:: install-cinder-config-common.inc
+
 Finalize installation
 ---------------------
 
@@ -36,9 +38,3 @@ Finalize installation
    .. code-block:: console
 
       # systemctl restart openstack-cinder-volume.service
-
-#. Use the ``cinder-volume-usage-audit`` command on Block Storage nodes
-   to retrieve meters on demand. For more information, see the
-   `OpenStack Administrator Guide <http://docs.openstack.org/admin-guide/
-   telemetry-data-collection.html#block-storage-audit-script-setup-to-get-
-   notifications>`__.
diff --git a/install-guide/source/cinder/install-cinder-rdo.rst b/install-guide/source/cinder/install-cinder-rdo.rst
index 75877e0b..981a1bc6 100644
--- a/install-guide/source/cinder/install-cinder-rdo.rst
+++ b/install-guide/source/cinder/install-cinder-rdo.rst
@@ -22,6 +22,8 @@ following actions:
      ...
      driver = messagingv2
 
+.. include:: install-cinder-config-common.inc
+
 Finalize installation
 ---------------------
 
@@ -36,9 +38,3 @@ Finalize installation
    .. code-block:: console
 
       # systemctl restart openstack-cinder-volume.service
-
-#. Use the ``cinder-volume-usage-audit`` command on Block Storage nodes
-   to retrieve meters on demand. For more information, see the
-   `OpenStack Administrator Guide <http://docs.openstack.org/admin-guide/
-   telemetry-data-collection.html#block-storage-audit-script-setup-to-get-
-   notifications>`__.
diff --git a/install-guide/source/cinder/install-cinder-ubuntu.rst b/install-guide/source/cinder/install-cinder-ubuntu.rst
index 8049542d..95f2ccf2 100644
--- a/install-guide/source/cinder/install-cinder-ubuntu.rst
+++ b/install-guide/source/cinder/install-cinder-ubuntu.rst
@@ -22,6 +22,8 @@ following actions:
      ...
      driver = messagingv2
 
+.. include:: install-cinder-config-common.inc
+
 Finalize installation
 ---------------------
 
@@ -37,9 +39,3 @@ Finalize installation
    .. code-block:: console
 
       # service cinder-volume restart
-
-#. Use the ``cinder-volume-usage-audit`` command on Block Storage nodes
-   to retrieve meters on demand. For more information, see the
-   `OpenStack Administrator Guide <http://docs.openstack.org/admin-guide/
-   telemetry-data-collection.html#block-storage-audit-script-setup-to-get-
-   notifications>`__.
diff --git a/install-guide/source/heat/install-heat-obs.rst b/install-guide/source/heat/install-heat-obs.rst
new file mode 100644
index 00000000..ce94f6d5
--- /dev/null
+++ b/install-guide/source/heat/install-heat-obs.rst
@@ -0,0 +1,28 @@
+Enable Orchestration service meters for openSUSE and SUSE Linux Enterprise
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Telemetry uses notifications to collect Orchestration service meters. Perform
+these steps on the controller node.
+
+Configure the Orchestration service to use Telemetry
+----------------------------------------------------
+
+* Edit the ``/etc/heat/heat.conf`` and complete the following actions:
+
+  * In the ``[oslo_messaging_notifications]`` sections, enable notifications:
+
+    .. code-block:: ini
+
+       [oslo_messaging_notifications]
+       ...
+       driver = messagingv2
+
+Finalize installation
+---------------------
+
+* Restart the Orchestration service:
+
+  .. code-block:: console
+
+     # systemctl restart openstack-heat-api.service \
+       openstack-heat-api-cfn.service openstack-heat-engine.service
diff --git a/install-guide/source/heat/install-heat-rdo.rst b/install-guide/source/heat/install-heat-rdo.rst
new file mode 100644
index 00000000..1e040764
--- /dev/null
+++ b/install-guide/source/heat/install-heat-rdo.rst
@@ -0,0 +1,28 @@
+Enable Orchestration service meters for Red Hat Enterprise Linux and CentOS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Telemetry uses notifications to collect Orchestration service meters. Perform
+these steps on the controller node.
+
+Configure the Orchestration service to use Telemetry
+----------------------------------------------------
+
+* Edit the ``/etc/heat/heat.conf`` and complete the following actions:
+
+  * In the ``[oslo_messaging_notifications]`` sections, enable notifications:
+
+    .. code-block:: ini
+
+       [oslo_messaging_notifications]
+       ...
+       driver = messagingv2
+
+Finalize installation
+---------------------
+
+* Restart the Orchestration service:
+
+  .. code-block:: console
+
+     # systemctl restart openstack-heat-api.service \
+       openstack-heat-api-cfn.service openstack-heat-engine.service
diff --git a/install-guide/source/heat/install-heat-ubuntu.rst b/install-guide/source/heat/install-heat-ubuntu.rst
new file mode 100644
index 00000000..f3dc4e9d
--- /dev/null
+++ b/install-guide/source/heat/install-heat-ubuntu.rst
@@ -0,0 +1,29 @@
+Enable Orchestration service meters for Ubuntu
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Telemetry uses notifications to collect Orchestration service meters. Perform
+these steps on the controller node.
+
+Configure the Orchestration service to use Telemetry
+----------------------------------------------------
+
+* Edit the ``/etc/heat/heat.conf`` and complete the following actions:
+
+  * In the ``[oslo_messaging_notifications]`` sections, enable notifications:
+
+    .. code-block:: ini
+
+       [oslo_messaging_notifications]
+       ...
+       driver = messagingv2
+
+Finalize installation
+---------------------
+
+* Restart the Orchestration service:
+
+  .. code-block:: console
+
+     # service heat-api restart
+     # service heat-api-cfn restart
+     # service heat-engine restart
diff --git a/install-guide/source/install-controller.rst b/install-guide/source/install-controller.rst
index b773f528..3a169cbe 100644
--- a/install-guide/source/install-controller.rst
+++ b/install-guide/source/install-controller.rst
@@ -42,6 +42,35 @@ Glance
    glance/install-glance-rdo.rst
    glance/install-glance-ubuntu.rst
 
+Heat
+----
+
+.. toctree::
+   :maxdepth: 1
+
+   heat/install-heat-obs.rst
+   heat/install-heat-rdo.rst
+   heat/install-heat-ubuntu.rst
+
+Keystone
+--------
+
+To enable auditing of API requests, Keystone provides middleware which captures
+API requests to a service and emits data to Ceilometer. Instructions to enable
+this functionality is available in `Keystone's developer documenation
+<https://docs.openstack.org/developer/keystonemiddleware/audit.html>`_.
+Ceilometer will captures this information as ``audit.http.*`` events.
+
+Neutron
+-------
+
+.. toctree::
+   :maxdepth: 1
+
+   neutron/install-neutron-obs.rst
+   neutron/install-neutron-rdo.rst
+   neutron/install-neutron-ubuntu.rst
+
 Swift
 -----
 
diff --git a/install-guide/source/neutron/install-neutron-obs.rst b/install-guide/source/neutron/install-neutron-obs.rst
new file mode 100644
index 00000000..37de9fe5
--- /dev/null
+++ b/install-guide/source/neutron/install-neutron-obs.rst
@@ -0,0 +1,27 @@
+Enable Networking service meters for openSUSE and SUSE Linux Enterprise
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Telemetry uses notifications to collect Networking service meters. Perform
+these steps on the controller node.
+
+Configure the Networking service to use Telemetry
+----------------------------------------------------
+
+* Edit the ``/etc/neutron/neutron.conf`` and complete the following actions:
+
+  * In the ``[oslo_messaging_notifications]`` sections, enable notifications:
+
+    .. code-block:: ini
+
+       [oslo_messaging_notifications]
+       ...
+       driver = messagingv2
+
+Finalize installation
+---------------------
+
+* Restart the Networking service:
+
+  .. code-block:: console
+
+     # systemctl restart neutron-server.service
diff --git a/install-guide/source/neutron/install-neutron-rdo.rst b/install-guide/source/neutron/install-neutron-rdo.rst
new file mode 100644
index 00000000..06567d59
--- /dev/null
+++ b/install-guide/source/neutron/install-neutron-rdo.rst
@@ -0,0 +1,27 @@
+Enable Networking service meters for Red Hat Enterprise Linux and CentOS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Telemetry uses notifications to collect Networking service meters. Perform
+these steps on the controller node.
+
+Configure the Networking service to use Telemetry
+----------------------------------------------------
+
+* Edit the ``/etc/neutron/neutron.conf`` and complete the following actions:
+
+  * In the ``[oslo_messaging_notifications]`` sections, enable notifications:
+
+    .. code-block:: ini
+
+       [oslo_messaging_notifications]
+       ...
+       driver = messagingv2
+
+Finalize installation
+---------------------
+
+* Restart the Networking service:
+
+  .. code-block:: console
+
+     # systemctl restart neutron-server.service
diff --git a/install-guide/source/neutron/install-neutron-ubuntu.rst b/install-guide/source/neutron/install-neutron-ubuntu.rst
new file mode 100644
index 00000000..3dacc8a6
--- /dev/null
+++ b/install-guide/source/neutron/install-neutron-ubuntu.rst
@@ -0,0 +1,27 @@
+Enable Networking service meters for Ubuntu
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Telemetry uses notifications to collect Networking service meters. Perform
+these steps on the controller node.
+
+Configure the Networking service to use Telemetry
+----------------------------------------------------
+
+* Edit the ``/etc/neutron/neutron.conf`` and complete the following actions:
+
+  * In the ``[oslo_messaging_notifications]`` sections, enable notifications:
+
+    .. code-block:: ini
+
+       [oslo_messaging_notifications]
+       ...
+       driver = messagingv2
+
+Finalize installation
+---------------------
+
+* Restart the Networking service:
+
+  .. code-block:: console
+
+     # service neutron-server restart
diff --git a/install-guide/source/swift/install-swift-config-common.inc b/install-guide/source/swift/install-swift-config-common.inc
index 5af6aa23..995d5e7a 100644
--- a/install-guide/source/swift/install-swift-config-common.inc
+++ b/install-guide/source/swift/install-swift-config-common.inc
@@ -21,7 +21,7 @@ run the Object Storage proxy service.
     .. code-block:: ini
 
        [pipeline:main]
-       pipeline = ceilometer catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk ratelimit authtoken keystoneauth container-quotas account-quotas slo dlo versioned_writes proxy-logging proxy-server
+       pipeline = catch_errors gatekeeper healthcheck proxy-logging cache container_sync bulk ratelimit authtoken keystoneauth container-quotas account-quotas slo dlo versioned_writes proxy-logging ceilometer proxy-server
 
   * In the ``[filter:ceilometer]`` section, configure notifications: