glance-registry.conf
This configuration file controls how the register server operates. More
information can be found in Configuring the Glance Registry.
DEFAULT
-
owner_is_tenant
Type: | boolean |
Default: | true |
Set the image owner to tenant or the authenticated user.
Assign a boolean value to determine the owner of an image. When set to
True, the owner of the image is the tenant. When set to False, the
owner of the image will be the authenticated user issuing the request.
Setting it to False makes the image private to the associated user and
sharing with other users within the same tenant (or “project”)
requires explicit image sharing via image membership.
Services which consume this:
* glance-api
* glare-api
* glance-registry
Possible values:
* True
* False
Related options:
* None
-
admin_role
Type: | string |
Default: | admin |
Role used to identify an authenticated user as administrator.
Provide a string value representing a Keystone role to identify an
administrative user. Users with this role will be granted
administrative privileges. The default value for this option is
‘admin’.
Services which consume this:
* glance-api
* glare-api
* glance-registry
* glance-scrubber
Possible values:
* A string value which is a valid Keystone role
Related options:
* None
-
allow_anonymous_access
Type: | boolean |
Default: | false |
Allow limited access to unauthenticated users.
Assign a boolean to determine API access for unathenticated
users. When set to False, the API cannot be accessed by
unauthenticated users. When set to True, unauthenticated users can
access the API with read-only privileges. This however only applies
when using ContextMiddleware.
Services which consumes this:
* glance-api
* glare-api
* glance-registry
Possible values:
* True
* False
Related options:
* None
-
max_request_id_length
Type: | integer |
Default: | 64 |
Minimum Value: | 0 |
Limit the request ID length.
Provide an integer value to limit the length of the request ID to
the specified length. The default value is 64. Users can change this
to any ineteger value between 0 and 16384 however keeping in mind that
a larger value may flood the logs.
Services which consumes this:
* glance-api
* glare-api
* glance-registry
Possible values:
* Integer value between 0 and 16384
Related options:
* None
-
allow_additional_image_properties
Type: | boolean |
Default: | true |
Whether to allow users to specify image properties beyond what the image schema provides
-
image_member_quota
-
Maximum number of image members per image. Negative values evaluate to unlimited.
-
image_property_quota
-
Maximum number of properties allowed on an image. Negative values evaluate to unlimited.
-
image_tag_quota
-
Maximum number of tags allowed on an image. Negative values evaluate to unlimited.
-
image_location_quota
-
Maximum number of locations allowed on an image. Negative values evaluate to unlimited.
-
data_api
Type: | string |
Default: | glance.db.sqlalchemy.api |
Python module path of data access API
-
limit_param_default
-
Default value for the number of items returned by a request if not specified explicitly in the request
-
api_limit_max
Type: | integer |
Default: | 1000 |
Maximum permissible number of items that could be returned by a request
-
show_image_direct_url
Type: | boolean |
Default: | false |
Whether to include the backend image storage location in image properties. Revealing storage location can be a security risk, so use this setting with caution!
-
show_multiple_locations
Type: | boolean |
Default: | false |
Whether to include the backend image locations in image properties. For example, if using the file system store a URL of “file:///path/to/image” will be returned to the user in the ‘direct_url’ meta-data field. Revealing storage location can be a security risk, so use this setting with caution! Setting this to true overrides the show_image_direct_url option.
-
image_size_cap
Type: | integer |
Default: | 1099511627776 |
Maximum Value: | 9223372036854775808 |
Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).WARNING: this value should only be increased after careful consideration and must be set to a value under 8 EB (9223372036854775808).
-
user_storage_quota
-
Set a system wide quota for every user. This value is the total capacity that a user can use across all storage systems. A value of 0 means unlimited.Optional unit can be specified for the value. Accepted units are B, KB, MB, GB and TB representing Bytes, KiloBytes, MegaBytes, GigaBytes and TeraBytes respectively. If no unit is specified then Bytes is assumed. Note that there should not be any space between value and unit and units are case sensitive.
-
enable_v1_api
Type: | boolean |
Default: | true |
Deploy the v1 OpenStack Images API.
-
enable_v2_api
Type: | boolean |
Default: | true |
Deploy the v2 OpenStack Images API.
-
enable_v1_registry
Type: | boolean |
Default: | true |
Deploy the v1 OpenStack Registry API.
-
enable_v2_registry
Type: | boolean |
Default: | true |
Deploy the v2 OpenStack Registry API.
-
pydev_worker_debug_host
Type: | string |
Default: | <None> |
The hostname/IP of the pydev process listening for debug connections
-
pydev_worker_debug_port
Type: | unknown type |
Default: | 5678 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
The port on which a pydev process is listening for connections.
-
metadata_encryption_key
Type: | string |
Default: | <None> |
AES key for encrypting store ‘location’ metadata. This includes, if used, Swift credentials. Should be set to a random string of length 16, 24 or 32 bytes
-
digest_algorithm
Type: | string |
Default: | sha256 |
Digest algorithm which will be used for digital signature. Use the command “openssl list-message-digest-algorithms” to get the available algorithms supported by the version of OpenSSL on the platform. Examples are “sha1”, “sha256”, “sha512”, etc.
-
bind_host
Type: | string |
Default: | 0.0.0.0 |
Address to bind the server. Useful when selecting a particular network interface.
-
bind_port
Type: | unknown type |
Default: | <None> |
Minimum Value: | 0 |
Maximum Value: | 65535 |
The port on which the server will listen.
-
backlog
Type: | integer |
Default: | 4096 |
The backlog value that will be used when creating the TCP listener socket.
-
tcp_keepidle
-
The value for the socket option TCP_KEEPIDLE. This is the time in seconds that the connection must be idle before TCP starts sending keepalive probes.
-
ca_file
Type: | string |
Default: | <None> |
CA certificate file to use to verify connecting clients.
-
cert_file
Type: | string |
Default: | <None> |
Certificate file to use when starting API server securely.
-
key_file
Type: | string |
Default: | <None> |
Private key file to use when starting API server securely.
Type: | string |
Default: | <None> |
The HTTP header used to determine the scheme for the original request, even if it was removed by an SSL terminating proxy. Typical value is “HTTP_X_FORWARDED_PROTO”.
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Use the http_proxy_to_wsgi middleware instead. |
-
workers
Type: | integer |
Default: | <None> |
The number of child process workers that will be created to service requests. The default will be equal to the number of CPUs available.
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 by the Keystone v3 API with big service catalogs
-
http_keepalive
Type: | boolean |
Default: | true |
If False, server will return the header “Connection: close”, If True, server will return “Connection: Keep-Alive” in its responses. In order to close the client socket connection explicitly after the response is sent and read successfully by the client, you simply have to set this option to False when you create a wsgi server.
-
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.
-
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.
-
rpc_zmq_matchmaker
Type: | string |
Default: | redis |
Valid Values: | redis, dummy |
MatchMaker driver.
-
rpc_zmq_contexts
-
Number of ZeroMQ contexts, defaults to 1.
-
rpc_zmq_topic_backlog
Type: | integer |
Default: | <None> |
Maximum number of ingress messages to locally buffer per topic. Default is unlimited.
-
rpc_zmq_ipc_dir
Type: | string |
Default: | /var/run/openstack |
Directory for holding IPC sockets.
-
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.
-
rpc_cast_timeout
-
Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq.
-
rpc_poll_timeout
-
The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired.
-
zmq_target_expire
-
Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout).
-
zmq_target_update
-
Update period in seconds of a name service record about existing target.
-
use_pub_sub
Type: | boolean |
Default: | true |
Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy.
-
use_router_proxy
Type: | boolean |
Default: | true |
Use ROUTER remote proxy.
-
rpc_zmq_min_port
Type: | unknown type |
Default: | 49153 |
Minimum Value: | 0 |
Maximum Value: | 65535 |
Minimal port number for random ports range.
-
rpc_zmq_max_port
Type: | integer |
Default: | 65536 |
Minimum Value: | 1 |
Maximum Value: | 65536 |
Maximal port number for random ports range.
-
rpc_zmq_bind_port_retries
-
Number of retries to find free port number before fail with ZMQBindError.
-
rpc_zmq_serialization
Type: | string |
Default: | json |
Valid Values: | json, msgpack |
Default serialization mechanism for serializing/deserializing outgoing/incoming messages
-
executor_thread_pool_size
-
Size of executor thread pool.
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> |
A URL representing the messaging driver to use and its full configuration.
-
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.
-
verbose
Type: | boolean |
Default: | true |
If set to false, the logging level will be set to WARNING instead of the default INFO level.
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
-
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 |
-
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.
-
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_stderr
Type: | boolean |
Default: | true |
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,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.
-
fatal_deprecations
Type: | boolean |
Default: | false |
Enables or disables fatal status of deprecations.
database
-
sqlite_db
Type: | string |
Default: | oslo.sqlite |
The file name to use with SQLite.
Deprecated Variations
Group |
Name |
DEFAULT |
sqlite_db |
Warning
This option is deprecated for removal.
Its value may be silently ignored
in the future.
Reason: | Should use config option connection or slave_connection to connect the database. |
-
sqlite_synchronous
Type: | boolean |
Default: | true |
If True, SQLite uses synchronous mode.
Deprecated Variations
Group |
Name |
DEFAULT |
sqlite_synchronous |
-
backend
Type: | string |
Default: | sqlalchemy |
The back end to use for the database.
Deprecated Variations
Group |
Name |
DEFAULT |
db_backend |
-
connection
Type: | string |
Default: | <None> |
The SQLAlchemy connection string to use to connect to the database.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_connection |
DATABASE |
sql_connection |
sql |
connection |
-
slave_connection
Type: | string |
Default: | <None> |
The SQLAlchemy connection string to use to connect to the slave database.
-
mysql_sql_mode
Type: | string |
Default: | 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=
-
idle_timeout
Type: | integer |
Default: | 3600 |
Timeout before idle SQL connections are reaped.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_idle_timeout |
DATABASE |
sql_idle_timeout |
sql |
idle_timeout |
-
min_pool_size
-
Minimum number of SQL connections to keep open in a pool.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_min_pool_size |
DATABASE |
sql_min_pool_size |
-
max_pool_size
-
Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_max_pool_size |
DATABASE |
sql_max_pool_size |
-
max_retries
-
Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_max_retries |
DATABASE |
sql_max_retries |
-
retry_interval
-
Interval between retries of opening a SQL connection.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_retry_interval |
DATABASE |
reconnect_interval |
-
max_overflow
-
If set, use this value for max_overflow with SQLAlchemy.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_max_overflow |
DATABASE |
sqlalchemy_max_overflow |
-
connection_debug
Type: | integer |
Default: | 0 |
Minimum Value: | 0 |
Maximum Value: | 100 |
Verbosity of SQL debugging information: 0=None, 100=Everything.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_connection_debug |
-
connection_trace
Type: | boolean |
Default: | false |
Add Python stack traces to SQL as comment strings.
Deprecated Variations
Group |
Name |
DEFAULT |
sql_connection_trace |
-
pool_timeout
Type: | integer |
Default: | <None> |
If set, use this value for pool_timeout with SQLAlchemy.
Deprecated Variations
Group |
Name |
DATABASE |
sqlalchemy_pool_timeout |
-
use_db_reconnect
Type: | boolean |
Default: | false |
Enable the experimental use of database reconnect on connection lost.
-
db_retry_interval
-
Seconds between retries of a database transaction.
-
db_inc_retry_interval
Type: | boolean |
Default: | true |
If True, increases the interval between retries of a database operation up to db_max_retry_interval.
-
db_max_retry_interval
-
If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
-
db_max_retries
-
Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
-
use_tpool
Type: | boolean |
Default: | false |
Enable the experimental use of thread pooling for all DB API calls
Deprecated Variations
Group |
Name |
DEFAULT |
dbapi_use_tpool |
keystone_authtoken
-
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.
-
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.
-
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.
-
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.
-
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.
-
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
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: | unknown type |
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: | 5000 |
Time in ms to wait between connection attempts.
-
check_timeout
Type: | integer |
Default: | 60000 |
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
-
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 |
-
container_name
Type: | string |
Default: | <None> |
Name for the AMQP container
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_ca_file
-
CA certificate PEM file to verify server certificate
Deprecated Variations
Group |
Name |
amqp1 |
ssl_ca_file |
-
ssl_cert_file
-
Identifying certificate PEM file to present to clients
Deprecated Variations
Group |
Name |
amqp1 |
ssl_cert_file |
-
ssl_key_file
-
Private key PEM file used to sign cert_file certificate
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 |
-
allow_insecure_clients
Type: | boolean |
Default: | false |
Accept clients using either SSL or plain TCP
Deprecated Variations
Group |
Name |
amqp1 |
allow_insecure_clients |
-
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 |
-
username
-
User name for message broker authentication
Deprecated Variations
Group |
Name |
amqp1 |
username |
-
password
-
Password for message broker authentication
Deprecated Variations
Group |
Name |
amqp1 |
password |
oslo_messaging_notifications
-
driver
Type: | multi-valued |
Default: | |
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 |
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 |
-
kombu_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 |
DEFAULT |
kombu_ssl_version |
-
kombu_ssl_keyfile
-
SSL key file (valid only if SSL enabled).
Deprecated Variations
Group |
Name |
DEFAULT |
kombu_ssl_keyfile |
-
kombu_ssl_certfile
-
SSL cert file (valid only if SSL enabled).
Deprecated Variations
Group |
Name |
DEFAULT |
kombu_ssl_certfile |
-
kombu_ssl_ca_certs
-
SSL certification authority file (valid only if SSL enabled).
Deprecated Variations
Group |
Name |
DEFAULT |
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 notbe 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: | unknown type |
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_use_ssl
Type: | boolean |
Default: | false |
Connect over SSL for RabbitMQ.
Deprecated Variations
Group |
Name |
DEFAULT |
rabbit_use_ssl |
-
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 |
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.
-
fake_rabbit
Type: | boolean |
Default: | false |
Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake
Deprecated Variations
Group |
Name |
DEFAULT |
fake_rabbit |
-
channel_max
Type: | integer |
Default: | <None> |
Maximum number of channels to allow
-
frame_max
Type: | integer |
Default: | <None> |
The maximum byte size for an AMQP frame
-
heartbeat_interval
-
How often to send heartbeats for consumer’s connections
-
ssl
Type: | boolean |
Default: | <None> |
Enable SSL
-
ssl_options
-
Arguments passed to ssl.wrap_socket
-
socket_timeout
Type: | floating point |
Default: | 0.25 |
Set socket timeout in seconds for connection’s socket
-
tcp_user_timeout
Type: | floating point |
Default: | 0.25 |
Set TCP_USER_TIMEOUT in seconds for connection’s socket
-
host_connection_reconnect_delay
Type: | floating point |
Default: | 0.25 |
Set delay for reconnection to some host which has connection error
-
connection_factory
Type: | string |
Default: | single |
Valid Values: | new, single, read_write |
Connection factory implementation
-
pool_max_size
-
Maximum number of connections to keep queued.
-
pool_max_overflow
-
Maximum number of connections to create above pool_max_size.
-
pool_timeout
-
Default number of seconds to wait for a connections to available
-
pool_recycle
-
Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire.
-
pool_stale
-
Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire.
-
notification_persistence
Type: | boolean |
Default: | false |
Persist notification messages.
-
default_notification_exchange
Type: | string |
Default: | ${control_exchange}_notification |
Exchange name for sending notifications
-
notification_listener_prefetch_count
-
Max number of not acknowledged message which RabbitMQ can send to notification listener.
-
default_notification_retry_attempts
-
Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry.
-
notification_retry_delay
Type: | floating point |
Default: | 0.25 |
Reconnecting retry delay in case of connectivity problem during sending notification message
-
rpc_queue_expiration
-
Time to live for rpc queues without consumers in seconds.
-
default_rpc_exchange
Type: | string |
Default: | ${control_exchange}_rpc |
Exchange name for sending RPC messages
-
rpc_reply_exchange
Type: | string |
Default: | ${control_exchange}_rpc_reply |
Exchange name for receiving RPC replies
-
rpc_listener_prefetch_count
-
Max number of not acknowledged message which RabbitMQ can send to rpc listener.
-
rpc_reply_listener_prefetch_count
-
Max number of not acknowledged message which RabbitMQ can send to rpc reply listener.
-
rpc_reply_retry_attempts
-
Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout
-
rpc_reply_retry_delay
Type: | floating point |
Default: | 0.25 |
Reconnecting retry delay in case of connectivity problem during sending reply.
-
default_rpc_retry_attempts
-
Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more then one time
-
rpc_retry_delay
Type: | floating point |
Default: | 0.25 |
Reconnecting retry delay in case of connectivity problem during sending RPC message
oslo_policy
-
policy_file
Type: | string |
Default: | policy.json |
The JSON 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 |
paste_deploy
-
flavor
Type: | string |
Default: | <None> |
Partial name of a pipeline in your paste configuration file with the service name removed. For example, if your paste section name is [pipeline:glance-api-keystone] use the value “keystone”
-
config_file
Type: | string |
Default: | <None> |
Name of the paste configuration file.
profiler
-
enabled
Type: | boolean |
Default: | false |
Enables the profiling for all services on this node. Default value is False
(fully disable the profiling feature).
Possible values:
* True: Enables the feature
* False: Disables the feature. The profiling cannot be started via this project
operations. If the profiling is triggered by another project, this project part
will be empty.
Deprecated Variations
Group |
Name |
profiler |
profiler_enabled |
-
trace_sqlalchemy
Type: | boolean |
Default: | false |
Enables SQL requests profiling in services. Default value is False (SQL
requests won’t be traced).
Possible values:
* True: Enables SQL requests profiling. Each SQL query will be part of the
trace and can the be analyzed by how much time was spent for that.
* False: Disables SQL requests profiling. The spent time is only shown on a
higher level of operations. Single SQL queries cannot be analyzed this
way.
-
hmac_keys
Type: | string |
Default: | SECRET_KEY |
Secret key(s) to use for encrypting context data for performance profiling.
This string value should have the following format: <key1>[,<key2>,...<keyn>],
where each key is some random string. A user who triggers the profiling via
the REST API has to set one of these keys in the headers of the REST API call
to include profiling results of this node for this particular project.
Both “enabled” flag and “hmac_keys” config options should be set to enable
profiling. Also, to generate correct profiling information across all services
at least one key needs to be consistent between OpenStack projects. This
ensures it can be used from client side to generate the trace, containing
information from all possible resources.