Liberty - Liberty - Liberty - Liberty - Liberty - Liberty - Liberty - Liberty -
The Identity service is configured in the
/etc/keystone/keystone.conf file.
The following tables provide a comprehensive list of the Identity service options.
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
admin_endpoint = None |
(StrOpt) The base admin endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:35357/v3/users will default to http://server:35357. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. |
admin_token = ADMIN |
(StrOpt) A "shared secret" that can be used to bootstrap Keystone. This "token" does not represent a user, and carries no explicit authorization. To disable in production (highly recommended), remove AdminTokenAuthMiddleware from your paste application pipelines (for example, in keystone-paste.ini). |
domain_id_immutable = True |
(BoolOpt) Set this to false if you want to enable the ability for user, group and project entities to be moved between domains by updating their domain_id. Allowing such movement is not recommended if the scope of a domain admin is being restricted by use of an appropriate policy file (see policy.v3cloudsample as an example). |
list_limit = None |
(IntOpt) The maximum number of entities that will be returned in a collection, with no limit set by default. This global limit may be then overridden for a specific driver, by specifying a list_limit in the appropriate section (e.g. [assignment]). |
max_param_size = 64 |
(IntOpt) Limit the sizes of user & project ID/names. |
max_project_tree_depth = 5 |
(IntOpt) Maximum depth of the project hierarchy. WARNING: setting it to a large value may adversely impact performance. |
max_token_size = 8192 |
(IntOpt) Similar to max_param_size, but provides an exception for token values. |
member_role_id = 9fe2ff9ee4384b1894a90878d3e92bab |
(StrOpt) Similar to the member_role_name option, this represents the default role ID used to associate users with their default projects in the v2 API. This will be used as the explicit role where one is not specified by the v2 API. |
member_role_name = _member_ |
(StrOpt) This is the role name used in combination with the member_role_id option; see that option for more detail. |
public_endpoint = None |
(StrOpt) The base public endpoint URL for Keystone that is advertised to clients (NOTE: this does NOT affect how Keystone listens for connections). Defaults to the base host URL of the request. E.g. a request to http://server:5000/v3/users will default to http://server:5000. You should only need to set this value if the base URL contains a path (e.g. /prefix/v3) or the endpoint should be found on a different server. |
secure_proxy_ssl_header = None |
(StrOpt) 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". |
strict_password_check = False |
(BoolOpt) If set to true, strict password length checking is performed for password manipulation. If a password exceeds the maximum length, the operation will fail with an HTTP 403 Forbidden error. If set to false, passwords are automatically truncated to the maximum length. |
| [endpoint_filter] | |
driver = sql |
(StrOpt) Entrypoint for the endpoint filter backend driver in the keystone.endpoint_filter namespace. |
return_all_endpoints_if_no_filter = True |
(BoolOpt) Toggle to return all active endpoints if no filter exists. |
| [endpoint_policy] | |
driver = sql |
(StrOpt) Entrypoint for the endpoint policy backend driver in the keystone.endpoint_policy namespace. |
enabled = True |
(BoolOpt) Enable endpoint_policy functionality. |
| [eventlet_server] | |
admin_bind_host = 0.0.0.0 |
(StrOpt) The IP address of the network interface for the admin service to listen on. |
admin_port = 35357 |
(IntOpt) The port number which the admin service listens on. |
admin_workers = None |
(IntOpt) The number of worker processes to serve the admin eventlet application. Defaults to number of CPUs (minimum of 2). |
client_socket_timeout = 900 |
(IntOpt) Timeout for socket operations on a client connection. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever. |
public_bind_host = 0.0.0.0 |
(StrOpt) The IP address of the network interface for the public service to listen on. |
public_port = 5000 |
(IntOpt) The port number which the public service listens on. |
public_workers = None |
(IntOpt) The number of worker processes to serve the public eventlet application. Defaults to number of CPUs (minimum of 2). |
tcp_keepalive = False |
(BoolOpt) Set this to true if you want to enable TCP_KEEPALIVE on server sockets, i.e. sockets used by the Keystone wsgi server for client connections. |
tcp_keepidle = 600 |
(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Only applies if tcp_keepalive is true. |
wsgi_keep_alive = True |
(BoolOpt) If set to false, disables keepalives on the server; all connections will be closed after serving one request. |
| [oslo_middleware] | |
max_request_body_size = 114688 |
(IntOpt) The maximum body size for each request, in bytes. |
secure_proxy_ssl_header = X-Forwarded-Proto |
(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy. |
| [paste_deploy] | |
config_file = keystone-paste.ini |
(StrOpt) Name of the paste configuration file that defines the available pipelines. |
| [resource] | |
cache_time = None |
(IntOpt) TTL (in seconds) to cache resource data. This has no effect unless global caching is enabled. |
caching = True |
(BoolOpt) Toggle for resource caching. This has no effect unless global caching is enabled. |
driver = None |
(StrOpt) Entrypoint for the resource backend driver in the keystone.resource namespace. Supplied drivers are ldap and sql. If a resource driver is not specified, the assignment driver will choose the resource driver. |
list_limit = None |
(IntOpt) Maximum number of entities that will be returned in a resource collection. |
| Configuration option = Default value | Description |
|---|---|
| [assignment] | |
driver = None |
(StrOpt) Entrypoint for the assignment backend driver in the keystone.assignment namespace. Supplied drivers are ldap and sql. If an assignment driver is not specified, the identity driver will choose the assignment driver. |
| Configuration option = Default value | Description |
|---|---|
| [auth] | |
external = None |
(StrOpt) Entrypoint for the external (REMOTE_USER) auth plugin module in the keystone.auth.external namespace. Supplied drivers are DefaultDomain and Domain. The default driver is DefaultDomain. |
methods = external, password, token, oauth1 |
(ListOpt) Allowed authentication methods. |
oauth1 = None |
(StrOpt) Entrypoint for the oAuth1.0 auth plugin module in the keystone.auth.oauth1 namespace. |
password = None |
(StrOpt) Entrypoint for the password auth plugin module in the keystone.auth.password namespace. |
token = None |
(StrOpt) Entrypoint for the token auth plugin module in the keystone.auth.token namespace. |
| Configuration option = Default value | Description |
|---|---|
| [keystone_authtoken] | |
admin_password = None |
(StrOpt) Service user password. |
admin_tenant_name = admin |
(StrOpt) Service tenant name. |
admin_token = None |
(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. |
admin_user = None |
(StrOpt) Service username. |
auth_admin_prefix = |
(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. |
auth_host = 127.0.0.1 |
(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. |
auth_plugin = None |
(StrOpt) Name of the plugin to load |
auth_port = 35357 |
(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. |
auth_protocol = https |
(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. |
auth_section = None |
(StrOpt) Config Section from which to load plugin specific options |
auth_uri = None |
(StrOpt) Complete public Identity API endpoint. |
auth_version = None |
(StrOpt) API version of the admin Identity API endpoint. |
cache = None |
(StrOpt) Env key for the swift cache. |
cafile = None |
(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
certfile = None |
(StrOpt) Required if identity server requires client certificate |
check_revocations_for_cached = False |
(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. |
delay_auth_decision = False |
(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
enforce_token_bind = permissive |
(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
hash_algorithms = md5 |
(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. |
http_connect_timeout = None |
(IntOpt) Request timeout value for communicating with Identity API server. |
http_request_max_retries = 3 |
(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. |
identity_uri = None |
(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ |
include_service_catalog = True |
(BoolOpt) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
insecure = False |
(BoolOpt) Verify HTTPS connections. |
keyfile = None |
(StrOpt) Required if identity server requires client certificate |
memcache_pool_conn_get_timeout = 10 |
(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
memcache_pool_dead_retry = 300 |
(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again. |
memcache_pool_maxsize = 10 |
(IntOpt) (Optional) Maximum total number of open connections to every memcached server. |
memcache_pool_socket_timeout = 3 |
(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server. |
memcache_pool_unused_timeout = 60 |
(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
memcache_secret_key = None |
(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
memcache_security_strategy = None |
(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
memcache_use_advanced_pool = False |
(BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
region_name = None |
(StrOpt) The region in which the identity server can be found. |
revocation_cache_time = 10 |
(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. |
signing_dir = None |
(StrOpt) Directory used to cache files related to PKI tokens. |
token_cache_time = 300 |
(IntOpt) 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. |
| Configuration option = Default value | Description |
|---|---|
| [eventlet_server_ssl] | |
ca_certs = /etc/keystone/ssl/certs/ca.pem |
(StrOpt) Path of the CA cert file for SSL. |
cert_required = False |
(BoolOpt) Require client certificate. |
certfile = /etc/keystone/ssl/certs/keystone.pem |
(StrOpt) Path of the certfile for SSL. For non-production environments, you may be interested in using `keystone-manage ssl_setup` to generate self-signed certificates. |
enable = False |
(BoolOpt) Toggle for SSL support on the Keystone eventlet servers. |
keyfile = /etc/keystone/ssl/private/keystonekey.pem |
(StrOpt) Path of the keyfile for SSL. |
| [signing] | |
ca_certs = /etc/keystone/ssl/certs/ca.pem |
(StrOpt) Path of the CA for token signing. |
ca_key = /etc/keystone/ssl/private/cakey.pem |
(StrOpt) Path of the CA key for token signing. |
cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=www.example.com |
(StrOpt) Certificate subject (auto generated certificate) for token signing. |
certfile = /etc/keystone/ssl/certs/signing_cert.pem |
(StrOpt) Path of the certfile for token signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. |
key_size = 2048 |
(IntOpt) Key size (in bits) for token signing cert (auto generated certificate). |
keyfile = /etc/keystone/ssl/private/signing_key.pem |
(StrOpt) Path of the keyfile for token signing. |
valid_days = 3650 |
(IntOpt) Days the token signing cert is valid for (auto generated certificate). |
| [ssl] | |
ca_key = /etc/keystone/ssl/private/cakey.pem |
(StrOpt) Path of the CA key file for SSL. |
cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=localhost |
(StrOpt) SSL certificate subject (auto generated certificate). |
key_size = 1024 |
(IntOpt) SSL key length (in bits) (auto generated certificate). |
valid_days = 3650 |
(IntOpt) Days the certificate is valid for once signed (auto generated certificate). |
| Configuration option = Default value | Description |
|---|---|
| [catalog] | |
cache_time = None |
(IntOpt) Time to cache catalog data (in seconds). This has no effect unless global and catalog caching are enabled. |
caching = True |
(BoolOpt) Toggle for catalog caching. This has no effect unless global caching is enabled. |
driver = sql |
(StrOpt) Entrypoint for the catalog backend driver in the keystone.catalog namespace. Supplied drivers are kvs, sql, templated, and endpoint_filter.sql |
list_limit = None |
(IntOpt) Maximum number of entities that will be returned in a catalog collection. |
template_file = default_catalog.templates |
(StrOpt) Catalog template file name for use with the template catalog backend. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
executor_thread_pool_size = 64 |
(IntOpt) Size of executor thread pool. |
memcached_servers = None |
(ListOpt) Memcached servers or None for in process cache. |
| [keystone_authtoken] | |
memcached_servers = None |
(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| [oslo_concurrency] | |
disable_process_locking = False |
(BoolOpt) Enables or disables inter-process locks. |
lock_path = None |
(StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. |
| Configuration option = Default value | Description |
|---|---|
| [cors] | |
allow_credentials = True |
(BoolOpt) Indicate that the actual request can include user credentials |
allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma |
(ListOpt) Indicate which header field names may be used during the actual request. |
allow_methods = GET, POST, PUT, DELETE, OPTIONS |
(ListOpt) Indicate which methods can be used during the actual request. |
allowed_origin = None |
(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. |
expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma |
(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
max_age = 3600 |
(IntOpt) Maximum cache age of CORS preflight requests. |
| [cors.subdomain] | |
allow_credentials = True |
(BoolOpt) Indicate that the actual request can include user credentials |
allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma |
(ListOpt) Indicate which header field names may be used during the actual request. |
allow_methods = GET, POST, PUT, DELETE, OPTIONS |
(ListOpt) Indicate which methods can be used during the actual request. |
allowed_origin = None |
(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header. |
expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma |
(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
max_age = 3600 |
(IntOpt) Maximum cache age of CORS preflight requests. |
| Configuration option = Default value | Description |
|---|---|
| [credential] | |
driver = sql |
(StrOpt) Entrypoint for the credential backend driver in the keystone.credential namespace. |
| Configuration option = Default value | Description |
|---|---|
| [database] | |
backend = sqlalchemy |
(StrOpt) The back end to use for the database. |
connection = None |
(StrOpt) The SQLAlchemy connection string to use to connect to the database. |
connection_debug = 0 |
(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything. |
connection_trace = False |
(BoolOpt) Add Python stack traces to SQL as comment strings. |
db_inc_retry_interval = True |
(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
db_max_retries = 20 |
(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
db_max_retry_interval = 10 |
(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
db_retry_interval = 1 |
(IntOpt) Seconds between retries of a database transaction. |
idle_timeout = 3600 |
(IntOpt) Timeout before idle SQL connections are reaped. |
max_overflow = None |
(IntOpt) If set, use this value for max_overflow with SQLAlchemy. |
max_pool_size = None |
(IntOpt) Maximum number of SQL connections to keep open in a pool. |
max_retries = 10 |
(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
min_pool_size = 1 |
(IntOpt) Minimum number of SQL connections to keep open in a pool. |
mysql_sql_mode = TRADITIONAL |
(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode= |
pool_timeout = None |
(IntOpt) If set, use this value for pool_timeout with SQLAlchemy. |
retry_interval = 10 |
(IntOpt) Interval between retries of opening a SQL connection. |
slave_connection = None |
(StrOpt) The SQLAlchemy connection string to use to connect to the slave database. |
sqlite_db = oslo.sqlite |
(StrOpt) The file name to use with SQLite. |
sqlite_synchronous = True |
(BoolOpt) If True, SQLite uses synchronous mode. |
use_db_reconnect = False |
(BoolOpt) Enable the experimental use of database reconnect on connection lost. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
pydev_debug_host = None |
(StrOpt) Host to connect to for remote debugger. |
pydev_debug_port = None |
(IntOpt) Port to connect to for remote debugger. |
standard_threads = False |
(BoolOpt) Do not monkey-patch threading system modules. |
| [audit] | |
namespace = openstack |
(StrOpt) namespace prefix for generated id |
| Configuration option = Default value | Description |
|---|---|
| [domain_config] | |
cache_time = 300 |
(IntOpt) TTL (in seconds) to cache domain config data. This has no effect unless domain config caching is enabled. |
caching = True |
(BoolOpt) Toggle for domain config caching. This has no effect unless global caching is enabled. |
driver = sql |
(StrOpt) Entrypoint for the domain config backend driver in the keystone.resource.domain_config namespace. |
| Configuration option = Default value | Description |
|---|---|
| [federation] | |
assertion_prefix = |
(StrOpt) Value to be used when filtering assertion parameters from the environment. |
driver = sql |
(StrOpt) Entrypoint for the federation backend driver in the keystone.federation namespace. |
federated_domain_name = Federated |
(StrOpt) A domain name that is reserved to allow federated ephemeral users to have a domain concept. Note that an admin will not be able to create a domain with this name or update an existing domain to this name. You are not advised to change this value unless you really have to. |
remote_id_attribute = None |
(StrOpt) Value to be used to obtain the entity ID of the Identity Provider from the environment (e.g. if using the mod_shib plugin this value is `Shib-Identity-Provider`). |
sso_callback_template = /etc/keystone/sso_callback_template.html |
(StrOpt) Location of Single Sign-On callback handler, will return a token to a trusted dashboard host. |
trusted_dashboard = [] |
(MultiStrOpt) A list of trusted dashboard hosts. Before accepting a Single Sign-On request to return a token, the origin host must be a member of the trusted_dashboard list. This configuration option may be repeated for multiple values. For example: trusted_dashboard=http://acme.com/auth/websso trusted_dashboard=http://beta.com/auth/websso |
| Configuration option = Default value | Description |
|---|---|
| [fernet_tokens] | |
key_repository = /etc/keystone/fernet-keys/ |
(StrOpt) Directory containing Fernet token keys. |
max_active_keys = 3 |
(IntOpt) This controls how many keys are held in rotation by keystone-manage fernet_rotate before they are discarded. The default value of 3 means that keystone will maintain one staged key, one primary key, and one secondary key. Increasing this value means that additional secondary keys will be kept in the rotation. |
| Configuration option = Default value | Description |
|---|---|
| [identity] | |
cache_time = 600 |
(IntOpt) Time to cache identity data (in seconds). This has no effect unless global and identity caching are enabled. |
caching = True |
(BoolOpt) Toggle for identity caching. This has no effect unless global caching is enabled. |
default_domain_id = default |
(StrOpt) This references the domain to use for all Identity API v2 requests (which are not aware of domains). A domain with this ID will be created for you by keystone-manage db_sync in migration 008. The domain referenced by this ID cannot be deleted on the v3 API, to prevent accidentally breaking the v2 API. There is nothing special about this domain, other than the fact that it must exist to order to maintain support for your v2 clients. |
domain_config_dir = /etc/keystone/domains |
(StrOpt) Path for Keystone to locate the domain specific identity configuration files if domain_specific_drivers_enabled is set to true. |
domain_configurations_from_database = False |
(BoolOpt) Extract the domain specific configuration options from the resource backend where they have been stored with the domain data. This feature is disabled by default (in which case the domain specific options will be loaded from files in the domain configuration directory); set to true to enable. |
domain_specific_drivers_enabled = False |
(BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration options, stored in either the resource backend or in a file in a domain configuration directory (depending on the setting of domain_configurations_from_database). Only values specific to the domain need to be specified in this manner. This feature is disabled by default; set to true to enable. |
driver = sql |
(StrOpt) Entrypoint for the identity backend driver in the keystone.identity namespace. Supplied drivers are ldap and sql. |
list_limit = None |
(IntOpt) Maximum number of entities that will be returned in an identity collection. |
max_password_length = 4096 |
(IntOpt) Maximum supported length for user passwords; decrease to improve performance. |
| Configuration option = Default value | Description |
|---|---|
| [kvs] | |
backends = |
(ListOpt) Extra dogpile.cache backend modules to register with the dogpile.cache library. |
config_prefix = keystone.kvs |
(StrOpt) Prefix for building the configuration dictionary for the KVS region. This should not need to be changed unless there is another dogpile.cache region with the same configuration name. |
default_lock_timeout = 5 |
(IntOpt) Default lock timeout (in seconds) for distributed locking. |
enable_key_mangler = True |
(BoolOpt) Toggle to disable using a key-mangling function to ensure fixed length keys. This is toggle-able for debugging purposes, it is highly recommended to always leave this set to true. |
| Configuration option = Default value | Description |
|---|---|
| [ldap] | |
alias_dereferencing = default |
(StrOpt) The LDAP dereferencing option for queries. The "default" option falls back to using default dereferencing configured by your ldap.conf. |
allow_subtree_delete = False |
(BoolOpt) Delete subtrees using the subtree delete control. Only enable this option if your LDAP server supports subtree deletion. |
auth_pool_connection_lifetime = 60 |
(IntOpt) End user auth connection lifetime in seconds. |
auth_pool_size = 100 |
(IntOpt) End user auth connection pool size. |
chase_referrals = None |
(BoolOpt) Override the system's default referral chasing behavior for queries. |
debug_level = None |
(IntOpt) Sets the LDAP debugging level for LDAP calls. A value of 0 means that debugging is not enabled. This value is a bitmask, consult your LDAP documentation for possible values. |
dumb_member = cn=dumb,dc=nonexistent |
(StrOpt) DN of the "dummy member" to use when "use_dumb_member" is enabled. |
group_additional_attribute_mapping = |
(ListOpt) Additional attribute mappings for groups. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. |
group_allow_create = True |
(BoolOpt) Allow group creation in LDAP backend. |
group_allow_delete = True |
(BoolOpt) Allow group deletion in LDAP backend. |
group_allow_update = True |
(BoolOpt) Allow group update in LDAP backend. |
group_attribute_ignore = |
(ListOpt) List of attributes stripped off the group on update. |
group_desc_attribute = description |
(StrOpt) LDAP attribute mapped to group description. |
group_filter = None |
(StrOpt) LDAP search filter for groups. |
group_id_attribute = cn |
(StrOpt) LDAP attribute mapped to group id. |
group_member_attribute = member |
(StrOpt) LDAP attribute mapped to show group membership. |
group_name_attribute = ou |
(StrOpt) LDAP attribute mapped to group name. |
group_objectclass = groupOfNames |
(StrOpt) LDAP objectclass for groups. |
group_tree_dn = None |
(StrOpt) Search base for groups. Defaults to the suffix value. |
page_size = 0 |
(IntOpt) Maximum results per page; a value of zero ("0") disables paging. |
password = None |
(StrOpt) Password for the BindDN to query the LDAP server. |
pool_connection_lifetime = 600 |
(IntOpt) Connection lifetime in seconds. |
pool_connection_timeout = -1 |
(IntOpt) Connector timeout in seconds. Value -1 indicates indefinite wait for response. |
pool_retry_delay = 0.1 |
(FloatOpt) Time span in seconds to wait between two reconnect trials. |
pool_retry_max = 3 |
(IntOpt) Maximum count of reconnect trials. |
pool_size = 10 |
(IntOpt) Connection pool size. |
project_additional_attribute_mapping = |
(ListOpt) Additional attribute mappings for projects. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. |
project_allow_create = True |
(BoolOpt) Allow project creation in LDAP backend. |
project_allow_delete = True |
(BoolOpt) Allow project deletion in LDAP backend. |
project_allow_update = True |
(BoolOpt) Allow project update in LDAP backend. |
project_attribute_ignore = |
(ListOpt) List of attributes stripped off the project on update. |
project_desc_attribute = description |
(StrOpt) LDAP attribute mapped to project description. |
project_domain_id_attribute = businessCategory |
(StrOpt) LDAP attribute mapped to project domain_id. |
project_enabled_attribute = enabled |
(StrOpt) LDAP attribute mapped to project enabled. |
project_enabled_emulation = False |
(BoolOpt) If true, Keystone uses an alternative method to determine if a project is enabled or not by checking if they are a member of the "project_enabled_emulation_dn" group. |
project_enabled_emulation_dn = None |
(StrOpt) DN of the group entry to hold enabled projects when using enabled emulation. |
project_filter = None |
(StrOpt) LDAP search filter for projects. |
project_id_attribute = cn |
(StrOpt) LDAP attribute mapped to project id. |
project_member_attribute = member |
(StrOpt) LDAP attribute mapped to project membership for user. |
project_name_attribute = ou |
(StrOpt) LDAP attribute mapped to project name. |
project_objectclass = groupOfNames |
(StrOpt) LDAP objectclass for projects. |
project_tree_dn = None |
(StrOpt) Search base for projects. Defaults to the suffix value. |
query_scope = one |
(StrOpt) The LDAP scope for queries, "one" represents oneLevel/singleLevel and "sub" represents subtree/wholeSubtree options. |
role_additional_attribute_mapping = |
(ListOpt) Additional attribute mappings for roles. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. |
role_allow_create = True |
(BoolOpt) Allow role creation in LDAP backend. |
role_allow_delete = True |
(BoolOpt) Allow role deletion in LDAP backend. |
role_allow_update = True |
(BoolOpt) Allow role update in LDAP backend. |
role_attribute_ignore = |
(ListOpt) List of attributes stripped off the role on update. |
role_filter = None |
(StrOpt) LDAP search filter for roles. |
role_id_attribute = cn |
(StrOpt) LDAP attribute mapped to role id. |
role_member_attribute = roleOccupant |
(StrOpt) LDAP attribute mapped to role membership. |
role_name_attribute = ou |
(StrOpt) LDAP attribute mapped to role name. |
role_objectclass = organizationalRole |
(StrOpt) LDAP objectclass for roles. |
role_tree_dn = None |
(StrOpt) Search base for roles. Defaults to the suffix value. |
suffix = cn=example,cn=com |
(StrOpt) LDAP server suffix |
tls_cacertdir = None |
(StrOpt) CA certificate directory path for communicating with LDAP servers. |
tls_cacertfile = None |
(StrOpt) CA certificate file path for communicating with LDAP servers. |
tls_req_cert = demand |
(StrOpt) Specifies what checks to perform on client certificates in an incoming TLS session. |
url = ldap://localhost |
(StrOpt) URL for connecting to the LDAP server. |
use_auth_pool = False |
(BoolOpt) Enable LDAP connection pooling for end user authentication. If use_pool is disabled, then this setting is meaningless and is not used at all. |
use_dumb_member = False |
(BoolOpt) If true, will add a dummy member to groups. This is required if the objectclass for groups requires the "member" attribute. |
use_pool = False |
(BoolOpt) Enable LDAP connection pooling. |
use_tls = False |
(BoolOpt) Enable TLS for communicating with LDAP servers. |
user = None |
(StrOpt) User BindDN to query the LDAP server. |
user_additional_attribute_mapping = |
(ListOpt) List of additional LDAP attributes used for mapping additional attribute mappings for users. Attribute mapping format is <ldap_attr>:<user_attr>, where ldap_attr is the attribute in the LDAP entry and user_attr is the Identity API attribute. |
user_allow_create = True |
(BoolOpt) Allow user creation in LDAP backend. |
user_allow_delete = True |
(BoolOpt) Allow user deletion in LDAP backend. |
user_allow_update = True |
(BoolOpt) Allow user updates in LDAP backend. |
user_attribute_ignore = default_project_id |
(ListOpt) List of attributes stripped off the user on update. |
user_default_project_id_attribute = None |
(StrOpt) LDAP attribute mapped to default_project_id for users. |
user_enabled_attribute = enabled |
(StrOpt) LDAP attribute mapped to user enabled flag. |
user_enabled_default = True |
(StrOpt) Default value to enable users. This should match an appropriate int value if the LDAP server uses non-boolean (bitmask) values to indicate if a user is enabled or disabled. If this is not set to "True" the typical value is "512". This is typically used when "user_enabled_attribute = userAccountControl". |
user_enabled_emulation = False |
(BoolOpt) If true, Keystone uses an alternative method to determine if a user is enabled or not by checking if they are a member of the "user_enabled_emulation_dn" group. |
user_enabled_emulation_dn = None |
(StrOpt) DN of the group entry to hold enabled users when using enabled emulation. |
user_enabled_invert = False |
(BoolOpt) Invert the meaning of the boolean enabled values. Some LDAP servers use a boolean lock attribute where "true" means an account is disabled. Setting "user_enabled_invert = true" will allow these lock attributes to be used. This setting will have no effect if "user_enabled_mask" or "user_enabled_emulation" settings are in use. |
user_enabled_mask = 0 |
(IntOpt) Bitmask integer to indicate the bit that the enabled value is stored in if the LDAP server represents "enabled" as a bit on an integer rather than a boolean. A value of "0" indicates the mask is not used. If this is not set to "0" the typical value is "2". This is typically used when "user_enabled_attribute = userAccountControl". |
user_filter = None |
(StrOpt) LDAP search filter for users. |
user_id_attribute = cn |
(StrOpt) LDAP attribute mapped to user id. WARNING: must not be a multivalued attribute. |
user_mail_attribute = mail |
(StrOpt) LDAP attribute mapped to user email. |
user_name_attribute = sn |
(StrOpt) LDAP attribute mapped to user name. |
user_objectclass = inetOrgPerson |
(StrOpt) LDAP objectclass for users. |
user_pass_attribute = userPassword |
(StrOpt) LDAP attribute mapped to password. |
user_tree_dn = None |
(StrOpt) Search base for users. Defaults to the suffix value. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
debug = False |
(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level). |
default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN |
(ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. |
fatal_deprecations = False |
(BoolOpt) Enables or disables fatal status of deprecations. |
instance_format = "[instance: %(uuid)s] " |
(StrOpt) The format for an instance that is passed with the log message. |
instance_uuid_format = "[instance: %(uuid)s] " |
(StrOpt) The format for an instance UUID that is passed with the log message. |
log_config_append = None |
(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). |
log_date_format = %Y-%m-%d %H:%M:%S |
(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
log_dir = None |
(StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. |
log_file = None |
(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. |
log_format = None |
(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. |
logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s |
(StrOpt) Format string to use for log messages with context. |
logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d |
(StrOpt) Data to append to log format when level is DEBUG. |
logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s |
(StrOpt) Format string to use for log messages without context. |
logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s |
(StrOpt) Prefix each line of exception output with this format. |
publish_errors = False |
(BoolOpt) Enables or disables publication of error events. |
syslog_log_facility = LOG_USER |
(StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
use_stderr = True |
(BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. |
use_syslog = False |
(BoolOpt) 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_syslog_rfc_format = True |
(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. |
verbose = True |
(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. |
watch_log_file = False |
(BoolOpt) (Optional) 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. |
| Configuration option = Default value | Description |
|---|---|
| [identity_mapping] | |
backward_compatible_ids = True |
(BoolOpt) The format of user and group IDs changed in Juno for backends that do not generate UUIDs (e.g. LDAP), with keystone providing a hash mapping to the underlying attribute in LDAP. By default this mapping is disabled, which ensures that existing IDs will not change. Even when the mapping is enabled by using domain specific drivers, any users and groups from the default domain being handled by LDAP will still not be mapped to ensure their IDs remain backward compatible. Setting this value to False will enable the mapping for even the default LDAP driver. It is only safe to do this if you do not already have assignments for users and groups from the default LDAP domain, and it is acceptable for Keystone to provide the different IDs to clients than it did previously. Typically this means that the only time you can set this value to False is when configuring a fresh installation. |
driver = sql |
(StrOpt) Entrypoint for the identity mapping backend driver in the keystone.identity.id_mapping namespace. |
generator = sha256 |
(StrOpt) Entrypoint for the public ID generator for user and group entities in the keystone.identity.id_generator namespace. The Keystone identity mapper only supports generators that produce no more than 64 characters. |
| Configuration option = Default value | Description |
|---|---|
| [memcache] | |
servers = localhost:11211 |
(ListOpt) Memcache servers in the format of "host:port". |
socket_timeout = 3 |
(IntOpt) Timeout in seconds for every call to a server. This is used by the key value store system (e.g. token pooled memcached persistence backend). |
| Configuration option = Default value | Description |
|---|---|
| [oauth1] | |
access_token_duration = 86400 |
(IntOpt) Duration (in seconds) for the OAuth Access Token. |
driver = sql |
(StrOpt) Entrypoint for hte OAuth backend driver in the keystone.oauth1 namespace. |
request_token_duration = 28800 |
(IntOpt) Duration (in seconds) for the OAuth Request Token. |
| Configuration option = Default value | Description |
|---|---|
| [os_inherit] | |
enabled = False |
(BoolOpt) role-assignment inheritance to projects from owning domain or from projects higher in the hierarchy can be optionally enabled. |
| Configuration option = Default value | Description |
|---|---|
| [oslo_policy] | |
policy_default_rule = default |
(StrOpt) Default rule. Enforced when a requested rule is not found. |
policy_dirs = ['policy.d'] |
(MultiStrOpt) 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. |
policy_file = policy.json |
(StrOpt) The JSON file that defines policies. |
| [policy] | |
driver = sql |
(StrOpt) Entrypoint for the policy backend driver in the keystone.policy namespace. Supplied drivers are rules and sql. |
list_limit = None |
(IntOpt) Maximum number of entities that will be returned in a policy collection. |
| Configuration option = Default value | Description |
|---|---|
| [revoke] | |
cache_time = 3600 |
(IntOpt) Time to cache the revocation list and the revocation events (in seconds). This has no effect unless global and token caching are enabled. |
caching = True |
(BoolOpt) Toggle for revocation event caching. This has no effect unless global caching is enabled. |
driver = sql |
(StrOpt) Entrypoint for an implementation of the backend for persisting revocation events in the keystone.revoke namespace. Supplied drivers are kvs and sql. |
expiration_buffer = 1800 |
(IntOpt) This value (calculated in seconds) is added to token expiration before a revocation event may be removed from the backend. |
| Configuration option = Default value | Description |
|---|---|
| [role] | |
cache_time = None |
(IntOpt) TTL (in seconds) to cache role data. This has no effect unless global caching is enabled. |
caching = True |
(BoolOpt) Toggle for role caching. This has no effect unless global caching is enabled. |
driver = None |
(StrOpt) Entrypoint for the role backend driver in the keystone.role namespace. Supplied drivers are ldap and sql. |
list_limit = None |
(IntOpt) Maximum number of entities that will be returned in a role collection. |
| Configuration option = Default value | Description |
|---|---|
| [auth] | |
saml2 = keystone.auth.plugins.mapped.Mapped |
(StrOpt) The saml2 auth plugin module. |
| Configuration option = Default value | Description |
|---|---|
| [saml] | |
assertion_expiration_time = 3600 |
(IntOpt) Default TTL, in seconds, for any generated SAML assertion created by Keystone. |
certfile = /etc/keystone/ssl/certs/signing_cert.pem |
(StrOpt) Path of the certfile for SAML signing. For non-production environments, you may be interested in using `keystone-manage pki_setup` to generate self-signed certificates. Note, the path cannot contain a comma. |
idp_contact_company = None |
(StrOpt) Company of contact person. |
idp_contact_email = None |
(StrOpt) Email address of contact person. |
idp_contact_name = None |
(StrOpt) Given name of contact person |
idp_contact_surname = None |
(StrOpt) Surname of contact person. |
idp_contact_telephone = None |
(StrOpt) Telephone number of contact person. |
idp_contact_type = other |
(StrOpt) The contact type describing the main point of contact for the identity provider. |
idp_entity_id = None |
(StrOpt) Entity ID value for unique Identity Provider identification. Usually FQDN is set with a suffix. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/idp |
idp_lang = en |
(StrOpt) Language used by the organization. |
idp_metadata_path = /etc/keystone/saml2_idp_metadata.xml |
(StrOpt) Path to the Identity Provider Metadata file. This file should be generated with the keystone-manage saml_idp_metadata command. |
idp_organization_display_name = None |
(StrOpt) Organization name to be displayed. |
idp_organization_name = None |
(StrOpt) Organization name the installation belongs to. |
idp_organization_url = None |
(StrOpt) URL of the organization. |
idp_sso_endpoint = None |
(StrOpt) Identity Provider Single-Sign-On service value, required in the Identity Provider's metadata. A value is required to generate IDP Metadata. For example: https://keystone.example.com/v3/OS-FEDERATION/saml2/sso |
keyfile = /etc/keystone/ssl/private/signing_key.pem |
(StrOpt) Path of the keyfile for SAML signing. Note, the path cannot contain a comma. |
relay_state_prefix = ss:mem: |
(StrOpt) The prefix to use for the RelayState SAML attribute, used when generating ECP wrapped assertions. |
xmlsec1_binary = xmlsec1 |
(StrOpt) Binary to be called for XML signing. Install the appropriate package, specify absolute path or adjust your PATH environment variable if the binary cannot be found. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
crypt_strength = 10000 |
(IntOpt) The value passed as the keyword "rounds" to passlib's encrypt method. |
| Configuration option = Default value | Description |
|---|---|
| [token] | |
allow_rescope_scoped_token = True |
(BoolOpt) Allow rescoping of scoped token. Setting allow_rescoped_scoped_token to false prevents a user from exchanging a scoped token for any other token. |
bind = |
(ListOpt) External auth mechanisms that should add bind information to token, e.g., kerberos,x509. |
cache_time = None |
(IntOpt) Time to cache tokens (in seconds). This has no effect unless global and token caching are enabled. |
caching = True |
(BoolOpt) Toggle for token system caching. This has no effect unless global caching is enabled. |
driver = sql |
(StrOpt) Entrypoint for the token persistence backend driver in the keystone.token.persistence namespace. Supplied drivers are kvs, memcache, memcache_pool, and sql. |
enforce_token_bind = permissive |
(StrOpt) Enforcement policy on tokens presented to Keystone with bind information. One of disabled, permissive, strict, required or a specifically required bind mode, e.g., kerberos or x509 to require binding to that authentication. |
expiration = 3600 |
(IntOpt) Amount of time a token should remain valid (in seconds). |
hash_algorithm = md5 |
(StrOpt) The hash algorithm to use for PKI tokens. This can be set to any algorithm that hashlib supports. WARNING: Before changing this value, the auth_token middleware must be configured with the hash_algorithms, otherwise token revocation will not be processed correctly. |
provider = uuid |
(StrOpt) Controls the token construction, validation, and revocation operations. Entrypoint in the keystone.token.provider namespace. Core providers are [fernet|pkiz|pki|uuid]. |
revoke_by_id = True |
(BoolOpt) Revoke token by token identifier. Setting revoke_by_id to true enables various forms of enumerating tokens, e.g. `list tokens for user`. These enumerations are processed to determine the list of tokens to revoke. Only disable if you are switching to using the Revoke extension with a backend other than KVS, which stores events in memory. |
| Configuration option = Default value | Description |
|---|---|
| [tokenless_auth] | |
issuer_attribute = SSL_CLIENT_I_DN |
(StrOpt) The issuer attribute that is served as an IdP ID for the X.509 tokenless authorization along with the protocol to look up its corresponding mapping. It is the environment variable in the WSGI environment that references to the issuer of the client certificate. |
protocol = x509 |
(StrOpt) The protocol name for the X.509 tokenless authorization along with the option issuer_attribute below can look up its corresponding mapping. |
trusted_issuer = [] |
(MultiStrOpt) The list of trusted issuers to further filter the certificates that are allowed to participate in the X.509 tokenless authorization. If the option is absent then no certificates will be allowed. The naming format for the attributes of a Distinguished Name(DN) must be separated by a comma and contain no spaces. This configuration option may be repeated for multiple values. For example: trusted_issuer=CN=john,OU=keystone,O=openstack trusted_issuer=CN=mary,OU=eng,O=abc |
| Configuration option = Default value | Description |
|---|---|
| [trust] | |
allow_redelegation = False |
(BoolOpt) Enable redelegation feature. |
driver = sql |
(StrOpt) Entrypoint for the trust backend driver in the keystone.trust namespace. |
enabled = True |
(BoolOpt) Delegation and impersonation features can be optionally disabled. |
max_redelegation_count = 3 |
(IntOpt) Maximum depth of trust redelegation. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
rpc_backend = rabbit |
(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. |
rpc_cast_timeout = 30 |
(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. |
rpc_conn_pool_size = 30 |
(IntOpt) Size of RPC connection pool. |
rpc_poll_timeout = 1 |
(IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. |
rpc_response_timeout = 60 |
(IntOpt) Seconds to wait for a response from a call. |
| [oslo_messaging_amqp] | |
allow_insecure_clients = False |
(BoolOpt) Accept clients using either SSL or plain TCP |
broadcast_prefix = broadcast |
(StrOpt) address prefix used when broadcasting to all servers |
container_name = None |
(StrOpt) Name for the AMQP container |
group_request_prefix = unicast |
(StrOpt) address prefix when sending to any server in group |
idle_timeout = 0 |
(IntOpt) Timeout for inactive connections (in seconds) |
password = |
(StrOpt) Password for message broker authentication |
sasl_config_dir = |
(StrOpt) Path to directory that contains the SASL configuration |
sasl_config_name = |
(StrOpt) Name of configuration file (without .conf suffix) |
sasl_mechanisms = |
(StrOpt) Space separated list of acceptable SASL mechanisms |
server_request_prefix = exclusive |
(StrOpt) address prefix used when sending to a specific server |
ssl_ca_file = |
(StrOpt) CA certificate PEM file to verify server certificate |
ssl_cert_file = |
(StrOpt) Identifying certificate PEM file to present to clients |
ssl_key_file = |
(StrOpt) Private key PEM file used to sign cert_file certificate |
ssl_key_password = None |
(StrOpt) Password for decrypting ssl_key_file (if encrypted) |
trace = False |
(BoolOpt) Debug: dump AMQP frames to stdout |
username = |
(StrOpt) User name for message broker authentication |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
control_exchange = keystone |
(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
default_publisher_id = None |
(StrOpt) Default publisher_id for outgoing notifications |
notification_driver = [] |
(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
notification_format = basic |
(StrOpt) Define the notification format for Identity Service events. A "basic" notification has information about the resource being operated on. A "cadf" notification has the same information, as well as information about the initiator of the event. |
notification_topics = notifications |
(ListOpt) AMQP topic used for OpenStack notifications. |
transport_url = None |
(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration. |
| Configuration option = Default value | Description |
|---|---|
| [oslo_messaging_qpid] | |
amqp_auto_delete = False |
(BoolOpt) Auto-delete queues in AMQP. |
amqp_durable_queues = False |
(BoolOpt) Use durable queues in AMQP. |
qpid_heartbeat = 60 |
(IntOpt) Seconds between connection keepalive heartbeats. |
qpid_hostname = localhost |
(StrOpt) Qpid broker hostname. |
qpid_hosts = $qpid_hostname:$qpid_port |
(ListOpt) Qpid HA cluster host:port pairs. |
qpid_password = |
(StrOpt) Password for Qpid connection. |
qpid_port = 5672 |
(IntOpt) Qpid broker port. |
qpid_protocol = tcp |
(StrOpt) Transport to use, either 'tcp' or 'ssl'. |
qpid_receiver_capacity = 1 |
(IntOpt) The number of prefetched messages held by receiver. |
qpid_sasl_mechanisms = |
(StrOpt) Space separated list of SASL mechanisms to use for auth. |
qpid_tcp_nodelay = True |
(BoolOpt) Whether to disable the Nagle algorithm. |
qpid_topology_version = 1 |
(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break. |
qpid_username = |
(StrOpt) Username for Qpid connection. |
send_single_reply = False |
(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. |
| Configuration option = Default value | Description |
|---|---|
| [oslo_messaging_rabbit] | |
amqp_auto_delete = False |
(BoolOpt) Auto-delete queues in AMQP. |
amqp_durable_queues = False |
(BoolOpt) Use durable queues in AMQP. |
fake_rabbit = False |
(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake |
heartbeat_rate = 2 |
(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. |
heartbeat_timeout_threshold = 60 |
(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL |
kombu_reconnect_delay = 1.0 |
(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
kombu_reconnect_timeout = 60 |
(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout. |
kombu_ssl_ca_certs = |
(StrOpt) SSL certification authority file (valid only if SSL enabled). |
kombu_ssl_certfile = |
(StrOpt) SSL cert file (valid only if SSL enabled). |
kombu_ssl_keyfile = |
(StrOpt) SSL key file (valid only if SSL enabled). |
kombu_ssl_version = |
(StrOpt) 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. |
rabbit_ha_queues = False |
(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. |
rabbit_host = localhost |
(StrOpt) The RabbitMQ broker address where a single node is used. |
rabbit_hosts = $rabbit_host:$rabbit_port |
(ListOpt) RabbitMQ HA cluster host:port pairs. |
rabbit_login_method = AMQPLAIN |
(StrOpt) The RabbitMQ login method. |
rabbit_max_retries = 0 |
(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). |
rabbit_password = guest |
(StrOpt) The RabbitMQ password. |
rabbit_port = 5672 |
(IntOpt) The RabbitMQ broker port where a single node is used. |
rabbit_retry_backoff = 2 |
(IntOpt) How long to backoff for between retries when connecting to RabbitMQ. |
rabbit_retry_interval = 1 |
(IntOpt) How frequently to retry connecting with RabbitMQ. |
rabbit_use_ssl = False |
(BoolOpt) Connect over SSL for RabbitMQ. |
rabbit_userid = guest |
(StrOpt) The RabbitMQ userid. |
rabbit_virtual_host = / |
(StrOpt) The RabbitMQ virtual host. |
send_single_reply = False |
(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
rpc_zmq_all_req_rep = True |
(BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. |
rpc_zmq_bind_address = * |
(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. |
rpc_zmq_concurrency = eventlet |
(StrOpt) Type of concurrency used. Either "native" or "eventlet" |
rpc_zmq_contexts = 1 |
(IntOpt) Number of ZeroMQ contexts, defaults to 1. |
rpc_zmq_host = localhost |
(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova. |
rpc_zmq_ipc_dir = /var/run/openstack |
(StrOpt) Directory for holding IPC sockets. |
rpc_zmq_matchmaker = redis |
(StrOpt) MatchMaker driver. |
rpc_zmq_topic_backlog = None |
(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. |
zmq_use_broker = True |
(BoolOpt) Shows whether zmq-messaging uses broker or not. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
host = 127.0.0.1 |
(StrOpt) Host to locate redis. |
password = |
(StrOpt) Password for Redis server (optional). |
port = 6379 |
(IntOpt) Use this port to connect to redis host. |
| [matchmaker_redis] | |
host = 127.0.0.1 |
(StrOpt) Host to locate redis. |
password = |
(StrOpt) Password for Redis server (optional). |
port = 6379 |
(IntOpt) Use this port to connect to redis host. |
