blob: 86c8b783661f5b81dce18286d0c9b2bfd6ce515f [file] [log] [blame]
Filip Pytlouna87b4712015-10-06 16:28:31 +02001
Aleš Komárek59ee0a82017-04-11 13:49:58 +02002==================
3Ceilometer Formula
4==================
Filip Pytlouna87b4712015-10-06 16:28:31 +02005
Jakub Pavlikf1514c62016-05-20 11:04:39 +02006The ceilometer project aims to deliver a unique point of contact for billing
7systems to acquire all of the measurements they need to establish customer
Nadya Shakhat3c3ed672017-05-02 13:58:17 +04008billing, across all current OpenStack components with work underway to
Jakub Pavlikf1514c62016-05-20 11:04:39 +02009support future OpenStack components.
Nadya Shakhat3c3ed672017-05-02 13:58:17 +040010This formula provides different backends for Ceilometer data: MongoDB, InfluxDB. Also,
11Graphite and direct (to Elasticsearch) publishers are available. If InfluxDB is used
12as a backend, heka is configured to consume messages from RabbitMQ and write in to
13InfluxDB, i.e. ceilometer collector service is not used in this configuration.
Filip Pytlouna87b4712015-10-06 16:28:31 +020014
Aleš Komárek59ee0a82017-04-11 13:49:58 +020015Sample Pillars
Filip Pytlouna87b4712015-10-06 16:28:31 +020016==============
17
18Ceilometer API/controller node
19
20.. code-block:: yaml
21
22 ceilometer:
23 server:
24 enabled: true
Nadya Shakhat3c3ed672017-05-02 13:58:17 +040025 version: mitaka
Filip Pytlouna87b4712015-10-06 16:28:31 +020026 cluster: true
27 secret: pwd
28 bind:
29 host: 127.0.0.1
30 port: 8777
31 identity:
32 engine: keystone
33 host: 127.0.0.1
34 port: 35357
35 tenant: service
36 user: ceilometer
37 password: pwd
38 message_queue:
39 engine: rabbitmq
40 host: 127.0.0.1
41 port: 5672
42 user: openstack
43 password: pwd
44 virtual_host: '/openstack'
Nadya Shakhat3c3ed672017-05-02 13:58:17 +040045
46Databases configuration
47
48MongoDB example:
49
50.. code-block:: yaml
51
52 ceilometer:
53 server:
Filip Pytlouna87b4712015-10-06 16:28:31 +020054 database:
55 engine: mongodb
Nadya Shakhat3c3ed672017-05-02 13:58:17 +040056 members:
57 - host: 10.0.106.10
58 port: 27017
59 - host: 10.0.106.20
60 port: 27017
61 - host: 10.0.106.30
62 port: 27017
Filip Pytlouna87b4712015-10-06 16:28:31 +020063 name: ceilometer
64 user: ceilometer
Nadya Shakhat3c3ed672017-05-02 13:58:17 +040065 password: password
66
67InfluxDB/Elasticsearch example:
68
69.. code-block:: yaml
70
71 ceilometer:
72 server:
73 database:
74 influxdb:
75 host: 10.0.106.10
76 port: 8086
77 user: ceilometer
78 password: password
79 database: ceilometer
80 elasticsearch:
81 enabled: true
82 host: 10.0.106.10
83 port: 9200
Filip Pytlouna87b4712015-10-06 16:28:31 +020084
smolaond0d14d22016-05-31 10:30:15 +020085Client-side RabbitMQ HA setup
86
87.. code-block:: yaml
88
89 ceilometer:
90 server:
91 ....
92 message_queue:
93 engine: rabbitmq
94 members:
Nadya Shakhat3c3ed672017-05-02 13:58:17 +040095 - host: 10.0.106.10
96 - host: 10.0.106.20
97 - host: 10.0.106.30
smolaond0d14d22016-05-31 10:30:15 +020098 user: openstack
99 password: pwd
100 virtual_host: '/openstack'
101 ....
102
103
Filip Pytlouna87b4712015-10-06 16:28:31 +0200104Ceilometer Graphite publisher
105
106.. code-block:: yaml
107
108 ceilometer:
109 server:
110 enabled: true
111 publisher:
112 graphite:
113 enabled: true
114 host: 10.0.0.1
115 port: 2003
116
117Ceilometer compute agent
118
119.. code-block:: yaml
120
121 ceilometer:
122 agent:
123 enabled: true
Nadya Shakhat3c3ed672017-05-02 13:58:17 +0400124 version: mitaka
Filip Pytlouna87b4712015-10-06 16:28:31 +0200125 secret: pwd
126 identity:
127 engine: keystone
128 host: 127.0.0.1
129 port: 35357
130 tenant: service
131 user: ceilometer
132 password: pwd
133 message_queue:
134 engine: rabbitmq
135 host: 127.0.0.1
136 port: 5672
137 user: openstack
138 password: pwd
139 virtual_host: '/openstack'
140 rabbit_ha_queues: true
141
Aleš Komárek59ee0a82017-04-11 13:49:58 +0200142More Information
143================
Filip Pytlouna87b4712015-10-06 16:28:31 +0200144
145* https://wiki.openstack.org/wiki/Ceilometer
146* http://docs.openstack.org/developer/ceilometer/install/manual.html
147* http://docs.openstack.org/developer/ceilometer/
148* https://fedoraproject.org/wiki/QA:Testcase_OpenStack_ceilometer_install
149* https://github.com/spilgames/ceilometer_graphite_publisher
150* http://engineering.spilgames.com/using-ceilometer-graphite/
151
Filip Pytloun23f63e12017-02-02 13:02:03 +0100152
153Documentation and Bugs
154======================
155
156To learn how to install and update salt-formulas, consult the documentation
157available online at:
158
159 http://salt-formulas.readthedocs.io/
160
161In the unfortunate event that bugs are discovered, they should be reported to
162the appropriate issue tracker. Use Github issue tracker for specific salt
163formula:
164
165 https://github.com/salt-formulas/salt-formula-ceilometer/issues
166
167For feature requests, bug reports or blueprints affecting entire ecosystem,
168use Launchpad salt-formulas project:
169
170 https://launchpad.net/salt-formulas
171
172You can also join salt-formulas-users team and subscribe to mailing list:
173
174 https://launchpad.net/~salt-formulas-users
175
176Developers wishing to work on the salt-formulas projects should always base
177their work on master branch and submit pull request against specific formula.
178
179 https://github.com/salt-formulas/salt-formula-ceilometer
180
181Any questions or feedback is always welcome so feel free to join our IRC
182channel:
183
184 #salt-formulas @ irc.freenode.net