Merge "update ipmi docs" into stable/queens

1 files changed, 28 insertions, 33 deletions

diff --git a/doc/source/admin/telemetry-measurements.rst b/doc/source/admin/telemetry-measurements.rst
index 53d84781..3d29c340 100644
--- a/doc/source/admin/telemetry-measurements.rst
+++ b/doc/source/admin/telemetry-measurements.rst
@@ -437,60 +437,55 @@ Compute:
 
 .. _telemetry-bare-metal-service:
 
-Bare metal service
-~~~~~~~~~~~~~~~~~~
+IPMI meters
+~~~~~~~~~~~
 
 Telemetry captures notifications that are emitted by the Bare metal
 service. The source of the notifications are IPMI sensors that collect
 data from the host machine.
 
-.. note::
+Alternatively, IPMI meters can be generated by deploying the
+ceilometer-agent-ipmi on each IPMI-capable node. For further information about
+the IPMI agent see :ref:`telemetry-ipmi-agent`.
+
+.. warning::
+
+   To avoid duplication of metering data and unnecessary load on the
+   IPMI interface, do not deploy the IPMI agent on nodes that are
+   managed by the Bare metal service and keep the
+   ``conductor.send_sensor_data`` option set to ``False`` in the
+   ``ironic.conf`` configuration file.
 
-   The sensor data is not available in the Bare metal service by
-   default. To enable the meters and configure this module to emit
-   notifications about the measured values see the `Installation
-   Guide <https://docs.openstack.org/ironic/latest/install/index.html>`__
-   for the Bare metal service.
 
-The following meters are recorded for the Bare metal service:
+The following IPMI sensor meters are recorded:
 
 +------------------+-------+------+----------+-------------+------------------+
 | Name             | Type  | Unit | Resource | Origin      | Note             |
 +==================+=======+======+==========+=============+==================+
 | **Meters added in the Mitaka release or earlier**                           |
 +------------------+-------+------+----------+-------------+------------------+
-| hardware.ipmi.fan| Gauge | RPM  | fan      | Notification| Fan rounds per   |
-|                  |       |      | sensor   |             | minute (RPM)     |
+| hardware.ipmi.fan| Gauge | RPM  | fan      | Notificatio\| Fan rounds per   |
+|                  |       |      | sensor   | n, Pollster | minute (RPM)     |
 +------------------+-------+------+----------+-------------+------------------+
-| hardware.ipmi\   | Gauge | C    | temper\  | Notification| Temperature read\|
-| .temperature     |       |      | ature    |             | ing from sensor  |
+| hardware.ipmi\   | Gauge | C    | temper\  | Notificatio\| Temperature read\|
+| .temperature     |       |      | ature    | n, Pollster | ing from sensor  |
 |                  |       |      | sensor   |             |                  |
 +------------------+-------+------+----------+-------------+------------------+
-| hardware.ipmi\   | Gauge | W    | current  | Notification| Current reading  |
-| .current         |       |      | sensor   |             | from sensor      |
+| hardware.ipmi\   | Gauge | W    | current  | Notificatio\| Current reading  |
+| .current         |       |      | sensor   | n, Pollster | from sensor      |
 +------------------+-------+------+----------+-------------+------------------+
-| hardware.ipmi\   | Gauge | V    | voltage  | Notification| Voltage reading  |
-| .voltage         |       |      | sensor   |             | from sensor      |
+| hardware.ipmi\   | Gauge | V    | voltage  | Notificatio\| Voltage reading  |
+| .voltage         |       |      | sensor   | n, Pollster | from sensor      |
 +------------------+-------+------+----------+-------------+------------------+
 
-IPMI based meters
-~~~~~~~~~~~~~~~~~
-Another way of gathering IPMI based data is to use IPMI sensors
-independently from the Bare metal service's components. The same meters as
-:ref:`telemetry-bare-metal-service` can be fetched except that origin is
-``Pollster`` instead of ``Notification``.
-
-You need to deploy the ceilometer-agent-ipmi on each IPMI-capable node
-in order to poll local sensor data. For further information about the
-IPMI agent see :ref:`telemetry-ipmi-agent`.
+.. note::
 
-.. warning::
+   The sensor data is not available in the Bare metal service by
+   default. To enable the meters and configure this module to emit
+   notifications about the measured values see the `Installation
+   Guide <https://docs.openstack.org/ironic/latest/install/index.html>`__
+   for the Bare metal service.
 
-   To avoid duplication of metering data and unnecessary load on the
-   IPMI interface, do not deploy the IPMI agent on nodes that are
-   managed by the Bare metal service and keep the
-   ``conductor.send_sensor_data`` option set to ``False`` in the
-   ``ironic.conf`` configuration file.
 
 Besides generic IPMI sensor data, the following Intel Node Manager
 meters are recorded from capable platform: