OpenStack Ceilometer Puppet Module
Go to file
OpenStack Release Bot 8fed7967ea Update master for stable/wallaby
Add file to the reno documentation build to show release notes for
stable/wallaby.

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on
stable/wallaby.

Sem-Ver: feature
Change-Id: Id0f7e4f49cb4e582b7b1c3df4ab96a79afa8cd94
2021-04-01 09:12:56 +00:00
doc Update sphinx to the latest version 2021-03-27 15:31:56 +08:00
examples Deprecate ceilometer::expirer 2020-05-01 00:03:54 +09:00
lib/puppet Remove api_paste_ini resource 2020-10-12 10:30:49 +00:00
manifests Merge "Use consistent names for service_credentials options" 2021-03-26 05:42:10 +00:00
releasenotes Update master for stable/wallaby 2021-04-01 09:12:56 +00:00
spec Merge "Use consistent names for service_credentials options" 2021-03-26 05:42:10 +00:00
templates Remove transformers from pipeline.yaml 2021-01-19 22:05:15 +09: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 Change to Puppet Litmus 2020-09-20 18:56:20 +02: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 Use openstack_spec_helper from zuul checkout 2020-08-30 22:53:21 +02:00
LICENSE Update LICENSE 2018-04-06 20:14:08 +08:00
README.md Change to Puppet Litmus 2020-09-20 18:56:20 +02:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:13 -05:00
bindep.txt Add Puppet package to bindep, for module build 2017-10-30 17:58:28 -04:00
metadata.json Merge "metadata.json: debian 11" 2021-03-31 07:04:14 +00: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 Replace deprecated UPPER_CONSTRAINTS_FILE variable 2020-11-11 09:08:35 +08:00

README.md

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. Development - Guide for contributing to the module
  7. Release Notes - Release notes for the project
  8. Contributors - Those with commits
  9. 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::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.

Development

Developer documentation for the entire puppet-openstack project

Release Notes

Contributors

Repository

This is the ceilometer module.