hostname
<server-hostname.example.com>
This option has a sample default set, which means that its actual default value may vary from the one documented above.
The hostname Octavia is running on
string
hot_plug_plugin
Name of the controller plugin to use
integer
30
1
Size of RPC connection pool.
Group |
Name |
---|---|
DEFAULT |
rpc_conn_pool_size |
integer
2
The pool size limit for connections expiration policy
integer
1200
The time-to-live in sec of idle connections in the pool
integer
64
Size of executor thread pool when executor is threading or eventlet.
Group |
Name |
---|---|
DEFAULT |
rpc_thread_pool_size |
integer
60
Seconds to wait for a response from a call.
string
rabbit://
The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is:
driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query
Example: rabbit://rabbitmq:password@127.0.0.1:5672//
For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html
string
octavia
The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
boolean
False
Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping
boolean
False
This option can be changed without restarting.
If set to true, the logging level will be set to DEBUG instead of the default INFO level.
string
<None>
This option can be changed without restarting.
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, log-date-format).
Group |
Name |
---|---|
DEFAULT |
log-config |
DEFAULT |
log_config |
string
%Y-%m-%d %H:%M:%S
Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.
string
<None>
(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.
Group |
Name |
---|---|
DEFAULT |
logfile |
string
<None>
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
Group |
Name |
---|---|
DEFAULT |
logdir |
boolean
False
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.
boolean
False
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.
boolean
False
Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.
string
LOG_USER
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
boolean
False
Use JSON formatting for logging. This option is ignored if log_config_append is set.
boolean
False
Log output to standard error. This option is ignored if log_config_append is set.
boolean
False
Log output to Windows Event Log.
integer
1
The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.
string
days
Seconds, Minutes, Hours, Days, Weekday, Midnight
Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.
integer
30
Maximum number of rotated log files.
integer
200
Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.
string
none
interval, size, none
Log rotation type.
Possible values
Rotate logs at predefined time intervals.
Rotate logs once they reach a predefined size.
Do not rotate log files.
string
%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s
Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter
string
%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter
string
%(funcName)s %(pathname)s:%(lineno)d
Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter
string
%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter
string
%(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s
Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter
list
['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=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', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO']
List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
boolean
False
Enables or disables publication of error events.
string
"[instance: %(uuid)s] "
The format for an instance that is passed with the log message.
string
"[instance: %(uuid)s] "
The format for an instance UUID that is passed with the log message.
integer
0
Interval, number of seconds, of log rate limiting.
integer
0
Maximum number of logged messages per rate_limit_interval.
string
CRITICAL
Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.
boolean
False
Enables or disables fatal status of deprecations.
boolean
True
This option can be changed without restarting.
Enables or disables logging values of all registered options when starting a service (at DEBUG level).
integer
60
This option can be changed without restarting.
Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.
string
/etc/octavia/certs/client_ca.pem
The ca which signed the client certificates
string
/etc/octavia/certs/server.pem
The server certificate for the agent server to use
string
<None>
The directory where new network interfaces are located
string
<None>
The file where the network interfaces are located. Specifying this will override any value set for agent_server_network_dir.
Warning
This option is deprecated for removal since Xena. Its value may be silently ignored in the future.
New amphora interface management does not support single interface file.
integer
180
The time in seconds to allow a request from the controller to run before terminating the socket.
string
TLSv1.2
SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3
Minimum TLS protocol for communication with the amphora agent.
list
<None>
List of log server ip and port pairs for Administrative logs. Additional hosts are backup to the primary server. If none is specified remote logging is disabled. Example 127.0.0.1:10514, 192.168.0.1:10514
list
<None>
List of log server ip and port pairs for tenant traffic logs. Additional hosts are backup to the primary server. If none is specified remote logging is disabled. Example 127.0.0.1:10514, 192.168.0.1:10514
integer
0
0
7
LOG_LOCAL facility number to use for user traffic logs.
integer
1
0
7
LOG_LOCAL facility number to use for amphora processes logs.
string
UDP
TCP, UDP
The log forwarding transport protocol. One of UDP or TCP.
integer
5
The maximum attempts to retry connecting to the logging host.
integer
2
The time, in seconds, to wait between retries connecting to the logging host.
integer
10000
The queue size (messages) to buffer log messages.
string
<None>
Custom logging configuration template.
boolean
False
When True, the amphora will forward all of the system logs (except tenant traffic logs) to the admin log target(s). When False, only amphora specific admin logs will be forwarded.
boolean
False
When True, no logs will be written to the amphora filesystem. When False, log files will be written to the local filesystem.
string
<None>
The amphora ID.
string
keepalived_lvs
The UDP API backend for amphora agent.
Warning
This option is deprecated for removal since Wallaby. Its value may be silently ignored in the future.
amphora-agent will not support any other backend than keepalived_lvs.
ip address
127.0.0.1
The host IP to bind to
port number
9876
0
65535
The port to bind to
string
keystone
noauth, keystone, testing
The auth strategy for API requests.
boolean
True
Allow the usage of pagination
boolean
True
Allow the usage of sorting
boolean
True
Allow the usage of filtering
boolean
True
Allow the usage of field selection
string
1000
The maximum number of items returned in a single response. The string ‘infinite’ or a negative integer value means ‘no limit’
string
<None>
Base URI for the API for use in pagination links. This will be autodetected from the request if not overridden here.
boolean
True
Allow users to create TLS Terminated listeners?
boolean
True
Allow users to create PING type Health Monitors?
boolean
True
Allow users to create PROMETHEUS type listeners?
dict
{'amphora': 'The Octavia Amphora driver.', 'octavia': 'Deprecated alias of the Octavia Amphora driver.'}
A comma separated list of dictionaries of the enabled provider driver names and descriptions. Must match the driver name in the octavia.api.drivers entrypoint.
string
amphora
Default provider driver.
integer
3
The minimum health monitor delay interval for the UDP-CONNECT Health Monitor type. A negative integer value means ‘no limit’.
boolean
False
When True, the oslo middleware healthcheck endpoint is enabled in the Octavia API.
integer
5
The interval healthcheck plugins should cache results, in seconds.
string
TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256
Default OpenSSL cipher string (colon-separated) for new TLS-enabled listeners.
string
TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256
Default OpenSSL cipher string (colon-separated) for new TLS-enabled pools.
string
''
Colon separated list of OpenSSL ciphers. Usage of these ciphers will be blocked.
Group |
Name |
---|---|
api_settings |
tls_cipher_blacklist |
list
['TLSv1.2', 'TLSv1.3']
List of TLS versions to use for new TLS-enabled listeners.
list
['TLSv1.2', 'TLSv1.3']
List of TLS versions to use for new TLS-enabled pools.
string
<None>
SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3, <None>
Minimum allowed TLS version for listeners and pools.
list
['h2', 'http/1.1', 'http/1.0']
List of ALPN protocols to use for new TLS-enabled listeners.
list
['h2', 'http/1.1', 'http/1.0']
List of ALPN protocols to use for new TLS-enabled pools.
boolean
False
Enable auditing of API requests
string
/etc/octavia/octavia_api_audit_map.conf
Path to audit map file for octavia-api service. Used only when API audit is enabled.
string
''
Comma separated list of REST API HTTP methods to be ignored during audit. For example: auditing will not be done on any GET or POST requests if this is set to “GET,POST”. It is used only when API audit is enabled.
string
barbican_cert_manager
Name of the cert manager to use
string
local_cert_generator
Name of the cert generator to use
string
barbican_acl_auth
Name of the Barbican authentication method to use
string
<None>
The name of the certificate service in the keystone catalog
string
<None>
A new endpoint to override the endpoint in the keystone catalog.
string
<None>
Region in Identity service catalog to use for communication with the barbican service.
string
publicURL
The endpoint_type to be used for barbican service.
string
<None>
CA certificates file path for the key manager service (such as Barbican).
boolean
False
Disable certificate validation on SSL connections
string
/etc/ssl/certs/ssl-cert-snakeoil.pem
Absolute path to the CA Certificate for signing. Defaults to env[OS_OCTAVIA_TLS_CA_CERT].
string
/etc/ssl/private/ssl-cert-snakeoil.key
Absolute path to the Private Key for signing. Defaults to env[OS_OCTAVIA_TLS_CA_KEY].
string
<None>
Passphrase for the Private Key. Defaults to env[OS_OCTAVIA_CA_KEY_PASS] or None.
string
insecure-key-do-not-use-this-key
Passphrase for encrypting Amphora Certificates and Private Keys. Must be 32, base64(url) compatible, characters long. Defaults to env[TLS_PASS_AMPS_DEFAULT] or insecure-key-do-not-use-this-key
string
sha256
Certificate signing digest. Defaults to env[OS_OCTAVIA_CA_SIGNING_DIGEST] or “sha256”.
integer
2592000
The validity time for the Amphora Certificates (in seconds).
string
<None>
The name of the cinder service in the keystone catalog
string
<None>
A new endpoint to override the endpoint in the keystone catalog.
string
<None>
Region in Identity service catalog to use for communication with the OpenStack services.
string
publicURL
Endpoint interface in identity service to use
string
<None>
CA certificates file path
string
<None>
Availability zone to use for creating Volume
boolean
False
Disable certificate validation on SSL connections
integer
16
Size of volume, in GB, for Amphora instance
string
<None>
Type of volume for Amphorae volume root disk
integer
5
Interval time to wait volume is created in available state
integer
300
Timeout to wait for volume creation success
integer
5
Maximum number of retries to create volume
integer
15
The maximum attempts to retry an action with the compute service.
integer
1
Seconds to wait before retrying an action with the compute service.
integer
1
The seconds to backoff retry attempts.
integer
10
The maximum interval in seconds between retry attempts.
integer
1
1
Number of workers for the controller-worker service.
integer
30
Retry attempts to wait for Amphora to become active
integer
10
Seconds to wait between checks on whether an Amphora has become active
string
''
Nova instance flavor id for the Amphora
string
''
Glance image tag for the Amphora image to boot. Use this option to be able to update the image without reconfiguring Octavia.
string
''
Restrict glance image selection to a specific owner ID. This is a recommended security setting.
string
''
Optional SSH keypair name, in nova, that will be used for the authorized_keys inside the amphora.
string
UTC
The timezone to use in the Amphora as represented in /usr/share/zoneinfo.
list
''
List of networks to attach to the Amphorae. All networks defined in the list will be attached to each amphora.
list
''
List of security groups to attach to the Amphora.
string
/etc/octavia/certs/ca_01.pem
Client CA for the amphora agent to use
string
amphora_haproxy_rest_driver
Name of the amphora driver to use
string
compute_nova_driver
Name of the compute driver to use
string
allowed_address_pairs_driver
Name of the network driver to use
string
volume_noop_driver
volume_noop_driver, volume_cinder_driver
Name of the volume driver to use
string
image_glance_driver
image_noop_driver, image_glance_driver
Name of the image driver to use
string
distributor_noop_driver
Name of the distributor driver to use
list
['stats_db']
List of drivers for updating amphora statistics.
Group |
Name |
---|---|
health_manager |
stats_update_driver |
string
SINGLE
ACTIVE_STANDBY, SINGLE
This option can be changed without restarting.
Load balancer topology configuration. SINGLE - One amphora per load balancer. ACTIVE_STANDBY - Two amphora per load balancer.
boolean
False
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.
Warning
This option is deprecated for removal since Antelope(2023.1). Its value may be silently ignored in the future.
User_data nova option is not used and is too small to replace the config_drive.
integer
5
Number of times an amphora delete should be retried.
integer
5
Time, in seconds, between amphora delete retries.
boolean
True
Enable octavia event notifications. See oslo_messaging_notifications section for additional requirements.
boolean
True
If True, SQLite uses synchronous mode.
Group |
Name |
---|---|
DEFAULT |
sqlite_synchronous |
string
sqlalchemy
The back end to use for the database.
Group |
Name |
---|---|
DEFAULT |
db_backend |
string
<None>
The SQLAlchemy connection string to use to connect to the database.
Group |
Name |
---|---|
DEFAULT |
sql_connection |
DATABASE |
sql_connection |
sql |
connection |
string
<None>
The SQLAlchemy connection string to use to connect to the slave database.
string
TRADITIONAL
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=
integer
<None>
For Galera only, configure wsrep_sync_wait causality checks on new connections. Default is None, meaning don’t configure any setting.
boolean
False
If True, transparently enables support for handling MySQL Cluster (NDB).
Warning
This option is deprecated for removal since 12.1.0. Its value may be silently ignored in the future.
Support for the MySQL NDB Cluster storage engine has been deprecated and will be removed in a future release.
integer
3600
Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool.
integer
5
Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.
integer
10
Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
Group |
Name |
---|---|
DEFAULT |
sql_max_retries |
DATABASE |
sql_max_retries |
integer
10
Interval between retries of opening a SQL connection.
Group |
Name |
---|---|
DEFAULT |
sql_retry_interval |
DATABASE |
reconnect_interval |
integer
50
If set, use this value for max_overflow with SQLAlchemy.
Group |
Name |
---|---|
DEFAULT |
sql_max_overflow |
DATABASE |
sqlalchemy_max_overflow |
integer
0
0
100
Verbosity of SQL debugging information: 0=None, 100=Everything.
Group |
Name |
---|---|
DEFAULT |
sql_connection_debug |
boolean
False
Add Python stack traces to SQL as comment strings.
Group |
Name |
---|---|
DEFAULT |
sql_connection_trace |
integer
<None>
If set, use this value for pool_timeout with SQLAlchemy.
Group |
Name |
---|---|
DATABASE |
sqlalchemy_pool_timeout |
boolean
False
Enable the experimental use of database reconnect on connection lost.
integer
1
Seconds between retries of a database transaction.
boolean
True
If True, increases the interval between retries of a database operation up to db_max_retry_interval.
integer
10
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
integer
20
Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
string
''
Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1¶m2=value2&…
string
/var/run/octavia/status.sock
Path to the driver status unix domain socket file.
string
/var/run/octavia/stats.sock
Path to the driver statistics unix domain socket file.
string
/var/run/octavia/get.sock
Path to the driver get unix domain socket file.
integer
5
Time, in seconds, to wait for a status update request.
integer
50
Maximum number of concurrent processes to use servicing status updates.
integer
5
Time, in seconds, to wait for a statistics update request.
integer
50
Maximum number of concurrent processes to use servicing statistics updates.
integer
5
Time, in seconds, to wait for a get request.
integer
50
Maximum number of concurrent processes to use servicing get requests.
floating point
0.75
0.01
0.99
Percentage of max_processes (both status and stats) in use to start logging warning messages about an overloaded driver-agent.
integer
60
The time, in seconds, to wait for provider agents to shutdown after the exit event has been set.
list
''
List of enabled provider agents. The driver-agent will launch these agents at startup.
string
<None>
The name of the glance service in the keystone catalog
string
<None>
A new endpoint to override the endpoint in the keystone catalog.
string
<None>
Region in Identity service catalog to use for communication with the OpenStack services.
string
publicURL
Endpoint interface in identity service to use
string
<None>
CA certificates file path
boolean
False
Disable certificate validation on SSL connections
string
/var/lib/octavia
Base directory for amphora files.
string
/var/lib/octavia/certs
Base directory for cert storage.
string
<None>
Custom haproxy template.
boolean
True
Set this to False to disable connection logging.
integer
120
Retry threshold for connecting to amphorae.
integer
5
Retry timeout between connection attempts in seconds.
integer
15
Retry threshold for connecting to active amphorae.
integer
2
Retry timeout between connection attempts in seconds for active amphora.
Group |
Name |
---|---|
haproxy_amphora |
active_connection_rety_interval |
integer
2
Retry threshold for connecting to an amphora in failover.
integer
5
Retry timeout between connection attempts in seconds for amphora in failover.
integer
-1
Number of amphorae that could be built per controller worker, simultaneously.
integer
120
Retry threshold for waiting for a build slot for an amphorae.
integer
5
Retry timeout between build attempts in seconds.
string
10k
Size of the HAProxy stick table. Accepts k, m, g suffixes.
string
{{ project_id }} {{ lb_id }} %f %ci %cp %t %{+Q}r %ST %B %U %[ssl_c_verify] %{+Q}[ssl_c_s_dn] %b %s %Tt %tsc
Log format string for user flow logging.
ip address
::
The host IP to bind to
port number
9443
0
65535
The port to bind to
string
o-hm0
Network interface through which to reach amphora, only required if using IPv6 link local addresses.
string
/usr/sbin/haproxy
The full path to haproxy
integer
2
The respawn count for haproxy’s upstart script
integer
2
The respawn interval for haproxy’s upstart script
floating point
10
The time in seconds to wait for a REST API to connect.
floating point
60
The time in seconds to wait for a REST API response.
integer
50000
Frontend client inactivity timeout.
integer
5000
Backend member connection timeout.
integer
50000
Backend member inactivity timeout.
integer
0
Time to wait for TCP packets for content inspection.
string
/etc/octavia/certs/client.pem
The client certificate to talk to the agent
string
/etc/octavia/certs/server_ca.pem
The ca which signed the server certificates
boolean
True
If False, use sysvinit.
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
This is now automatically discovered and configured.
integer
15
The number of times the database action will be attempted.
integer
1
The initial delay before a retry attempt.
integer
1
The time to backoff retry attempts.
integer
5
The maximum amount of time to wait between retry attempts.
integer
50000
Default connection_limit for listeners, used when setting “-1” or when unsetting connection_limit with the listener API.
ip address
127.0.0.1
IP address the controller will listen on for heart beats
port number
5555
0
65535
Port number the controller will listen on for heart beats
integer
10
Number of threads performing amphora failovers.
integer
<None>
Number of processes for amphora health update.
integer
<None>
Number of processes for amphora stats update.
string
<None>
This option can be changed without restarting.
key used to validate amphora sending the message
integer
60
Interval, in seconds, to wait before failing over an amphora.
integer
3
Sleep time between health checks in seconds.
integer
0
sets the value of the heartbeat recv buffer
integer
<None>
Stop failovers if the count of simultaneously failed amphora reaches this number. This may prevent large scale accidental failover events, like in the case of network failures or read-only database issues.
list
[]
This option can be changed without restarting.
List of controller ip and port pairs for the heartbeat receivers. Example 127.0.0.1:5555, 192.168.0.1:5555
integer
10
This option can be changed without restarting.
Sleep time between sending heartbeats.
string
health_db
Driver for updating amphora health system.
Warning
This option is deprecated for removal since Victoria. Its value may be silently ignored in the future.
This driver interface was removed.
integer
30
DB cleanup interval in seconds
integer
604800
Amphora expiry age in seconds
integer
604800
Load balancer expiry age in seconds
integer
3600
Certificate check interval in seconds
integer
1209600
Seconds until certificate expiration
integer
10
Number of threads performing amphora certificate rotation
integer
1
Amphora role and priority advertisement interval in seconds.
integer
5
VRRP health check script run interval in seconds.
integer
2
Number of successive failures before transition to a fail state.
integer
2
Number of consecutive successes before transition to a success state.
integer
5
Time in seconds between gratuitous ARP announcements from the MASTER.
integer
2
Number of gratuitous ARP announcements to make on each refresh interval.
string
<None>
Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint.
Group |
Name |
---|---|
keystone_authtoken |
auth_uri |
string
<None>
Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint. This option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
Warning
This option is deprecated for removal since Queens. Its value may be silently ignored in the future.
The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.
string
<None>
API version of the Identity API endpoint.
string
internal
Interface to use for the Identity API endpoint. Valid values are “public”, “internal” (default) or “admin”.
boolean
False
Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
integer
<None>
Request timeout value for communicating with Identity API server.
integer
3
How many times are we trying to reconnect when communicating with Identity API Server.
string
<None>
Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the memcached_servers
option instead.
string
<None>
Required if identity server requires client certificate
string
<None>
Required if identity server requires client certificate
string
<None>
A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
boolean
False
Verify HTTPS connections.
string
<None>
The region in which the identity server can be found.
list
<None>
Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
Group |
Name |
---|---|
keystone_authtoken |
memcache_servers |
integer
300
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.
string
None
None, MAC, ENCRYPT
(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.
string
<None>
(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
integer
300
(Optional) Number of seconds memcached server is considered dead before it is tried again.
integer
10
(Optional) Maximum total number of open connections to every memcached server.
integer
3
(Optional) Socket timeout in seconds for communicating with a memcached server.
integer
60
(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
integer
10
(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
boolean
True
(Optional) Use the advanced (eventlet safe) memcached client pool.
boolean
True
(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.
string
permissive
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.
list
['service']
A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check.
boolean
False
For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible.
string
<None>
The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules.
unknown type
<None>
Authentication type to load
Group |
Name |
---|---|
keystone_authtoken |
auth_plugin |
unknown type
<None>
Config Section from which to load plugin specific options
integer
15
The maximum attempts to retry an action with the networking service.
integer
1
Seconds to wait before retrying an action with the networking service.
integer
1
The seconds to backoff retry attempts.
integer
10
The maximum interval in seconds between retry attempts.
integer
300
Seconds to wait for a port to detach from an amphora.
boolean
True
Can users supply a network_id for their VIP?
boolean
True
Can users supply a subnet_id for their VIP?
boolean
True
Can users supply a port_id for their VIP?
list
<None>
List of network_ids that are valid for VIP creation. If this field is empty, no validation is performed.
list
['169.254.169.254']
List of IP addresses reserved from being used for member addresses. IPv6 addresses should be in expanded, uppercase form.
boolean
False
When True, users can use network resources they cannot normally see as VIP or member subnets. Making this True may allow users to access resources on subnets they do not normally have access to via neutron RBAC policies.
string
<None>
The name of the neutron service in the keystone catalog
string
<None>
A new endpoint to override the endpoint in the keystone catalog.
string
<None>
Region in Identity service catalog to use for communication with the OpenStack services.
string
publicURL
Endpoint interface in identity service to use
string
<None>
CA certificates file path
boolean
False
Disable certificate validation on SSL connections
string
<None>
The name of the nova service in the keystone catalog
string
<None>
A new endpoint to override the endpoint in the keystone catalog.
string
<None>
Region in Identity service catalog to use for communication with the OpenStack services.
string
publicURL
Endpoint interface in identity service to use
string
<None>
CA certificates file path
boolean
False
Disable certificate validation on SSL connections
boolean
False
Flag to indicate if nova anti-affinity feature is turned on. This option is only used when creating amphorae in ACTIVE_STANDBY topology.
string
anti-affinity
anti-affinity, soft-anti-affinity
Sets the anti-affinity policy for nova
integer
0
If non-zero, generate a random name of the length provided for each amphora, in the format “a[A-Z0-9]*”. Otherwise, the default name format will be used: “amphora-{UUID}”.
string
<None>
Availability zone to use for creating Amphorae
string
<None>
Topic (i.e. Queue) Name
string
<None>
Name for the AMQP container. must be globally unique. Defaults to a generated UUID
Group |
Name |
---|---|
amqp1 |
container_name |
integer
0
Timeout for inactive connections (in seconds)
Group |
Name |
---|---|
amqp1 |
idle_timeout |
boolean
False
Debug: dump AMQP frames to stdout
Group |
Name |
---|---|
amqp1 |
trace |
boolean
False
Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.
string
''
CA certificate PEM file used to verify the server’s certificate
Group |
Name |
---|---|
amqp1 |
ssl_ca_file |
string
''
Self-identifying certificate PEM file for client authentication
Group |
Name |
---|---|
amqp1 |
ssl_cert_file |
string
''
Private key PEM file used to sign ssl_cert_file certificate (optional)
Group |
Name |
---|---|
amqp1 |
ssl_key_file |
string
<None>
Password for decrypting ssl_key_file (if encrypted)
Group |
Name |
---|---|
amqp1 |
ssl_key_password |
boolean
False
By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name.
string
''
Space separated list of acceptable SASL mechanisms
Group |
Name |
---|---|
amqp1 |
sasl_mechanisms |
string
''
Path to directory that contains the SASL configuration
Group |
Name |
---|---|
amqp1 |
sasl_config_dir |
string
''
Name of configuration file (without .conf suffix)
Group |
Name |
---|---|
amqp1 |
sasl_config_name |
string
''
SASL realm to use if no realm present in username
integer
1
1
Seconds to pause before attempting to re-connect.
integer
2
0
Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
integer
30
1
Maximum limit for connection_retry_interval + connection_retry_backoff
integer
10
1
Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
integer
0
-1
The maximum number of attempts to re-send a reply message which failed due to a recoverable error.
integer
30
5
The deadline for an rpc reply message delivery.
integer
30
5
The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
integer
30
5
The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
integer
600
1
The duration to schedule a purge of idle sender links. Detach link after expiry.
string
dynamic
Indicates the addressing mode used by the driver. Permitted values: ‘legacy’ - use legacy non-routable addressing ‘routable’ - use routable addresses ‘dynamic’ - use legacy addresses if the message bus does not support routing otherwise use routable addressing
boolean
True
Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private ‘subnet’ per virtual host. Set to False if the message bus supports virtual hosting using the ‘hostname’ field in the AMQP 1.0 Open performative as the name of the virtual host.
string
exclusive
address prefix used when sending to a specific server
Group |
Name |
---|---|
amqp1 |
server_request_prefix |
string
broadcast
address prefix used when broadcasting to all servers
Group |
Name |
---|---|
amqp1 |
broadcast_prefix |
string
unicast
address prefix when sending to any server in group
Group |
Name |
---|---|
amqp1 |
group_request_prefix |
string
openstack.org/om/rpc
Address prefix for all generated RPC addresses
string
openstack.org/om/notify
Address prefix for all generated Notification addresses
string
multicast
Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
string
unicast
Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.
string
anycast
Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.
string
<None>
Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else ‘notify’
string
<None>
Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else ‘rpc’
integer
200
1
Window size for incoming RPC Reply messages.
integer
100
1
Window size for incoming RPC Request messages
integer
100
1
Window size for incoming Notification messages
multi-valued
rpc-cast
rpc-reply
Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: ‘rpc-call’ - send RPC Calls pre-settled ‘rpc-reply’- send RPC Replies pre-settled ‘rpc-cast’ - Send RPC Casts pre-settled ‘notify’ - Send Notifications pre-settled
integer
1048576
Max fetch bytes of Kafka consumer
floating point
1.0
Default timeout(s) for Kafka consumers
integer
10
Pool Size for Kafka Consumers
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Driver no longer uses connection pool.
integer
2
The pool size limit for connections expiration policy
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Driver no longer uses connection pool.
integer
1200
The time-to-live in sec of idle connections in the pool
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Driver no longer uses connection pool.
string
oslo_messaging_consumer
Group id for Kafka consumer. Consumers in one group will coordinate message consumption
floating point
0.0
Upper bound on the delay for KafkaProducer batching in seconds
integer
16384
Size of batch for the producer async send
string
none
none, gzip, snappy, lz4, zstd
The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version
boolean
False
Enable asynchronous consumer commits
integer
500
The maximum number of records returned in a poll call
string
PLAINTEXT
PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL
Protocol used to communicate with brokers
string
PLAIN
Mechanism when security protocol is SASL
string
''
CA certificate PEM file used to verify the server certificate
string
''
Client certificate PEM file used for authentication.
string
''
Client key PEM file used for authentication.
string
''
Client key password file used for authentication.
multi-valued
''
The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
Group |
Name |
---|---|
DEFAULT |
notification_driver |
string
<None>
A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
Group |
Name |
---|---|
DEFAULT |
notification_transport_url |
list
['notifications']
AMQP topic used for OpenStack notifications.
Group |
Name |
---|---|
rpc_notifier2 |
topics |
DEFAULT |
notification_topics |
integer
-1
The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite
boolean
False
Use durable queues in AMQP. If rabbit_quorum_queue is enabled, queues will be durable and this value will be ignored.
boolean
False
Auto-delete queues in AMQP.
Group |
Name |
---|---|
DEFAULT |
amqp_auto_delete |
boolean
False
Connect over SSL.
Group |
Name |
---|---|
oslo_messaging_rabbit |
rabbit_use_ssl |
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.
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_version |
string
''
SSL key file (valid only if SSL enabled).
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_keyfile |
string
''
SSL cert file (valid only if SSL enabled).
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_certfile |
string
''
SSL certification authority file (valid only if SSL enabled).
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_ssl_ca_certs |
boolean
False
Global toggle for enforcing the OpenSSL FIPS mode. This feature requires Python support. This is available in Python 3.9 in all environments and may have been backported to older Python versions on select environments. If the Python executable used does not support OpenSSL FIPS mode, an exception will be raised.
boolean
False
Run the health check heartbeat thread through a native python thread by default. If this option is equal to False then the health check heartbeat will inherit the execution model from the parent process. For example if the parent process has monkey patched the stdlib by using eventlet/greenlet then the heartbeat will be run through a green thread. This option should be set to True only for the wsgi services.
floating point
1.0
How long to wait before reconnecting in response to an AMQP consumer cancel notification.
Group |
Name |
---|---|
DEFAULT |
kombu_reconnect_delay |
string
<None>
EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.
integer
60
How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
Group |
Name |
---|---|
oslo_messaging_rabbit |
kombu_reconnect_timeout |
string
round-robin
round-robin, shuffle
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.
string
AMQPLAIN
PLAIN, AMQPLAIN, EXTERNAL, RABBIT-CR-DEMO
The RabbitMQ login method.
Group |
Name |
---|---|
DEFAULT |
rabbit_login_method |
integer
1
How frequently to retry connecting with RabbitMQ.
integer
2
How long to backoff for between retries when connecting to RabbitMQ.
Group |
Name |
---|---|
DEFAULT |
rabbit_retry_backoff |
integer
30
Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
boolean
False
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”}’ “
Group |
Name |
---|---|
DEFAULT |
rabbit_ha_queues |
boolean
False
Use quorum queues in RabbitMQ (x-queue-type: quorum). The quorum queue is a modern queue type for RabbitMQ implementing a durable, replicated FIFO queue based on the Raft consensus algorithm. It is available as of RabbitMQ 3.8.0. If set this option will conflict with the HA queues (rabbit_ha_queues
) aka mirrored queues, in other words the HA queues should be disabled, quorum queues durable by default so the amqp_durable_queues opion is ignored when this option enabled.
integer
0
Each time a message is redelivered to a consumer, a counter is incremented. Once the redelivery count exceeds the delivery limit the message gets dropped or dead-lettered (if a DLX exchange has been configured) Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.
integer
0
By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of messages in the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.
integer
0
By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of memory bytes used by the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.
integer
1800
1
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.
integer
0
Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
integer
60
Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat).
integer
2
How often times during the heartbeat_timeout_threshold we check the heartbeat.
boolean
True
(DEPRECATED) Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply, so the MessageUndeliverable exception is raised in case the client queue does not exist.MessageUndeliverable exception will be used to loop for a timeout to lets a chance to sender to recover.This flag is deprecated and it will not be possible to deactivate this functionality anymore
Warning
This option is deprecated for removal. Its value may be silently ignored in the future.
Mandatory flag no longer deactivable.
boolean
False
Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down
integer
-1
Default per project load balancer quota.
integer
-1
Default per project listener quota.
integer
-1
Default per project member quota.
integer
-1
Default per project pool quota.
integer
-1
Default per project health monitor quota.
integer
-1
Default per project l7policy quota.
integer
-1
Default per project l7rule quota.
unknown type
<None>
Authentication URL
unknown type
<None>
Authentication type to load
Group |
Name |
---|---|
service_auth |
auth_plugin |
string
<None>
PEM encoded Certificate Authority to use when verifying HTTPs connections.
string
<None>
PEM encoded client certificate cert file
boolean
False
Collect per-API call timing information.
unknown type
<None>
Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
unknown type
<None>
Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
unknown type
<None>
Domain ID to scope to
unknown type
<None>
Domain name to scope to
boolean
False
Verify HTTPS connections.
string
<None>
PEM encoded client certificate key file
unknown type
<None>
User’s password
unknown type
<None>
Domain ID containing project
unknown type
<None>
Domain name containing project
unknown type
<None>
Project ID to scope to
Group |
Name |
---|---|
service_auth |
tenant-id |
service_auth |
tenant_id |
unknown type
<None>
Project name to scope to
Group |
Name |
---|---|
service_auth |
tenant-name |
service_auth |
tenant_name |
boolean
False
Log requests to multiple loggers.
unknown type
<None>
Scope for system operations
unknown type
<None>
Tenant ID
unknown type
<None>
Tenant Name
integer
<None>
Timeout value for http requests
unknown type
<None>
ID of the trust to use as a trustee use
unknown type
<None>
User’s domain id
unknown type
<None>
User’s domain name
unknown type
<None>
User id
unknown type
<None>
Username
Group |
Name |
---|---|
service_auth |
user-name |
service_auth |
user_name |
string
parallel
serial, parallel
TaskFlow engine to use.
Possible values
Runs all tasks on a single thread
Schedules tasks onto different threads to allow for running non-dependent tasks simultaneously
integer
5
The maximum number of workers
boolean
False
If True, disables the controller worker taskflow flows from reverting. This will leave resources in an inconsistent state and should only be used for debugging purposes.
string
sqlite://
Persistence database, which will be used to store tasks states. Database connection url with db name
boolean
False
If True, enables TaskFlow jobboard.
string
redis_taskflow_driver
redis_taskflow_driver, zookeeper_taskflow_driver
Jobboard backend driver that will monitor job state.
Possible values
Driver that will use Redis to store job states.
Driver that will use Zookeeper to store job states.
list
['127.0.0.1']
Jobboard backend server host(s).
port number
6379
0
65535
Jobboard backend server port
string
''
Jobboard backend server password
string
octavia_jobboard
Jobboard name that should be used to store taskflow job id and claims for it.
string
<None>
Sentinel name if it is used for Redis.
dict
{'ssl': False, 'ssl_keyfile': None, 'ssl_certfile': None, 'ssl_ca_certs': None, 'ssl_cert_reqs': 'required'}
Redis jobboard backend ssl configuration options.
dict
{'use_ssl': False, 'keyfile': None, 'keyfile_password': None, 'certfile': None, 'verify_certs': True}
Zookeeper jobboard backend ssl configuration options.
integer
30
For backends like redis claiming jobs requiring setting the expiry - how many seconds the claim should be retained for.
boolean
False
If for analysis required saving logbooks info, set this parameter to True. By default remove logbook from persistence backend when job completed.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.