OpenStack Ceilometer Puppet Module
Go to file
Tobias Urdin acdaa37d3a [ussuri][goal] Add CONTRIBUTING.rst
Story: 2007236
Task: 38552

Depends-On: https://review.opendev.org/#/c/726509/
Change-Id: I7a53fc5aaf3971f535acaf867cbbb1d5904346cd
2020-05-10 22:31:33 +02:00
doc Bump openstackdocstheme to 1.30.0 2020-04-30 15:28:37 +08:00
examples Deprecate ceilometer::expirer 2020-05-01 00:03:54 +09:00
lib/puppet Merge "Deprecate parameter and resource for api-paste.ini" 2020-05-04 14:11:12 +00:00
manifests Merge "Deprecate ceilometer::expirer" 2020-05-04 17:52:57 +00:00
releasenotes Merge "Deprecate ceilometer::expirer" 2020-05-04 17:52:57 +00:00
spec Merge "Deprecate ceilometer::expirer" 2020-05-04 17:52:57 +00:00
templates Add support to customize polling meters 2018-07-24 12:16:05 +02:00
.gitignore Dissuade .gitignore references to personal tools 2018-10-08 11:39:23 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:45:43 +00:00
.travis.yml Add rspec tests for ceilometer and ceilometer::api 2013-04-04 17:40:02 -04:00
.zuul.yaml switch documentation job to new PTI 2018-08-31 08:24:33 -04:00
bindep.txt Add Puppet package to bindep, for module build 2017-10-30 17:58:28 -04:00
CHANGELOG.md Optimize the link address and correct author 2017-06-21 10:25:12 +07:00
CONTRIBUTING.rst [ussuri][goal] Add CONTRIBUTING.rst 2020-05-10 22:31:33 +02:00
Gemfile Move to opendev 2019-04-21 14:44:48 +08:00
LICENSE Update LICENSE 2018-04-06 20:14:08 +08:00
metadata.json Runs on Debian 10. 2020-05-02 22:28:36 +02:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:13 -05:00
README.md Change rpsec to rspec 2020-04-30 13:24:45 +08:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-02 18:19:32 +01:00
setup.py Add basic structure for ReNo 2016-03-14 08:24:10 -04:00
tox.ini [ussuri][goal] Cleanup for python 2.7 drop 2020-02-15 18:42:57 -06:00

Team and repository tags

Team and repository tags

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. Beaker-Rspec - Beaker-rspec tests for the project
  7. Development - Guide for contributing to the module
  8. Release Notes - Release notes for the project
  9. Contributors - Those with commits
  10. Repository - The project source code repository

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',
  default_transport_url => 'rabbit://ceilometer:an_even_bigger_secret@127.0.0.1:5672',
}
class { 'ceilometer::keystone::auth':
  password => 'a_big_secret',
}
class { 'ceilometer::collector': }
class { 'ceilometer::expirer': }
class { 'ceilometer::agent::polling': }
class { 'ceilometer::agent::notification': }
class { 'ceilometer::db': }
class { 'ceilometer::keystone::authtoken':
  password => 'a_big_secret',
  auth_url => 'http://127.0.0.1:5000/',
}

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

Release Notes

Contributors

Repository

This is the ceilometer module.