aodh/doc/source/index.rst
Doug Hellmann ca1444764f Start updating documentation for V2 API
Move the web API documentation into the 'webapi'
subdirectory to avoid conflicts with the auto-generated
'api' directory contents. Create a v2 doc file
as a placeholder until the automatic documentation
features of WSME are more complete.

blueprint api-server-pecan-wsme

Change-Id: Ide11ad0b4cebb29318b8bb977bc5165334e22a2c
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2012-12-04 12:58:03 -05: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 webapi/index contributing/index releasenotes/index api/index glossary

Indices and tables

  • genindex
  • modindex
  • search

To Do