deb-ceilometer/doc/source/index.rst
Doug Hellmann 093c39b952 Add API documentation
Use sphinxcontrib-httpdomain to produce documentation for
the web API. Add docstrings to the exposed functions.

See http://packages.python.org/sphinxcontrib-httpdomain/
for details about the format of the auto-generated
output.

Change-Id: I62edd1d00c048c4bce34711a23686f0089bbf4e7
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2012-08-07 10:19:19 -04:00

2.7 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 ceilometer works and how to contribute to the project.

Table of contents

architecture measurements install configuration api contributing/index glossary

Indices and tables

  • genindex
  • modindex
  • search

To Do