From 6aabea4b51a681187f49bc8226606f0e936f1280 Mon Sep 17 00:00:00 2001 From: Marc Pilon Date: Tue, 11 Feb 2014 11:13:09 -0500 Subject: [PATCH] [API] Document all MnB config options Change-Id: If8cb83f90deb7f1e55c53f09582777bdbc7505b4 --- doc/admin_api/config.rst | 56 +++++++++++++++++ doc/config.rst | 132 +++++++++++++++++++++++++++++++++++++++ etc/libra.cfg | 9 --- 3 files changed, 188 insertions(+), 9 deletions(-) diff --git a/doc/admin_api/config.rst b/doc/admin_api/config.rst index 924d7f7f..0d40d92a 100644 --- a/doc/admin_api/config.rst +++ b/doc/admin_api/config.rst @@ -161,3 +161,59 @@ Command Line Options The number of days before DELETED load balancers are purged from the database. The purge is run every 24 hours. Purge is not run if no value is provided. + + .. option:: --stats_enable + + Enable / Disable usage statistics gathering + + .. option:: --exists_freq + + Minutes between sending of billing exists messages + + .. option:: --usage_freq + + Minutes between sending of billing usage messages + + .. option:: --stats_freqs + + Minutes between collecting usage statistics + + .. option:: --stats_purge_enable + + Enable / Disable purging of usage statistics + + .. option:: --stats_purge_days + + Number of days to keep usage statistics + + .. option:: --delete_timer_seconds + + Which second of each minute delete timer should run + + .. option:: --ping_timer_seconds + + Which second of each minute ping timer should run + + .. option:: --stats_timer_seconds + + Which second of each minute statistics timer should run + + .. option:: --usage_timer_seconds + + Which second of each minute usage timer should run + + .. option:: --probe_timer_seconds + + Which second of each minute probe timer should run + + .. option:: --offline_timer_seconds + + Which second of each minute offline timer should run + + .. option:: --vips_timer_seconds + + Which second of each minute vips timer should run + + .. option:: --exists_timer_seconds + + Which second of each minute exists timer should run diff --git a/doc/config.rst b/doc/config.rst index 12541105..a238740c 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -24,6 +24,30 @@ DEFAULT Section 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: @@ -40,6 +64,114 @@ DEFAULT Section Specifies the group for the process when run in daemon mode. + .. option:: verbose + + Prints more verbose output. Sets logging level to INFO from WARNING + + .. option:: debug + + Prints debug output. Sets logging level to DEBUG from WARNING + + .. option:: 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. + + .. option:: notification_driver + + Driver or drivers to handle sending notifications for metering / billing. + For instance, the openstack rpc driver is + openstack.common.notifier.rpc_notifier. + + .. option:: default_notification_level + + Default notification level for outgoing notifications + + .. option:: default_publisher_id + + Default publisher_id for outgoing notifications + + .. option:: host + + Default host name to use in notifications. Will use default_publisher_id + or gethostname() if not set. + + .. option:: host + + Default host name to use in notifications. Will use default_publisher_id + or gethostname() if not set. + + .. option:: 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 + + .. option:: kombu_ssl_keyfile + + SSL key file (valid only if SSL enabled) + + .. option:: kombu_ssl_certfile + + SSL cert file (valid only if SSL enabled) + + .. option:: kombu_ssl_ca_certs + + SSL certification authority file (valid only if SSL enabled) + + .. option:: rabbit_use_ssl + + Connect over SSL for RabbitMQ + + .. option:: rabbit_userid + + The RabbitMQ userid + + .. option:: rabbit_password + + The RabbitMQ password + + .. option:: rabbit_host + + The RabbitMQ broker address where a single node is used + + .. option:: rabbit_port + + The RabbitMQ broker port where a single node is used + + .. option:: rabbit_hosts + + RabbitMQ HA cluster host:port pairs + + .. option:: rabbit_virtual_host + + The RabbitMQ virtual host + + .. option:: rabbit_retry_interval + + How frequently to retry connecting with RabbitMQ + + .. option:: rabbit_retry_backoff + + How long to backoff for between retries when connecting to RabbitMQ + + .. option:: rabbit_max_retries + + Maximum retries with trying to connect to RabbitMQ (the default of 0 + implies an infinite retry count) + + .. option:: rabbit_ha_queues + + Use H/A queues in RabbitMQ (x-ha-policy: all). You need to wipe RabbitMQ + database when changing this option. + + .. option:: control_exchange + + AMQP exchange to connect to if using RabbitMQ or Qpid + + .. option:: amqp_durable_queues + + Use durable queues in amqp. Gearman Section ^^^^^^^^^^^^^^^ diff --git a/etc/libra.cfg b/etc/libra.cfg index f1314a04..bdfd9b07 100644 --- a/etc/libra.cfg +++ b/etc/libra.cfg @@ -19,12 +19,6 @@ #group = libra #billing_enable = False -# Other logging options -#syslog = false -#syslog_socket = /dev/log -#syslog_faciltiy = local7 -#logstash = HOST:PORT - # Openstack #notification_driver = openstack.common.notifier.rpc_notifier #default_notification_level = INFO @@ -49,9 +43,6 @@ rabbit_use_ssl = True #rabbit_retry_backoff = 2 #rabbit_max_retries = 0 #rabbit_ha_queues = False -#rpc_thread_pool_size = 64 -#rpc_conn_pool_size = 30 -#rpc_response_timeout = 60 #control_exchange = openstack #amqp_durable_queues = False