..
      Copyright 2012 Nicolas Barcet for Canonical

      Licensed under the Apache License, Version 2.0 (the "License"); you may
      not use this file except in compliance with the License. You may obtain
      a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
      License for the specific language governing permissions and limitations
      under the License.

==================================================
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
================

.. toctree::
   :maxdepth: 1

   initial_setup
   agent/writing_plugin_agent

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`