OpenStack Ceilometer Puppet Module
Go to file
Andreas Jaeger 2743cbde8d Move other-requirements.txt to bindep.txt
The default filename for documenting binary dependencies has been
changed from "other-requirements.txt" to "bindep.txt" with the release
of bindep 2.1.0. While the previous name is still supported, it will
be deprecated.

Move the file around to follow this change.

Note that this change is self-testing, the OpenStack CI infrastructure
will use a "bindep.txt" file to setup nodes for testing.

For more information about bindep, see also:
http://docs.openstack.org/infra/manual/drivers.html#package-requirements
http://docs.openstack.org/infra/bindep/

As well as this announcement:
http://lists.openstack.org/pipermail/openstack-dev/2016-August/101590.html

Change-Id: I96293203fdfd42fdb71bcfd87537ad504255011c
2016-08-12 21:05:28 +02:00
examples metering_secret was renamed to telemetry_secret 2016-05-15 11:31:58 +02:00
lib/puppet Don't print sensitive information to stdout during run. 2016-06-28 13:09:27 +02:00
manifests Add event_pipeline.yaml management 2016-08-09 15:52:18 +10:00
releasenotes Add event_pipeline.yaml management 2016-08-09 15:52:18 +10:00
spec Add event_pipeline.yaml management 2016-08-09 15:52:18 +10:00
templates Add event_pipeline.yaml management 2016-08-09 15:52:18 +10:00
.gitignore Add basic structure for ReNo 2016-03-14 08:24:10 -04:00
.gitreview Update .gitreview file for project rename 2015-06-12 23:12:30 +00:00
.travis.yml Add rspec tests for ceilometer and ceilometer::api 2013-04-04 17:40:02 -04:00
CHANGELOG.md Release 8.0.0 2016-03-23 16:06:56 -04:00
Gemfile Gemfile: rely on puppet-openstack_spec_helper for dependencies 2016-03-30 11:44:00 -04:00
LICENSE Synchronize LICENSE file with OpenStack projects 2015-04-20 09:17:21 -04:00
README.md Merge "Change wiki to docs" 2016-06-03 13:42:38 +00:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:13 -05:00
bindep.txt Move other-requirements.txt to bindep.txt 2016-08-12 21:05:28 +02:00
metadata.json Prepare 9.1.0 (newton-2) 2016-07-07 09:07:24 -04:00
setup.cfg Add basic structure for ReNo 2016-03-14 08:24:10 -04:00
setup.py Add basic structure for ReNo 2016-03-14 08:24:10 -04:00
test-requirements.txt Add basic structure for ReNo 2016-03-14 08:24:10 -04:00
tox.ini Add basic structure for ReNo 2016-03-14 08:24:10 -04:00

README.md

Ceilometer

Table of Contents

  1. Overview - What is the ceilometer module?
  2. Module Description - What does the module do?
  3. Setup - The basics of getting started with ceilometer
  4. Implementation - An under-the-hood peek at what the module is doing
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. Contributors - Those with commits

Overview

The ceilometer module is part of OpenStack, an effort by the OpenStack infrastructure team to provice continuous integration testing and code review for OpenStack and OpenStack community projects as part of the core software. The module itself is used to flexibly configure and manage the metering service for OpenStack.

Module Description

The ceilometer module is an attempt to make Puppet capable of managing the entirety of ceilometer. This includes manifests to provision the ceilometer api, agents, and database stores. A ceilometer_config type is supplied to assist in the manipulation of configuration files.

Setup

What the ceilometer module affects

Installing ceilometer

puppet module install openstack/ceilometer

Beginning with ceilometer

To utilize the ceilometer module's functionality you will need to declare multiple resources. This is not an exhaustive list of all the components needed. We recommend that you consult and understand the core openstack documentation to assist you in understanding the available deployment options.

class { '::ceilometer':
  telemetry_secret    => 'secrete',
  rabbit_userid       => 'ceilometer',
  rabbit_password     => 'an_even_bigger_secret',
  rabbit_host         => '127.0.0.1',
}
class { '::ceilometer::client': }
class { '::ceilometer::collector': }
class { '::ceilometer::expirer': }
class { '::ceilometer::agent::central': }
class { '::ceilometer::agent::notification': }
class { '::ceilometer::db': }
class { '::ceilometer::api':
  enabled               => true,
  keystone_password     => 'a_big_secret',
  keystone_identity_uri => 'http://127.0.0.1:35357/',
}

Implementation

ceilometer

ceilometer is a combination of Puppet manifests and Ruby code to deliver configuration and extra functionality through types and providers.

Types

ceilometer_config

The ceilometer_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/ceilometer/ceilometer.conf file.

ceilometer_config { 'DEFAULT/http_timeout' :
  value => 600,
}

This will write http_timeout=600 in the [DEFAULT] section.

name

Section/setting name to manage from ceilometer.conf

value

The value of the setting to be defined.

secret

Whether to hide the value from Puppet logs. Defaults to false.

ensure_absent_val

If value is equal to ensure_absent_val then the resource will behave as if ensure => absent was specified. Defaults to <SERVICE DEFAULT>

Limitations

  • The ceilometer modules have only been tested on RedHat and Ubuntu family systems.

Beaker-Rspec

This module has beaker-rspec tests

To run:

shell bundle install bundle exec rspec spec/acceptance

Development

Developer documentation for the entire puppet-openstack project

Contributors

This is the ceilometer module.