From ae1d3d5821e7a537d6fd09d09e7f35164ddb262c Mon Sep 17 00:00:00 2001 From: "Nicolas Barcet (nijaba)" Date: Tue, 9 Oct 2012 17:17:13 +0200 Subject: [PATCH] Some more doc fixes 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 --- ReleaseNotes | 38 ++++----------------------- doc/source/contributing/areas.rst | 2 +- doc/source/contributing/resources.rst | 2 +- doc/source/install.rst | 2 +- doc/source/releasenotes/folsom.rst | 12 ++++----- 5 files changed, 14 insertions(+), 42 deletions(-) diff --git a/ReleaseNotes b/ReleaseNotes index 9769c83e4..921c1986f 100644 --- a/ReleaseNotes +++ b/ReleaseNotes @@ -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 -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: +Documentation for the project can be found at: http://ceilometer.readthedocs.org The project home is at: diff --git a/doc/source/contributing/areas.rst b/doc/source/contributing/areas.rst index 38510f733..c22dcc490 100644 --- a/doc/source/contributing/areas.rst +++ b/doc/source/contributing/areas.rst @@ -50,7 +50,7 @@ the service and manager base classes still need to move. 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 ceilometer to monitor a real OpenStack installation or to perform some load testing would be especially helpful. diff --git a/doc/source/contributing/resources.rst b/doc/source/contributing/resources.rst index fd1ce5b61..58935fa4b 100644 --- a/doc/source/contributing/resources.rst +++ b/doc/source/contributing/resources.rst @@ -20,7 +20,7 @@ ========================= :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 :Code Hosting: https://github.com/stackforge/ceilometer :Code Review: https://review.openstack.org/#/q/status:open+project:stackforge/ceilometer,n,z diff --git a/doc/source/install.rst b/doc/source/install.rst index 953339bb1..827d31e9b 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -20,7 +20,7 @@ Install ================================================ Installing and Running the Development Version -++++++++++++++++++++++++++++++++++++++++++++++= +++++++++++++++++++++++++++++++++++++++++++++++ Ceilometer has four daemons. The :term:`compute agent` runs on the Nova compute node(s) while the :term:`central agent` and diff --git a/doc/source/releasenotes/folsom.rst b/doc/source/releasenotes/folsom.rst index e79889912..384a2311a 100644 --- a/doc/source/releasenotes/folsom.rst +++ b/doc/source/releasenotes/folsom.rst @@ -20,34 +20,34 @@ Version 0.1 (Folsom) This is the first release of ceilometer. Please take all appropriate caution 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 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. -2. Components +Components 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 in :doc:`../measurements`. -3. Quantum delete events +Quantum delete events 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. -4. Database backend +Database backend The only tested and complete database backend is currently MongoDB, the SQLAlchemy one is still work in progress. -5. Installation +Installation 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. -6. Volume of data +Volume of data 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.