Load-Balancer-as-a-Service configuration options

Load-Balancer-as-a-Service configuration options

Use the following options in the neutron_lbaas.conf file for the LBaaS agent.

Description of Load-Balancer-as-a-Service configuration options
Configuration option = Default value Description
[certificates]  
barbican_auth = barbican_acl_auth (String) Name of the Barbican authentication method to use
cert_manager_type = barbican (String) Certificate Manager plugin. Defaults to barbican.
storage_path = /var/lib/neutron-lbaas/certificates/ (String) Absolute path to the certificate storage directory. Defaults to env[OS_LBAAS_TLS_STORAGE].

Use the following options in the lbaas_agent.ini file for the LBaaS agent.

Description of LBaaS agent configuration options
Configuration option = Default value Description
[DEFAULT]  
debug = False (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level.
device_driver = ['neutron_lbaas.drivers.haproxy.namespace_driver.HaproxyNSDriver'] (Multi-valued) Drivers used to manage loadbalancing devices
interface_driver = None (String) The driver used to manage the virtual interface.
periodic_interval = 40 (Integer) Seconds between running periodic tasks
[haproxy]  
loadbalancer_state_path = $state_path/lbaas (String) Location to store config and state files
send_gratuitous_arp = 3 (Integer) When delete and re-add the same vip, send this many gratuitous ARPs to flush the ARP cache in the Router. Set it below or equal to 0 to disable this feature.
user_group = nogroup (String) The user group

Use the following options in the services_lbaas.conf file for the LBaaS agent.

Description of LBaaS Embrane, Radware, NetScaler, HAproxy, octavia plug-in configuration options
Configuration option = Default value Description
[DEFAULT]  
loadbalancer_pool_scheduler_driver = neutron_lbaas.services.loadbalancer.agent_scheduler.ChanceScheduler (String) Driver to use for scheduling pool to a default loadbalancer agent
loadbalancer_scheduler_driver = neutron_lbaas.agent_scheduler.ChanceScheduler (String) Driver to use for scheduling to a default loadbalancer agent
[haproxy]  
jinja_config_template = /usr/lib/python/site-packages/neutron-lbaas/neutron_lbaas/services/loadbalancer/drivers/haproxy/templates/haproxy.loadbalancer.j2 (String) Jinja template file for haproxy configuration
[netscaler_driver]  
is_synchronous = True (String) Setting for option to enable synchronous operationsNetScaler Control Center Server.
netscaler_ncc_cleanup_mode = None (String) Setting to enable/disable cleanup mode for NetScaler Control Center Server
netscaler_ncc_password = None (String) Password to login to the NetScaler Control Center Server.
netscaler_ncc_uri = None (String) The URL to reach the NetScaler Control Center Server.
netscaler_ncc_username = None (String) Username to login to the NetScaler Control Center Server.
netscaler_status_collection = True,300 (String) Setting for member status collection fromNetScaler Control Center Server.
periodic_task_interval = 2 (String) Setting for periodic task collection interval fromNetScaler Control Center Server..
[octavia]  
allocates_vip = False (Boolean) True if Octavia will be responsible for allocating the VIP. False if neutron-lbaas will allocate it and pass to Octavia.
base_url = http://127.0.0.1:9876 (String) URL of Octavia controller root
request_poll_interval = 3 (Integer) Interval in seconds to poll octavia when an entity is created, updated, or deleted.
request_poll_timeout = 100 (Integer) Time to stop polling octavia when a status of an entity does not change.
[radware]  
actions_to_skip = setup_l2_l3 (List) List of actions that are not pushed to the completion queue.
ha_secondary_address = None (String) IP address of secondary vDirect server.
l2_l3_ctor_params = {'ha_network_name': 'HA-Network', 'service': '_REPLACE_', 'ha_ip_pool_name': 'default', 'twoleg_enabled': '_REPLACE_', 'allocate_ha_ips': True, 'allocate_ha_vrrp': True} (Dict) Parameter for l2_l3 workflow constructor.
l2_l3_setup_params = {'data_ip_address': '192.168.200.99', 'data_port': 1, 'gateway': '192.168.200.1', 'ha_port': 2, 'data_ip_mask': '255.255.255.0'} (Dict) Parameter for l2_l3 workflow setup.
l2_l3_workflow_name = openstack_l2_l3 (String) Name of l2_l3 workflow. Default: openstack_l2_l3.
l4_action_name = BaseCreate (String) Name of the l4 workflow action. Default: BaseCreate.
l4_workflow_name = openstack_l4 (String) Name of l4 workflow. Default: openstack_l4.
service_adc_type = VA (String) Service ADC type. Default: VA.
service_adc_version = (String) Service ADC version.
service_cache = 20 (Integer) Size of service cache. Default: 20.
service_compression_throughput = 100 (Integer) Service compression throughput. Default: 100.
service_ha_pair = False (Boolean) Enables or disables the Service HA pair. Default: False.
service_isl_vlan = -1 (Integer) A required VLAN for the interswitch link to use.
service_resource_pool_ids = (List) Resource pool IDs.
service_session_mirroring_enabled = False (Boolean) Enable or disable Alteon interswitch link for stateful session failover. Default: False.
service_ssl_throughput = 100 (Integer) Service SSL throughput. Default: 100.
service_throughput = 1000 (Integer) Service throughput. Default: 1000.
vdirect_address = None (String) IP address of vDirect server.
vdirect_password = radware (String) vDirect user password.
vdirect_user = vDirect (String) vDirect user name.
[radwarev2]  
child_workflow_template_names = manage_l3 (List) Name of child workflow templates used.Default: manage_l3
ha_secondary_address = None (String) IP address of secondary vDirect server.
service_adc_type = VA (String) Service ADC type. Default: VA.
service_adc_version = (String) Service ADC version.
service_cache = 20 (Integer) Size of service cache. Default: 20.
service_compression_throughput = 100 (Integer) Service compression throughput. Default: 100.
service_ha_pair = False (Boolean) Enables or disables the Service HA pair. Default: False.
service_isl_vlan = -1 (Integer) A required VLAN for the interswitch link to use.
service_resource_pool_ids = (List) Resource pool IDs.
service_session_mirroring_enabled = False (Boolean) Enable or disable Alteon interswitch link for stateful session failover. Default: False.
service_ssl_throughput = 100 (Integer) Service SSL throughput. Default: 100.
service_throughput = 1000 (Integer) Service throughput. Default: 1000.
stats_action_name = stats (String) Name of the workflow action for statistics. Default: stats.
vdirect_address = None (String) IP address of vDirect server.
vdirect_password = radware (String) vDirect user password.
vdirect_user = vDirect (String) vDirect user name.
workflow_action_name = apply (String) Name of the workflow action. Default: apply.
workflow_params = {'data_ip_address': '192.168.200.99', 'ha_network_name': 'HA-Network', 'ha_port': 2, 'allocate_ha_ips': True, 'ha_ip_pool_name': 'default', 'allocate_ha_vrrp': True, 'data_port': 1, 'gateway': '192.168.200.1', 'twoleg_enabled': '_REPLACE_', 'data_ip_mask': '255.255.255.0'} (Dict) Parameter for l2_l3 workflow constructor.
workflow_template_name = os_lb_v2 (String) Name of the workflow template. Default: os_lb_v2.
[radwarev2_debug]  
configure_l3 = True (Boolean) Configule ADC with L3 parameters?
configure_l4 = True (Boolean) Configule ADC with L4 parameters?
provision_service = True (Boolean) Provision ADC service?

Octavia configuration options

Octavia is an operator-grade open source load balancing solution. Use the following options in the /etc/octavia/octavia.conf file to configure the octavia service.

Description of authorization token configuration options
Configuration option = Default value Description
[keystone_authtoken]  
admin_password = None (String) Service user password.
admin_tenant_name = admin (String) Service tenant name.
admin_token = None (String) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use admin_user and admin_password instead.
admin_user = None (String) Service username.
auth_admin_prefix = (String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri.
auth_host = 127.0.0.1 (String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.
auth_port = 35357 (Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri.
auth_protocol = https (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri.
auth_section = None (Unknown) Config Section from which to load plugin specific options
auth_type = None (Unknown) Authentication type to load
auth_uri = None (String) Complete public Identity API endpoint.
auth_version = None (String) API version of the admin Identity API endpoint.
cache = None (String) Env key for the swift cache.
cafile = None (String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
certfile = None (String) Required if identity server requires client certificate
check_revocations_for_cached = False (Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
delay_auth_decision = False (Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
enforce_token_bind = permissive (String) Used to control the use and type of token binding. Can be set to: “disabled” to not check token binding. “permissive” (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. “strict” like “permissive” but if the bind type is unknown the token will be rejected. “required” any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.
hash_algorithms = md5 (List) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance.
http_connect_timeout = None (Integer) Request timeout value for communicating with Identity API server.
http_request_max_retries = 3 (Integer) How many times are we trying to reconnect when communicating with Identity API Server.
identity_uri = None (String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/
include_service_catalog = True (Boolean) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.
insecure = False (Boolean) Verify HTTPS connections.
keyfile = None (String) Required if identity server requires client certificate
memcache_pool_conn_get_timeout = 10 (Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
memcache_pool_dead_retry = 300 (Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again.
memcache_pool_maxsize = 10 (Integer) (Optional) Maximum total number of open connections to every memcached server.
memcache_pool_socket_timeout = 3 (Integer) (Optional) Socket timeout in seconds for communicating with a memcached server.
memcache_pool_unused_timeout = 60 (Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
memcache_secret_key = None (String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
memcache_security_strategy = None (String) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.
memcache_use_advanced_pool = False (Boolean) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
memcached_servers = None (List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
region_name = None (String) The region in which the identity server can be found.
revocation_cache_time = 10 (Integer) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.
signing_dir = None (String) Directory used to cache files related to PKI tokens.
token_cache_time = 300 (Integer) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely.
[keystone_authtoken_v3]  
admin_project_domain = default (String) Admin project keystone authentication domain
admin_user_domain = default (String) Admin user keystone authentication domain
Description of cache configuration options
Configuration option = Default value Description
[DEFAULT]  
memcached_servers = None (List) Memcached servers or None for in process cache.
Description of common configuration options
Configuration option = Default value Description
[DEFAULT]  
allow_bulk = True (Boolean) Allow the usage of the bulk API
allow_pagination = False (Boolean) Allow the usage of the pagination
allow_sorting = False (Boolean) Allow the usage of the sorting
pagination_max_limit = -1 (String) The maximum number of items returned in a single response, value was ‘infinite’ or negative integer means no limit
api_extensions_path = (String) The path for API extensions
api_handler = queue_producer (String) The handler that the API communicates with
api_paste_config = api-paste.ini (String) The API paste config file to use
auth_strategy = keystone (String) The type of authentication to use
bind_host = 0.0.0.0 (Unknown) The host IP to bind to
bind_port = 9876 (Port number) The port to bind to
control_exchange = octavia (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
debug = False (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level.
default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN, keystoneauth=WARN, oslo.cache=INFO, dogpile.core.dogpile=INFO (List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
executor_thread_pool_size = 64 (Integer) Size of executor thread pool.
fatal_deprecations = False (Boolean) Enables or disables fatal status of deprecations.
host = localhost (String) The hostname Octavia is running on
octavia_plugins = hot_plug_plugin (String) Name of the controller plugin to use
[amphora_agent]  
agent_server_ca = /etc/octavia/certs/client_ca.pem (String) The ca which signed the client certificates
agent_server_cert = /etc/octavia/certs/server.pem (String) The server certificate for the agent.py server to use
agent_server_network_dir = /etc/network/interfaces.d/ (String) The directory where new network interfaces are located
agent_server_network_file = None (String) The file where the network interfaces are located. Specifying this will override any value set for agent_server_network_dir.
amphora_id = None (String) The amphora ID.
[anchor]  
password = simplepassword (String) Anchor password
url = http://localhost:9999/v1/sign/default (String) Anchor URL
username = myusername (String) Anchor username
[certificates]  
barbican_auth = barbican_acl_auth (String) Name of the Barbican authentication method to use
ca_certificate = /etc/ssl/certs/ssl-cert-snakeoil.pem (String) Absolute path to the CA Certificate for signing. Defaults to env[OS_OCTAVIA_TLS_CA_CERT].
ca_private_key = /etc/ssl/private/ssl-cert-snakeoil.key (String) Absolute path to the Private Key for signing. Defaults to env[OS_OCTAVIA_TLS_CA_KEY].
ca_private_key_passphrase = None (String) Passphrase for the Private Key. Defaults to env[OS_OCTAVIA_CA_KEY_PASS] or None.
cert_generator = local_cert_generator (String) Name of the cert generator to use
cert_manager = barbican_cert_manager (String) Name of the cert manager to use
endpoint_type = publicURL (String) The endpoint_type to be used for barbican service.
region_name = None (String) Region in Identity service catalog to use for communication with the barbican service.
signing_digest = sha256 (String) Certificate signing digest. Defaults to env[OS_OCTAVIA_CA_SIGNING_DIGEST] or “sha256”.
storage_path = /var/lib/octavia/certificates/ (String) Absolute path to the certificate storage directory. Defaults to env[OS_OCTAVIA_TLS_STORAGE].
[controller_worker]  
amp_active_retries = 10 (Integer) Retry attempts to wait for Amphora to become active
amp_active_wait_sec = 10 (Integer) Seconds to wait between checks on whether an Amphora has become active
amp_flavor_id = (String) Nova instance flavor id for the Amphora
amp_image_id = (String) DEPRECATED: Glance image id for the Amphora image to boot Superseded by amp_image_tag option.
amp_image_tag = (String) Glance image tag for the Amphora image to boot. Use this option to be able to update the image without reconfiguring Octavia. Ignored if amp_image_id is defined.
amp_network = (String) Network to attach to the Amphora
amp_secgroup_list = (List) List of security groups to attach to the Amphora
amp_ssh_access_allowed = True (Boolean) Determines whether or not to allow access to the Amphorae
amp_ssh_key_name = (String) SSH key name used to boot the Amphora
amphora_driver = amphora_noop_driver (String) Name of the amphora driver to use
cert_generator = local_cert_generator (String) Name of the cert generator to use
client_ca = /etc/octavia/certs/ca_01.pem (String) Client CA for the amphora agent to use
compute_driver = compute_noop_driver (String) Name of the compute driver to use
loadbalancer_topology = SINGLE (String) Load balancer topology configuration. SINGLE - One amphora per load balancer. ACTIVE_STANDBY - Two amphora per load balancer.
network_driver = network_noop_driver (String) Name of the network driver to use
user_data_config_drive = False (Boolean) If True, build cloud-init user-data that is passed to the config drive on Amphora boot instead of personality files. If False, utilize personality files.
[glance]  
ca_certificates_file = None (String) CA certificates file path
endpoint = None (String) A new endpoint to override the endpoint in the keystone catalog.
endpoint_type = publicURL (String) Endpoint interface in identity service to use
insecure = False (Boolean) Disable certificate validation on SSL connections
region_name = None (String) Region in Identity service catalog to use for communication with the OpenStack services.
service_name = None (String) The name of the glance service in the keystone catalog
[haproxy_amphora]  
base_cert_dir = /var/lib/octavia/certs (String) Base directory for cert storage.
base_path = /var/lib/octavia (String) Base directory for amphora files.
bind_host = 0.0.0.0 (Unknown) The host IP to bind to
bind_port = 9443 (Port number) The port to bind to
client_cert = /etc/octavia/certs/client.pem (String) The client certificate to talk to the agent
connection_max_retries = 300 (Integer) Retry threshold for connecting to amphorae.
connection_retry_interval = 5 (Integer) Retry timeout between connection attempts in seconds.
haproxy_cmd = /usr/sbin/haproxy (String) The full path to haproxy
haproxy_stick_size = 10k (String) Size of the HAProxy stick table. Accepts k, m, g suffixes. Example: 10k
haproxy_template = None (String) Custom haproxy template.
respawn_count = 2 (Integer) The respawn count for haproxy’s upstart script
respawn_interval = 2 (Integer) The respawn interval for haproxy’s upstart script
rest_request_conn_timeout = 10 (Floating point) The time in seconds to wait for a REST API to connect.
rest_request_read_timeout = 60 (Floating point) The time in seconds to wait for a REST API response.
server_ca = /etc/octavia/certs/server_ca.pem (String) The ca which signed the server certificates
use_upstart = True (Boolean) If False, use sysvinit.
[health_manager]  
bind_ip = 0.0.0.0 (Unknown) IP address the controller will listen on for heart beats
bind_port = 5555 (Port number) Port number the controller will listen onfor heart beats
controller_ip_port_list = (List) List of controller ip and port pairs for the heartbeat receivers. Example 127.0.0.1:5555, 192.168.0.1:5555
event_streamer_driver = noop_event_streamer (String) Specifies which driver to use for the event_streamer for syncing the octavia and neutron_lbaas dbs. If you don’t need to sync the database or are running octavia in stand alone mode use the noop_event_streamer
failover_threads = 10 (Integer) Number of threads performing amphora failovers.
health_check_interval = 3 (Integer) Sleep time between health checks in seconds.
heartbeat_interval = 10 (Integer) Sleep time between sending hearthbeats.
heartbeat_key = None (String) key used to validate amphora sendingthe message
heartbeat_timeout = 60 (Integer) Interval, in seconds, to wait before failing over an amphora.
sock_rlimit = 0 (Integer) sets the value of the heartbeat recv buffer
status_update_threads = 50 (Integer) Number of threads performing amphora status update.
[house_keeping]  
amphora_expiry_age = 604800 (Integer) Amphora expiry age in seconds
cert_expiry_buffer = 1209600 (Integer) Seconds until certificate expiration
cert_interval = 3600 (Integer) Certificate check interval in seconds
cert_rotate_threads = 10 (Integer) Number of threads performing amphora certificate rotation
cleanup_interval = 30 (Integer) DB cleanup interval in seconds
spare_amphora_pool_size = 0 (Integer) Number of spare amphorae
spare_check_interval = 30 (Integer) Spare check interval in seconds
[keepalived_vrrp]  
vrrp_advert_int = 1 (Integer) Amphora role and priority advertisement interval in seconds.
vrrp_check_interval = 5 (Integer) VRRP health check script run interval in seconds.
vrrp_fail_count = 2 (Integer) Number of successive failure before transition to a fail state.
vrrp_garp_refresh_count = 2 (Integer) Number of gratuitous ARP announcements to make on each refresh interval.
vrrp_garp_refresh_interval = 5 (Integer) Time in seconds between gratuitous ARP announcements from the MASTER.
vrrp_success_count = 2 (Integer) Number of successive failure before transition to a success state.
[networking]  
lb_network_name = None (String) Name of amphora internal network
max_retries = 15 (Integer) The maximum attempts to retry an action with the networking service.
retry_interval = 1 (Integer) Seconds to wait before retrying an action with the networking service.
[neutron]  
ca_certificates_file = None (String) CA certificates file path
endpoint = None (String) A new endpoint to override the endpoint in the keystone catalog.
endpoint_type = publicURL (String) Endpoint interface in identity service to use
insecure = False (Boolean) Disable certificate validation on SSL connections
region_name = None (String) Region in Identity service catalog to use for communication with the OpenStack services.
service_name = None (String) The name of the neutron service in the keystone catalog
[nova]  
ca_certificates_file = None (String) CA certificates file path
enable_anti_affinity = False (Boolean) Flag to indicate if nova anti-affinity feature is turned on.
endpoint = None (String) A new endpoint to override the endpoint in the keystone catalog.
endpoint_type = publicURL (String) Endpoint interface in identity service to use
insecure = False (Boolean) Disable certificate validation on SSL connections
region_name = None (String) Region in Identity service catalog to use for communication with the OpenStack services.
service_name = None (String) The name of the nova service in the keystone catalog
[oslo_middleware]  
max_request_body_size = 114688 (Integer) The maximum body size for each request, in bytes.
secure_proxy_ssl_header = X-Forwarded-Proto (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
[task_flow]  
engine = serial (String) TaskFlow engine to use
max_workers = 5 (Integer) The maximum number of workers
Description of CORS configuration options
Configuration option = Default value Description
[cors]  
allow_credentials = True (Boolean) Indicate that the actual request can include user credentials
allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma (List) Indicate which header field names may be used during the actual request.
allow_methods = GET, POST, PUT, DELETE, OPTIONS (List) Indicate which methods can be used during the actual request.
allowed_origin = None (List) Indicate whether this resource may be shared with the domain received in the requests “origin” header.
expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
max_age = 3600 (Integer) Maximum cache age of CORS preflight requests.
[cors.subdomain]  
allow_credentials = True (Boolean) Indicate that the actual request can include user credentials
allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma (List) Indicate which header field names may be used during the actual request.
allow_methods = GET, POST, PUT, DELETE, OPTIONS (List) Indicate which methods can be used during the actual request.
allowed_origin = None (List) Indicate whether this resource may be shared with the domain received in the requests “origin” header.
expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
max_age = 3600 (Integer) Maximum cache age of CORS preflight requests.
Description of database configuration options
Configuration option = Default value Description
[database]  
backend = sqlalchemy (String) The back end to use for the database.
connection = None (String) The SQLAlchemy connection string to use to connect to the database.
connection_debug = 0 (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything.
connection_trace = False (Boolean) Add Python stack traces to SQL as comment strings.
db_inc_retry_interval = True (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
db_max_retries = 20 (Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
db_max_retry_interval = 10 (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
db_retry_interval = 1 (Integer) Seconds between retries of a database transaction.
idle_timeout = 3600 (Integer) Timeout before idle SQL connections are reaped.
max_overflow = 50 (Integer) If set, use this value for max_overflow with SQLAlchemy.
max_pool_size = None (Integer) Maximum number of SQL connections to keep open in a pool.
max_retries = 10 (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
min_pool_size = 1 (Integer) Minimum number of SQL connections to keep open in a pool.
mysql_sql_mode = TRADITIONAL (String) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=
pool_timeout = None (Integer) If set, use this value for pool_timeout with SQLAlchemy.
retry_interval = 10 (Integer) Interval between retries of opening a SQL connection.
slave_connection = None (String) The SQLAlchemy connection string to use to connect to the slave database.
sqlite_db = oslo.sqlite (String) The file name to use with SQLite.
sqlite_synchronous = True (Boolean) If True, SQLite uses synchronous mode.
use_db_reconnect = False (Boolean) Enable the experimental use of database reconnect on connection lost.
Description of logging configuration options
Configuration option = Default value Description
[DEFAULT]  
instance_format = "[instance: %(uuid)s] " (String) The format for an instance that is passed with the log message.
instance_uuid_format = "[instance: %(uuid)s] " (String) The format for an instance UUID that is passed with the log message.
log_config_append = None (String) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).
log_date_format = %Y-%m-%d %H:%M:%S (String) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set.
log_dir = None (String) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
log_file = None (String) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s (String) Format string to use for log messages with context.
logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d (String) Additional data to append to log message when logging level for the message is DEBUG.
logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s (String) Format string to use for log messages when context is undefined.
logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s (String) Prefix each line of exception output with this format.
logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s (String) Defines the format string for %(user_identity)s that is used in logging_context_format_string.
publish_errors = False (Boolean) Enables or disables publication of error events.
syslog_log_facility = LOG_USER (String) Syslog facility to receive log lines. This option is ignored if log_config_append is set.
use_stderr = True (Boolean) Log output to standard error. This option is ignored if log_config_append is set.
use_syslog = False (Boolean) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
verbose = True (Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level.
watch_log_file = False (Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.
Description of RabbitMQ configuration options
Configuration option = Default value Description
[oslo_messaging_rabbit]  
amqp_auto_delete = False (Boolean) Auto-delete queues in AMQP.
amqp_durable_queues = False (Boolean) Use durable queues in AMQP.
channel_max = None (Integer) Maximum number of channels to allow
default_notification_exchange = ${control_exchange}_notification (String) Exchange name for for sending notifications
default_notification_retry_attempts = -1 (Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry.
default_rpc_exchange = ${control_exchange}_rpc (String) Exchange name for sending RPC messages
default_rpc_retry_attempts = -1 (Integer) Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more then one time
fake_rabbit = False (Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
frame_max = None (Integer) The maximum byte size for an AMQP frame
heartbeat_interval = 1 (Integer) How often to send heartbeats for consumer’s connections
heartbeat_rate = 2 (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat.
heartbeat_timeout_threshold = 60 (Integer) Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disable the heartbeat). EXPERIMENTAL
host_connection_reconnect_delay = 0.25 (Floating point) Set delay for reconnection to some host which has connection error
kombu_compression = None (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions.
kombu_failover_strategy = round-robin (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config.
kombu_missing_consumer_retry_timeout = 60 (Integer) How long to wait a missing client beforce abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
kombu_reconnect_delay = 1.0 (Floating point) How long to wait before reconnecting in response to an AMQP consumer cancel notification.
kombu_ssl_ca_certs = (String) SSL certification authority file (valid only if SSL enabled).
kombu_ssl_certfile = (String) SSL cert file (valid only if SSL enabled).
kombu_ssl_keyfile = (String) SSL key file (valid only if SSL enabled).
kombu_ssl_version = (String) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.
notification_listener_prefetch_count = 100 (Integer) Max number of not acknowledged message which RabbitMQ can send to notification listener.
notification_persistence = False (Boolean) Persist notification messages.
notification_retry_delay = 0.25 (Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message
pool_max_overflow = 0 (Integer) Maximum number of connections to create above pool_max_size.
pool_max_size = 10 (Integer) Maximum number of connections to keep queued.
pool_recycle = 600 (Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire.
pool_stale = 60 (Integer) Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire.
pool_timeout = 30 (Integer) Default number of seconds to wait for a connections to available
rabbit_ha_queues = False (Boolean) Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “
rabbit_host = localhost (String) The RabbitMQ broker address where a single node is used.
rabbit_hosts = $rabbit_host:$rabbit_port (List) RabbitMQ HA cluster host:port pairs.
rabbit_interval_max = 30 (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
rabbit_login_method = AMQPLAIN (String) The RabbitMQ login method.
rabbit_max_retries = 0 (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
rabbit_password = guest (String) The RabbitMQ password.
rabbit_port = 5672 (Port number) The RabbitMQ broker port where a single node is used.
rabbit_qos_prefetch_count = 0 (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
rabbit_retry_backoff = 2 (Integer) How long to backoff for between retries when connecting to RabbitMQ.
rabbit_retry_interval = 1 (Integer) How frequently to retry connecting with RabbitMQ.
rabbit_transient_queues_ttl = 1800 (Integer) Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.
rabbit_use_ssl = False (Boolean) Connect over SSL for RabbitMQ.
rabbit_userid = guest (String) The RabbitMQ userid.
rabbit_virtual_host = / (String) The RabbitMQ virtual host.
rpc_conn_pool_size = 30 (Integer) Size of RPC connection pool.
rpc_listener_prefetch_count = 100 (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener.
rpc_queue_expiration = 60 (Integer) Time to live for rpc queues without consumers in seconds.
rpc_reply_exchange = ${control_exchange}_rpc_reply (String) Exchange name for receiving RPC replies
rpc_reply_listener_prefetch_count = 100 (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc reply listener.
rpc_reply_retry_attempts = -1 (Integer) Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout
rpc_reply_retry_delay = 0.25 (Floating point) Reconnecting retry delay in case of connectivity problem during sending reply.
rpc_retry_delay = 0.25 (Floating point) Reconnecting retry delay in case of connectivity problem during sending RPC message
socket_timeout = 0.25 (Floating point) Set socket timeout in seconds for connection’s socket
ssl = None (Boolean) Enable SSL
ssl_options = None (Dict) Arguments passed to ssl.wrap_socket
tcp_user_timeout = 0.25 (Floating point) Set TCP_USER_TIMEOUT in seconds for connection’s socket
Description of Redis configuration options
Configuration option = Default value Description
[matchmaker_redis]  
check_timeout = 20000 (Integer) Time in ms to wait before the transaction is killed.
host = 127.0.0.1 (String) Host to locate redis.
password = (String) Password for Redis server (optional).
port = 6379 (Port number) Use this port to connect to redis host.
sentinel_group_name = oslo-messaging-zeromq (String) Redis replica set name.
sentinel_hosts = (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ]
socket_timeout = 1000 (Integer) Timeout in ms on blocking socket operations
wait_timeout = 500 (Integer) Time in ms to wait between connection attempts.
Description of RPC configuration options
Configuration option = Default value Description
[DEFAULT]  
transport_url = None (String) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.
[oslo_concurrency]  
disable_process_locking = False (Boolean) Enables or disables inter-process locks.
lock_path = None (String) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.
[oslo_messaging]  
event_stream_topic = neutron_lbaas_event (String) topic name for communicating events through a queue
topic = None (String) No help text available for this option.
[oslo_messaging_amqp]  
allow_insecure_clients = False (Boolean) Accept clients using either SSL or plain TCP
broadcast_prefix = broadcast (String) address prefix used when broadcasting to all servers
container_name = None (String) Name for the AMQP container
group_request_prefix = unicast (String) address prefix when sending to any server in group
idle_timeout = 0 (Integer) Timeout for inactive connections (in seconds)
password = (String) Password for message broker authentication
sasl_config_dir = (String) Path to directory that contains the SASL configuration
sasl_config_name = (String) Name of configuration file (without .conf suffix)
sasl_mechanisms = (String) Space separated list of acceptable SASL mechanisms
server_request_prefix = exclusive (String) address prefix used when sending to a specific server
ssl_ca_file = (String) CA certificate PEM file to verify server certificate
ssl_cert_file = (String) Identifying certificate PEM file to present to clients
ssl_key_file = (String) Private key PEM file used to sign cert_file certificate
ssl_key_password = None (String) Password for decrypting ssl_key_file (if encrypted)
trace = False (Boolean) Debug: dump AMQP frames to stdout
username = (String) User name for message broker authentication
[oslo_messaging_notifications]  
driver = [] (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
topics = notifications (List) AMQP topic used for OpenStack notifications.
transport_url = None (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
Description of ZeroMQ configuration options
Configuration option = Default value Description
[DEFAULT]  
rpc_backend = rabbit (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
rpc_cast_timeout = -1 (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq.
rpc_conn_pool_size = 30 (Integer) Size of RPC connection pool.
rpc_poll_timeout = 1 (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
rpc_response_timeout = 60 (Integer) Seconds to wait for a response from a call.
rpc_zmq_bind_address = * (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address.
rpc_zmq_bind_port_retries = 100 (Integer) Number of retries to find free port number before fail with ZMQBindError.
rpc_zmq_concurrency = eventlet (String) Type of concurrency used. Either “native” or “eventlet”
rpc_zmq_contexts = 1 (Integer) Number of ZeroMQ contexts, defaults to 1.
rpc_zmq_host = localhost (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.
rpc_zmq_ipc_dir = /var/run/openstack (String) Directory for holding IPC sockets.
rpc_zmq_matchmaker = redis (String) MatchMaker driver.
rpc_zmq_max_port = 65536 (Integer) Maximal port number for random ports range.
rpc_zmq_min_port = 49152 (Port number) Minimal port number for random ports range.
rpc_zmq_topic_backlog = None (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
use_pub_sub = True (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
zmq_target_expire = 120 (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.