barbican.conf
DEFAULT
-
api_paste_config
Type: | string |
Default: | api-paste.ini |
File name for the paste.deploy config for api service
-
wsgi_log_format
Type: | string |
Default: | %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f |
A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.
-
tcp_keepidle
-
Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.
-
wsgi_default_pool_size
-
Size of the pool of greenthreads used by wsgi
Type: | integer |
Default: | 16384 |
Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).
-
wsgi_keep_alive
Type: | boolean |
Default: | true |
If False, closes the client socket connection explicitly.
-
client_socket_timeout
-
Timeout for client connections’ socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of ‘0’ means wait forever.
-
run_external_periodic_tasks
Type: | boolean |
Default: | true |
Some periodic tasks can be run in a separate process. Should we run them here?
-
rpc_conn_pool_size
-
Size of RPC connection pool.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_conn_pool_size |
-
conn_pool_min_size
-
The pool size limit for connections expiration policy
-
conn_pool_ttl
Type: | integer |
Default: | 1200 |
The time-to-live in sec of idle connections in the pool
-
rpc_zmq_bind_address
-
ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_bind_address |
-
rpc_zmq_matchmaker
Type: | string |
Default: | redis |
Valid Values: | redis, sentinel, dummy |
MatchMaker driver.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_matchmaker |
-
rpc_zmq_contexts
-
Number of ZeroMQ contexts, defaults to 1.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_contexts |
-
rpc_zmq_topic_backlog
Type: | integer |
Default: | <None> |
Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_topic_backlog |
-
rpc_zmq_ipc_dir
Type: | string |
Default: | /var/run/openstack |
Directory for holding IPC sockets.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_ipc_dir |
-
rpc_zmq_host
Type: | string |
Default: | localhost |
Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_host |
-
zmq_linger
-
Number of seconds to wait before all pending messages will be sent after closing a socket. 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. Positive values specify an upper bound for the linger period.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_cast_timeout |
-
rpc_poll_timeout
-
The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_poll_timeout |
-
zmq_target_expire
-
Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
Deprecated Variations
Group |
Name |
DEFAULT |
zmq_target_expire |
-
zmq_target_update
-
Update period in seconds of a name service record about existing target.
Deprecated Variations
Group |
Name |
DEFAULT |
zmq_target_update |
-
use_pub_sub
Type: | boolean |
Default: | false |
Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
Deprecated Variations
Group |
Name |
DEFAULT |
use_pub_sub |
-
use_router_proxy
Type: | boolean |
Default: | false |
Use ROUTER remote proxy.
Deprecated Variations
Group |
Name |
DEFAULT |
use_router_proxy |
-
use_dynamic_connections
Type: | boolean |
Default: | false |
This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise).
-
zmq_failover_connections
-
How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode.
-
rpc_zmq_min_port
Type: | port number |
Default: | 49153 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
Minimal port number for random ports range.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_min_port |
-
rpc_zmq_max_port
Type: | integer |
Default: | 65536 |
Minimum Value: | 1 |
Maximum Value: | 65536 |
Maximal port number for random ports range.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_max_port |
-
rpc_zmq_bind_port_retries
-
Number of retries to find free port number before fail with ZMQBindError.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_bind_port_retries |
-
rpc_zmq_serialization
Type: | string |
Default: | json |
Valid Values: | json, msgpack |
Default serialization mechanism for serializing/deserializing outgoing/incoming messages
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_serialization |
-
zmq_immediate
Type: | boolean |
Default: | true |
This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.
-
zmq_tcp_keepalive
-
Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively.
-
zmq_tcp_keepalive_idle
-
The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.
-
zmq_tcp_keepalive_cnt
-
The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.
-
zmq_tcp_keepalive_intvl
-
The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.
-
rpc_thread_pool_size
-
Maximum number of (green) threads to work concurrently.
-
rpc_message_ttl
-
Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server.
-
rpc_use_acks
Type: | boolean |
Default: | false |
Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB.
-
rpc_ack_timeout_base
-
Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier.
-
rpc_ack_timeout_multiplier
-
Number to multiply base ack timeout by after each retry attempt.
-
rpc_retry_attempts
-
Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.
-
subscribe_on
-
List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker.
-
executor_thread_pool_size
-
Size of executor thread pool when executor is threading or eventlet.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_thread_pool_size |
-
rpc_response_timeout
-
Seconds to wait for a response from a call.
-
transport_url
Type: | string |
Default: | <None> |
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
-
rpc_backend
Type: | string |
Default: | rabbit |
The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq.
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
control_exchange
Type: | string |
Default: | openstack |
The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
-
debug
Type: | boolean |
Default: | false |
Mutable: | 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.
-
log_config_append
Type: | string |
Default: | <None> |
Mutable: | 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, logging_context_format_string).
Deprecated Variations
Group |
Name |
DEFAULT |
log-config |
DEFAULT |
log_config |
-
log_date_format
Type: | string |
Default: | %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.
-
log_file
Type: | string |
Default: | <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.
Deprecated Variations
Group |
Name |
DEFAULT |
logfile |
-
log_dir
Type: | string |
Default: | <None> |
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
Deprecated Variations
Group |
Name |
DEFAULT |
logdir |
-
watch_log_file
Type: | boolean |
Default: | 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.
-
use_syslog
Type: | boolean |
Default: | 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.
-
use_journal
Type: | boolean |
Default: | 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.
-
syslog_log_facility
Type: | string |
Default: | LOG_USER |
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
-
use_json
Type: | boolean |
Default: | false |
Use JSON formatting for logging. This option is ignored if log_config_append is set.
-
use_stderr
Type: | boolean |
Default: | false |
Log output to standard error. This option is ignored if log_config_append is set.
-
logging_context_format_string
Type: | string |
Default: | %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s |
Format string to use for log messages with context.
-
logging_default_format_string
Type: | string |
Default: | %(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.
-
logging_debug_format_suffix
Type: | string |
Default: | %(funcName)s %(pathname)s:%(lineno)d |
Additional data to append to log message when logging level for the message is DEBUG.
-
logging_exception_prefix
Type: | string |
Default: | %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s |
Prefix each line of exception output with this format.
-
logging_user_identity_format
Type: | string |
Default: | %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s |
Defines the format string for %(user_identity)s that is used in logging_context_format_string.
-
default_log_levels
Type: | list |
Default: | 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,dogpile.core.dogpile=INFO |
List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.
-
publish_errors
Type: | boolean |
Default: | false |
Enables or disables publication of error events.
-
instance_format
Type: | string |
Default: | "[instance: %(uuid)s] " |
The format for an instance that is passed with the log message.
-
instance_uuid_format
Type: | string |
Default: | "[instance: %(uuid)s] " |
The format for an instance UUID that is passed with the log message.
-
rate_limit_interval
-
Interval, number of seconds, of log rate limiting.
-
rate_limit_burst
-
Maximum number of logged messages per rate_limit_interval.
-
rate_limit_except_level
Type: | string |
Default: | 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.
-
fatal_deprecations
Type: | boolean |
Default: | false |
Enables or disables fatal status of deprecations.
-
admin_role
Type: | string |
Default: | admin |
Role used to identify an authenticated user as administrator.
-
allow_anonymous_access
Type: | boolean |
Default: | false |
Allow unauthenticated users to access the API with read-only privileges. This only applies when using ContextMiddleware.
-
max_allowed_request_size_in_bytes
Type: | integer |
Default: | 15000 |
Maximum allowed http request size against the barbican-api.
-
max_allowed_secret_in_bytes
Type: | integer |
Default: | 10000 |
Maximum allowed secret size in bytes.
-
host_href
Type: | string |
Default: | http://localhost:9311 |
Host name, for use in HATEOAS-style references Note: Typically this would be the load balanced endpoint that clients would use to communicate back with this service. If a deployment wants to derive host from wsgi request instead then make this blank. Blank is needed to override default config value which is ‘http://localhost:9311’
-
sql_connection
Type: | string |
Default: | sqlite:///barbican.sqlite |
SQLAlchemy connection string for the reference implementation registry server. Any valid SQLAlchemy connection string is fine. See: http://www.sqlalchemy.org/docs/05/reference/sqlalchemy/connections.html#sqlalchemy.create_engine. Note: For absolute addresses, use ‘////’ slashes after ‘sqlite:’.
-
sql_idle_timeout
Type: | integer |
Default: | 3600 |
Period in seconds after which SQLAlchemy should reestablish its connection to the database. MySQL uses a default wait_timeout of 8 hours, after which it will drop idle connections. This can result in ‘MySQL Gone Away’ exceptions. If you notice this, you can lower this value to ensure that SQLAlchemy reconnects before MySQL can drop the connection.
-
sql_max_retries
-
Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
-
sql_retry_interval
-
Interval between retries of opening a SQL connection.
-
db_auto_create
Type: | boolean |
Default: | true |
Create the Barbican database on service startup.
-
max_limit_paging
-
Maximum page size for the ‘limit’ paging URL parameter.
-
default_limit_paging
-
Default page size for the ‘limit’ paging URL parameter.
-
sql_pool_class
Type: | string |
Default: | QueuePool |
Accepts a class imported from the sqlalchemy.pool module, and handles the details of building the pool for you. If commented out, SQLAlchemy will select based on the database dialect. Other options are QueuePool (for SQLAlchemy-managed connections) and NullPool (to disabled SQLAlchemy management of connections). See http://docs.sqlalchemy.org/en/latest/core/pooling.html for more details
-
sql_pool_logging
Type: | boolean |
Default: | false |
Show SQLAlchemy pool-related debugging output in logs (sets DEBUG log level output) if specified.
-
sql_pool_size
-
Size of pool used by SQLAlchemy. This is the largest number of connections that will be kept persistently in the pool. Can be set to 0 to indicate no size limit. To disable pooling, use a NullPool with sql_pool_class instead. Comment out to allow SQLAlchemy to select the default.
-
sql_pool_max_overflow
-
# The maximum overflow size of the pool used by SQLAlchemy. When the number of checked-out connections reaches the size set in sql_pool_size, additional connections will be returned up to this limit. It follows then that the total number of simultaneous connections the pool will allow is sql_pool_size + sql_pool_max_overflow. Can be set to -1 to indicate no overflow limit, so no limit will be placed on the total number of concurrent connections. Comment out to allow SQLAlchemy to select the default.
-
backdoor_port
Type: | string |
Default: | <None> |
Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file.
-
backdoor_socket
Type: | string |
Default: | <None> |
Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option.
certificate
-
namespace
Type: | string |
Default: | barbican.certificate.plugin |
Extension namespace to search for plugins.
-
enabled_certificate_plugins
Type: | multi-valued |
Default: | simple_certificate |
List of certificate plugins to load.
certificate_event
-
namespace
Type: | string |
Default: | barbican.certificate.event.plugin |
Extension namespace to search for eventing plugins.
-
enabled_certificate_event_plugins
Type: | multi-valued |
Default: | simple_certificate_event |
List of certificate plugins to load.
cors
-
allowed_origin
-
Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com
-
allow_credentials
Type: | boolean |
Default: | true |
Indicate that the actual request can include user credentials
Type: | list |
Default: | X-Auth-Token,X-Openstack-Request-Id,X-Project-Id,X-Identity-Status,X-User-Id,X-Storage-Token,X-Domain-Id,X-User-Domain-Id,X-Project-Domain-Id,X-Roles |
Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.
-
max_age
Type: | integer |
Default: | 3600 |
Maximum cache age of CORS preflight requests.
-
allow_methods
Type: | list |
Default: | GET,PUT,POST,DELETE,PATCH |
Indicate which methods can be used during the actual request.
Type: | list |
Default: | X-Auth-Token,X-Openstack-Request-Id,X-Project-Id,X-Identity-Status,X-User-Id,X-Storage-Token,X-Domain-Id,X-User-Domain-Id,X-Project-Domain-Id,X-Roles |
Indicate which header field names may be used during the actual request.
crypto
-
namespace
Type: | string |
Default: | barbican.crypto.plugin |
Extension namespace to search for plugins.
-
enabled_crypto_plugins
Type: | multi-valued |
Default: | simple_crypto |
List of crypto plugins to load.
dogtag_plugin
-
pem_path
Type: | string |
Default: | /etc/barbican/kra_admin_cert.pem |
Path to PEM file for authentication
-
dogtag_host
Type: | string |
Default: | localhost |
Hostname for the Dogtag instance
-
dogtag_port
Type: | port number |
Default: | 8443 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
Port for the Dogtag instance
-
nss_db_path
Type: | string |
Default: | /etc/barbican/alias |
Path to the NSS certificate database
-
nss_password
Type: | string |
Default: | <None> |
Password for the NSS certificate databases
-
simple_cmc_profile
Type: | string |
Default: | caOtherCert |
Profile for simple CMC requests
-
auto_approved_profiles
Type: | string |
Default: | caServerCert |
List of automatically approved enrollment profiles
-
ca_expiration_time
-
Time in days for CA entries to expire
-
plugin_working_dir
Type: | string |
Default: | /etc/barbican/dogtag |
Working directory for Dogtag plugin
-
plugin_name
Type: | string |
Default: | Dogtag KRA |
User friendly plugin name
-
retries
-
Retries when storing or generating secrets
keystone_authtoken
-
www_authenticate_uri
Type: | string |
Default: | <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.
Deprecated Variations
Group |
Name |
keystone_authtoken |
auth_uri |
-
auth_uri
Type: | string |
Default: | <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.
Reason: | The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release. |
-
auth_version
Type: | string |
Default: | <None> |
API version of the admin Identity API endpoint.
-
delay_auth_decision
Type: | boolean |
Default: | false |
Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.
-
http_connect_timeout
Type: | integer |
Default: | <None> |
Request timeout value for communicating with Identity API server.
-
http_request_max_retries
-
How many times are we trying to reconnect when communicating with Identity API Server.
-
cache
Type: | string |
Default: | <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.
-
certfile
Type: | string |
Default: | <None> |
Required if identity server requires client certificate
-
keyfile
Type: | string |
Default: | <None> |
Required if identity server requires client certificate
-
cafile
Type: | string |
Default: | <None> |
A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.
-
insecure
Type: | boolean |
Default: | false |
Verify HTTPS connections.
-
region_name
Type: | string |
Default: | <None> |
The region in which the identity server can be found.
-
signing_dir
Type: | string |
Default: | <None> |
Directory used to cache files related to PKI tokens. This option has been deprecated in the Ocata release and will be removed in the P release.
Warning
This option is deprecated for removal since Ocata.
Its value may be silently ignored
in the future.
Reason: | PKI token format is no longer supported. |
-
memcached_servers
-
Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.
Deprecated Variations
Group |
Name |
keystone_authtoken |
memcache_servers |
-
token_cache_time
-
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.
-
revocation_cache_time
-
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. Only valid for PKI tokens. This option has been deprecated in the Ocata release and will be removed in the P release.
Warning
This option is deprecated for removal since Ocata.
Its value may be silently ignored
in the future.
Reason: | PKI token format is no longer supported. |
-
memcache_security_strategy
Type: | string |
Default: | None |
Valid Values: | 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.
-
memcache_secret_key
Type: | string |
Default: | <None> |
(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.
-
memcache_pool_dead_retry
-
(Optional) Number of seconds memcached server is considered dead before it is tried again.
-
memcache_pool_maxsize
-
(Optional) Maximum total number of open connections to every memcached server.
-
memcache_pool_socket_timeout
-
(Optional) Socket timeout in seconds for communicating with a memcached server.
-
memcache_pool_unused_timeout
-
(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.
-
memcache_pool_conn_get_timeout
-
(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.
-
memcache_use_advanced_pool
Type: | boolean |
Default: | false |
(Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.
-
include_service_catalog
Type: | boolean |
Default: | 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.
-
enforce_token_bind
Type: | string |
Default: | 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.
-
check_revocations_for_cached
Type: | boolean |
Default: | false |
If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server.
Warning
This option is deprecated for removal since Ocata.
Its value may be silently ignored
in the future.
Reason: | PKI token format is no longer supported. |
-
hash_algorithms
-
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.
Warning
This option is deprecated for removal since Ocata.
Its value may be silently ignored
in the future.
Reason: | PKI token format is no longer supported. |
-
service_token_roles
Type: | list |
Default: | 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.
-
service_token_roles_required
Type: | boolean |
Default: | 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.
-
auth_type
Type: | unknown type |
Default: | <None> |
Authentication type to load
Deprecated Variations
Group |
Name |
keystone_authtoken |
auth_plugin |
-
auth_section
Type: | unknown type |
Default: | <None> |
Config Section from which to load plugin specific options
keystone_notifications
-
enable
Type: | boolean |
Default: | false |
True enables keystone notification listener functionality.
-
control_exchange
Type: | string |
Default: | keystone |
The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.
-
topic
Type: | string |
Default: | notifications |
Keystone notification queue topic name. This name needs to match one of values mentioned in Keystone deployment’s ‘notification_topics’ configuration e.g. notification_topics=notifications, barbican_notificationsMultiple servers may listen on a topic and messages will be dispatched to one of the servers in a round-robin fashion. That’s why Barbican service should have its own dedicated notification queue so that it receives all of Keystone notifications.
-
allow_requeue
Type: | boolean |
Default: | false |
True enables requeue feature in case of notification processing error. Enable this only when underlying transport supports this feature.
-
version
-
Version of tasks invoked via notifications
-
thread_pool_size
-
Define the number of max threads to be used for notification server processing functionality.
kmip_plugin
-
username
Type: | string |
Default: | <None> |
Username for authenticating with KMIP server
-
password
Type: | string |
Default: | <None> |
Password for authenticating with KMIP server
-
host
Type: | string |
Default: | localhost |
Address of the KMIP server
-
port
Type: | port number |
Default: | 5696 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
Port for the KMIP server
-
ssl_version
Type: | string |
Default: | PROTOCOL_TLSv1_2 |
SSL version, maps to the module ssl’s constants
-
ca_certs
Type: | string |
Default: | <None> |
File path to concatenated “certification authority” certificates
-
certfile
Type: | string |
Default: | <None> |
File path to local client certificate
-
keyfile
Type: | string |
Default: | <None> |
File path to local client certificate keyfile
-
pkcs1_only
Type: | boolean |
Default: | false |
Only support PKCS#1 encoding of asymmetric keys
-
plugin_name
Type: | string |
Default: | KMIP HSM |
User friendly plugin name
matchmaker_redis
-
host
Type: | string |
Default: | 127.0.0.1 |
Host to locate redis.
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
port
Type: | port number |
Default: | 6379 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
Use this port to connect to redis host.
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
password
-
Password for Redis server (optional).
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
sentinel_hosts
-
List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port … ]
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
sentinel_group_name
Type: | string |
Default: | oslo-messaging-zeromq |
Redis replica set name.
-
wait_timeout
Type: | integer |
Default: | 2000 |
Time in ms to wait between connection attempts.
-
check_timeout
Type: | integer |
Default: | 20000 |
Time in ms to wait before the transaction is killed.
-
socket_timeout
Type: | integer |
Default: | 10000 |
Timeout in ms on blocking socket operations.
oslo_messaging_amqp
-
container_name
Type: | string |
Default: | <None> |
Name for the AMQP container. must be globally unique. Defaults to a generated UUID
Deprecated Variations
Group |
Name |
amqp1 |
container_name |
-
idle_timeout
-
Timeout for inactive connections (in seconds)
Deprecated Variations
Group |
Name |
amqp1 |
idle_timeout |
-
trace
Type: | boolean |
Default: | false |
Debug: dump AMQP frames to stdout
Deprecated Variations
Group |
Name |
amqp1 |
trace |
-
ssl
Type: | boolean |
Default: | 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.
-
ssl_ca_file
-
CA certificate PEM file used to verify the server’s certificate
Deprecated Variations
Group |
Name |
amqp1 |
ssl_ca_file |
-
ssl_cert_file
-
Self-identifying certificate PEM file for client authentication
Deprecated Variations
Group |
Name |
amqp1 |
ssl_cert_file |
-
ssl_key_file
-
Private key PEM file used to sign ssl_cert_file certificate (optional)
Deprecated Variations
Group |
Name |
amqp1 |
ssl_key_file |
-
ssl_key_password
Type: | string |
Default: | <None> |
Password for decrypting ssl_key_file (if encrypted)
Deprecated Variations
Group |
Name |
amqp1 |
ssl_key_password |
-
ssl_verify_vhost
Type: | boolean |
Default: | 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.
-
allow_insecure_clients
Type: | boolean |
Default: | false |
Accept clients using either SSL or plain TCP
Deprecated Variations
Group |
Name |
amqp1 |
allow_insecure_clients |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Not applicable - not a SSL server |
-
sasl_mechanisms
-
Space separated list of acceptable SASL mechanisms
Deprecated Variations
Group |
Name |
amqp1 |
sasl_mechanisms |
-
sasl_config_dir
-
Path to directory that contains the SASL configuration
Deprecated Variations
Group |
Name |
amqp1 |
sasl_config_dir |
-
sasl_config_name
-
Name of configuration file (without .conf suffix)
Deprecated Variations
Group |
Name |
amqp1 |
sasl_config_name |
-
sasl_default_realm
-
SASL realm to use if no realm present in username
-
username
-
User name for message broker authentication
Deprecated Variations
Group |
Name |
amqp1 |
username |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Should use configuration option transport_url to provide the username. |
-
password
-
Password for message broker authentication
Deprecated Variations
Group |
Name |
amqp1 |
password |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Should use configuration option transport_url to provide the password. |
-
connection_retry_interval
Type: | integer |
Default: | 1 |
Minimum Value: | 1 |
Seconds to pause before attempting to re-connect.
-
connection_retry_backoff
Type: | integer |
Default: | 2 |
Minimum Value: | 0 |
Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.
-
connection_retry_interval_max
Type: | integer |
Default: | 30 |
Minimum Value: | 1 |
Maximum limit for connection_retry_interval + connection_retry_backoff
-
link_retry_delay
Type: | integer |
Default: | 10 |
Minimum Value: | 1 |
Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.
-
default_reply_retry
Type: | integer |
Default: | 0 |
Minimum Value: | -1 |
The maximum number of attempts to re-send a reply message which failed due to a recoverable error.
-
default_reply_timeout
Type: | integer |
Default: | 30 |
Minimum Value: | 5 |
The deadline for an rpc reply message delivery.
-
default_send_timeout
Type: | integer |
Default: | 30 |
Minimum Value: | 5 |
The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.
-
default_notify_timeout
Type: | integer |
Default: | 30 |
Minimum Value: | 5 |
The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.
-
default_sender_link_timeout
Type: | integer |
Default: | 600 |
Minimum Value: | 1 |
The duration to schedule a purge of idle sender links. Detach link after expiry.
-
addressing_mode
Type: | string |
Default: | 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
-
pseudo_vhost
Type: | boolean |
Default: | 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.
-
server_request_prefix
Type: | string |
Default: | exclusive |
address prefix used when sending to a specific server
Deprecated Variations
Group |
Name |
amqp1 |
server_request_prefix |
-
broadcast_prefix
Type: | string |
Default: | broadcast |
address prefix used when broadcasting to all servers
Deprecated Variations
Group |
Name |
amqp1 |
broadcast_prefix |
-
group_request_prefix
Type: | string |
Default: | unicast |
address prefix when sending to any server in group
Deprecated Variations
Group |
Name |
amqp1 |
group_request_prefix |
-
rpc_address_prefix
Type: | string |
Default: | openstack.org/om/rpc |
Address prefix for all generated RPC addresses
-
notify_address_prefix
Type: | string |
Default: | openstack.org/om/notify |
Address prefix for all generated Notification addresses
-
multicast_address
Type: | string |
Default: | multicast |
Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.
-
unicast_address
Type: | string |
Default: | 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.
-
anycast_address
Type: | string |
Default: | 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.
-
default_notification_exchange
Type: | string |
Default: | <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’
-
default_rpc_exchange
Type: | string |
Default: | <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’
-
reply_link_credit
Type: | integer |
Default: | 200 |
Minimum Value: | 1 |
Window size for incoming RPC Reply messages.
-
rpc_server_credit
Type: | integer |
Default: | 100 |
Minimum Value: | 1 |
Window size for incoming RPC Request messages
-
notify_server_credit
Type: | integer |
Default: | 100 |
Minimum Value: | 1 |
Window size for incoming Notification messages
-
pre_settled
Type: | multi-valued |
Default: | rpc-cast |
Default: | 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
oslo_messaging_kafka
-
kafka_default_host
Type: | string |
Default: | localhost |
Default Kafka broker Host
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
kafka_default_port
Type: | port number |
Default: | 9092 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
Default Kafka broker Port
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
kafka_max_fetch_bytes
Type: | integer |
Default: | 1048576 |
Max fetch bytes of Kafka consumer
-
kafka_consumer_timeout
Type: | floating point |
Default: | 1.0 |
Default timeout(s) for Kafka consumers
-
pool_size
-
Pool Size for Kafka Consumers
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Driver no longer uses connection pool. |
-
conn_pool_min_size
-
The pool size limit for connections expiration policy
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Driver no longer uses connection pool. |
-
conn_pool_ttl
Type: | integer |
Default: | 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.
Reason: | Driver no longer uses connection pool. |
-
consumer_group
Type: | string |
Default: | oslo_messaging_consumer |
Group id for Kafka consumer. Consumers in one group will coordinate message consumption
-
producer_batch_timeout
Type: | floating point |
Default: | 0.0 |
Upper bound on the delay for KafkaProducer batching in seconds
-
producer_batch_size
Type: | integer |
Default: | 16384 |
Size of batch for the producer async send
-
enable_auto_commit
Type: | boolean |
Default: | false |
Enable asynchronous consumer commits
-
max_poll_records
-
The maximum number of records returned in a poll call
-
security_protocol
Type: | string |
Default: | PLAINTEXT |
Valid Values: | PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL |
Protocol used to communicate with brokers
-
sasl_mechanism
Type: | string |
Default: | PLAIN |
Mechanism when security protocol is SASL
-
ssl_cafile
-
CA certificate PEM file used to verify the server certificate
oslo_messaging_notifications
-
driver
Type: | multi-valued |
Default: | u'' |
The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop
Deprecated Variations
Group |
Name |
DEFAULT |
notification_driver |
-
transport_url
Type: | string |
Default: | <None> |
A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.
Deprecated Variations
Group |
Name |
DEFAULT |
notification_transport_url |
-
topics
Type: | list |
Default: | notifications |
AMQP topic used for OpenStack notifications.
Deprecated Variations
Group |
Name |
rpc_notifier2 |
topics |
DEFAULT |
notification_topics |
-
retry
-
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
oslo_messaging_rabbit
-
amqp_durable_queues
Type: | boolean |
Default: | false |
Use durable queues in AMQP.
Deprecated Variations
Group |
Name |
DEFAULT |
amqp_durable_queues |
DEFAULT |
rabbit_durable_queues |
-
amqp_auto_delete
Type: | boolean |
Default: | false |
Auto-delete queues in AMQP.
Deprecated Variations
Group |
Name |
DEFAULT |
amqp_auto_delete |
-
ssl
Type: | boolean |
Default: | false |
Connect over SSL.
Deprecated Variations
Group |
Name |
oslo_messaging_rabbit |
rabbit_use_ssl |
-
ssl_version
-
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.
Deprecated Variations
Group |
Name |
oslo_messaging_rabbit |
kombu_ssl_version |
-
ssl_key_file
-
SSL key file (valid only if SSL enabled).
Deprecated Variations
Group |
Name |
oslo_messaging_rabbit |
kombu_ssl_keyfile |
-
ssl_cert_file
-
SSL cert file (valid only if SSL enabled).
Deprecated Variations
Group |
Name |
oslo_messaging_rabbit |
kombu_ssl_certfile |
-
ssl_ca_file
-
SSL certification authority file (valid only if SSL enabled).
Deprecated Variations
Group |
Name |
oslo_messaging_rabbit |
kombu_ssl_ca_certs |
-
kombu_reconnect_delay
Type: | floating point |
Default: | 1.0 |
How long to wait before reconnecting in response to an AMQP consumer cancel notification.
Deprecated Variations
Group |
Name |
DEFAULT |
kombu_reconnect_delay |
-
kombu_compression
Type: | string |
Default: | <None> |
EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.
-
kombu_missing_consumer_retry_timeout
-
How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.
Deprecated Variations
Group |
Name |
oslo_messaging_rabbit |
kombu_reconnect_timeout |
-
kombu_failover_strategy
Type: | string |
Default: | round-robin |
Valid Values: | 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.
-
rabbit_host
Type: | string |
Default: | localhost |
The RabbitMQ broker address where a single node is used.
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_host |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
rabbit_port
Type: | port number |
Default: | 5672 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
The RabbitMQ broker port where a single node is used.
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_port |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
rabbit_hosts
Type: | list |
Default: | $rabbit_host:$rabbit_port |
RabbitMQ HA cluster host:port pairs.
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_hosts |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
rabbit_userid
Type: | string |
Default: | guest |
The RabbitMQ userid.
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_userid |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
rabbit_password
Type: | string |
Default: | guest |
The RabbitMQ password.
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_password |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
rabbit_login_method
Type: | string |
Default: | AMQPLAIN |
Valid Values: | PLAIN, AMQPLAIN, RABBIT-CR-DEMO |
The RabbitMQ login method.
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_login_method |
-
rabbit_virtual_host
-
The RabbitMQ virtual host.
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_virtual_host |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Replaced by [DEFAULT]/transport_url |
-
rabbit_retry_interval
-
How frequently to retry connecting with RabbitMQ.
-
rabbit_retry_backoff
-
How long to backoff for between retries when connecting to RabbitMQ.
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_retry_backoff |
-
rabbit_interval_max
-
Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
-
rabbit_max_retries
-
Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_max_retries |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
-
rabbit_ha_queues
Type: | boolean |
Default: | 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”}’ “
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_ha_queues |
-
rabbit_transient_queues_ttl
Type: | integer |
Default: | 1800 |
Minimum Value: | 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.
-
rabbit_qos_prefetch_count
-
Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.
-
heartbeat_timeout_threshold
-
Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disable the heartbeat). EXPERIMENTAL
-
heartbeat_rate
-
How often times during the heartbeat_timeout_threshold we check the heartbeat.
oslo_messaging_zmq
-
rpc_zmq_bind_address
-
ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_bind_address |
-
rpc_zmq_matchmaker
Type: | string |
Default: | redis |
Valid Values: | redis, sentinel, dummy |
MatchMaker driver.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_matchmaker |
-
rpc_zmq_contexts
-
Number of ZeroMQ contexts, defaults to 1.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_contexts |
-
rpc_zmq_topic_backlog
Type: | integer |
Default: | <None> |
Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_topic_backlog |
-
rpc_zmq_ipc_dir
Type: | string |
Default: | /var/run/openstack |
Directory for holding IPC sockets.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_ipc_dir |
-
rpc_zmq_host
Type: | string |
Default: | localhost |
Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_host |
-
zmq_linger
-
Number of seconds to wait before all pending messages will be sent after closing a socket. 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. Positive values specify an upper bound for the linger period.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_cast_timeout |
-
rpc_poll_timeout
-
The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_poll_timeout |
-
zmq_target_expire
-
Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
Deprecated Variations
Group |
Name |
DEFAULT |
zmq_target_expire |
-
zmq_target_update
-
Update period in seconds of a name service record about existing target.
Deprecated Variations
Group |
Name |
DEFAULT |
zmq_target_update |
-
use_pub_sub
Type: | boolean |
Default: | false |
Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
Deprecated Variations
Group |
Name |
DEFAULT |
use_pub_sub |
-
use_router_proxy
Type: | boolean |
Default: | false |
Use ROUTER remote proxy.
Deprecated Variations
Group |
Name |
DEFAULT |
use_router_proxy |
-
use_dynamic_connections
Type: | boolean |
Default: | false |
This option makes direct connections dynamic or static. It makes sense only with use_router_proxy=False which means to use direct connections for direct message types (ignored otherwise).
-
zmq_failover_connections
-
How many additional connections to a host will be made for failover reasons. This option is actual only in dynamic connections mode.
-
rpc_zmq_min_port
Type: | port number |
Default: | 49153 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
Minimal port number for random ports range.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_min_port |
-
rpc_zmq_max_port
Type: | integer |
Default: | 65536 |
Minimum Value: | 1 |
Maximum Value: | 65536 |
Maximal port number for random ports range.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_max_port |
-
rpc_zmq_bind_port_retries
-
Number of retries to find free port number before fail with ZMQBindError.
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_bind_port_retries |
-
rpc_zmq_serialization
Type: | string |
Default: | json |
Valid Values: | json, msgpack |
Default serialization mechanism for serializing/deserializing outgoing/incoming messages
Deprecated Variations
Group |
Name |
DEFAULT |
rpc_zmq_serialization |
-
zmq_immediate
Type: | boolean |
Default: | true |
This option configures round-robin mode in zmq socket. True means not keeping a queue when server side disconnects. False means to keep queue and messages even if server is disconnected, when the server appears we send all accumulated messages to it.
-
zmq_tcp_keepalive
-
Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any other negative value) means to skip any overrides and leave it to OS default; 0 and 1 (or any other positive value) mean to disable and enable the option respectively.
-
zmq_tcp_keepalive_idle
-
The duration between two keepalive transmissions in idle condition. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.
-
zmq_tcp_keepalive_cnt
-
The number of retransmissions to be carried out before declaring that remote end is not available. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.
-
zmq_tcp_keepalive_intvl
-
The duration between two successive keepalive retransmissions, if acknowledgement to the previous keepalive transmission is not received. The unit is platform dependent, for example, seconds in Linux, milliseconds in Windows etc. The default value of -1 (or any other negative value and 0) means to skip any overrides and leave it to OS default.
-
rpc_thread_pool_size
-
Maximum number of (green) threads to work concurrently.
-
rpc_message_ttl
-
Expiration timeout in seconds of a sent/received message after which it is not tracked anymore by a client/server.
-
rpc_use_acks
Type: | boolean |
Default: | false |
Wait for message acknowledgements from receivers. This mechanism works only via proxy without PUB/SUB.
-
rpc_ack_timeout_base
-
Number of seconds to wait for an ack from a cast/call. After each retry attempt this timeout is multiplied by some specified multiplier.
-
rpc_ack_timeout_multiplier
-
Number to multiply base ack timeout by after each retry attempt.
-
rpc_retry_attempts
-
Default number of message sending attempts in case of any problems occurred: positive value N means at most N retries, 0 means no retries, None or -1 (or any other negative values) mean to retry forever. This option is used only if acknowledgments are enabled.
-
subscribe_on
-
List of publisher hosts SubConsumer can subscribe on. This option has higher priority then the default publishers list taken from the matchmaker.
oslo_middleware
Type: | boolean |
Default: | false |
Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.
oslo_policy
-
enforce_scope
Type: | boolean |
Default: | false |
This option controls whether or not to enforce scope when evaluating policies. If True
, the scope of the token used in the request is compared to the scope_types
of the policy being enforced. If the scopes do not match, an InvalidScope
exception will be raised. If False
, a message will be logged informing operators that policies are being invoked with mismatching scope.
-
policy_file
Type: | string |
Default: | policy.json |
The file that defines policies.
Deprecated Variations
Group |
Name |
DEFAULT |
policy_file |
-
policy_default_rule
Type: | string |
Default: | default |
Default rule. Enforced when a requested rule is not found.
Deprecated Variations
Group |
Name |
DEFAULT |
policy_default_rule |
-
policy_dirs
Type: | multi-valued |
Default: | policy.d |
Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.
Deprecated Variations
Group |
Name |
DEFAULT |
policy_dirs |
-
remote_content_type
Type: | string |
Default: | application/x-www-form-urlencoded |
Valid Values: | application/x-www-form-urlencoded, application/json |
Content Type to send and receive data for REST based policy check
-
remote_ssl_verify_server_crt
Type: | boolean |
Default: | false |
server identity verification for REST based policy check
-
remote_ssl_ca_crt_file
Type: | string |
Default: | <None> |
Absolute path to ca cert file for REST based policy check
-
remote_ssl_client_crt_file
Type: | string |
Default: | <None> |
Absolute path to client cert for REST based policy check
-
remote_ssl_client_key_file
Type: | string |
Default: | <None> |
Absolute path client key file REST based policy check
p11_crypto_plugin
-
library_path
Type: | string |
Default: | <None> |
Path to vendor PKCS11 library
-
login
Type: | string |
Default: | <None> |
Password to login to PKCS11 session
-
mkek_label
Type: | string |
Default: | <None> |
Master KEK label (as stored in the HSM)
-
mkek_length
Type: | integer |
Default: | <None> |
Master KEK length in bytes.
-
hmac_label
Type: | string |
Default: | <None> |
Master HMAC Key label (as stored in the HSM)
-
slot_id
-
HSM Slot ID
-
rw_session
Type: | boolean |
Default: | true |
Flag for Read/Write Sessions
-
pkek_length
-
Project KEK length in bytes.
-
pkek_cache_ttl
-
Project KEK Cache Time To Live, in seconds
-
pkek_cache_limit
-
Project KEK Cache Item Limit
-
encryption_mechanism
Type: | string |
Default: | CKM_AES_CBC |
Secret encryption mechanism
Deprecated Variations
Group |
Name |
p11_crypto_plugin |
algorithm |
-
hmac_key_type
Type: | string |
Default: | CKK_AES |
HMAC Key Type
-
hmac_keygen_mechanism
Type: | string |
Default: | CKM_AES_KEY_GEN |
HMAC Key Generation Algorithm
-
seed_file
-
File to pull entropy for seeding RNG
-
seed_length
-
Amount of data to read from file for seed
-
plugin_name
Type: | string |
Default: | PKCS11 HSM |
User friendly plugin name
-
aes_gcm_generate_iv
Type: | boolean |
Default: | true |
Generate IVs for CKM_AES_GCM mechanism.
Deprecated Variations
Group |
Name |
p11_crypto_plugin |
generate_iv |
-
always_set_cka_sensitive
Type: | boolean |
Default: | true |
Always set CKA_SENSITIVE=CK_TRUE including CKA_EXTRACTABLE=CK_TRUE keys.
queue
-
enable
Type: | boolean |
Default: | false |
True enables queuing, False invokes workers synchronously
-
namespace
Type: | string |
Default: | barbican |
Queue namespace
-
topic
Type: | string |
Default: | barbican.workers |
Queue topic name
-
version
-
Version of tasks invoked via queue
-
server_name
Type: | string |
Default: | barbican.queue |
Server name for RPC task processing server
-
asynchronous_workers
-
Number of asynchronous worker processes
quotas
-
quota_secrets
-
Number of secrets allowed per project
-
quota_orders
-
Number of orders allowed per project
-
quota_containers
-
Number of containers allowed per project
-
quota_consumers
-
Number of consumers allowed per project
-
quota_cas
-
Number of CAs allowed per project
retry_scheduler
-
initial_delay_seconds
Type: | floating point |
Default: | 10.0 |
Seconds (float) to wait before starting retry scheduler
-
periodic_interval_max_seconds
Type: | floating point |
Default: | 10.0 |
Seconds (float) to wait between periodic schedule events
secretstore
-
namespace
Type: | string |
Default: | barbican.secretstore.plugin |
Extension namespace to search for plugins.
-
enabled_secretstore_plugins
Type: | multi-valued |
Default: | store_crypto |
List of secret store plugins to load.
-
enable_multiple_secret_stores
Type: | boolean |
Default: | false |
Flag to enable multiple secret store plugin backend support. Default is False
-
stores_lookup_suffix
-
List of suffix to use for looking up plugins which are supported with multiple backend support.
simple_crypto_plugin
-
kek
Type: | string |
Default: | dGhpcnR5X3R3b19ieXRlX2tleWJsYWhibGFoYmxhaGg= |
Key encryption key to be used by Simple Crypto Plugin
-
plugin_name
Type: | string |
Default: | Software Only Crypto |
User friendly plugin name
snakeoil_ca_plugin
-
ca_cert_path
Type: | string |
Default: | <None> |
Path to CA certificate file
-
ca_cert_key_path
Type: | string |
Default: | <None> |
Path to CA certificate key file
-
ca_cert_chain_path
Type: | string |
Default: | <None> |
Path to CA certificate chain file
-
ca_cert_pkcs7_path
Type: | string |
Default: | <None> |
Path to CA chain pkcs7 file
-
subca_cert_key_directory
Type: | string |
Default: | /etc/barbican/snakeoil-cas |
Directory in which to store certs/keys for subcas
ssl
-
ca_file
Type: | string |
Default: | <None> |
CA certificate file to use to verify connecting clients.
Deprecated Variations
Group |
Name |
DEFAULT |
ssl_ca_file |
-
cert_file
Type: | string |
Default: | <None> |
Certificate file to use when starting the server securely.
Deprecated Variations
Group |
Name |
DEFAULT |
ssl_cert_file |
-
key_file
Type: | string |
Default: | <None> |
Private key file to use when starting the server securely.
Deprecated Variations
Group |
Name |
DEFAULT |
ssl_key_file |
-
version
Type: | string |
Default: | <None> |
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.
-
ciphers
Type: | string |
Default: | <None> |
Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.