aodh/doc/source/index.rst
Ildiko Vancsa 93c094755d Remove duplications from docco
This patch removes some duplications which we have since the Admin
Guide for Ceilometer exists. The Measurements section is moved
under contributing, as the list of meters is now moved to OPenStack
Manuals. The corresponding patch sets available here:

https://review.openstack.org/#/q/status:open+project:openstack/openstack-manuals+branch:master+topic:telemetry-measurements,n,z

Change-Id: I2bdf6c929136df43dad98758e5ac6f4e50f20d61
2015-02-27 22:32:19 +01:00

87 lines
2.3 KiB
ReStructuredText

..
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 :term:`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 :term:`non-repudiable`.
This documentation offers information on how Ceilometer works and how to
contribute to the project.
Overview
========
.. toctree::
:maxdepth: 2
overview
architecture
measurements
events
webapi/index
Developer Documentation
=======================
.. toctree::
:maxdepth: 2
install/index
configuration
plugins
new_meters
testing
contributing
Appendix
========
.. toctree::
:maxdepth: 1
releasenotes/index
glossary
sourcecode/autoindex
.. update index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`