openstack/deb-ceilometer
Code Issues Proposed changes

Some more doc fixes

Browse Source 
There was a spurious = at the end of a line in install.rst that made
the TOC go bad.

Updated the link to the new dev mailing list

areas.rst - testing was mentioning a pre-release, changed to first
version.

Reformated (again) the release notes, hoping it will render better.

Updated the ReleaseNotes file to now point to the rst

Change-Id: Iabf03772498094b0b7e1014abb7fa56547feb636
This commit is contained in:
Nicolas Barcet (nijaba) 2012-10-09 17:17:13 +02:00
parent fe3be9bacd
commit ae1d3d5821
5 changed files with 14 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
ReleaseNotes
View File

@ -1,37 +1,9 @@
Ceilometer v0.1 (Folsom) Release Notes Release notes are maintained in rst format in
====================================== doc/source/releasenotes/
they can be read online at
http://ceilometer.readthedocs.org/en/latest/releasenotes/index.html
This is the first release of ceilometer. Please take all appropriate caution Documentation for the project can be found at:
in using it, as it is a technology preview at this time.
It is curently tested to work with OpenStack 2012.2 Folsom. Due to its use of
openstack-common, and the modification that were made in term of notification
to many other components (glance, cinder, quantum), it will not easily work
with any prior version of OpenStack.
Currently covered components are: Nova, Nova-network, Glance, Cinder and
Quantum. Notably, there is no support yet for Swift and it was decided not
to support nova-volume in favor of Cinder. A detailed list of meters covered
per component can be found at:
xxxx
Quantum delete notifications do not include the same metadata as the other
messages, so we ignore them for now. This isn't ideal, since it may mean we
miss charging for some amount of time, but it is better than throwing away the
existing metadata for a resource when it is deleted.
The only tested and complete database backend is currently MongoDB, the
SQLAlchemy one is still work in progress.
The current best source of information on how to deploy this project is found
as the devstack implementation but feel free to come to #openstack-metering on
freenode for more info.
Please note that metering can generate lots of data very quickly. Have a look
at the following spreadsheet to evaluate what you will end up with.
http://wiki.openstack.org/EfficientMetering#Volume_of_data
Some documentation for the project can be found at:
http://ceilometer.readthedocs.org http://ceilometer.readthedocs.org
The project home is at: The project home is at:

2
doc/source/contributing/areas.rst
View File

@ -50,7 +50,7 @@ the service and manager base classes still need to move.
Testing Testing
======= =======
The pre-release version of ceilometer has extensive unit tests, but The first version of ceilometer has extensive unit tests, but
has not seen much run-time in real environments. Setting up a copy of has not seen much run-time in real environments. Setting up a copy of
ceilometer to monitor a real OpenStack installation or to perform some ceilometer to monitor a real OpenStack installation or to perform some
load testing would be especially helpful. load testing would be especially helpful.

2
doc/source/contributing/resources.rst
View File

@ -20,7 +20,7 @@
========================= =========================
:Bug tracker: http://launchpad.net/ceilometer :Bug tracker: http://launchpad.net/ceilometer
:Mailing list: http://lists.launchpad.net/openstack (prefix subjects with ``[metering]`` for faster responses) :Mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev (prefix subjects with ``[metering]`` for faster responses)
:Wiki: http://wiki.openstack.org/EfficientMetering :Wiki: http://wiki.openstack.org/EfficientMetering
:Code Hosting: https://github.com/stackforge/ceilometer :Code Hosting: https://github.com/stackforge/ceilometer
:Code Review: https://review.openstack.org/#/q/status:open+project:stackforge/ceilometer,n,z :Code Review: https://review.openstack.org/#/q/status:open+project:stackforge/ceilometer,n,z

2
doc/source/install.rst
View File

@ -20,7 +20,7 @@ Install
================================================ ================================================
Installing and Running the Development Version Installing and Running the Development Version
++++++++++++++++++++++++++++++++++++++++++++++= ++++++++++++++++++++++++++++++++++++++++++++++
Ceilometer has four daemons. The :term:`compute agent` runs on the Ceilometer has four daemons. The :term:`compute agent` runs on the
Nova compute node(s) while the :term:`central agent` and Nova compute node(s) while the :term:`central agent` and

12
doc/source/releasenotes/folsom.rst
View File

@ -20,34 +20,34 @@ Version 0.1 (Folsom)
This is the first release of ceilometer. Please take all appropriate caution This is the first release of ceilometer. Please take all appropriate caution
in using it, as it is a technology preview at this time. in using it, as it is a technology preview at this time.
1. Version of OpenStack Version of OpenStack
It is curently tested to work with OpenStack 2012.2 Folsom. Due to its use of It is curently tested to work with OpenStack 2012.2 Folsom. Due to its use of
openstack-common, and the modification that were made in term of notification openstack-common, and the modification that were made in term of notification
to many other components (glance, cinder, quantum), it will not easily work to many other components (glance, cinder, quantum), it will not easily work
with any prior version of OpenStack. with any prior version of OpenStack.
2. Components Components
Currently covered components are: Nova, Nova-network, Glance, Cinder and Currently covered components are: Nova, Nova-network, Glance, Cinder and
Quantum. Notably, there is no support yet for Swift and it was decided not Quantum. Notably, there is no support yet for Swift and it was decided not
to support nova-volume in favor of Cinder. A detailed list of meters covered to support nova-volume in favor of Cinder. A detailed list of meters covered
per component can be found at in :doc:`../measurements`. per component can be found at in :doc:`../measurements`.
3. Quantum delete events Quantum delete events
Quantum delete notifications do not include the same metadata as the other Quantum delete notifications do not include the same metadata as the other
messages, so we ignore them for now. This isn't ideal, since it may mean we messages, so we ignore them for now. This isn't ideal, since it may mean we
miss charging for some amount of time, but it is better than throwing away the miss charging for some amount of time, but it is better than throwing away the
existing metadata for a resource when it is deleted. existing metadata for a resource when it is deleted.
4. Database backend Database backend
The only tested and complete database backend is currently MongoDB, the The only tested and complete database backend is currently MongoDB, the
SQLAlchemy one is still work in progress. SQLAlchemy one is still work in progress.
5. Installation Installation
The current best source of information on how to deploy this project is found The current best source of information on how to deploy this project is found
as the devstack implementation but feel free to come to #openstack-metering on as the devstack implementation but feel free to come to #openstack-metering on
freenode for more info. freenode for more info.
6. Volume of data Volume of data
Please note that metering can generate lots of data very quickly. Have a look Please note that metering can generate lots of data very quickly. Have a look
at the following spreadsheet to evaluate what you will end up with. at the following spreadsheet to evaluate what you will end up with.