[DOCS] Move ceilometer configs from developer docs
This commit moves the ceilometer configs in the developer docs over to the role. It also cleans up README.rst and index.rst to support the new tree structure for role docs. As a note, some of the role docs(like this one), do a literalinclude on files in the integrated repo. These references need to be fixed to reference the link since the included file will no longer exist in a guaranteed location that can be referenced with relative paths. Change-Id: Icfaa49c1876b633adf6b61881006c676b1a57cdc Signed-off-by: alextricity25 <miguel.cantu@rackspace.com>
This commit is contained in:
alextricity25
parent
cb2139b5f8
commit
6d7679d077
|
|
@ -37,9 +37,8 @@ Example Playbook
|
|||
Tags
|
||||
====
|
||||
|
||||
This role supports two tags: ``ceilometer-install`` and ``ceilometer-config``
|
||||
This role supports two tags: ``ceilometer-install`` and ``ceilometer-config``.
|
||||
|
||||
The ``ceilometer-install`` tag can be used to install and upgrade.
|
||||
|
||||
The ``ceilometer-config`` tag can be used to maintain configuration of the
|
||||
service.
|
||||
The ``ceilometer-config`` tag can be used to maintain configuration of the service.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,174 @@
|
|||
=========================================================
|
||||
Configuring the Telemetry (ceilometer) service (optional)
|
||||
=========================================================
|
||||
|
||||
The Telemetry module (ceilometer) performs the following functions:
|
||||
|
||||
- Efficiently polls metering data related to OpenStack services.
|
||||
|
||||
- Collects event and metering data by monitoring notifications sent from
|
||||
services.
|
||||
|
||||
- Publishes collected data to various targets including data stores and
|
||||
message queues.
|
||||
|
||||
.. note::
|
||||
|
||||
As of Liberty, the alarming functionality is in a separate component.
|
||||
The metering-alarm containers handle the functionality through aodh
|
||||
services. For configuring these services, see the aodh docs:
|
||||
http://docs.openstack.org/developer/aodh/
|
||||
|
||||
Configure a MongoDB backend prior to running the ceilometer playbooks.
|
||||
The connection data is in the ``user_variables.yml`` file
|
||||
(see section `Configuring the user data`_ below).
|
||||
|
||||
|
||||
Setting up a MongoDB database for ceilometer
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
1. Install the MongoDB package:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# apt-get install mongodb-server mongodb-clients python-pymongo
|
||||
|
||||
2. Edit the ``/etc/mongodb.conf`` file and change the ``bind_i`` to the
|
||||
management interface:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
bind_ip = 10.0.0.11
|
||||
|
||||
3. Edit the ``/etc/mongodb.conf`` file and enable ``smallfiles``:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
smallfiles = true
|
||||
|
||||
4. Restart the MongoDB service:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# service mongodb restart
|
||||
|
||||
5. Create the ceilometer database:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# mongo --host controller --eval 'db = db.getSiblingDB("ceilometer"); db.addUser({user: "ceilometer", pwd: "CEILOMETER_DBPASS", roles: [ "readWrite", "dbAdmin" ]})'
|
||||
|
||||
This returns:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
MongoDB shell version: 2.4.x
|
||||
connecting to: controller:27017/test
|
||||
{
|
||||
"user" : "ceilometer",
|
||||
"pwd" : "72f25aeee7ad4be52437d7cd3fc60f6f",
|
||||
"roles" : [
|
||||
"readWrite",
|
||||
"dbAdmin"
|
||||
],
|
||||
"_id" : ObjectId("5489c22270d7fad1ba631dc3")
|
||||
}
|
||||
|
||||
.. note::
|
||||
|
||||
Ensure ``CEILOMETER_DBPASS`` matches the
|
||||
``ceilometer_container_db_password`` in the
|
||||
``/etc/openstack_deploy/user_secrets.yml`` file. This is
|
||||
how Ansible knows how to configure the connection string
|
||||
within the ceilometer configuration files.
|
||||
|
||||
Configuring the hosts
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Configure ceilometer by specifying the ``metering-compute_hosts`` and
|
||||
``metering-infra_hosts`` directives in the
|
||||
``/etc/openstack_deploy/conf.d/ceilometer.yml`` file:
|
||||
`ceilometer.yml.example
|
||||
<https://github.com/openstack/openstack-ansible/blob/master/etc/openstack_deploy/conf.d/ceilometer.yml.example>`_
|
||||
|
||||
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`` host several
|
||||
services:
|
||||
|
||||
- A central agent (ceilometer-agent-central): Runs on a central
|
||||
management server to poll for resource utilization statistics for
|
||||
resources not tied to instances or compute nodes. Multiple agents
|
||||
can be started to enable workload partitioning (See HA section
|
||||
below).
|
||||
|
||||
- A notification agent (ceilometer-agent-notification): Runs on a
|
||||
central management server(s) and consumes messages from the
|
||||
message queue(s) to build event and metering data. Multiple
|
||||
notification agents can be started to enable workload partitioning
|
||||
(See HA section below).
|
||||
|
||||
- A collector (ceilometer-collector): Runs on central management
|
||||
server(s) and dispatches data to a data store
|
||||
or external consumer without modification.
|
||||
|
||||
- An API server (ceilometer-api): Runs on one or more central
|
||||
management servers to provide data access from the data store.
|
||||
|
||||
|
||||
Configuring the hosts for an HA deployment
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Ceilometer supports running the polling and notification agents in an
|
||||
HA deployment.
|
||||
|
||||
The Tooz library provides the coordination within the groups of service
|
||||
instances. Tooz can be used with several backends. At the time of this
|
||||
writing, the following backends are supported:
|
||||
|
||||
- Zookeeper: Recommended solution by the Tooz project.
|
||||
|
||||
- Redis: Recommended solution by the Tooz project.
|
||||
|
||||
- Memcached: Recommended for testing.
|
||||
|
||||
.. important::
|
||||
|
||||
The OpenStack-Ansible project does not deploy these backends.
|
||||
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`_ 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:
|
||||
coordination:
|
||||
backend_url: "zookeeper://172.20.1.110:2181"
|
||||
notification:
|
||||
workload_partitioning: True
|
||||
|
||||
|
||||
Configuring the user data
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Specify the following configurations in the
|
||||
``/etc/openstack_deploy/user_variables.yml`` file:
|
||||
|
||||
- The type of database backend ceilometer uses. Currently only
|
||||
MongoDB is supported: ``ceilometer_db_type: mongodb``
|
||||
|
||||
- The IP address of the MongoDB host: ``ceilometer_db_ip:
|
||||
localhost``
|
||||
|
||||
- The port of the MongoDB service: ``ceilometer_db_port: 27017``
|
||||
|
||||
|
||||
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.
|
||||
|
|
@ -1 +1,30 @@
|
|||
.. include:: ../../README.rst
|
||||
=================
|
||||
Table of Contents
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
overview.rst
|
||||
configure-ceilometer.rst
|
||||
|
||||
Default variables
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: ../../defaults/main.yml
|
||||
:language: yaml
|
||||
:start-after: under the License.
|
||||
|
||||
Example playbook
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: ../../examples/playbook.yml
|
||||
:language: yaml
|
||||
|
||||
Tags
|
||||
~~~~
|
||||
|
||||
This role supports two tags: ``ceilometer-install`` and
|
||||
``ceilometer-config``. The ``ceilometer-install`` tag can be used to install
|
||||
and upgrade. The ``ceilometer-config`` tag can be used to maintain the
|
||||
configuration of the service.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
- name: Install ceilometer server
|
||||
hosts: ceilometer_all
|
||||
user: root
|
||||
roles:
|
||||
- { role: "os_ceilometer", tags: [ "ceilometer-config", "ceilometer-install" ] }
|
||||
vars:
|
||||
external_lb_vip_address: 172.16.24.1
|
||||
internal_lb_vip_address: 192.168.0.1
|
||||
Loading…
Reference in New Issue