Browse code

Document local.conf settings for ceilometer

Describe the various settings that can be made to control the
behavior of Ceilometer. Doing in lib/ceilometer for now. When there
is more something under doc may be warranted.

Change-Id: I9cd47085a5e91bae0a88f6e26f6c8bdc86c02978

Chris Dent authored on 2014/12/08 23:26:28
Showing 1 changed files
... ...
@@ -1,13 +1,32 @@
1 1
 # lib/ceilometer
2 2
 # Install and start **Ceilometer** service
3 3
 
4
-# To enable a minimal set of Ceilometer services, add the following to localrc:
4
+# To enable a minimal set of Ceilometer services, add the following to the
5
+# localrc section of local.conf:
5 6
 #
6 7
 #   enable_service ceilometer-acompute ceilometer-acentral ceilometer-anotification ceilometer-collector ceilometer-api
7 8
 #
8
-# To ensure Ceilometer alarming services are enabled also, further add to the localrc:
9
+# To ensure Ceilometer alarming services are enabled also, further add to the
10
+# localrc section of local.conf:
9 11
 #
10 12
 #   enable_service ceilometer-alarm-notifier ceilometer-alarm-evaluator
13
+#
14
+# To ensure events are stored, add the following section to local.conf:
15
+#
16
+#   [[post-config|$CEILOMETER_CONF]]
17
+#   [notification]
18
+#   store_events=True
19
+#
20
+# Several variables set in the localrc section adjust common behaviors
21
+# of Ceilometer (see within for additional settings):
22
+#
23
+#   CEILOMETER_USE_MOD_WSGI:       When True, run the api under mod_wsgi.
24
+#   CEILOMETER_PIPELINE_INTERVAL:  The number of seconds between pipeline processing
25
+#                                  runs. Default 600.
26
+#   CEILOMETER_BACKEND:            The database backend (e.g. 'mysql', 'mongodb')
27
+#   CEILOMETER_COORDINATION_URL:   The URL for a group membership service provided
28
+#                                  by tooz.
29
+
11 30
 
12 31
 # Dependencies:
13 32
 #