summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoanna H. Huang <joanna.huitzu.huang@gmail.com>2014-09-17 13:04:57 +0000
committerJoanna H. Huang <joanna.huitzu.huang@gmail.com>2014-09-18 15:54:45 +0000
commit49371bbd2dee1a0140177ed8db57120e9f2e31c0 (patch)
tree5c6990a0d47304c63e15154a26882380705afae0
parent85b859f42f10038edd22578cad266e5be58ceb01 (diff)
downloadceilometer-49371bbd2dee1a0140177ed8db57120e9f2e31c0.tar.gz
Modified docs to update DevStack's config filename
As reported in the bug, the documentation needs to be updated with new config file DevStack uses. This patch simply updates information in "Installing and Running the Development Version" page. Change-Id: I5ee8f528be44b4fe801b38c748fff7314980a93e Closes-Bug: #1370476
-rw-r--r--doc/source/install/development.rst30
1 files changed, 20 insertions, 10 deletions
diff --git a/doc/source/install/development.rst b/doc/source/install/development.rst
index 1d45bcea..5addf61d 100644
--- a/doc/source/install/development.rst
+++ b/doc/source/install/development.rst
@@ -34,7 +34,15 @@ Configuring Devstack
.. index::
double: installing; devstack
-1. Create a ``localrc`` file as input to devstack.
+1. Create a ``local.conf`` file as input to devstack.
+
+ .. note::
+
+ ``local.conf`` replaces the former configuration file called ``localrc``.
+ If you used localrc before, remove it to switch to using the new file.
+ For further information see the `localrc description page
+ <http://devstack.org/localrc.html>`_ or `devstack configuration
+ <http://devstack.org/configuration.html>`_.
2. Ceilometer makes extensive use of the messaging bus, but has not
yet been tested with ZeroMQ. We recommend using Rabbit or qpid for
@@ -50,19 +58,21 @@ Configuring Devstack
notification_driver=cinder.openstack.common.notifier.rpc_notifier
5. The ceilometer services are not enabled by default, so they must be
- enabled in ``localrc`` before running ``stack.sh``.
+ enabled in ``local.conf`` before running ``stack.sh``.
+
+ This example ``local.conf`` file shows all of the settings required for
+ ceilometer::
-This example ``localrc`` file shows all of the settings required for
-ceilometer::
+ [[local|localrc]]
- # Enable the ceilometer metering services
- enable_service ceilometer-acompute ceilometer-acentral ceilometer-anotification ceilometer-collector
+ # Enable the ceilometer metering services
+ enable_service ceilometer-acompute ceilometer-acentral ceilometer-anotification ceilometer-collector
- # Enable the ceilometer alarming services
- enable_service ceilometer-alarm-evaluator,ceilometer-alarm-notifier
+ # Enable the ceilometer alarming services
+ enable_service ceilometer-alarm-evaluator,ceilometer-alarm-notifier
- # Enable the ceilometer api services
- enable_service ceilometer-api
+ # Enable the ceilometer api services
+ enable_service ceilometer-api
6. If you use Data Processing (Sahara) service at your DevStack, it will
generate notifications by default.