Juju Charm - Ceilometer
Go to file
James Page 4bf409fb18 Use transport_url for Ocata or later
The ceilometer charm was already using transport_url for
Ocata or later deployments; resync helpers and include new
revised sectional config for SSL and HA settings.

Change-Id: Ib1822a89de8da6986552229a2b84ec5b784550ed
Closes-Bug: 1817672
2019-02-26 12:08:04 +01:00
actions Status blocked until ceilometer-upgrade action 2019-01-29 23:59:57 +00:00
charmhelpers Use transport_url for Ocata or later 2019-02-26 12:08:04 +01:00
hooks Update pre-install hooks to fail on error 2019-02-08 15:46:28 -06:00
lib Use leader set for ceilometer-upgrade checks 2019-02-07 20:23:02 +00:00
templates Use transport_url for Ocata or later 2019-02-26 12:08:04 +01:00
tests Update functional test definitions 2019-02-06 14:47:06 -06:00
unit_tests Use leader set for ceilometer-upgrade checks 2019-02-07 20:23:02 +00:00
.coveragerc Add unit tests, tidylint 2013-10-20 12:32:35 -07:00
.gitignore Enable xenial-pike amulet test 2017-12-06 11:15:06 -08:00
.gitreview Add gitreview prior to migration to openstack 2016-02-24 21:53:27 +00:00
.project Add missing files 2013-03-31 12:21:09 +01:00
.pydevproject Add unit tests, tidylint 2013-10-20 12:32:35 -07:00
.testr.conf Add tox support 2015-11-02 09:42:43 +00:00
.zuul.yaml import zuul job settings from project-config 2018-09-11 13:06:20 -04:00
LICENSE Re-license charm as Apache-2.0 2016-06-28 11:36:46 +01:00
Makefile Tests dir no longer need copy of charmhelpers 2018-10-10 12:38:59 +00:00
README.md Support listening to multiple rabbit queues. 2018-10-19 07:30:12 +00:00
actions.yaml Clarify ceilometer-upgrade action description 2018-12-06 14:39:50 -06:00
charm-helpers-hooks.yaml Update charm-helpers-hooks.yaml and sync ch 2019-02-12 15:55:17 -08:00
config.yaml Make event_sink publisher configurable 2019-02-07 10:09:48 +00:00
copyright Drop use of openstack OCF resources 2017-09-25 13:10:23 +01:00
hardening.yaml Add hardening support 2016-03-24 11:12:40 +00:00
icon.svg Update charm icon 2017-08-02 17:47:21 +01:00
metadata.yaml Support listening to multiple rabbit queues. 2018-10-19 07:30:12 +00:00
requirements.txt Update requirements 2018-10-03 11:14:54 -05:00
revision resync charmhelper 2014-03-12 13:10:19 +01:00
setup.cfg Account for ssl port monitoring. 2014-12-17 16:22:18 -07:00
test-requirements.txt Update requirements 2018-10-03 11:14:54 -05:00
tox.ini fix tox python3 overrides 2018-11-02 01:02:57 +00:00

README.md

Overview

This charm provides the Ceilometer service for OpenStack. It is intended to be used alongside the other OpenStack components, starting with the Folsom release.

Ceilometer is made up of 2 separate services: an API service, and a collector service. This charm allows them to be deployed in different combination, depending on user preference and requirements.

This charm was developed to support deploying Folsom on both Ubuntu Quantal and Ubuntu Precise. Since Ceilometer is only available for Ubuntu 12.04 via the Ubuntu Cloud Archive, deploying this charm to a Precise machine will by default install Ceilometer and its dependencies from the Cloud Archive.

Usage

In order to deploy Ceilometer service (prior to Queens), the MongoDB service is required:

juju deploy mongodb
juju deploy ceilometer
juju add-relation ceilometer mongodb

For OpenStack Queens or later, Gnocchi should be used instead of MongoDB for resource, metrics and measure storage:

juju add-relation ceilometer gnocchi

Note: When ceilometer is related to gnocchi the ceilometer-upgrade action must be run post deployment in order to update its data store in gnocchi.

juju run-action ceilometer-upgrade

then Keystone and Rabbit relationships need to be established:

juju add-relation ceilometer:amqp rabbitmq
juju add-relation ceilometer keystone:identity-service
juju add-relation ceilometer keystone:identity-notifications

For OpenStack Queens, the identity-service relation must be replaced with the identity-credentials relation:

juju add-relation ceilometer keystone:identity-credentials

Ceilometer@Queens does not provide an API service.

In order to capture the calculations, a Ceilometer compute agent needs to be installed in each nova node, and be related with Ceilometer service:

juju deploy ceilometer-agent
juju add-relation ceilometer-agent nova-compute
juju add-relation ceilometer:ceilometer-service ceilometer-agent:ceilometer-service

Ceilometer provides an API service that can be used to retrieve Openstack metrics.

If ceilometer needs to listen to multiple message queues then use the amqp interface to relate ceilometer to the message broker that it should publish to and use the amqp-listener interface for all message brokers ceilometer should monitor.

juju add-relation ceilometer:amqp rabbitmq-central
juju add-relation ceilometer:amqp-listener rabbitmq-neutron
juju add-relation ceilometer:amqp-listener rabbitmq-nova-cell2

HA/Clustering

There are two mutually exclusive high availability options: using virtual IP(s) or DNS. In both cases, a relationship to hacluster is required which provides the corosync back end HA functionality.

To use virtual IP(s) the clustered nodes must be on the same subnet such that the VIP is a valid IP on the subnet for one of the node's interfaces and each node has an interface in said subnet. The VIP becomes a highly-available API endpoint.

At a minimum, the config option 'vip' must be set in order to use virtual IP HA. If multiple networks are being used, a VIP should be provided for each network, separated by spaces. Optionally, vip_iface or vip_cidr may be specified.

To use DNS high availability there are several prerequisites. However, DNS HA does not require the clustered nodes to be on the same subnet. Currently the DNS HA feature is only available for MAAS 2.0 or greater environments. MAAS 2.0 requires Juju 2.0 or greater. The clustered nodes must have static or "reserved" IP addresses registered in MAAS. The DNS hostname(s) must be pre-registered in MAAS before use with DNS HA.

At a minimum, the config option 'dns-ha' must be set to true and at least one of 'os-public-hostname', 'os-internal-hostname' or 'os-internal-hostname' must be set in order to use DNS HA. One or more of the above hostnames may be set.

The charm will throw an exception in the following circumstances: If neither 'vip' nor 'dns-ha' is set and the charm is related to hacluster If both 'vip' and 'dns-ha' are set as they are mutually exclusive If 'dns-ha' is set and none of the os-{admin,internal,public}-hostname(s) are set

Network Space support

This charm supports the use of Juju Network Spaces, allowing the charm to be bound to network space configurations managed directly by Juju. This is only supported with Juju 2.0 and above.

API endpoints can be bound to distinct network spaces supporting the network separation of public, internal and admin endpoints.

To use this feature, use the --bind option when deploying the charm:

juju deploy ceilometer --bind "public=public-space internal=internal-space admin=admin-space"

alternatively these can also be provided as part of a juju native bundle configuration:

ceilometer:
  charm: cs:xenial/ceilometer
  bindings:
    public: public-space
    admin: admin-space
    internal: internal-space

NOTE: Spaces must be configured in the underlying provider prior to attempting to use them.

NOTE: Existing deployments using os-*-network configuration options will continue to function; these options are preferred over any network space binding provided if set.