deb-ceilometer/doc/source/index.rst
gordon chung 51f478febe rewriting history
start to rewrite the purpose of 'ceilometer' and how it fits with
'telemetry'. this touches index and overview sections only.

updates
- fix gnocchi links
- correct goal of ceilometer (data collection only)
- make ceilometer api optional
- highlight purpose of ceilometer db vs gnocchi
- point out gnocchi is more responsive if not requiring full fidelity

Change-Id: Idce892227281d2cb1fe3c4c0cfdf048b487a3b7f
2016-02-02 23:15:50 +00:00

76 lines
1.8 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 is a data collection service that provides the
ability to normalise and transform data across all current OpenStack core
components with work underway to support future OpenStack components.
Ceilometer is a component of the Telemetry project. Its data can be used to
provide customer billing, resource tracking, and alarming capabilities
across all OpenStack core components.
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
gmr
Appendix
========
.. toctree::
:maxdepth: 1
releasenotes/index
glossary
api/index
.. update index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`