openstack/ceilometer
Code Issues Proposed changes
ceilometer/doc/source/index.rst
Doug Hellmann 4bcd1c46a0 Add Sphinx wrapper around existing docs 
bug 1018443

This patch sets up a basic Sphinx project to allow us to
build the documentation. It also moves the "dev" docs
into the new doc source directory.

Change-Id: Ie2ad0f2e4ed237f1373c4357d5763fd5218d738a
2012-06-27 11:39:37 -04:00

1.9 KiB
Raw Blame History

Welcome to the Ceilometer developer documentation!

The ceilometer project aims to deliver a unique point of contact for billing systems to aquire all meters they need to establish customer billing, accross all current and future OpenStack core 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 (http://en.wikipedia.org/wiki/Non-repudiation)

This documentation has for objective to give you some clues on how to contribute code to ceilometer.

Table of content

initial_setup agent/writing_agent_plugin

Indices and tables

  • genindex
  • modindex
  • search