diff --git a/doc/source/admin/telemetry-measurements.rst b/doc/source/admin/telemetry-measurements.rst index 7116531ac3..f9b08bf35c 100644 --- a/doc/source/admin/telemetry-measurements.rst +++ b/doc/source/admin/telemetry-measurements.rst @@ -447,13 +447,47 @@ 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. +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 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 | Notificatio\| Fan rounds per | +| | | | sensor | n, Pollster | minute (RPM) | ++------------------+-------+------+----------+-------------+------------------+ +| hardware.ipmi\ | Gauge | C | temper\ | Notificatio\| Temperature read\| +| .temperature | | | ature | n, Pollster | ing from sensor | +| | | | sensor | | | ++------------------+-------+------+----------+-------------+------------------+ +| hardware.ipmi\ | Gauge | W | current | Notificatio\| Current reading | +| .current | | | sensor | n, Pollster | from sensor | ++------------------+-------+------+----------+-------------+------------------+ +| hardware.ipmi\ | Gauge | V | voltage | Notificatio\| Voltage reading | +| .voltage | | | sensor | n, Pollster | from sensor | ++------------------+-------+------+----------+-------------+------------------+ + .. note:: The sensor data is not available in the Bare metal service by @@ -462,45 +496,6 @@ data from the host machine. Guide `__ for the Bare metal service. -The following meters are recorded for the Bare metal service: - -+------------------+-------+------+----------+-------------+------------------+ -| 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\ | Gauge | C | temper\ | Notification| Temperature read\| -| .temperature | | | ature | | ing from sensor | -| | | | sensor | | | -+------------------+-------+------+----------+-------------+------------------+ -| hardware.ipmi\ | Gauge | W | current | Notification| Current reading | -| .current | | | sensor | | from sensor | -+------------------+-------+------+----------+-------------+------------------+ -| hardware.ipmi\ | Gauge | V | voltage | Notification| Voltage reading | -| .voltage | | | sensor | | 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`. - -.. 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. Besides generic IPMI sensor data, the following Intel Node Manager meters are recorded from capable platform: diff --git a/doc/source/install/install-compute-common.inc b/doc/source/install/install-compute-common.inc index 6aad132d97..882e574524 100644 --- a/doc/source/install/install-compute-common.inc +++ b/doc/source/install/install-compute-common.inc @@ -50,3 +50,26 @@ Configure Compute to use Telemetry [oslo_messaging_notifications] ... driver = messagingv2 + +Configure Compute to poll IPMI meters +------------------------------------- + +.. note:: + + To enable IPMI meters, ensure IPMITool is installed and the host supports + Intel Node Manager. + +* Edit the ``/etc/sudoers`` file and include:: + + .. code-block:: ini + + ceilometer ALL = (root) NOPASSWD: /usr/bin/ceilometer-rootwrap /etc/ceilometer/rootwrap.conf * + +* Edit the ``/etc/ceilometer/polling.yaml`` to include the required meters, for example:: + + .. code-block:: yaml + + - name: ipmi + interval: 300 + meters: + - hardware.ipmi.temperature diff --git a/doc/source/install/install-compute-obs.rst b/doc/source/install/install-compute-obs.rst index 726dcb84a4..db71dd0fa9 100644 --- a/doc/source/install/install-compute-obs.rst +++ b/doc/source/install/install-compute-obs.rst @@ -12,6 +12,7 @@ Install and configure components .. code-block:: console # zypper install openstack-ceilometer-agent-compute + # zypper install openstack-ceilometer-agent-ipmi (optional) .. include:: install-compute-common.inc @@ -24,6 +25,8 @@ Finalize installation # systemctl enable openstack-ceilometer-agent-compute.service # systemctl start openstack-ceilometer-agent-compute.service + # systemctl enable openstack-ceilometer-agent-ipmi.service (optional) + # systemctl start openstack-ceilometer-agent-ipmi.service (optional) #. Restart the Compute service: diff --git a/doc/source/install/install-compute-rdo.rst b/doc/source/install/install-compute-rdo.rst index c2f9d86c34..da3d072cf9 100644 --- a/doc/source/install/install-compute-rdo.rst +++ b/doc/source/install/install-compute-rdo.rst @@ -12,6 +12,7 @@ Install and configure components .. code-block:: console # yum install openstack-ceilometer-compute + # yum install openstack-ceilometer-ipmi (optional) .. include:: install-compute-common.inc @@ -24,6 +25,8 @@ Finalize installation # systemctl enable openstack-ceilometer-compute.service # systemctl start openstack-ceilometer-compute.service + # systemctl enable openstack-ceilometer-ipmi.service (optional) + # systemctl start openstack-ceilometer-ipmi.service (optional) #. Restart the Compute service: diff --git a/doc/source/install/install-compute-ubuntu.rst b/doc/source/install/install-compute-ubuntu.rst index e1d59b8cfb..a52bd7773c 100644 --- a/doc/source/install/install-compute-ubuntu.rst +++ b/doc/source/install/install-compute-ubuntu.rst @@ -12,6 +12,7 @@ Install and configure components .. code-block:: console # apt-get install ceilometer-agent-compute + # apt-get install ceilometer-agent-ipmi (optional) .. include:: install-compute-common.inc @@ -23,6 +24,7 @@ Finalize installation .. code-block:: console # service ceilometer-agent-compute restart + # service ceilometer-agent-ipmi restart (optional) #. Restart the Compute service: