libra/doc/config.rst
Marc Pilon 6aabea4b51 [API] Document all MnB config options
Change-Id: If8cb83f90deb7f1e55c53f09582777bdbc7505b4
2014-02-11 11:13:09 -05:00

5.6 KiB

Configuration

Configuration of Services

Configuration File Format

Libra uses the Oslo configuration library so its format is similar to other OpenStack programs.

DEFAULT Section

The [DEFAULT] section contains generic options common to the various Libra utilities (worker, mgm, etc).

[DEFAULT]
daemon = true
user = libra
group = libra
verbose = false
debug = false
billing_enable = false
notification_driver = []
default_notification_level = INFO
default_publisher_id = None
host = localhost
kombu_ssl_version =
kombu_ssl_keyfile =
kombu_ssl_certfile =
kombu_ssl_ca_certs =
rabbit_use_ssl = false
rabbit_userid = guest
rabbit_password = guest
rabbit_host = localhost
rabbit_port = 5672
rabbit_hosts = []
rabbit_virtual_host = / 
rabbit_retry_interval = 1
rabbit_retry_backoff = 2
rabbit_max_retries = 0
rabbit_ha_queues = false
control_exchange = openstack
amqp_durable_queues = false

Options supported in this section:

daemon

Run as a daemon. Default is 'true'.

user

Specifies the user for the process when in daemon mode. Default is the current user.

group

Specifies the group for the process when run in daemon mode.

verbose

Prints more verbose output. Sets logging level to INFO from WARNING

debug

Prints debug output. Sets logging level to DEBUG from WARNING

billing_enable

Enables the sending of billing information to a rabbitMQ host. It sends create and delete loadbalancer messages as well as exists and usage messages on a periodic, configurable basis. See admin_api config.

notification_driver

Driver or drivers to handle sending notifications for metering / billing. For instance, the openstack rpc driver is openstack.common.notifier.rpc_notifier.

default_notification_level

Default notification level for outgoing notifications

default_publisher_id

Default publisher_id for outgoing notifications

host

Default host name to use in notifications. Will use default_publisher_id or gethostname() if not set.

host

Default host name to use in notifications. Will use default_publisher_id or gethostname() if not set.

kombu_ssl_version

SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions

kombu_ssl_keyfile

SSL key file (valid only if SSL enabled)

kombu_ssl_certfile

SSL cert file (valid only if SSL enabled)

kombu_ssl_ca_certs

SSL certification authority file (valid only if SSL enabled)

rabbit_use_ssl

Connect over SSL for RabbitMQ

rabbit_userid

The RabbitMQ userid

rabbit_password

The RabbitMQ password

rabbit_host

The RabbitMQ broker address where a single node is used

rabbit_port

The RabbitMQ broker port where a single node is used

rabbit_hosts

RabbitMQ HA cluster host:port pairs

rabbit_virtual_host

The RabbitMQ virtual host

rabbit_retry_interval

How frequently to retry connecting with RabbitMQ

rabbit_retry_backoff

How long to backoff for between retries when connecting to RabbitMQ

rabbit_max_retries

Maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count)

rabbit_ha_queues

Use H/A queues in RabbitMQ (x-ha-policy: all). You need to wipe RabbitMQ database when changing this option.

control_exchange

AMQP exchange to connect to if using RabbitMQ or Qpid

amqp_durable_queues

Use durable queues in amqp.

Gearman Section

The [gearman] section contains options specific to connecting to a Gearman job server. All of the Libra utilities will read this section since each connects to Gearman.

In order to support SSL connections, it is required that all three SSL related options be supplied. Also, the user owning the process must be able to read all SSL files.

[gearman]
servers = 10.0.0.1:4730, 10.0.0.2:4730
poll = 1
ssl_ca = /etc/ssl/gearman.ca
ssl_cert = /etc/ssl/gearman.cert
ssl_key = /etc/ssl/gearman.key

Options supported in this section:

keepalive

Enable TCP KEEPALIVE pings. Default is 'false'.

keepcnt

Max KEEPALIVE probes to send before killing connection.

keepidle

Seconds of idle time before sending KEEPALIVE probes.

keepintvl

Seconds between TCP KEEPALIVE probes.

poll

Gearman worker polling timeout. Default is 1.

reconnect_sleep

Seconds to sleep between job server reconnects. Default is 60.

servers

Comma-separated list of Gearman job servers and port in HOST:PORT format.

ssl_ca

Gearman SSL certificate authority.

ssl_cert

Gearman SSL certificate.

ssl_key

Gearman SSL key.