Juno - Juno - Juno - Juno - Juno - Juno - Juno - Juno -
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_bind_host = 0.0.0.0 | (StrOpt) The IP address of the network interface for the admin service to listen on. |
| 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/v2.0/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/v2.0) or the endpoint should be found on a different server. |
| admin_port = 35357 | (IntOpt) The port number which the admin service listens on. |
| 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). |
| admin_workers = None | (IntOpt) The number of worker processes to serve the admin WSGI application. Defaults to number of CPUs (minimum of 2). |
| compute_port = 8774 | (IntOpt) (Deprecated) The port which the OpenStack Compute service listens on. This option was only used for string replacement in the templated catalog backend. Templated catalogs should replace the "$(compute_port)s" substitution with the static port of the compute service. As of Juno, this option is deprecated and will be removed in the L release. |
| 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_request_body_size = 114688 | (IntOpt) Enforced by optional sizelimit middleware (keystone.middleware:RequestBodySizeLimiter). |
| max_token_size = 8192 | (IntOpt) Similar to max_param_size, but provides an exception for token values. |
| member_role_id = 9fe2ff9ee4384b1894a90878d3e92bab | (StrOpt) During a SQL upgrade member_role_id will be used to create a new role that will replace records in the assignment table with explicit role grants. After migration, the member_role_id will be used in the API add_user_to_project. |
| member_role_name = _member_ | (StrOpt) During a SQL upgrade member_role_name will be used to create a new role that will replace records in the assignment table with explicit role grants. After migration, member_role_name will be ignored. |
| public_bind_host = 0.0.0.0 | (StrOpt) The IP address of the network interface for the public service to listen on. |
| 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/v2.0/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/v2.0) or the endpoint should be found on a different server. |
| 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 WSGI application. Defaults to number of CPUs (minimum of 2). |
| 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. |
| 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. Not supported on OS X. |
| [endpoint_filter] | |
| driver = keystone.contrib.endpoint_filter.backends.sql.EndpointFilter | (StrOpt) Endpoint Filter backend driver |
| return_all_endpoints_if_no_filter = True | (BoolOpt) Toggle to return all active endpoints if no filter exists. |
| [endpoint_policy] | |
| driver = keystone.contrib.endpoint_policy.backends.sql.EndpointPolicy | (StrOpt) Endpoint policy backend driver |
| [paste_deploy] | |
| config_file = keystone-paste.ini | (StrOpt) Name of the paste configuration file that defines the available pipelines. |
| Configuration option = Default value | Description |
|---|---|
| [assignment] | |
| cache_time = None | (IntOpt) TTL (in seconds) to cache assignment data. This has no effect unless global caching is enabled. |
| caching = True | (BoolOpt) Toggle for assignment caching. This has no effect unless global caching is enabled. |
| driver = None | (StrOpt) Assignment backend driver. |
| list_limit = None | (IntOpt) Maximum number of entities that will be returned in an assignment collection. |
| Configuration option = Default value | Description |
|---|---|
| [auth] | |
| external = keystone.auth.plugins.external.DefaultDomain | (StrOpt) The external (REMOTE_USER) auth plugin module. |
| methods = external, password, token | (ListOpt) Default auth methods. |
| password = keystone.auth.plugins.password.Password | (StrOpt) The password auth plugin module. |
| token = keystone.auth.plugins.token.Token | (StrOpt) The token auth plugin module. |
| Configuration option = Default value | Description |
|---|---|
| [keystone_authtoken] | |
| admin_password = None | (StrOpt) Keystone account password |
| admin_tenant_name = admin | (StrOpt) Keystone service account tenant name to validate user tokens |
| 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) Keystone account 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_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_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 Keystone 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 Keystone 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 | (BoolOpt) 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 Keystone server requires client certificate |
| 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. |
| 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 |
|---|---|
| [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. |
| token_format = None | (StrOpt) Deprecated in favor of provider in the [token] section. |
| valid_days = 3650 | (IntOpt) Days the token signing cert is valid for (auto generated certificate). |
| [ssl] | |
| ca_certs = /etc/keystone/ssl/certs/ca.pem | (StrOpt) Path of the ca cert file for SSL. |
| ca_key = /etc/keystone/ssl/private/cakey.pem | (StrOpt) Path of the CA key file for SSL. |
| cert_required = False | (BoolOpt) Require client certificate. |
| cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=localhost | (StrOpt) SSL certificate subject (auto generated 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. |
| key_size = 1024 | (IntOpt) SSL key length (in bits) (auto generated certificate). |
| keyfile = /etc/keystone/ssl/private/keystonekey.pem | (StrOpt) Path of the keyfile for SSL. |
| 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 = keystone.catalog.backends.sql.Catalog | (StrOpt) Catalog backend driver. |
| endpoint_substitution_whitelist = tenant_id, user_id, public_bind_host, admin_bind_host, compute_host, compute_port, admin_port, public_port, public_endpoint, admin_endpoint | (ListOpt) (Deprecated) List of possible substitutions for use in formatting endpoints. Use caution when modifying this list. It will give users with permission to create endpoints the ability to see those values in your configuration file. This option will be removed in Juno. |
| 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] | |
| 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. |
| Configuration option = Default value | Description |
|---|---|
| [credential] | |
| driver = keystone.credential.backends.sql.Credential | (StrOpt) Credential backend driver. |
| 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 database connection retries up to db_max_retry_interval. |
| db_max_retries = 20 | (IntOpt) Maximum database connection retries 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 database connection retries. |
| db_retry_interval = 1 | (IntOpt) Seconds between database connection retries. |
| 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 db 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] | |
| backdoor_port = None | (StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file. |
| 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 |
|---|---|
| [ec2] | |
| driver = keystone.contrib.ec2.backends.kvs.Ec2 | (StrOpt) EC2Credential backend driver. |
| [keystone_ec2_token] | |
| cafile = None | (StrOpt) A PEM encoded certificate authority to use when verifying HTTPS connections. Defaults to the system CAs. |
| certfile = None | (StrOpt) Client certificate key filename. Required if EC2 server requires client certificate. |
| insecure = False | (BoolOpt) Disable SSL certificate verification. |
| keyfile = None | (StrOpt) Required if EC2 server requires client certificate. |
| url = http://localhost:5000/v2.0/ec2tokens | (StrOpt) URL to get token from ec2 request. |
| Configuration option = Default value | Description |
|---|---|
| [federation] | |
| assertion_prefix = | (StrOpt) Value to be used when filtering assertion parameters from the environment. |
| driver = keystone.contrib.federation.backends.sql.Federation | (StrOpt) Federation backend driver. |
| Configuration option = Default value | Description |
|---|---|
| [identity] | |
| 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_specific_drivers_enabled = False | (BoolOpt) A subset (or all) of domains can have their own identity driver, each with their own partial configuration file in a domain configuration directory. Only values specific to the domain need to be placed in the domain specific configuration file. This feature is disabled by default; set to true to enable. |
| driver = keystone.identity.backends.sql.Identity | (StrOpt) Identity backend driver. |
| 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 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. This can be either "never", "searching", "always", "finding" or "default". 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. |
| 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 |
| query_scope = one | (StrOpt) The LDAP scope for queries, this can be either "one" (onelevel/singleLevel) or "sub" (subtree/wholeSubtree). |
| 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. |
| 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) Valid options for tls_req_cert are demand, never, and allow. |
| 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, tenants | (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. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| debug = False | (BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING 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, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN | (ListOpt) List of logger=LEVEL pairs. |
| 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. |
| log_date_format = %Y-%m-%d %H:%M:%S | (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . |
| log_dir = None | (StrOpt) (Optional) The base directory used for relative --log-file paths. |
| log_file = None | (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. |
| 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. |
| 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 TRACE %(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. |
| use_stderr = True | (BoolOpt) Log output to standard error. |
| use_syslog = False | (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. |
| use_syslog_rfc_format = False | (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 I, and will be removed in J. |
| verbose = False | (BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). |
| 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 = keystone.identity.mapping_backends.sql.Mapping | (StrOpt) Keystone Identity Mapping backend driver. |
| generator = keystone.identity.id_generators.sha256.Generator | (StrOpt) Public ID generator for user and group entities. 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 = keystone.contrib.oauth1.backends.sql.OAuth1 | (StrOpt) Credential backend driver. |
| 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 can be optionally enabled. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| policy_default_rule = default | (StrOpt) Default rule. Enforced when a requested rule is not found. |
| policy_file = policy.json | (StrOpt) The JSON file that defines policies. |
| [policy] | |
| driver = keystone.policy.backends.sql.Policy | (StrOpt) Policy backend driver. |
| list_limit = None | (IntOpt) Maximum number of entities that will be returned in a policy collection. |
| Configuration option = Default value | Description |
|---|---|
| [revoke] | |
| caching = True | (BoolOpt) Toggle for revocation event caching. This has no effect unless global caching is enabled. |
| driver = keystone.contrib.revoke.backends.kvs.Revoke | (StrOpt) An implementation of the backend for persisting revocation events. |
| 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 |
|---|---|
| [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) Contact type. Allowed values are: technical, support, administrative billing, and other |
| 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. |
| 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 = 40000 | (IntOpt) The value passed as the keyword "rounds" to passlib's encrypt method. |
| Configuration option = Default value | Description |
|---|---|
| [stats] | |
| driver = keystone.contrib.stats.backends.kvs.Stats | (StrOpt) Stats backend driver. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| fake_rabbit = False | (BoolOpt) If passed, use a fake RabbitMQ provider. |
| Configuration option = Default value | Description |
|---|---|
| [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 = keystone.token.persistence.backends.sql.Token | (StrOpt) Token persistence backend driver. |
| 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 = None | (StrOpt) Controls the token construction, validation, and revocation operations. Core providers are "keystone.token.providers.[pkiz|pki|uuid].Provider". The default provider is uuid. |
| revocation_cache_time = 3600 | (IntOpt) Time to cache the revocation list and the revocation events if revoke extension is enabled (in seconds). This has no effect unless global and token caching are enabled. |
| 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 |
|---|---|
| [trust] | |
| driver = keystone.trust.backends.sql.Trust | (StrOpt) Trust backend driver. |
| enabled = True | (BoolOpt) Delegation and impersonation features can be optionally disabled. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| matchmaker_heartbeat_freq = 300 | (IntOpt) Heartbeat frequency. |
| matchmaker_heartbeat_ttl = 600 | (IntOpt) Heartbeat time-to-live. |
| 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_response_timeout = 60 | (IntOpt) Seconds to wait for a response from a call. |
| rpc_thread_pool_size = 64 | (IntOpt) Size of RPC greenthread pool. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| amqp_auto_delete = False | (BoolOpt) Auto-delete queues in amqp. |
| amqp_durable_queues = False | (BoolOpt) Use durable queues in amqp. |
| 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) Driver or drivers to handle sending notifications. |
| 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 |
|---|---|
| [DEFAULT] | |
| 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. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| kombu_reconnect_delay = 1.0 | (FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| 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, SSLv23 and SSLv3. SSLv2 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. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| 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_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 = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost | (StrOpt) MatchMaker driver. |
| rpc_zmq_port = 9501 | (IntOpt) ZeroMQ receiver listening port. |
| rpc_zmq_topic_backlog = None | (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. |
| Configuration option = Default value | Description |
|---|---|
| [matchmaker_redis] | |
| host = 127.0.0.1 | (StrOpt) Host to locate redis. |
| password = None | (StrOpt) Password for Redis server (optional). |
| port = 6379 | (IntOpt) Use this port to connect to redis host. |
| [matchmaker_ring] | |
| ringfile = /etc/oslo/matchmaker_ring.json | (StrOpt) Matchmaker ring file (JSON). |
