~libra-core/libra/master

« back to all changes in this revision

Viewing changes to doc/config.rst

  • Committer: Monty Taylor
  • Date: 2015-10-17 20:03:27 UTC
  • Revision ID: git-v1:c7082fa72ac73b23b48ce63fc82aa7da2d3e5d6a
Retire stackforge/libra

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.. _configuration:
2
 
 
3
 
=============
4
 
Configuration
5
 
=============
6
 
 
7
 
Configuration of Services
8
 
=========================
9
 
 
10
 
Configuration File Format
11
 
-------------------------
12
 
   Libra uses the `Oslo configuration library <https://wiki.openstack.org/wiki/Oslo/Config>`_
13
 
   so its format is similar to other OpenStack programs.
14
 
 
15
 
DEFAULT Section
16
 
^^^^^^^^^^^^^^^
17
 
 
18
 
   The ``[DEFAULT]`` section contains generic options common to the various
19
 
   Libra utilities (worker, mgm, etc).
20
 
 
21
 
   .. code-block:: ini
22
 
 
23
 
      [DEFAULT]
24
 
      daemon = true
25
 
      user = libra
26
 
      group = libra
27
 
      verbose = false
28
 
      debug = false
29
 
      billing_enable = false
30
 
      notification_driver = []
31
 
      default_notification_level = INFO
32
 
      default_publisher_id = None
33
 
      host = localhost
34
 
      kombu_ssl_version =
35
 
      kombu_ssl_keyfile =
36
 
      kombu_ssl_certfile =
37
 
      kombu_ssl_ca_certs =
38
 
      rabbit_use_ssl = false
39
 
      rabbit_userid = guest
40
 
      rabbit_password = guest
41
 
      rabbit_host = localhost
42
 
      rabbit_port = 5672
43
 
      rabbit_hosts = []
44
 
      rabbit_virtual_host = / 
45
 
      rabbit_retry_interval = 1
46
 
      rabbit_retry_backoff = 2
47
 
      rabbit_max_retries = 0
48
 
      rabbit_ha_queues = false
49
 
      control_exchange = openstack
50
 
      amqp_durable_queues = false
51
 
 
52
 
   Options supported in this section:
53
 
 
54
 
   .. option:: daemon
55
 
 
56
 
      Run as a daemon. Default is 'true'.
57
 
 
58
 
   .. option:: user
59
 
 
60
 
      Specifies the user for the process when in daemon mode. Default is the
61
 
      current user.
62
 
 
63
 
   .. option:: group
64
 
 
65
 
      Specifies the group for the process when run in daemon mode.
66
 
 
67
 
   .. option:: verbose
68
 
 
69
 
      Prints more verbose output. Sets logging level to INFO from WARNING
70
 
 
71
 
   .. option:: debug
72
 
 
73
 
      Prints debug output. Sets logging level to DEBUG from WARNING
74
 
 
75
 
   .. option:: billing_enable
76
 
 
77
 
      Enables the sending of billing information to a rabbitMQ host. It sends
78
 
      create and delete loadbalancer messages as well as exists and usage 
79
 
      messages on a periodic, configurable basis. See admin_api config.
80
 
 
81
 
   .. option:: notification_driver
82
 
 
83
 
      Driver or drivers to handle sending notifications for metering / billing.
84
 
      For instance, the openstack rpc driver is 
85
 
      openstack.common.notifier.rpc_notifier.
86
 
 
87
 
   .. option:: default_notification_level
88
 
 
89
 
      Default notification level for outgoing notifications
90
 
 
91
 
   .. option:: default_publisher_id
92
 
 
93
 
      Default publisher_id for outgoing notifications
94
 
 
95
 
   .. option:: host
96
 
 
97
 
      Default host name to use in notifications. Will use default_publisher_id
98
 
      or gethostname() if not set.
99
 
 
100
 
   .. option:: host
101
 
 
102
 
      Default host name to use in notifications. Will use default_publisher_id
103
 
      or gethostname() if not set.
104
 
 
105
 
   .. option:: kombu_ssl_version
106
 
 
107
 
      SSL version to use (valid only if SSL enabled). valid values are TLSv1,
108
 
      SSLv23 and SSLv3. SSLv2 may be available on some distributions
109
 
 
110
 
   .. option:: kombu_ssl_keyfile
111
 
 
112
 
      SSL key file (valid only if SSL enabled)
113
 
 
114
 
   .. option:: kombu_ssl_certfile
115
 
 
116
 
      SSL cert file (valid only if SSL enabled)
117
 
 
118
 
   .. option:: kombu_ssl_ca_certs
119
 
 
120
 
      SSL certification authority file (valid only if SSL enabled)
121
 
 
122
 
   .. option:: rabbit_use_ssl
123
 
 
124
 
      Connect over SSL for RabbitMQ
125
 
 
126
 
   .. option:: rabbit_userid
127
 
 
128
 
      The RabbitMQ userid
129
 
 
130
 
   .. option:: rabbit_password
131
 
 
132
 
      The RabbitMQ password
133
 
 
134
 
   .. option:: rabbit_host
135
 
 
136
 
      The RabbitMQ broker address where a single node is used
137
 
 
138
 
   .. option:: rabbit_port
139
 
 
140
 
      The RabbitMQ broker port where a single node is used
141
 
 
142
 
   .. option:: rabbit_hosts
143
 
 
144
 
      RabbitMQ HA cluster host:port pairs
145
 
 
146
 
   .. option:: rabbit_virtual_host
147
 
 
148
 
      The RabbitMQ virtual host
149
 
 
150
 
   .. option:: rabbit_retry_interval
151
 
 
152
 
      How frequently to retry connecting with RabbitMQ
153
 
 
154
 
   .. option:: rabbit_retry_backoff
155
 
 
156
 
      How long to backoff for between retries when connecting to RabbitMQ
157
 
 
158
 
   .. option:: rabbit_max_retries
159
 
 
160
 
      Maximum retries with trying to connect to RabbitMQ (the default of 0
161
 
      implies an infinite retry count)
162
 
 
163
 
   .. option:: rabbit_ha_queues
164
 
 
165
 
      Use H/A queues in RabbitMQ (x-ha-policy: all). You need to wipe RabbitMQ
166
 
      database when changing this option.
167
 
 
168
 
   .. option:: control_exchange
169
 
 
170
 
      AMQP exchange to connect to if using RabbitMQ or Qpid
171
 
 
172
 
   .. option:: amqp_durable_queues
173
 
 
174
 
      Use durable queues in amqp.
175
 
 
176
 
Gearman Section
177
 
^^^^^^^^^^^^^^^
178
 
 
179
 
   The ``[gearman]`` section contains options specific to connecting to
180
 
   a Gearman job server. All of the Libra utilities will read this section
181
 
   since each connects to Gearman.
182
 
 
183
 
   In order to support SSL connections, it is required that all three SSL
184
 
   related options be supplied. Also, the user owning the process must be
185
 
   able to read all SSL files.
186
 
 
187
 
   .. code-block:: ini
188
 
 
189
 
      [gearman]
190
 
      servers = 10.0.0.1:4730, 10.0.0.2:4730
191
 
      poll = 1
192
 
      ssl_ca = /etc/ssl/gearman.ca
193
 
      ssl_cert = /etc/ssl/gearman.cert
194
 
      ssl_key = /etc/ssl/gearman.key
195
 
 
196
 
   Options supported in this section:
197
 
 
198
 
   .. option:: keepalive
199
 
 
200
 
      Enable TCP KEEPALIVE pings. Default is 'false'.
201
 
 
202
 
   .. option:: keepcnt
203
 
 
204
 
      Max KEEPALIVE probes to send before killing connection.
205
 
 
206
 
   .. option:: keepidle
207
 
 
208
 
      Seconds of idle time before sending KEEPALIVE probes.
209
 
 
210
 
   .. option:: keepintvl
211
 
 
212
 
      Seconds between TCP KEEPALIVE probes.
213
 
 
214
 
   .. option:: poll
215
 
 
216
 
      Gearman worker polling timeout. Default is 1.
217
 
 
218
 
   .. option:: reconnect_sleep
219
 
 
220
 
      Seconds to sleep between job server reconnects. Default is 60.
221
 
 
222
 
   .. option:: servers
223
 
 
224
 
      Comma-separated list of Gearman job servers and port in HOST:PORT format.
225
 
 
226
 
   .. option:: ssl_ca
227
 
 
228
 
      Gearman SSL certificate authority.
229
 
 
230
 
   .. option:: ssl_cert
231
 
 
232
 
      Gearman SSL certificate.
233
 
 
234
 
   .. option:: ssl_key
235
 
 
236
 
      Gearman SSL key.