From f1514c60c0cd1edacc71d9f2da6233bd4b1e94d2 Mon Sep 17 00:00:00 2001 From: Jakub Pavlik Date: Fri, 20 May 2016 11:04:39 +0200 Subject: [PATCH] Add documentation and bug links Change-Id: I2aa255aa7795c9929c32fae7f9486f1665a3613f Closes-Bug: #1583855 --- README.rst | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 8ffe648..7e59df8 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,10 @@ Ceilometer ========== -The 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. +The 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. Sample pillars ============== @@ -96,8 +99,10 @@ Things to improve/consider ========================== * Graphite publisher http://engineering.spilgames.com/using-ceilometer-graphite/ -* Juno additions - Split Events/Meters and Alarms databases, Polling angets are HA now, active/Activr Workload partitioning to central agents -* Kilo additions - Splint Events - Meters - Agents, notification agents are HA now (everything is HA now), events - elastic search +* Juno additions - Split Events/Meters and Alarms databases, Polling angets are +HA now, active/Activr Workload partitioning to central agents +* Kilo additions - Splint Events - Meters - Agents, notification agents are HA +now (everything is HA now), events - elastic search * User notifier publisher vs rpc publisher (Juno+) * Enable jittering (rendom delay) to polling. (Kilo+) * Collect what you need - pipeline.yaml, tweak polling interval (Icehouse+) @@ -117,3 +122,29 @@ Deployment scenarios * Custom consumers - kafka - Apache Storm (kilo+) * Debugging - Collecttions - Elastic serach - Kibana * Noisy services - Multiple notification buses + +Documentation and Bugs +============================ + +To learn how to deploy OpenStack Salt, consult the documentation available +online at: + + https://wiki.openstack.org/wiki/OpenStackSalt + +In the unfortunate event that bugs are discovered, they should be reported to +the appropriate bug tracker. If you obtained the software from a 3rd party +operating system vendor, it is often wise to use their own bug tracker for +reporting problems. In all other cases use the master OpenStack bug tracker, +available at: + + http://bugs.launchpad.net/openstack-salt + +Developers wishing to work on the OpenStack Salt project should always base +their work on the latest formulas code, available from the master GIT +repository at: + + https://git.openstack.org/cgit/openstack/salt-formula-ceilometer + +Developers should also join the discussion on the IRC list, at: + + https://wiki.openstack.org/wiki/Meetings/openstack-salt