From 9c5020cd4354201b525a7f3b6f3d2cccdfce7adf Mon Sep 17 00:00:00 2001 From: "Nicolas Barcet (nijaba)" Date: Fri, 5 Oct 2012 20:16:43 +0200 Subject: [PATCH] Update readme and create release notes This is a first stab at the release notes which will need to be completed before release. Change-Id: Iecc5ebf5c7b23165b861d678ee97a7392099a7a2 --- README.md | 4 +++- ReleaseNotes | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 ReleaseNotes diff --git a/README.md b/README.md index 1017c3364..b6505ea63 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ ceilometer ========== -See blueprint at http://wiki.openstack.org/EfficientMetering +See the ReleaseNotes document and the project home for more info. + + http://launchpad.net/ceilometer diff --git a/ReleaseNotes b/ReleaseNotes new file mode 100644 index 000000000..2a31ad54a --- /dev/null +++ b/ReleaseNotes @@ -0,0 +1,34 @@ +Ceilometer v0.1 (Folsom) Release Notes +====================================== + +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 + +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 + +The project home is at: + http://launchpad.net/ceilometer +