aodh/doc/source/index.rst
Ildiko Vancsa b436ddad47 Fix doc gate job false success
pbr config was missing from setup.cfg. With adding "warnerrors = true"
under '[pbr]' in setup.cfg, the Sphinx build will fail in case of
warnings and errors during the build process.

This patch also fixes the currently existing problems in the developer
documentation of Ceilometer. The unused todo extension was also removed.

Fixes-Bug: #1317648
Fixes-Bug: #1321193
Fixes-Bug: #1272845

Change-Id: If1a9d7aca5c1d350568a83fb49bb8ea3defefdca
2014-06-02 18:11:45 +02:00

2.1 KiB

Welcome to the Ceilometer developer documentation!

The Ceilometer project aims to deliver a unique point of contact for billing systems to acquire all of the measurements they need to establish customer billing, across all current OpenStack core components with work underway to support future OpenStack components.

What is the purpose of the project and vision for it?

  • Provide efficient collection of metering data, in terms of CPU and network costs.
  • Allow deployers to integrate with the metering system directly or by replacing components.
  • Data may be collected by monitoring notifications sent from existing services or by polling the infrastructure.
  • Allow deployers to configure the type of data collected to meet their operating requirements.
  • The data collected by the metering system is made visible to some users through a REST API.
  • The metering messages are signed and non-repudiable.

This documentation offers information on how Ceilometer works and how to contribute to the project.

Table of contents

architecture measurements events install/index configuration webapi/index contributing/index releasenotes/index glossary sourcecode/autoindex

Indices and tables

  • genindex
  • modindex
  • search