Thanks to Yassine Lamgarchal for noticing the documentation did not explicitely state where 'ceilometer' must be found in the pipeline. While we're at it, fix a typo: "these lines" should be used instead of "this lines". Change-Id: Iffff9b779d48bafefb249bba0f4db4a006f94a70
15 KiB
Installing Manually
Installing the Collector
double: installing; collector
If you want to be able to retrieve image samples, you need to instruct Glance to send notifications to the bus by changing
notifier_strategy
torabbit
orqpid
inglance-api.conf
and restarting the service.If you want to be able to retrieve volume samples, you need to instruct Cinder to send notifications to the bus by changing
notification_driver
tocinder.openstack.common.notifier.rabbit_notifier
andcontrol_exchange
tocinder
, before restarting the service.In order to retrieve object store statistics, ceilometer needs access to swift with
ResellerAdmin
role. You should give this role to youros_username
user for tenantos_tenant_name
:$ keystone role-create --name=ResellerAdmin +----------+----------------------------------+ | Property | Value | +----------+----------------------------------+ | id | 462fa46c13fd4798a95a3bfbe27b5e54 | | name | ResellerAdmin | +----------+----------------------------------+ $ keystone user-role-add --tenant_id $SERVICE_TENANT \ --user_id $CEILOMETER_USER \ --role_id 462fa46c13fd4798a95a3bfbe27b5e54
You'll also need to add the Ceilometer middleware to Swift to account for incoming and outgoing traffic, by adding these lines to
/etc/swift/proxy-server.conf
:[filter:ceilometer] use = egg:ceilometer#swift
And adding
ceilometer
in thepipeline
of that same file, right beforeproxy-server
.Install MongoDB.
Follow the instructions to install the MongoDB package for your operating system, then start the service.
Clone the ceilometer git repository to the management server:
$ cd /opt/stack $ git clone https://git.openstack.org/openstack/ceilometer.git
As a user with
root
permissions orsudo
privileges, run the ceilometer installer:$ cd ceilometer $ sudo python setup.py install
Copy the sample configuration files from the source tree to their final location.
$ mkdir -p /etc/ceilometer $ cp etc/ceilometer/*.json /etc/ceilometer $ cp etc/ceilometer/*.yaml /etc/ceilometer $ cp etc/ceilometer/ceilometer.conf.sample /etc/ceilometer/ceilometer.conf
Edit
/etc/ceilometer/ceilometer.conf
Configure RPC
Set the RPC-related options correctly so ceilometer's daemons can communicate with each other and receive notifications from the other projects.
In particular, look for the
*_control_exchange
options and make sure the names are correct. If you did not change thecontrol_exchange
settings for the other components, the defaults should be correct.Note
Ceilometer makes extensive use of the messaging bus, but has not yet been tested with ZeroMQ. We recommend using Rabbit or qpid for now.
Set the
metering_secret
value.Set the
metering_secret
value to a large, random, value. Use the same value in all ceilometer configuration files, on all nodes, so that messages passing between the nodes can be validated.
Refer to
/configuration
for details about any other options you might want to modify before starting the service.Start the collector.
$ ceilometer-collector
Note
The default development configuration of the collector logs to stderr, so you may want to run this step using a screen session or other tool for maintaining a long-running program in the background.
Installing the Compute Agent
double: installing; compute agent
Note
The compute agent must be installed on each nova compute node.
Configure nova.
The
nova
compute service needs the following configuration to be set innova.conf
:# nova-compute configuration for ceilometer instance_usage_audit=True instance_usage_audit_period=hour notify_on_state_change=vm_and_task_state notification_driver=nova.openstack.common.notifier.rpc_notifier notification_driver=ceilometer.compute.nova_notifier
Clone the ceilometer git repository to the server:
$ cd /opt/stack $ git clone https://git.openstack.org/openstack/ceilometer.git
As a user with
root
permissions orsudo
privileges, run the ceilometer installer:$ cd ceilometer $ sudo python setup.py install
Copy the sample configuration files from the source tree to their final location.
$ mkdir -p /etc/ceilometer $ cp etc/ceilometer/*.json /etc/ceilometer $ cp etc/ceilometer/*.yaml /etc/ceilometer $ cp etc/ceilometer/ceilometer.conf.sample /etc/ceilometer/ceilometer.conf
Edit
/etc/ceilometer/ceilometer.conf
Configure RPC
Set the RPC-related options correctly so ceilometer's daemons can communicate with each other and receive notifications from the other projects.
In particular, look for the
*_control_exchange
options and make sure the names are correct. If you did not change thecontrol_exchange
settings for the other components, the defaults should be correct.Note
Ceilometer makes extensive use of the messaging bus, but has not yet been tested with ZeroMQ. We recommend using Rabbit or qpid for now.
Set the
metering_secret
value.Set the
metering_secret
value to a large, random, value. Use the same value in all ceilometer configuration files, on all nodes, so that messages passing between the nodes can be validated.
Refer to
/configuration
for details about any other options you might want to modify before starting the service.Start the agent.
$ ceilometer-agent-compute
Note
The default development configuration of the agent logs to stderr, so you may want to run this step using a screen session or other tool for maintaining a long-running program in the background.
Installing the Central Agent
double: installing; agent
Note
The central agent needs to be able to talk to keystone and any of the services being polled for updates.
Clone the ceilometer git repository to the server:
$ cd /opt/stack $ git clone https://git.openstack.org/openstack/ceilometer.git
As a user with
root
permissions orsudo
privileges, run the ceilometer installer:$ cd ceilometer $ sudo python setup.py install
Copy the sample configuration files from the source tree to their final location.
$ mkdir -p /etc/ceilometer $ cp etc/ceilometer/*.json /etc/ceilometer $ cp etc/ceilometer/*.yaml /etc/ceilometer $ cp etc/ceilometer/ceilometer.conf.sample /etc/ceilometer/ceilometer.conf
Edit
/etc/ceilometer/ceilometer.conf
Configure RPC
Set the RPC-related options correctly so ceilometer's daemons can communicate with each other and receive notifications from the other projects.
In particular, look for the
*_control_exchange
options and make sure the names are correct. If you did not change thecontrol_exchange
settings for the other components, the defaults should be correct.Note
Ceilometer makes extensive use of the messaging bus, but has not yet been tested with ZeroMQ. We recommend using Rabbit or qpid for now.
Set the
metering_secret
value.Set the
metering_secret
value to a large, random, value. Use the same value in all ceilometer configuration files, on all nodes, so that messages passing between the nodes can be validated.
Refer to
/configuration
for details about any other options you might want to modify before starting the service.Start the agent
$ ceilometer-agent-central
Installing the API Server
double: installing; API
Note
The API server needs to be able to talk to keystone and ceilometer's database.
Clone the ceilometer git repository to the server:
$ cd /opt/stack $ git clone https://git.openstack.org/openstack/ceilometer.git
As a user with
root
permissions orsudo
privileges, run the ceilometer installer:$ cd ceilometer $ sudo python setup.py install
Copy the sample configuration files from the source tree to their final location.
$ mkdir -p /etc/ceilometer $ cp etc/ceilometer/*.json /etc/ceilometer $ cp etc/ceilometer/*.yaml /etc/ceilometer $ cp etc/ceilometer/ceilometer.conf.sample /etc/ceilometer/ceilometer.conf
Edit
/etc/ceilometer/ceilometer.conf
Configure RPC
Set the RPC-related options correctly so ceilometer's daemons can communicate with each other and receive notifications from the other projects.
In particular, look for the
*_control_exchange
options and make sure the names are correct. If you did not change thecontrol_exchange
settings for the other components, the defaults should be correct.Note
Ceilometer makes extensive use of the messaging bus, but has not yet been tested with ZeroMQ. We recommend using Rabbit or qpid for now.
Refer to
/configuration
for details about any other options you might want to modify before starting the service.Start the API server.
$ ceilometer-api
Note
The development version of the API server logs to stderr, so you may want to run this step using a screen session or other tool for maintaining a long-running program in the background.
Configuring keystone to work with API
double: installing; configure keystone
Note
The API server needs to be able to talk to keystone to authenticate.
Create a service for ceilometer in keystone
$ keystone service-create --name=ceilometer \ --type=metering \ --description="Ceilometer Service"
Create an endpoint in keystone for ceilometer
$ keystone endpoint-create --region RegionOne \ --service_id $CEILOMETER_SERVICE \ --publicurl "http://$SERVICE_HOST:8777/" \ --adminurl "http://$SERVICE_HOST:8777/" \ --internalurl "http://$SERVICE_HOST:8777/"
Note
CEILOMETER_SERVICE is the id of the service created by the first command and SERVICE_HOST is the host where the Ceilometer API is running. The default port value for ceilometer API is 8777. If the port value has been customized, adjust accordingly.
Notifications queues
double: installing; notifications queues
By default, Ceilometer consumes notifications on the RPC bus sent to notification_topics by using a queue/pool name that is identical to the topic name. You shouldn't have different applications consuming messages from this queue. If you want to also consume the topic notifications with a system other than Ceilometer, you should configure a separate queue that listens for the same messages.
Using multiple dispatchers
double: installing; multiple dispatchers
The Ceilometer collector allows multiple dispatchers to be configured so that metering data can be easily sent to multiple internal and external systems.
Ceilometer by default only saves metering data in a database, to allow Ceilometer to send metering data to other systems in addition to the database, multiple dispatchers can be developed and enabled by modifying Ceilometer configuration file.
Ceilometer ships two dispatchers currently. One is called database dispatcher, and the other is called file dispatcher. As the names imply, database dispatcher basically sends metering data to a database driver, eventually metering data will be saved in database. File dispatcher sends metering data into a file. The location, name, size of the file can be configured in ceilometer configuration file. These two dispatchers are shipped in the Ceilometer egg and defined in the entry_points as follows:
[ceilometer.dispatcher]
file = ceilometer.collector.dispatcher.file:FileDispatcher
database = ceilometer.collector.dispatcher.database:DatabaseDispatcher
To use both dispatchers on a Ceilometer collector service, add the following line in file ceilometer.conf:
[collector]
dispatcher=database
dispatcher=file
If there is no dispatcher present, database dispatcher is used as the default. If in some cases such as traffic tests, no dispatcher is needed, one can configure the line like the following:
dispatcher=
With above configuration, no dispatcher is used by the Ceilometer collector service, all metering data received by Ceilometer collector will be dropped.
Using other databases
double: installing; database, hbase, mysql, db2
Ceilometer by default uses mongodb as its backend data repository. A deployment can choose to use other databases, currently the supported databases are mongodb, hbase, mysql (or sqlalchemy-enabled databases) and db2. To use a database other than MongoDB, edit the database section in ceilometer.conf:
To use db2 as the data repository, make the section look like this:
[database]
connection = db2://username:password@host:27017/ceilometer
To use mongodb as the data repository, make the section look like this:
[database]
connection = mongodb://username:password@host:27017/ceilometer