From 85fde9f62d2b7b937c88e5a46a4a875abab30b0c Mon Sep 17 00:00:00 2001 From: Travis Truman Date: Mon, 1 Aug 2016 16:43:38 -0400 Subject: [PATCH] [DOCS] - Cleanup Telemetry docs - Directly include example config file - Remove unnecessary configuration guidance Change-Id: I979a2fb5e0db093f770c410f8ccfe6caac30fe88 Closes-Bug: #1606401 --- .../developer-docs/configure-ceilometer.rst | 59 +++---------------- .../conf.d/ceilometer.yml.example | 7 ++- 2 files changed, 13 insertions(+), 53 deletions(-) diff --git a/doc/source/developer-docs/configure-ceilometer.rst b/doc/source/developer-docs/configure-ceilometer.rst index 58c3ffb0a6..74339e6659 100644 --- a/doc/source/developer-docs/configure-ceilometer.rst +++ b/doc/source/developer-docs/configure-ceilometer.rst @@ -92,27 +92,12 @@ Configure ceilometer by specifying the ``metering-compute_hosts`` and example included in the ``etc/openstack_deploy/conf.d/ceilometer.yml.example`` file: - .. code-block:: bash +.. literalinclude:: ../../../etc/openstack_deploy/conf.d/ceilometer.yml.example + :language: yaml - # The compute host that the ceilometer compute agent runs on - ``metering-compute_hosts``: - compute1: - ip: 172.20.236.110 - - # The infra node that the central agents runs on - ``metering-infra_hosts``: - infra1: - ip: 172.20.236.111 - # Adding more than one host requires further configuration for ceilometer - # to work properly. - infra2: - ip: 172.20.236.112 - infra3: - ip: 172.20.236.113 - -The ``metering-compute_hosts`` houses the ``ceilometer-agent-compute`` +The ``metering-compute_hosts`` host the ``ceilometer-agent-compute`` service. It runs on each compute node and polls for resource -utilization statistics. The ``metering-infra_hosts`` houses several +utilization statistics. The ``metering-infra_hosts`` host several services: - A central agent (ceilometer-agent-central): Runs on a central @@ -154,14 +139,16 @@ writing, the following backends are supported: .. important:: The OpenStack-Ansible project does not deploy these backends. - The backends exist before deploying the ceilometer service. + One of the backends must exist before deploying the ceilometer service. Achieve HA by configuring the proper directives in ``ceilometer.conf`` using ``ceilometer_ceilometer_conf_overrides`` in the ``user_variables.yml`` file. -The ceilometer admin guide[1] details the +The `Ceilometer Admin Guide`_ details the options used in ``ceilometer.conf`` for HA deployment. The following is an example of ``ceilometer_ceilometer_conf_overrides``: +.. _Ceilometer Admin Guide: http://docs.openstack.org/admin-guide/telemetry-data-collection.html + .. code-block:: yaml ceilometer_ceilometer_conf_overrides: @@ -180,45 +167,17 @@ Specify the following configurations in the - The type of database backend ceilometer uses. Currently only MongoDB is supported: ``ceilometer_db_type: mongodb`` - - The IP address of the MonogoDB host: ``ceilometer_db_ip: + - The IP address of the MongoDB host: ``ceilometer_db_ip: localhost`` - The port of the MongoDB service: ``ceilometer_db_port: 27017`` - - This configures swift to send notifications to the message bus: - ``swift_ceilometer_enabled: False`` - - - This configures heat to send notifications to the message bus: - ``heat_ceilometer_enabled: False`` - - - This configures cinder to send notifications to the message bus: - ``cinder_ceilometer_enabled: False`` - - - This configures glance to send notifications to the message bus: - ``glance_ceilometer_enabled: False`` - - - This configures nova to send notifications to the message bus: - ``nova_ceilometer_enabled: False`` - - - This configures neutron to send notifications to the message bus: - ``neutron_ceilometer_enabled: False`` - - - This configures keystone to send notifications to the message bus: - ``keystone_ceilometer_enabled: False`` Run the ``os-ceilometer-install.yml`` playbook. If deploying a new OpenStack (instead of only ceilometer), run ``setup-openstack.yml``. The ceilometer playbooks run as part of this playbook. -References -~~~~~~~~~~ - -[1] `Ceilometer Admin Guide`_ - -.. _Ceilometer Admin Guide: http://docs.openstack.org/admin-guide/telemetry-data-collection.html - - -------------- .. include:: navigation.txt diff --git a/etc/openstack_deploy/conf.d/ceilometer.yml.example b/etc/openstack_deploy/conf.d/ceilometer.yml.example index 99c1642197..4695a9b8f3 100644 --- a/etc/openstack_deploy/conf.d/ceilometer.yml.example +++ b/etc/openstack_deploy/conf.d/ceilometer.yml.example @@ -1,11 +1,12 @@ -# The compute host that the ceilometer compute agent will be running on. +# The compute hosts that will run the ceilometer compute agent. This list +# should contain every host in the compute_hosts list. metering-compute_hosts: compute1: ip: 172.20.236.110 -# The infra nodes that the central agents will be running on +# The infra hosts that will run the central agents. # For running Ceilometer in HA for workload partitioning, see -# the HA section in the ceilometer configuration docs. +# http://docs.openstack.org/admin-guide/telemetry-data-collection.html#support-for-ha-deployment metering-infra_hosts: infra1: ip: 172.20.236.111