Add initial meta-stx to support StarlingX build
[pti/rtp.git] / meta-stx / recipes-devtools / python / files / python-keystone / keystone.conf
1 #
2 ## Copyright (C) 2019 Wind River Systems, Inc.
3 #
4 #  Licensed under the Apache License, Version 2.0 (the "License");
5 #  you may not use this file except in compliance with the License.
6 #  You may obtain a copy of the License at
7 #
8 #      http://www.apache.org/licenses/LICENSE-2.0
9 #
10 #  Unless required by applicable law or agreed to in writing, software
11 #  distributed under the License is distributed on an "AS IS" BASIS,
12 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 #  See the License for the specific language governing permissions and
14 #  limitations under the License.
15
16 [DEFAULT]
17
18 #
19 # From keystone
20 #
21
22 # Using this feature is *NOT* recommended. Instead, use the `keystone-manage
23 # bootstrap` command. The value of this option is treated as a "shared secret"
24 # that can be used to bootstrap Keystone through the API. This "token" does not
25 # represent a user (it has no identity), and carries no explicit authorization
26 # (it effectively bypasses most authorization checks). If set to `None`, the
27 # value is ignored and the `admin_token` middleware is effectively disabled.
28 # (string value)
29 #admin_token = <None>
30
31 # The base public endpoint URL for Keystone that is advertised to clients
32 # (NOTE: this does NOT affect how Keystone listens for connections). Defaults
33 # to the base host URL of the request. For example, if keystone receives a
34 # request to `http://server:5000/v3/users`, then this will option will be
35 # automatically treated as `http://server:5000`. You should only need to set
36 # option if either the value of the base URL contains a path that keystone does
37 # not automatically infer (`/prefix/v3`), or if the endpoint should be found on
38 # a different host. (uri value)
39 #public_endpoint = <None>
40
41 # DEPRECATED: The base admin endpoint URL for Keystone that is advertised to
42 # clients (NOTE: this does NOT affect how Keystone listens for connections).
43 # Defaults to the base host URL of the request. For example, if keystone
44 # receives a request to `http://server:35357/v3/users`, then this will option
45 # will be automatically treated as `http://server:35357`. You should only need
46 # to set option if either the value of the base URL contains a path that
47 # keystone does not automatically infer (`/prefix/v3`), or if the endpoint
48 # should be found on a different host. (uri value)
49 # This option is deprecated for removal since R.
50 # Its value may be silently ignored in the future.
51 # Reason: With the removal of the 2.0 API keystone does not distinguish between
52 # admin and public endpoints.
53 #admin_endpoint = <None>
54
55 # Maximum depth of the project hierarchy, excluding the project acting as a
56 # domain at the top of the hierarchy. WARNING: Setting it to a large value may
57 # adversely impact performance. (integer value)
58 #max_project_tree_depth = 5
59
60 # Limit the sizes of user & project ID/names. (integer value)
61 #max_param_size = 64
62
63 # Similar to `[DEFAULT] max_param_size`, but provides an exception for token
64 # values. With Fernet tokens, this can be set as low as 255. With UUID tokens,
65 # this should be set to 32). (integer value)
66 #max_token_size = 255
67
68 # The maximum number of entities that will be returned in a collection. This
69 # global limit may be then overridden for a specific driver, by specifying a
70 # list_limit in the appropriate section (for example, `[assignment]`). No limit
71 # is set by default. In larger deployments, it is recommended that you set this
72 # to a reasonable number to prevent operations like listing all users and
73 # projects from placing an unnecessary load on the system. (integer value)
74 #list_limit = <None>
75
76 # If set to true, strict password length checking is performed for password
77 # manipulation. If a password exceeds the maximum length, the operation will
78 # fail with an HTTP 403 Forbidden error. If set to false, passwords are
79 # automatically truncated to the maximum length. (boolean value)
80 #strict_password_check = false
81
82 # If set to true, then the server will return information in HTTP responses
83 # that may allow an unauthenticated or authenticated user to get more
84 # information than normal, such as additional details about why authentication
85 # failed. This may be useful for debugging but is insecure. (boolean value)
86 #insecure_debug = false
87
88 # Default `publisher_id` for outgoing notifications. If left undefined,
89 # Keystone will default to using the server's host name. (string value)
90 #default_publisher_id = <None>
91
92 # Define the notification format for identity service events. A `basic`
93 # notification only has information about the resource being operated on. A
94 # `cadf` notification has the same information, as well as information about
95 # the initiator of the event. The `cadf` option is entirely backwards
96 # compatible with the `basic` option, but is fully CADF-compliant, and is
97 # recommended for auditing use cases. (string value)
98 # Possible values:
99 # basic - <No description provided>
100 # cadf - <No description provided>
101 #notification_format = cadf
102
103 # You can reduce the number of notifications keystone emits by explicitly
104 # opting out. Keystone will not emit notifications that match the patterns
105 # expressed in this list. Values are expected to be in the form of
106 # `identity.<resource_type>.<operation>`. By default, all notifications related
107 # to authentication are automatically suppressed. This field can be set
108 # multiple times in order to opt-out of multiple notification topics. For
109 # example, the following suppresses notifications describing user creation or
110 # successful authentication events: notification_opt_out=identity.user.create
111 # notification_opt_out=identity.authenticate.success (multi valued)
112 #notification_opt_out = identity.authenticate.success
113 #notification_opt_out = identity.authenticate.pending
114 #notification_opt_out = identity.authenticate.failed
115
116 #
117 # From oslo.log
118 #
119
120 # If set to true, the logging level will be set to DEBUG instead of the default
121 # INFO level. (boolean value)
122 # Note: This option can be changed without restarting.
123 #debug = false
124
125 # The name of a logging configuration file. This file is appended to any
126 # existing logging configuration files. For details about logging configuration
127 # files, see the Python logging module documentation. Note that when logging
128 # configuration files are used then all logging configuration is set in the
129 # configuration file and other logging configuration options are ignored (for
130 # example, logging_context_format_string). (string value)
131 # Note: This option can be changed without restarting.
132 # Deprecated group/name - [DEFAULT]/log_config
133 #log_config_append = <None>
134
135 # Defines the format string for %%(asctime)s in log records. Default:
136 # %(default)s . This option is ignored if log_config_append is set. (string
137 # value)
138 #log_date_format = %Y-%m-%d %H:%M:%S
139
140 # (Optional) Name of log file to send logging output to. If no default is set,
141 # logging will go to stderr as defined by use_stderr. This option is ignored if
142 # log_config_append is set. (string value)
143 # Deprecated group/name - [DEFAULT]/logfile
144 #log_file = <None>
145
146 # (Optional) The base directory used for relative log_file  paths. This option
147 # is ignored if log_config_append is set. (string value)
148 # Deprecated group/name - [DEFAULT]/logdir
149 #log_dir = <None>
150
151 # Uses logging handler designed to watch file system. When log file is moved or
152 # removed this handler will open a new log file with specified path
153 # instantaneously. It makes sense only if log_file option is specified and
154 # Linux platform is used. This option is ignored if log_config_append is set.
155 # (boolean value)
156 #watch_log_file = false
157
158 # Use syslog for logging. Existing syslog format is DEPRECATED and will be
159 # changed later to honor RFC5424. This option is ignored if log_config_append
160 # is set. (boolean value)
161 #use_syslog = false
162
163 # Enable journald for logging. If running in a systemd environment you may wish
164 # to enable journal support. Doing so will use the journal native protocol
165 # which includes structured metadata in addition to log messages.This option is
166 # ignored if log_config_append is set. (boolean value)
167 #use_journal = false
168
169 # Syslog facility to receive log lines. This option is ignored if
170 # log_config_append is set. (string value)
171 #syslog_log_facility = LOG_USER
172
173 # Use JSON formatting for logging. This option is ignored if log_config_append
174 # is set. (boolean value)
175 #use_json = false
176
177 # Log output to standard error. This option is ignored if log_config_append is
178 # set. (boolean value)
179 #use_stderr = false
180
181 # Format string to use for log messages with context. (string value)
182 #logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s
183
184 # Format string to use for log messages when context is undefined. (string
185 # value)
186 #logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
187
188 # Additional data to append to log message when logging level for the message
189 # is DEBUG. (string value)
190 #logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d
191
192 # Prefix each line of exception output with this format. (string value)
193 #logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s
194
195 # Defines the format string for %(user_identity)s that is used in
196 # logging_context_format_string. (string value)
197 #logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s
198
199 # List of package logging levels in logger=LEVEL pairs. This option is ignored
200 # if log_config_append is set. (list value)
201 #default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,oslo_messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN,taskflow=WARN,keystoneauth=WARN,oslo.cache=INFO,dogpile.core.dogpile=INFO
202
203 # Enables or disables publication of error events. (boolean value)
204 #publish_errors = false
205
206 # The format for an instance that is passed with the log message. (string
207 # value)
208 #instance_format = "[instance: %(uuid)s] "
209
210 # The format for an instance UUID that is passed with the log message. (string
211 # value)
212 #instance_uuid_format = "[instance: %(uuid)s] "
213
214 # Interval, number of seconds, of log rate limiting. (integer value)
215 #rate_limit_interval = 0
216
217 # Maximum number of logged messages per rate_limit_interval. (integer value)
218 #rate_limit_burst = 0
219
220 # Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG
221 # or empty string. Logs with level greater or equal to rate_limit_except_level
222 # are not filtered. An empty string means that all levels are filtered. (string
223 # value)
224 #rate_limit_except_level = CRITICAL
225
226 # Enables or disables fatal status of deprecations. (boolean value)
227 #fatal_deprecations = false
228
229 #
230 # From oslo.messaging
231 #
232
233 # Size of RPC connection pool. (integer value)
234 #rpc_conn_pool_size = 30
235
236 # The pool size limit for connections expiration policy (integer value)
237 #conn_pool_min_size = 2
238
239 # The time-to-live in sec of idle connections in the pool (integer value)
240 #conn_pool_ttl = 1200
241
242 # ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP.
243 # The "host" option should point or resolve to this address. (string value)
244 #rpc_zmq_bind_address = *
245
246 # MatchMaker driver. (string value)
247 # Possible values:
248 # redis - <No description provided>
249 # sentinel - <No description provided>
250 # dummy - <No description provided>
251 #rpc_zmq_matchmaker = redis
252
253 # Number of ZeroMQ contexts, defaults to 1. (integer value)
254 #rpc_zmq_contexts = 1
255
256 # Maximum number of ingress messages to locally buffer per topic. Default is
257 # unlimited. (integer value)
258 #rpc_zmq_topic_backlog = <None>
259
260 # Directory for holding IPC sockets. (string value)
261 #rpc_zmq_ipc_dir = /var/run/openstack
262
263 # Name of this node. Must be a valid hostname, FQDN, or IP address. Must match
264 # "host" option, if running Nova. (string value)
265 #rpc_zmq_host = localhost
266
267 # Number of seconds to wait before all pending messages will be sent after
268 # closing a socket. The default value of -1 specifies an infinite linger
269 # period. The value of 0 specifies no linger period. Pending messages shall be
270 # discarded immediately when the socket is closed. Positive values specify an
271 # upper bound for the linger period. (integer value)
272 # Deprecated group/name - [DEFAULT]/rpc_cast_timeout
273 #zmq_linger = -1
274
275 # The default number of seconds that poll should wait. Poll raises timeout
276 # exception when timeout expired. (integer value)
277 #rpc_poll_timeout = 1
278
279 # Expiration timeout in seconds of a name service record about existing target
280 # ( < 0 means no timeout). (integer value)
281 #zmq_target_expire = 300
282
283 # Update period in seconds of a name service record about existing target.
284 # (integer value)
285 #zmq_target_update = 180
286
287 # Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. (boolean
288 # value)
289 #use_pub_sub = false
290
291 # Use ROUTER remote proxy. (boolean value)
292 #use_router_proxy = false
293
294 # This option makes direct connections dynamic or static. It makes sense only
295 # with use_router_proxy=False which means to use direct connections for direct
296 # message types (ignored otherwise). (boolean value)
297 #use_dynamic_connections = false
298
299 # How many additional connections to a host will be made for failover reasons.
300 # This option is actual only in dynamic connections mode. (integer value)
301 #zmq_failover_connections = 2
302
303 # Minimal port number for random ports range. (port value)
304 # Minimum value: 0
305 # Maximum value: 65535
306 #rpc_zmq_min_port = 49153
307
308 # Maximal port number for random ports range. (integer value)
309 # Minimum value: 1
310 # Maximum value: 65536
311 #rpc_zmq_max_port = 65536
312
313 # Number of retries to find free port number before fail with ZMQBindError.
314 # (integer value)
315 #rpc_zmq_bind_port_retries = 100
316
317 # Default serialization mechanism for serializing/deserializing
318 # outgoing/incoming messages (string value)
319 # Possible values:
320 # json - <No description provided>
321 # msgpack - <No description provided>
322 #rpc_zmq_serialization = json
323
324 # This option configures round-robin mode in zmq socket. True means not keeping
325 # a queue when server side disconnects. False means to keep queue and messages
326 # even if server is disconnected, when the server appears we send all
327 # accumulated messages to it. (boolean value)
328 #zmq_immediate = true
329
330 # Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any
331 # other negative value) means to skip any overrides and leave it to OS default;
332 # 0 and 1 (or any other positive value) mean to disable and enable the option
333 # respectively. (integer value)
334 #zmq_tcp_keepalive = -1
335
336 # The duration between two keepalive transmissions in idle condition. The unit
337 # is platform dependent, for example, seconds in Linux, milliseconds in Windows
338 # etc. The default value of -1 (or any other negative value and 0) means to
339 # skip any overrides and leave it to OS default. (integer value)
340 #zmq_tcp_keepalive_idle = -1
341
342 # The number of retransmissions to be carried out before declaring that remote
343 # end is not available. The default value of -1 (or any other negative value
344 # and 0) means to skip any overrides and leave it to OS default. (integer
345 # value)
346 #zmq_tcp_keepalive_cnt = -1
347
348 # The duration between two successive keepalive retransmissions, if
349 # acknowledgement to the previous keepalive transmission is not received. The
350 # unit is platform dependent, for example, seconds in Linux, milliseconds in
351 # Windows etc. The default value of -1 (or any other negative value and 0)
352 # means to skip any overrides and leave it to OS default. (integer value)
353 #zmq_tcp_keepalive_intvl = -1
354
355 # Maximum number of (green) threads to work concurrently. (integer value)
356 #rpc_thread_pool_size = 100
357
358 # Expiration timeout in seconds of a sent/received message after which it is
359 # not tracked anymore by a client/server. (integer value)
360 #rpc_message_ttl = 300
361
362 # Wait for message acknowledgements from receivers. This mechanism works only
363 # via proxy without PUB/SUB. (boolean value)
364 #rpc_use_acks = false
365
366 # Number of seconds to wait for an ack from a cast/call. After each retry
367 # attempt this timeout is multiplied by some specified multiplier. (integer
368 # value)
369 #rpc_ack_timeout_base = 15
370
371 # Number to multiply base ack timeout by after each retry attempt. (integer
372 # value)
373 #rpc_ack_timeout_multiplier = 2
374
375 # Default number of message sending attempts in case of any problems occurred:
376 # positive value N means at most N retries, 0 means no retries, None or -1 (or
377 # any other negative values) mean to retry forever. This option is used only if
378 # acknowledgments are enabled. (integer value)
379 #rpc_retry_attempts = 3
380
381 # List of publisher hosts SubConsumer can subscribe on. This option has higher
382 # priority then the default publishers list taken from the matchmaker. (list
383 # value)
384 #subscribe_on =
385
386 # Size of executor thread pool when executor is threading or eventlet. (integer
387 # value)
388 # Deprecated group/name - [DEFAULT]/rpc_thread_pool_size
389 #executor_thread_pool_size = 64
390
391 # Seconds to wait for a response from a call. (integer value)
392 #rpc_response_timeout = 60
393
394 # A URL representing the messaging driver to use and its full configuration.
395 # (string value)
396 #transport_url = <None>
397
398 # DEPRECATED: The messaging driver to use, defaults to rabbit. Other drivers
399 # include amqp and zmq. (string value)
400 # This option is deprecated for removal.
401 # Its value may be silently ignored in the future.
402 # Reason: Replaced by [DEFAULT]/transport_url
403 #rpc_backend = rabbit
404
405 # The default exchange under which topics are scoped. May be overridden by an
406 # exchange name specified in the transport_url option. (string value)
407 #control_exchange = keystone
408
409
410 [access_rules_config]
411
412 #
413 # From keystone
414 #
415
416 # Entry point for the access rules config backend driver in the
417 # `keystone.access_rules_config` namespace.  Keystone only provides a `json`
418 # driver, so there is no reason to change this unless you are providing a
419 # custom entry point. (string value)
420 #driver = json
421
422 # Toggle for access rules caching. This has no effect unless global caching is
423 # enabled. (boolean value)
424 #caching = true
425
426 # Time to cache access rule data in seconds. This has no effect unless global
427 # caching is enabled. (integer value)
428 #cache_time = <None>
429
430 # Path to access rules configuration. If not present, no access rule
431 # configuration will be loaded and application credential access rules will be
432 # unavailable. (string value)
433 #rules_file = /etc/keystone/access_rules.json
434
435 # Toggles permissive mode for access rules. When enabled, application
436 # credentials can be created with any access rules regardless of operator's
437 # configuration. (boolean value)
438 #permissive = false
439
440
441 [application_credential]
442
443 #
444 # From keystone
445 #
446
447 # Entry point for the application credential backend driver in the
448 # `keystone.application_credential` namespace.  Keystone only provides a `sql`
449 # driver, so there is no reason to change this unless you are providing a
450 # custom entry point. (string value)
451 #driver = sql
452
453 # Toggle for application credential caching. This has no effect unless global
454 # caching is enabled. (boolean value)
455 #caching = true
456
457 # Time to cache application credential data in seconds. This has no effect
458 # unless global caching is enabled. (integer value)
459 #cache_time = <None>
460
461 # Maximum number of application credentials a user is permitted to create. A
462 # value of -1 means unlimited. If a limit is not set, users are permitted to
463 # create application credentials at will, which could lead to bloat in the
464 # keystone database or open keystone to a DoS attack. (integer value)
465 #user_limit = -1
466
467
468 [assignment]
469
470 #
471 # From keystone
472 #
473
474 # Entry point for the assignment backend driver (where role assignments are
475 # stored) in the `keystone.assignment` namespace. Only a SQL driver is supplied
476 # by keystone itself. Unless you are writing proprietary drivers for keystone,
477 # you do not need to set this option. (string value)
478 #driver = sql
479
480 # A list of role names which are prohibited from being an implied role. (list
481 # value)
482 #prohibited_implied_role = admin
483
484
485 [auth]
486
487 #
488 # From keystone
489 #
490
491 # Allowed authentication methods. Note: You should disable the `external` auth
492 # method if you are currently using federation. External auth and federation
493 # both use the REMOTE_USER variable. Since both the mapped and external plugin
494 # are being invoked to validate attributes in the request environment, it can
495 # cause conflicts. (list value)
496 #methods = external,password,token,oauth1,mapped,application_credential
497
498 # Entry point for the password auth plugin module in the
499 # `keystone.auth.password` namespace. You do not need to set this unless you
500 # are overriding keystone's own password authentication plugin. (string value)
501 #password = <None>
502
503 # Entry point for the token auth plugin module in the `keystone.auth.token`
504 # namespace. You do not need to set this unless you are overriding keystone's
505 # own token authentication plugin. (string value)
506 #token = <None>
507
508 # Entry point for the external (`REMOTE_USER`) auth plugin module in the
509 # `keystone.auth.external` namespace. Supplied drivers are `DefaultDomain` and
510 # `Domain`. The default driver is `DefaultDomain`, which assumes that all users
511 # identified by the username specified to keystone in the `REMOTE_USER`
512 # variable exist within the context of the default domain. The `Domain` option
513 # expects an additional environment variable be presented to keystone,
514 # `REMOTE_DOMAIN`, containing the domain name of the `REMOTE_USER` (if
515 # `REMOTE_DOMAIN` is not set, then the default domain will be used instead).
516 # You do not need to set this unless you are taking advantage of "external
517 # authentication", where the application server (such as Apache) is handling
518 # authentication instead of keystone. (string value)
519 #external = <None>
520
521 # Entry point for the OAuth 1.0a auth plugin module in the
522 # `keystone.auth.oauth1` namespace. You do not need to set this unless you are
523 # overriding keystone's own `oauth1` authentication plugin. (string value)
524 #oauth1 = <None>
525
526 # Entry point for the mapped auth plugin module in the `keystone.auth.mapped`
527 # namespace. You do not need to set this unless you are overriding keystone's
528 # own `mapped` authentication plugin. (string value)
529 #mapped = <None>
530
531 # Entry point for the application_credential auth plugin module in the
532 # `keystone.auth.application_credential` namespace. You do not need to set this
533 # unless you are overriding keystone's own `application_credential`
534 # authentication plugin. (string value)
535 #application_credential = <None>
536
537
538 [cache]
539
540 #
541 # From oslo.cache
542 #
543
544 # Prefix for building the configuration dictionary for the cache region. This
545 # should not need to be changed unless there is another dogpile.cache region
546 # with the same configuration name. (string value)
547 #config_prefix = cache.oslo
548
549 # Default TTL, in seconds, for any cached item in the dogpile.cache region.
550 # This applies to any cached method that doesn't have an explicit cache
551 # expiration time defined for it. (integer value)
552 #expiration_time = 600
553
554 # Cache backend module. For eventlet-based or environments with hundreds of
555 # threaded servers, Memcache with pooling (oslo_cache.memcache_pool) is
556 # recommended. For environments with less than 100 threaded servers, Memcached
557 # (dogpile.cache.memcached) or Redis (dogpile.cache.redis) is recommended. Test
558 # environments with a single instance of the server can use the
559 # dogpile.cache.memory backend. (string value)
560 # Possible values:
561 # oslo_cache.memcache_pool - <No description provided>
562 # oslo_cache.dict - <No description provided>
563 # dogpile.cache.memcached - <No description provided>
564 # dogpile.cache.redis - <No description provided>
565 # dogpile.cache.memory - <No description provided>
566 # dogpile.cache.null - <No description provided>
567 #backend = dogpile.cache.null
568
569 # Arguments supplied to the backend module. Specify this option once per
570 # argument to be passed to the dogpile.cache backend. Example format:
571 # "<argname>:<value>". (multi valued)
572 #backend_argument =
573
574 # Proxy classes to import that will affect the way the dogpile.cache backend
575 # functions. See the dogpile.cache documentation on changing-backend-behavior.
576 # (list value)
577 #proxies =
578
579 # Global toggle for caching. (boolean value)
580 #enabled = true
581
582 # Extra debugging from the cache backend (cache keys, get/set/delete/etc
583 # calls). This is only really useful if you need to see the specific cache-
584 # backend get/set/delete calls with the keys/values.  Typically this should be
585 # left set to false. (boolean value)
586 #debug_cache_backend = false
587
588 # Memcache servers in the format of "host:port". (dogpile.cache.memcache and
589 # oslo_cache.memcache_pool backends only). (list value)
590 #memcache_servers = localhost:11211
591
592 # Number of seconds memcached server is considered dead before it is tried
593 # again. (dogpile.cache.memcache and oslo_cache.memcache_pool backends only).
594 # (integer value)
595 #memcache_dead_retry = 300
596
597 # Timeout in seconds for every call to a server. (dogpile.cache.memcache and
598 # oslo_cache.memcache_pool backends only). (integer value)
599 #memcache_socket_timeout = 3
600
601 # Max total number of open connections to every memcached server.
602 # (oslo_cache.memcache_pool backend only). (integer value)
603 #memcache_pool_maxsize = 10
604
605 # Number of seconds a connection to memcached is held unused in the pool before
606 # it is closed. (oslo_cache.memcache_pool backend only). (integer value)
607 #memcache_pool_unused_timeout = 60
608
609 # Number of seconds that an operation will wait to get a memcache client
610 # connection. (integer value)
611 #memcache_pool_connection_get_timeout = 10
612
613
614 [catalog]
615
616 #
617 # From keystone
618 #
619
620 # Absolute path to the file used for the templated catalog backend. This option
621 # is only used if the `[catalog] driver` is set to `templated`. (string value)
622 #template_file = default_catalog.templates
623
624 # Entry point for the catalog driver in the `keystone.catalog` namespace.
625 # Keystone provides a `sql` option (which supports basic CRUD operations
626 # through SQL), a `templated` option (which loads the catalog from a templated
627 # catalog file on disk), and a `endpoint_filter.sql` option (which supports
628 # arbitrary service catalogs per project). (string value)
629 #driver = sql
630
631 # Toggle for catalog caching. This has no effect unless global caching is
632 # enabled. In a typical deployment, there is no reason to disable this.
633 # (boolean value)
634 #caching = true
635
636 # Time to cache catalog data (in seconds). This has no effect unless global and
637 # catalog caching are both enabled. Catalog data (services, endpoints, etc.)
638 # typically does not change frequently, and so a longer duration than the
639 # global default may be desirable. (integer value)
640 #cache_time = <None>
641
642 # Maximum number of entities that will be returned in a catalog collection.
643 # There is typically no reason to set this, as it would be unusual for a
644 # deployment to have enough services or endpoints to exceed a reasonable limit.
645 # (integer value)
646 #list_limit = <None>
647
648
649 [cors]
650
651 #
652 # From oslo.middleware
653 #
654
655 # Indicate whether this resource may be shared with the domain received in the
656 # requests "origin" header. Format: "<protocol>://<host>[:<port>]", no trailing
657 # slash. Example: https://horizon.example.com (list value)
658 #allowed_origin = <None>
659
660 # Indicate that the actual request can include user credentials (boolean value)
661 #allow_credentials = true
662
663 # Indicate which headers are safe to expose to the API. Defaults to HTTP Simple
664 # Headers. (list value)
665 #expose_headers = X-Auth-Token,X-Openstack-Request-Id,X-Subject-Token,Openstack-Auth-Receipt
666
667 # Maximum cache age of CORS preflight requests. (integer value)
668 #max_age = 3600
669
670 # Indicate which methods can be used during the actual request. (list value)
671 #allow_methods = GET,PUT,POST,DELETE,PATCH
672
673 # Indicate which header field names may be used during the actual request.
674 # (list value)
675 #allow_headers = X-Auth-Token,X-Openstack-Request-Id,X-Subject-Token,X-Project-Id,X-Project-Name,X-Project-Domain-Id,X-Project-Domain-Name,X-Domain-Id,X-Domain-Name,Openstack-Auth-Receipt
676
677
678 [credential]
679
680 #
681 # From keystone
682 #
683
684 # Entry point for the credential backend driver in the `keystone.credential`
685 # namespace. Keystone only provides a `sql` driver, so there's no reason to
686 # change this unless you are providing a custom entry point. (string value)
687 #driver = sql
688
689 # Entry point for credential encryption and decryption operations in the
690 # `keystone.credential.provider` namespace. Keystone only provides a `fernet`
691 # driver, so there's no reason to change this unless you are providing a custom
692 # entry point to encrypt and decrypt credentials. (string value)
693 #provider = fernet
694
695 # Directory containing Fernet keys used to encrypt and decrypt credentials
696 # stored in the credential backend. Fernet keys used to encrypt credentials
697 # have no relationship to Fernet keys used to encrypt Fernet tokens. Both sets
698 # of keys should be managed separately and require different rotation policies.
699 # Do not share this repository with the repository used to manage keys for
700 # Fernet tokens. (string value)
701 #key_repository = /etc/keystone/credential-keys/
702
703
704 [database]
705
706 #
707 # From oslo.db
708 #
709
710 # If True, SQLite uses synchronous mode. (boolean value)
711 #sqlite_synchronous = true
712
713 # The back end to use for the database. (string value)
714 # Deprecated group/name - [DEFAULT]/db_backend
715 #backend = sqlalchemy
716
717 # The SQLAlchemy connection string to use to connect to the database. (string
718 # value)
719 # Deprecated group/name - [DEFAULT]/sql_connection
720 # Deprecated group/name - [DATABASE]/sql_connection
721 # Deprecated group/name - [sql]/connection
722 #connection = <None>
723
724 # The SQLAlchemy connection string to use to connect to the slave database.
725 # (string value)
726 #slave_connection = <None>
727
728 # The SQL mode to be used for MySQL sessions. This option, including the
729 # default, overrides any server-set SQL mode. To use whatever SQL mode is set
730 # by the server configuration, set this to no value. Example: mysql_sql_mode=
731 # (string value)
732 #mysql_sql_mode = TRADITIONAL
733
734 # If True, transparently enables support for handling MySQL Cluster (NDB).
735 # (boolean value)
736 #mysql_enable_ndb = false
737
738 # Connections which have been present in the connection pool longer than this
739 # number of seconds will be replaced with a new one the next time they are
740 # checked out from the pool. (integer value)
741 # Deprecated group/name - [DATABASE]/idle_timeout
742 # Deprecated group/name - [database]/idle_timeout
743 # Deprecated group/name - [DEFAULT]/sql_idle_timeout
744 # Deprecated group/name - [DATABASE]/sql_idle_timeout
745 # Deprecated group/name - [sql]/idle_timeout
746 #connection_recycle_time = 3600
747
748 # Minimum number of SQL connections to keep open in a pool. (integer value)
749 # Deprecated group/name - [DEFAULT]/sql_min_pool_size
750 # Deprecated group/name - [DATABASE]/sql_min_pool_size
751 #min_pool_size = 1
752
753 # Maximum number of SQL connections to keep open in a pool. Setting a value of
754 # 0 indicates no limit. (integer value)
755 # Deprecated group/name - [DEFAULT]/sql_max_pool_size
756 # Deprecated group/name - [DATABASE]/sql_max_pool_size
757 #max_pool_size = 5
758
759 # Maximum number of database connection retries during startup. Set to -1 to
760 # specify an infinite retry count. (integer value)
761 # Deprecated group/name - [DEFAULT]/sql_max_retries
762 # Deprecated group/name - [DATABASE]/sql_max_retries
763 #max_retries = 10
764
765 # Interval between retries of opening a SQL connection. (integer value)
766 # Deprecated group/name - [DEFAULT]/sql_retry_interval
767 # Deprecated group/name - [DATABASE]/reconnect_interval
768 #retry_interval = 10
769
770 # If set, use this value for max_overflow with SQLAlchemy. (integer value)
771 # Deprecated group/name - [DEFAULT]/sql_max_overflow
772 # Deprecated group/name - [DATABASE]/sqlalchemy_max_overflow
773 #max_overflow = 50
774
775 # Verbosity of SQL debugging information: 0=None, 100=Everything. (integer
776 # value)
777 # Minimum value: 0
778 # Maximum value: 100
779 # Deprecated group/name - [DEFAULT]/sql_connection_debug
780 #connection_debug = 0
781
782 # Add Python stack traces to SQL as comment strings. (boolean value)
783 # Deprecated group/name - [DEFAULT]/sql_connection_trace
784 #connection_trace = false
785
786 # If set, use this value for pool_timeout with SQLAlchemy. (integer value)
787 # Deprecated group/name - [DATABASE]/sqlalchemy_pool_timeout
788 #pool_timeout = <None>
789
790 # Enable the experimental use of database reconnect on connection lost.
791 # (boolean value)
792 #use_db_reconnect = false
793
794 # Seconds between retries of a database transaction. (integer value)
795 #db_retry_interval = 1
796
797 # If True, increases the interval between retries of a database operation up to
798 # db_max_retry_interval. (boolean value)
799 #db_inc_retry_interval = true
800
801 # If db_inc_retry_interval is set, the maximum seconds between retries of a
802 # database operation. (integer value)
803 #db_max_retry_interval = 10
804
805 # Maximum retries in case of connection error or deadlock error before error is
806 # raised. Set to -1 to specify an infinite retry count. (integer value)
807 #db_max_retries = 20
808
809
810 [domain_config]
811
812 #
813 # From keystone
814 #
815
816 # Entry point for the domain-specific configuration driver in the
817 # `keystone.resource.domain_config` namespace. Only a `sql` option is provided
818 # by keystone, so there is no reason to set this unless you are providing a
819 # custom entry point. (string value)
820 #driver = sql
821
822 # Toggle for caching of the domain-specific configuration backend. This has no
823 # effect unless global caching is enabled. There is normally no reason to
824 # disable this. (boolean value)
825 #caching = true
826
827 # Time-to-live (TTL, in seconds) to cache domain-specific configuration data.
828 # This has no effect unless `[domain_config] caching` is enabled. (integer
829 # value)
830 #cache_time = 300
831
832
833 [endpoint_filter]
834
835 #
836 # From keystone
837 #
838
839 # Entry point for the endpoint filter driver in the `keystone.endpoint_filter`
840 # namespace. Only a `sql` option is provided by keystone, so there is no reason
841 # to set this unless you are providing a custom entry point. (string value)
842 #driver = sql
843
844 # This controls keystone's behavior if the configured endpoint filters do not
845 # result in any endpoints for a user + project pair (and therefore a
846 # potentially empty service catalog). If set to true, keystone will return the
847 # entire service catalog. If set to false, keystone will return an empty
848 # service catalog. (boolean value)
849 #return_all_endpoints_if_no_filter = true
850
851
852 [endpoint_policy]
853
854 #
855 # From keystone
856 #
857
858 # Entry point for the endpoint policy driver in the `keystone.endpoint_policy`
859 # namespace. Only a `sql` driver is provided by keystone, so there is no reason
860 # to set this unless you are providing a custom entry point. (string value)
861 #driver = sql
862
863
864 [eventlet_server]
865
866 #
867 # From keystone
868 #
869
870 # DEPRECATED: The IP address of the network interface for the public service to
871 # listen on. (unknown value)
872 # Deprecated group/name - [DEFAULT]/bind_host
873 # Deprecated group/name - [DEFAULT]/public_bind_host
874 # This option is deprecated for removal since K.
875 # Its value may be silently ignored in the future.
876 # Reason: Support for running keystone under eventlet has been removed in the
877 # Newton release. These options remain for backwards compatibility because they
878 # are used for URL substitutions.
879 #public_bind_host = 0.0.0.0
880
881 # DEPRECATED: The port number for the public service to listen on. (port value)
882 # Minimum value: 0
883 # Maximum value: 65535
884 # Deprecated group/name - [DEFAULT]/public_port
885 # This option is deprecated for removal since K.
886 # Its value may be silently ignored in the future.
887 # Reason: Support for running keystone under eventlet has been removed in the
888 # Newton release. These options remain for backwards compatibility because they
889 # are used for URL substitutions.
890 #public_port = 5000
891
892 # DEPRECATED: The IP address of the network interface for the admin service to
893 # listen on. (unknown value)
894 # Deprecated group/name - [DEFAULT]/bind_host
895 # Deprecated group/name - [DEFAULT]/admin_bind_host
896 # This option is deprecated for removal since K.
897 # Its value may be silently ignored in the future.
898 # Reason: Support for running keystone under eventlet has been removed in the
899 # Newton release. These options remain for backwards compatibility because they
900 # are used for URL substitutions.
901 #admin_bind_host = 0.0.0.0
902
903 # DEPRECATED: The port number for the admin service to listen on. (port value)
904 # Minimum value: 0
905 # Maximum value: 65535
906 # Deprecated group/name - [DEFAULT]/admin_port
907 # This option is deprecated for removal since K.
908 # Its value may be silently ignored in the future.
909 # Reason: Support for running keystone under eventlet has been removed in the
910 # Newton release. These options remain for backwards compatibility because they
911 # are used for URL substitutions.
912 #admin_port = 35357
913
914
915 [federation]
916
917 #
918 # From keystone
919 #
920
921 # Entry point for the federation backend driver in the `keystone.federation`
922 # namespace. Keystone only provides a `sql` driver, so there is no reason to
923 # set this option unless you are providing a custom entry point. (string value)
924 #driver = sql
925
926 # Prefix to use when filtering environment variable names for federated
927 # assertions. Matched variables are passed into the federated mapping engine.
928 # (string value)
929 #assertion_prefix =
930
931 # Value to be used to obtain the entity ID of the Identity Provider from the
932 # environment. For `mod_shib`, this would be `Shib-Identity-Provider`. For
933 # `mod_auth_openidc`, this could be `HTTP_OIDC_ISS`. For `mod_auth_mellon`,
934 # this could be `MELLON_IDP`. (string value)
935 #remote_id_attribute = <None>
936
937 # An arbitrary domain name that is reserved to allow federated ephemeral users
938 # to have a domain concept. Note that an admin will not be able to create a
939 # domain with this name or update an existing domain to this name. You are not
940 # advised to change this value unless you really have to. (string value)
941 #federated_domain_name = Federated
942
943 # A list of trusted dashboard hosts. Before accepting a Single Sign-On request
944 # to return a token, the origin host must be a member of this list. This
945 # configuration option may be repeated for multiple values. You must set this
946 # in order to use web-based SSO flows. For example:
947 # trusted_dashboard=https://acme.example.com/auth/websso
948 # trusted_dashboard=https://beta.example.com/auth/websso (multi valued)
949 #trusted_dashboard =
950
951 # Absolute path to an HTML file used as a Single Sign-On callback handler. This
952 # page is expected to redirect the user from keystone back to a trusted
953 # dashboard host, by form encoding a token in a POST request. Keystone's
954 # default value should be sufficient for most deployments. (string value)
955 #sso_callback_template = /etc/keystone/sso_callback_template.html
956
957 # Toggle for federation caching. This has no effect unless global caching is
958 # enabled. There is typically no reason to disable this. (boolean value)
959 #caching = true
960
961
962 [fernet_receipts]
963
964 #
965 # From keystone
966 #
967
968 # Directory containing Fernet receipt keys. This directory must exist before
969 # using `keystone-manage fernet_setup` for the first time, must be writable by
970 # the user running `keystone-manage fernet_setup` or `keystone-manage
971 # fernet_rotate`, and of course must be readable by keystone's server process.
972 # The repository may contain keys in one of three states: a single staged key
973 # (always index 0) used for receipt validation, a single primary key (always
974 # the highest index) used for receipt creation and validation, and any number
975 # of secondary keys (all other index values) used for receipt validation. With
976 # multiple keystone nodes, each node must share the same key repository
977 # contents, with the exception of the staged key (index 0). It is safe to run
978 # `keystone-manage fernet_rotate` once on any one node to promote a staged key
979 # (index 0) to be the new primary (incremented from the previous highest
980 # index), and produce a new staged key (a new key with index 0); the resulting
981 # repository can then be atomically replicated to other nodes without any risk
982 # of race conditions (for example, it is safe to run `keystone-manage
983 # fernet_rotate` on host A, wait any amount of time, create a tarball of the
984 # directory on host A, unpack it on host B to a temporary location, and
985 # atomically move (`mv`) the directory into place on host B). Running
986 # `keystone-manage fernet_rotate` *twice* on a key repository without syncing
987 # other nodes will result in receipts that can not be validated by all nodes.
988 # (string value)
989 #key_repository = /etc/keystone/fernet-keys/
990
991 # This controls how many keys are held in rotation by `keystone-manage
992 # fernet_rotate` before they are discarded. The default value of 3 means that
993 # keystone will maintain one staged key (always index 0), one primary key (the
994 # highest numerical index), and one secondary key (every other index).
995 # Increasing this value means that additional secondary keys will be kept in
996 # the rotation. (integer value)
997 # Minimum value: 1
998 #max_active_keys = 3
999
1000
1001 [fernet_tokens]
1002
1003 #
1004 # From keystone
1005 #
1006
1007 # Directory containing Fernet token keys. This directory must exist before
1008 # using `keystone-manage fernet_setup` for the first time, must be writable by
1009 # the user running `keystone-manage fernet_setup` or `keystone-manage
1010 # fernet_rotate`, and of course must be readable by keystone's server process.
1011 # The repository may contain keys in one of three states: a single staged key
1012 # (always index 0) used for token validation, a single primary key (always the
1013 # highest index) used for token creation and validation, and any number of
1014 # secondary keys (all other index values) used for token validation. With
1015 # multiple keystone nodes, each node must share the same key repository
1016 # contents, with the exception of the staged key (index 0). It is safe to run
1017 # `keystone-manage fernet_rotate` once on any one node to promote a staged key
1018 # (index 0) to be the new primary (incremented from the previous highest
1019 # index), and produce a new staged key (a new key with index 0); the resulting
1020 # repository can then be atomically replicated to other nodes without any risk
1021 # of race conditions (for example, it is safe to run `keystone-manage
1022 # fernet_rotate` on host A, wait any amount of time, create a tarball of the
1023 # directory on host A, unpack it on host B to a temporary location, and
1024 # atomically move (`mv`) the directory into place on host B). Running
1025 # `keystone-manage fernet_rotate` *twice* on a key repository without syncing
1026 # other nodes will result in tokens that can not be validated by all nodes.
1027 # (string value)
1028 #key_repository = /etc/keystone/fernet-keys/
1029
1030 # This controls how many keys are held in rotation by `keystone-manage
1031 # fernet_rotate` before they are discarded. The default value of 3 means that
1032 # keystone will maintain one staged key (always index 0), one primary key (the
1033 # highest numerical index), and one secondary key (every other index).
1034 # Increasing this value means that additional secondary keys will be kept in
1035 # the rotation. (integer value)
1036 # Minimum value: 1
1037 #max_active_keys = 3
1038
1039
1040 [healthcheck]
1041
1042 #
1043 # From oslo.middleware
1044 #
1045
1046 # DEPRECATED: The path to respond to healtcheck requests on. (string value)
1047 # This option is deprecated for removal.
1048 # Its value may be silently ignored in the future.
1049 #path = /healthcheck
1050
1051 # Show more detailed information as part of the response (boolean value)
1052 #detailed = false
1053
1054 # Additional backends that can perform health checks and report that
1055 # information back as part of a request. (list value)
1056 #backends =
1057
1058 # Check the presence of a file to determine if an application is running on a
1059 # port. Used by DisableByFileHealthcheck plugin. (string value)
1060 #disable_by_file_path = <None>
1061
1062 # Check the presence of a file based on a port to determine if an application
1063 # is running on a port. Expects a "port:path" list of strings. Used by
1064 # DisableByFilesPortsHealthcheck plugin. (list value)
1065 #disable_by_file_paths =
1066
1067
1068 [identity]
1069
1070 #
1071 # From keystone
1072 #
1073
1074 # This references the domain to use for all Identity API v2 requests (which are
1075 # not aware of domains). A domain with this ID can optionally be created for
1076 # you by `keystone-manage bootstrap`. The domain referenced by this ID cannot
1077 # be deleted on the v3 API, to prevent accidentally breaking the v2 API. There
1078 # is nothing special about this domain, other than the fact that it must exist
1079 # to order to maintain support for your v2 clients. There is typically no
1080 # reason to change this value. (string value)
1081 #default_domain_id = default
1082
1083 # A subset (or all) of domains can have their own identity driver, each with
1084 # their own partial configuration options, stored in either the resource
1085 # backend or in a file in a domain configuration directory (depending on the
1086 # setting of `[identity] domain_configurations_from_database`). Only values
1087 # specific to the domain need to be specified in this manner. This feature is
1088 # disabled by default, but may be enabled by default in a future release; set
1089 # to true to enable. (boolean value)
1090 #domain_specific_drivers_enabled = false
1091
1092 # By default, domain-specific configuration data is read from files in the
1093 # directory identified by `[identity] domain_config_dir`. Enabling this
1094 # configuration option allows you to instead manage domain-specific
1095 # configurations through the API, which are then persisted in the backend
1096 # (typically, a SQL database), rather than using configuration files on disk.
1097 # (boolean value)
1098 #domain_configurations_from_database = false
1099
1100 # Absolute path where keystone should locate domain-specific `[identity]`
1101 # configuration files. This option has no effect unless `[identity]
1102 # domain_specific_drivers_enabled` is set to true. There is typically no reason
1103 # to change this value. (string value)
1104 #domain_config_dir = /etc/keystone/domains
1105
1106 # Entry point for the identity backend driver in the `keystone.identity`
1107 # namespace. Keystone provides a `sql` and `ldap` driver. This option is also
1108 # used as the default driver selection (along with the other configuration
1109 # variables in this section) in the event that `[identity]
1110 # domain_specific_drivers_enabled` is enabled, but no applicable domain-
1111 # specific configuration is defined for the domain in question. Unless your
1112 # deployment primarily relies on `ldap` AND is not using domain-specific
1113 # configuration, you should typically leave this set to `sql`. (string value)
1114 #driver = sql
1115
1116 # Toggle for identity caching. This has no effect unless global caching is
1117 # enabled. There is typically no reason to disable this. (boolean value)
1118 #caching = true
1119
1120 # Time to cache identity data (in seconds). This has no effect unless global
1121 # and identity caching are enabled. (integer value)
1122 #cache_time = 600
1123
1124 # Maximum allowed length for user passwords. Decrease this value to improve
1125 # performance. Changing this value does not effect existing passwords. (integer
1126 # value)
1127 # Maximum value: 4096
1128 #max_password_length = 4096
1129
1130 # Maximum number of entities that will be returned in an identity collection.
1131 # (integer value)
1132 #list_limit = <None>
1133
1134 # The password hashing algorithm to use for passwords stored within keystone.
1135 # (string value)
1136 # Possible values:
1137 # bcrypt - <No description provided>
1138 # scrypt - <No description provided>
1139 # pbkdf2_sha512 - <No description provided>
1140 #password_hash_algorithm = bcrypt
1141
1142 # This option represents a trade off between security and performance. Higher
1143 # values lead to slower performance, but higher security. Changing this option
1144 # will only affect newly created passwords as existing password hashes already
1145 # have a fixed number of rounds applied, so it is safe to tune this option in a
1146 # running cluster.  The default for bcrypt is 12, must be between 4 and 31,
1147 # inclusive.  The default for scrypt is 16, must be within `range(1,32)`.  The
1148 # default for pbkdf_sha512 is 60000, must be within `range(1,1<<32)`  WARNING:
1149 # If using scrypt, increasing this value increases BOTH time AND memory
1150 # requirements to hash a password. (integer value)
1151 #password_hash_rounds = <None>
1152
1153 # Optional block size to pass to scrypt hash function (the `r` parameter).
1154 # Useful for tuning scrypt to optimal performance for your CPU architecture.
1155 # This option is only used when the `password_hash_algorithm` option is set to
1156 # `scrypt`. Defaults to 8. (integer value)
1157 #scrypt_block_size = <None>
1158
1159 # Optional parallelism to pass to scrypt hash function (the `p` parameter).
1160 # This option is only used when the `password_hash_algorithm` option is set to
1161 # `scrypt`. Defaults to 1. (integer value)
1162 #scrypt_parallelism = <None>
1163
1164 # Number of bytes to use in scrypt and pbkfd2_sha512 hashing salt.  Default for
1165 # scrypt is 16 bytes. Default for pbkfd2_sha512 is 16 bytes.  Limited to a
1166 # maximum of 96 bytes due to the size of the column used to store password
1167 # hashes. (integer value)
1168 # Minimum value: 0
1169 # Maximum value: 96
1170 #salt_bytesize = <None>
1171
1172
1173 [identity_mapping]
1174
1175 #
1176 # From keystone
1177 #
1178
1179 # Entry point for the identity mapping backend driver in the
1180 # `keystone.identity.id_mapping` namespace. Keystone only provides a `sql`
1181 # driver, so there is no reason to change this unless you are providing a
1182 # custom entry point. (string value)
1183 #driver = sql
1184
1185 # Entry point for the public ID generator for user and group entities in the
1186 # `keystone.identity.id_generator` namespace. The Keystone identity mapper only
1187 # supports generators that produce 64 bytes or less. Keystone only provides a
1188 # `sha256` entry point, so there is no reason to change this value unless
1189 # you're providing a custom entry point. (string value)
1190 #generator = sha256
1191
1192 # The format of user and group IDs changed in Juno for backends that do not
1193 # generate UUIDs (for example, LDAP), with keystone providing a hash mapping to
1194 # the underlying attribute in LDAP. By default this mapping is disabled, which
1195 # ensures that existing IDs will not change. Even when the mapping is enabled
1196 # by using domain-specific drivers (`[identity]
1197 # domain_specific_drivers_enabled`), any users and groups from the default
1198 # domain being handled by LDAP will still not be mapped to ensure their IDs
1199 # remain backward compatible. Setting this value to false will enable the new
1200 # mapping for all backends, including the default LDAP driver. It is only
1201 # guaranteed to be safe to enable this option if you do not already have
1202 # assignments for users and groups from the default LDAP domain, and you
1203 # consider it to be acceptable for Keystone to provide the different IDs to
1204 # clients than it did previously (existing IDs in the API will suddenly
1205 # change). Typically this means that the only time you can set this value to
1206 # false is when configuring a fresh installation, although that is the
1207 # recommended value. (boolean value)
1208 #backward_compatible_ids = true
1209
1210
1211 [jwt_tokens]
1212
1213 #
1214 # From keystone
1215 #
1216
1217 # Directory containing public keys for validating JWS token signatures. This
1218 # directory must exist in order for keystone's server process to start. It must
1219 # also be readable by keystone's server process. It must contain at least one
1220 # public key that corresponds to a private key in `keystone.conf [jwt_tokens]
1221 # jws_private_key_repository`. This option is only applicable in deployments
1222 # issuing JWS tokens and setting `keystone.conf [tokens] provider = jws`.
1223 # (string value)
1224 #jws_public_key_repository = /etc/keystone/jws-keys/public
1225
1226 # Directory containing private keys for signing JWS tokens. This directory must
1227 # exist in order for keystone's server process to start. It must also be
1228 # readable by keystone's server process. It must contain at least one private
1229 # key that corresponds to a public key in `keystone.conf [jwt_tokens]
1230 # jws_public_key_repository`. In the event there are multiple private keys in
1231 # this directory, keystone will use a key named `private.pem` to sign tokens.
1232 # In the future, keystone may support the ability to sign tokens with multiple
1233 # private keys. For now, only a key named `private.pem` within this directory
1234 # is required to issue JWS tokens. This option is only applicable in
1235 # deployments issuing JWS tokens and setting `keystone.conf [tokens] provider =
1236 # jws`. (string value)
1237 #jws_private_key_repository = /etc/keystone/jws-keys/private
1238
1239
1240 [ldap]
1241
1242 #
1243 # From keystone
1244 #
1245
1246 # URL(s) for connecting to the LDAP server. Multiple LDAP URLs may be specified
1247 # as a comma separated string. The first URL to successfully bind is used for
1248 # the connection. (string value)
1249 #url = ldap://localhost
1250
1251 # The user name of the administrator bind DN to use when querying the LDAP
1252 # server, if your LDAP server requires it. (string value)
1253 #user = <None>
1254
1255 # The password of the administrator bind DN to use when querying the LDAP
1256 # server, if your LDAP server requires it. (string value)
1257 #password = <None>
1258
1259 # The default LDAP server suffix to use, if a DN is not defined via either
1260 # `[ldap] user_tree_dn` or `[ldap] group_tree_dn`. (string value)
1261 #suffix = cn=example,cn=com
1262
1263 # The search scope which defines how deep to search within the search base. A
1264 # value of `one` (representing `oneLevel` or `singleLevel`) indicates a search
1265 # of objects immediately below to the base object, but does not include the
1266 # base object itself. A value of `sub` (representing `subtree` or
1267 # `wholeSubtree`) indicates a search of both the base object itself and the
1268 # entire subtree below it. (string value)
1269 # Possible values:
1270 # one - <No description provided>
1271 # sub - <No description provided>
1272 #query_scope = one
1273
1274 # Defines the maximum number of results per page that keystone should request
1275 # from the LDAP server when listing objects. A value of zero (`0`) disables
1276 # paging. (integer value)
1277 # Minimum value: 0
1278 #page_size = 0
1279
1280 # The LDAP dereferencing option to use for queries involving aliases. A value
1281 # of `default` falls back to using default dereferencing behavior configured by
1282 # your `ldap.conf`. A value of `never` prevents aliases from being dereferenced
1283 # at all. A value of `searching` dereferences aliases only after name
1284 # resolution. A value of `finding` dereferences aliases only during name
1285 # resolution. A value of `always` dereferences aliases in all cases. (string
1286 # value)
1287 # Possible values:
1288 # never - <No description provided>
1289 # searching - <No description provided>
1290 # always - <No description provided>
1291 # finding - <No description provided>
1292 # default - <No description provided>
1293 #alias_dereferencing = default
1294
1295 # Sets the LDAP debugging level for LDAP calls. A value of 0 means that
1296 # debugging is not enabled. This value is a bitmask, consult your LDAP
1297 # documentation for possible values. (integer value)
1298 # Minimum value: -1
1299 #debug_level = <None>
1300
1301 # Sets keystone's referral chasing behavior across directory partitions. If
1302 # left unset, the system's default behavior will be used. (boolean value)
1303 #chase_referrals = <None>
1304
1305 # The search base to use for users. Defaults to the `[ldap] suffix` value.
1306 # (string value)
1307 #user_tree_dn = <None>
1308
1309 # The LDAP search filter to use for users. (string value)
1310 #user_filter = <None>
1311
1312 # The LDAP object class to use for users. (string value)
1313 #user_objectclass = inetOrgPerson
1314
1315 # The LDAP attribute mapped to user IDs in keystone. This must NOT be a
1316 # multivalued attribute. User IDs are expected to be globally unique across
1317 # keystone domains and URL-safe. (string value)
1318 #user_id_attribute = cn
1319
1320 # The LDAP attribute mapped to user names in keystone. User names are expected
1321 # to be unique only within a keystone domain and are not expected to be URL-
1322 # safe. (string value)
1323 #user_name_attribute = sn
1324
1325 # The LDAP attribute mapped to user descriptions in keystone. (string value)
1326 #user_description_attribute = description
1327
1328 # The LDAP attribute mapped to user emails in keystone. (string value)
1329 #user_mail_attribute = mail
1330
1331 # The LDAP attribute mapped to user passwords in keystone. (string value)
1332 #user_pass_attribute = userPassword
1333
1334 # The LDAP attribute mapped to the user enabled attribute in keystone. If
1335 # setting this option to `userAccountControl`, then you may be interested in
1336 # setting `[ldap] user_enabled_mask` and `[ldap] user_enabled_default` as well.
1337 # (string value)
1338 #user_enabled_attribute = enabled
1339
1340 # Logically negate the boolean value of the enabled attribute obtained from the
1341 # LDAP server. Some LDAP servers use a boolean lock attribute where "true"
1342 # means an account is disabled. Setting `[ldap] user_enabled_invert = true`
1343 # will allow these lock attributes to be used. This option will have no effect
1344 # if either the `[ldap] user_enabled_mask` or `[ldap] user_enabled_emulation`
1345 # options are in use. (boolean value)
1346 #user_enabled_invert = false
1347
1348 # Bitmask integer to select which bit indicates the enabled value if the LDAP
1349 # server represents "enabled" as a bit on an integer rather than as a discrete
1350 # boolean. A value of `0` indicates that the mask is not used. If this is not
1351 # set to `0` the typical value is `2`. This is typically used when `[ldap]
1352 # user_enabled_attribute = userAccountControl`. Setting this option causes
1353 # keystone to ignore the value of `[ldap] user_enabled_invert`. (integer value)
1354 # Minimum value: 0
1355 #user_enabled_mask = 0
1356
1357 # The default value to enable users. This should match an appropriate integer
1358 # value if the LDAP server uses non-boolean (bitmask) values to indicate if a
1359 # user is enabled or disabled. If this is not set to `True`, then the typical
1360 # value is `512`. This is typically used when `[ldap] user_enabled_attribute =
1361 # userAccountControl`. (string value)
1362 #user_enabled_default = True
1363
1364 # List of user attributes to ignore on create and update, or whether a specific
1365 # user attribute should be filtered for list or show user. (list value)
1366 #user_attribute_ignore = default_project_id
1367
1368 # The LDAP attribute mapped to a user's default_project_id in keystone. This is
1369 # most commonly used when keystone has write access to LDAP. (string value)
1370 #user_default_project_id_attribute = <None>
1371
1372 # If enabled, keystone uses an alternative method to determine if a user is
1373 # enabled or not by checking if they are a member of the group defined by the
1374 # `[ldap] user_enabled_emulation_dn` option. Enabling this option causes
1375 # keystone to ignore the value of `[ldap] user_enabled_invert`. (boolean value)
1376 #user_enabled_emulation = false
1377
1378 # DN of the group entry to hold enabled users when using enabled emulation.
1379 # Setting this option has no effect unless `[ldap] user_enabled_emulation` is
1380 # also enabled. (string value)
1381 #user_enabled_emulation_dn = <None>
1382
1383 # Use the `[ldap] group_member_attribute` and `[ldap] group_objectclass`
1384 # settings to determine membership in the emulated enabled group. Enabling this
1385 # option has no effect unless `[ldap] user_enabled_emulation` is also enabled.
1386 # (boolean value)
1387 #user_enabled_emulation_use_group_config = false
1388
1389 # A list of LDAP attribute to keystone user attribute pairs used for mapping
1390 # additional attributes to users in keystone. The expected format is
1391 # `<ldap_attr>:<user_attr>`, where `ldap_attr` is the attribute in the LDAP
1392 # object and `user_attr` is the attribute which should appear in the identity
1393 # API. (list value)
1394 #user_additional_attribute_mapping =
1395
1396 # The search base to use for groups. Defaults to the `[ldap] suffix` value.
1397 # (string value)
1398 #group_tree_dn = <None>
1399
1400 # The LDAP search filter to use for groups. (string value)
1401 #group_filter = <None>
1402
1403 # The LDAP object class to use for groups. If setting this option to
1404 # `posixGroup`, you may also be interested in enabling the `[ldap]
1405 # group_members_are_ids` option. (string value)
1406 #group_objectclass = groupOfNames
1407
1408 # The LDAP attribute mapped to group IDs in keystone. This must NOT be a
1409 # multivalued attribute. Group IDs are expected to be globally unique across
1410 # keystone domains and URL-safe. (string value)
1411 #group_id_attribute = cn
1412
1413 # The LDAP attribute mapped to group names in keystone. Group names are
1414 # expected to be unique only within a keystone domain and are not expected to
1415 # be URL-safe. (string value)
1416 #group_name_attribute = ou
1417
1418 # The LDAP attribute used to indicate that a user is a member of the group.
1419 # (string value)
1420 #group_member_attribute = member
1421
1422 # Enable this option if the members of the group object class are keystone user
1423 # IDs rather than LDAP DNs. This is the case when using `posixGroup` as the
1424 # group object class in Open Directory. (boolean value)
1425 #group_members_are_ids = false
1426
1427 # The LDAP attribute mapped to group descriptions in keystone. (string value)
1428 #group_desc_attribute = description
1429
1430 # List of group attributes to ignore on create and update. or whether a
1431 # specific group attribute should be filtered for list or show group. (list
1432 # value)
1433 #group_attribute_ignore =
1434
1435 # A list of LDAP attribute to keystone group attribute pairs used for mapping
1436 # additional attributes to groups in keystone. The expected format is
1437 # `<ldap_attr>:<group_attr>`, where `ldap_attr` is the attribute in the LDAP
1438 # object and `group_attr` is the attribute which should appear in the identity
1439 # API. (list value)
1440 #group_additional_attribute_mapping =
1441
1442 # If enabled, group queries will use Active Directory specific filters for
1443 # nested groups. (boolean value)
1444 #group_ad_nesting = false
1445
1446 # An absolute path to a CA certificate file to use when communicating with LDAP
1447 # servers. This option will take precedence over `[ldap] tls_cacertdir`, so
1448 # there is no reason to set both. (string value)
1449 #tls_cacertfile = <None>
1450
1451 # An absolute path to a CA certificate directory to use when communicating with
1452 # LDAP servers. There is no reason to set this option if you've also set
1453 # `[ldap] tls_cacertfile`. (string value)
1454 #tls_cacertdir = <None>
1455
1456 # Enable TLS when communicating with LDAP servers. You should also set the
1457 # `[ldap] tls_cacertfile` and `[ldap] tls_cacertdir` options when using this
1458 # option. Do not set this option if you are using LDAP over SSL (LDAPS) instead
1459 # of TLS. (boolean value)
1460 #use_tls = false
1461
1462 # Specifies which checks to perform against client certificates on incoming TLS
1463 # sessions. If set to `demand`, then a certificate will always be requested and
1464 # required from the LDAP server. If set to `allow`, then a certificate will
1465 # always be requested but not required from the LDAP server. If set to `never`,
1466 # then a certificate will never be requested. (string value)
1467 # Possible values:
1468 # demand - <No description provided>
1469 # never - <No description provided>
1470 # allow - <No description provided>
1471 #tls_req_cert = demand
1472
1473 # The connection timeout to use with the LDAP server. A value of `-1` means
1474 # that connections will never timeout. (integer value)
1475 # Minimum value: -1
1476 #connection_timeout = -1
1477
1478 # Enable LDAP connection pooling for queries to the LDAP server. There is
1479 # typically no reason to disable this. (boolean value)
1480 #use_pool = true
1481
1482 # The size of the LDAP connection pool. This option has no effect unless
1483 # `[ldap] use_pool` is also enabled. (integer value)
1484 # Minimum value: 1
1485 #pool_size = 10
1486
1487 # The maximum number of times to attempt reconnecting to the LDAP server before
1488 # aborting. A value of zero prevents retries. This option has no effect unless
1489 # `[ldap] use_pool` is also enabled. (integer value)
1490 # Minimum value: 0
1491 #pool_retry_max = 3
1492
1493 # The number of seconds to wait before attempting to reconnect to the LDAP
1494 # server. This option has no effect unless `[ldap] use_pool` is also enabled.
1495 # (floating point value)
1496 #pool_retry_delay = 0.1
1497
1498 # The connection timeout to use when pooling LDAP connections. A value of `-1`
1499 # means that connections will never timeout. This option has no effect unless
1500 # `[ldap] use_pool` is also enabled. (integer value)
1501 # Minimum value: -1
1502 #pool_connection_timeout = -1
1503
1504 # The maximum connection lifetime to the LDAP server in seconds. When this
1505 # lifetime is exceeded, the connection will be unbound and removed from the
1506 # connection pool. This option has no effect unless `[ldap] use_pool` is also
1507 # enabled. (integer value)
1508 # Minimum value: 1
1509 #pool_connection_lifetime = 600
1510
1511 # Enable LDAP connection pooling for end user authentication. There is
1512 # typically no reason to disable this. (boolean value)
1513 #use_auth_pool = true
1514
1515 # The size of the connection pool to use for end user authentication. This
1516 # option has no effect unless `[ldap] use_auth_pool` is also enabled. (integer
1517 # value)
1518 # Minimum value: 1
1519 #auth_pool_size = 100
1520
1521 # The maximum end user authentication connection lifetime to the LDAP server in
1522 # seconds. When this lifetime is exceeded, the connection will be unbound and
1523 # removed from the connection pool. This option has no effect unless `[ldap]
1524 # use_auth_pool` is also enabled. (integer value)
1525 # Minimum value: 1
1526 #auth_pool_connection_lifetime = 60
1527
1528
1529 [matchmaker_redis]
1530
1531 #
1532 # From oslo.messaging
1533 #
1534
1535 # DEPRECATED: Host to locate redis. (string value)
1536 # This option is deprecated for removal.
1537 # Its value may be silently ignored in the future.
1538 # Reason: Replaced by [DEFAULT]/transport_url
1539 #host = 127.0.0.1
1540
1541 # DEPRECATED: Use this port to connect to redis host. (port value)
1542 # Minimum value: 0
1543 # Maximum value: 65535
1544 # This option is deprecated for removal.
1545 # Its value may be silently ignored in the future.
1546 # Reason: Replaced by [DEFAULT]/transport_url
1547 #port = 6379
1548
1549 # DEPRECATED: Password for Redis server (optional). (string value)
1550 # This option is deprecated for removal.
1551 # Its value may be silently ignored in the future.
1552 # Reason: Replaced by [DEFAULT]/transport_url
1553 #password =
1554
1555 # DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode), e.g.,
1556 # [host:port, host1:port ... ] (list value)
1557 # This option is deprecated for removal.
1558 # Its value may be silently ignored in the future.
1559 # Reason: Replaced by [DEFAULT]/transport_url
1560 #sentinel_hosts =
1561
1562 # Redis replica set name. (string value)
1563 #sentinel_group_name = oslo-messaging-zeromq
1564
1565 # Time in ms to wait between connection attempts. (integer value)
1566 #wait_timeout = 2000
1567
1568 # Time in ms to wait before the transaction is killed. (integer value)
1569 #check_timeout = 20000
1570
1571 # Timeout in ms on blocking socket operations. (integer value)
1572 #socket_timeout = 10000
1573
1574
1575 [memcache]
1576
1577 #
1578 # From keystone
1579 #
1580
1581 # Number of seconds memcached server is considered dead before it is tried
1582 # again. This is used by the key value store system. (integer value)
1583 #dead_retry = 300
1584
1585 # Timeout in seconds for every call to a server. This is used by the key value
1586 # store system. (integer value)
1587 #socket_timeout = 3
1588
1589 # Max total number of open connections to every memcached server. This is used
1590 # by the key value store system. (integer value)
1591 #pool_maxsize = 10
1592
1593 # Number of seconds a connection to memcached is held unused in the pool before
1594 # it is closed. This is used by the key value store system. (integer value)
1595 #pool_unused_timeout = 60
1596
1597 # Number of seconds that an operation will wait to get a memcache client
1598 # connection. This is used by the key value store system. (integer value)
1599 #pool_connection_get_timeout = 10
1600
1601
1602 [oauth1]
1603
1604 #
1605 # From keystone
1606 #
1607
1608 # Entry point for the OAuth backend driver in the `keystone.oauth1` namespace.
1609 # Typically, there is no reason to set this option unless you are providing a
1610 # custom entry point. (string value)
1611 #driver = sql
1612
1613 # Number of seconds for the OAuth Request Token to remain valid after being
1614 # created. This is the amount of time the user has to authorize the token.
1615 # Setting this option to zero means that request tokens will last forever.
1616 # (integer value)
1617 # Minimum value: 0
1618 #request_token_duration = 28800
1619
1620 # Number of seconds for the OAuth Access Token to remain valid after being
1621 # created. This is the amount of time the consumer has to interact with the
1622 # service provider (which is typically keystone). Setting this option to zero
1623 # means that access tokens will last forever. (integer value)
1624 # Minimum value: 0
1625 #access_token_duration = 86400
1626
1627
1628 [oslo_messaging_amqp]
1629
1630 #
1631 # From oslo.messaging
1632 #
1633
1634 # Name for the AMQP container. must be globally unique. Defaults to a generated
1635 # UUID (string value)
1636 #container_name = <None>
1637
1638 # Timeout for inactive connections (in seconds) (integer value)
1639 #idle_timeout = 0
1640
1641 # Debug: dump AMQP frames to stdout (boolean value)
1642 #trace = false
1643
1644 # Attempt to connect via SSL. If no other ssl-related parameters are given, it
1645 # will use the system's CA-bundle to verify the server's certificate. (boolean
1646 # value)
1647 #ssl = false
1648
1649 # CA certificate PEM file used to verify the server's certificate (string
1650 # value)
1651 #ssl_ca_file =
1652
1653 # Self-identifying certificate PEM file for client authentication (string
1654 # value)
1655 #ssl_cert_file =
1656
1657 # Private key PEM file used to sign ssl_cert_file certificate (optional)
1658 # (string value)
1659 #ssl_key_file =
1660
1661 # Password for decrypting ssl_key_file (if encrypted) (string value)
1662 #ssl_key_password = <None>
1663
1664 # By default SSL checks that the name in the server's certificate matches the
1665 # hostname in the transport_url. In some configurations it may be preferable to
1666 # use the virtual hostname instead, for example if the server uses the Server
1667 # Name Indication TLS extension (rfc6066) to provide a certificate per virtual
1668 # host. Set ssl_verify_vhost to True if the server's SSL certificate uses the
1669 # virtual host name instead of the DNS name. (boolean value)
1670 #ssl_verify_vhost = false
1671
1672 # DEPRECATED: Accept clients using either SSL or plain TCP (boolean value)
1673 # This option is deprecated for removal.
1674 # Its value may be silently ignored in the future.
1675 # Reason: Not applicable - not a SSL server
1676 #allow_insecure_clients = false
1677
1678 # Space separated list of acceptable SASL mechanisms (string value)
1679 #sasl_mechanisms =
1680
1681 # Path to directory that contains the SASL configuration (string value)
1682 #sasl_config_dir =
1683
1684 # Name of configuration file (without .conf suffix) (string value)
1685 #sasl_config_name =
1686
1687 # SASL realm to use if no realm present in username (string value)
1688 #sasl_default_realm =
1689
1690 # DEPRECATED: User name for message broker authentication (string value)
1691 # This option is deprecated for removal.
1692 # Its value may be silently ignored in the future.
1693 # Reason: Should use configuration option transport_url to provide the
1694 # username.
1695 #username =
1696
1697 # DEPRECATED: Password for message broker authentication (string value)
1698 # This option is deprecated for removal.
1699 # Its value may be silently ignored in the future.
1700 # Reason: Should use configuration option transport_url to provide the
1701 # password.
1702 #password =
1703
1704 # Seconds to pause before attempting to re-connect. (integer value)
1705 # Minimum value: 1
1706 #connection_retry_interval = 1
1707
1708 # Increase the connection_retry_interval by this many seconds after each
1709 # unsuccessful failover attempt. (integer value)
1710 # Minimum value: 0
1711 #connection_retry_backoff = 2
1712
1713 # Maximum limit for connection_retry_interval + connection_retry_backoff
1714 # (integer value)
1715 # Minimum value: 1
1716 #connection_retry_interval_max = 30
1717
1718 # Time to pause between re-connecting an AMQP 1.0 link that failed due to a
1719 # recoverable error. (integer value)
1720 # Minimum value: 1
1721 #link_retry_delay = 10
1722
1723 # The maximum number of attempts to re-send a reply message which failed due to
1724 # a recoverable error. (integer value)
1725 # Minimum value: -1
1726 #default_reply_retry = 0
1727
1728 # The deadline for an rpc reply message delivery. (integer value)
1729 # Minimum value: 5
1730 #default_reply_timeout = 30
1731
1732 # The deadline for an rpc cast or call message delivery. Only used when caller
1733 # does not provide a timeout expiry. (integer value)
1734 # Minimum value: 5
1735 #default_send_timeout = 30
1736
1737 # The deadline for a sent notification message delivery. Only used when caller
1738 # does not provide a timeout expiry. (integer value)
1739 # Minimum value: 5
1740 #default_notify_timeout = 30
1741
1742 # The duration to schedule a purge of idle sender links. Detach link after
1743 # expiry. (integer value)
1744 # Minimum value: 1
1745 #default_sender_link_timeout = 600
1746
1747 # Indicates the addressing mode used by the driver.
1748 # Permitted values:
1749 # 'legacy'   - use legacy non-routable addressing
1750 # 'routable' - use routable addresses
1751 # 'dynamic'  - use legacy addresses if the message bus does not support routing
1752 # otherwise use routable addressing (string value)
1753 #addressing_mode = dynamic
1754
1755 # Enable virtual host support for those message buses that do not natively
1756 # support virtual hosting (such as qpidd). When set to true the virtual host
1757 # name will be added to all message bus addresses, effectively creating a
1758 # private 'subnet' per virtual host. Set to False if the message bus supports
1759 # virtual hosting using the 'hostname' field in the AMQP 1.0 Open performative
1760 # as the name of the virtual host. (boolean value)
1761 #pseudo_vhost = true
1762
1763 # address prefix used when sending to a specific server (string value)
1764 #server_request_prefix = exclusive
1765
1766 # address prefix used when broadcasting to all servers (string value)
1767 #broadcast_prefix = broadcast
1768
1769 # address prefix when sending to any server in group (string value)
1770 #group_request_prefix = unicast
1771
1772 # Address prefix for all generated RPC addresses (string value)
1773 #rpc_address_prefix = openstack.org/om/rpc
1774
1775 # Address prefix for all generated Notification addresses (string value)
1776 #notify_address_prefix = openstack.org/om/notify
1777
1778 # Appended to the address prefix when sending a fanout message. Used by the
1779 # message bus to identify fanout messages. (string value)
1780 #multicast_address = multicast
1781
1782 # Appended to the address prefix when sending to a particular RPC/Notification
1783 # server. Used by the message bus to identify messages sent to a single
1784 # destination. (string value)
1785 #unicast_address = unicast
1786
1787 # Appended to the address prefix when sending to a group of consumers. Used by
1788 # the message bus to identify messages that should be delivered in a round-
1789 # robin fashion across consumers. (string value)
1790 #anycast_address = anycast
1791
1792 # Exchange name used in notification addresses.
1793 # Exchange name resolution precedence:
1794 # Target.exchange if set
1795 # else default_notification_exchange if set
1796 # else control_exchange if set
1797 # else 'notify' (string value)
1798 #default_notification_exchange = <None>
1799
1800 # Exchange name used in RPC addresses.
1801 # Exchange name resolution precedence:
1802 # Target.exchange if set
1803 # else default_rpc_exchange if set
1804 # else control_exchange if set
1805 # else 'rpc' (string value)
1806 #default_rpc_exchange = <None>
1807
1808 # Window size for incoming RPC Reply messages. (integer value)
1809 # Minimum value: 1
1810 #reply_link_credit = 200
1811
1812 # Window size for incoming RPC Request messages (integer value)
1813 # Minimum value: 1
1814 #rpc_server_credit = 100
1815
1816 # Window size for incoming Notification messages (integer value)
1817 # Minimum value: 1
1818 #notify_server_credit = 100
1819
1820 # Send messages of this type pre-settled.
1821 # Pre-settled messages will not receive acknowledgement
1822 # from the peer. Note well: pre-settled messages may be
1823 # silently discarded if the delivery fails.
1824 # Permitted values:
1825 # 'rpc-call' - send RPC Calls pre-settled
1826 # 'rpc-reply'- send RPC Replies pre-settled
1827 # 'rpc-cast' - Send RPC Casts pre-settled
1828 # 'notify'   - Send Notifications pre-settled
1829 #  (multi valued)
1830 #pre_settled = rpc-cast
1831 #pre_settled = rpc-reply
1832
1833
1834 [oslo_messaging_kafka]
1835
1836 #
1837 # From oslo.messaging
1838 #
1839
1840 # DEPRECATED: Default Kafka broker Host (string value)
1841 # This option is deprecated for removal.
1842 # Its value may be silently ignored in the future.
1843 # Reason: Replaced by [DEFAULT]/transport_url
1844 #kafka_default_host = localhost
1845
1846 # DEPRECATED: Default Kafka broker Port (port value)
1847 # Minimum value: 0
1848 # Maximum value: 65535
1849 # This option is deprecated for removal.
1850 # Its value may be silently ignored in the future.
1851 # Reason: Replaced by [DEFAULT]/transport_url
1852 #kafka_default_port = 9092
1853
1854 # Max fetch bytes of Kafka consumer (integer value)
1855 #kafka_max_fetch_bytes = 1048576
1856
1857 # Default timeout(s) for Kafka consumers (floating point value)
1858 #kafka_consumer_timeout = 1.0
1859
1860 # Pool Size for Kafka Consumers (integer value)
1861 #pool_size = 10
1862
1863 # The pool size limit for connections expiration policy (integer value)
1864 #conn_pool_min_size = 2
1865
1866 # The time-to-live in sec of idle connections in the pool (integer value)
1867 #conn_pool_ttl = 1200
1868
1869 # Group id for Kafka consumer. Consumers in one group will coordinate message
1870 # consumption (string value)
1871 #consumer_group = oslo_messaging_consumer
1872
1873 # Upper bound on the delay for KafkaProducer batching in seconds (floating
1874 # point value)
1875 #producer_batch_timeout = 0.0
1876
1877 # Size of batch for the producer async send (integer value)
1878 #producer_batch_size = 16384
1879
1880
1881 [oslo_messaging_notifications]
1882
1883 #
1884 # From oslo.messaging
1885 #
1886
1887 # The Drivers(s) to handle sending notifications. Possible values are
1888 # messaging, messagingv2, routing, log, test, noop (multi valued)
1889 # Deprecated group/name - [DEFAULT]/notification_driver
1890 #driver =
1891
1892 # A URL representing the messaging driver to use for notifications. If not set,
1893 # we fall back to the same configuration used for RPC. (string value)
1894 # Deprecated group/name - [DEFAULT]/notification_transport_url
1895 #transport_url = <None>
1896
1897 # AMQP topic used for OpenStack notifications. (list value)
1898 # Deprecated group/name - [rpc_notifier2]/topics
1899 # Deprecated group/name - [DEFAULT]/notification_topics
1900 #topics = notifications
1901
1902 # The maximum number of attempts to re-send a notification message which failed
1903 # to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite
1904 # (integer value)
1905 #retry = -1
1906
1907
1908 [oslo_messaging_rabbit]
1909
1910 #
1911 # From oslo.messaging
1912 #
1913
1914 # Use durable queues in AMQP. (boolean value)
1915 # Deprecated group/name - [DEFAULT]/amqp_durable_queues
1916 # Deprecated group/name - [DEFAULT]/rabbit_durable_queues
1917 #amqp_durable_queues = false
1918
1919 # Auto-delete queues in AMQP. (boolean value)
1920 #amqp_auto_delete = false
1921
1922 # Enable SSL (boolean value)
1923 #ssl = <None>
1924
1925 # SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and
1926 # SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some
1927 # distributions. (string value)
1928 # Deprecated group/name - [oslo_messaging_rabbit]/kombu_ssl_version
1929 #ssl_version =
1930
1931 # SSL key file (valid only if SSL enabled). (string value)
1932 # Deprecated group/name - [oslo_messaging_rabbit]/kombu_ssl_keyfile
1933 #ssl_key_file =
1934
1935 # SSL cert file (valid only if SSL enabled). (string value)
1936 # Deprecated group/name - [oslo_messaging_rabbit]/kombu_ssl_certfile
1937 #ssl_cert_file =
1938
1939 # SSL certification authority file (valid only if SSL enabled). (string value)
1940 # Deprecated group/name - [oslo_messaging_rabbit]/kombu_ssl_ca_certs
1941 #ssl_ca_file =
1942
1943 # How long to wait before reconnecting in response to an AMQP consumer cancel
1944 # notification. (floating point value)
1945 #kombu_reconnect_delay = 1.0
1946
1947 # EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not
1948 # be used. This option may not be available in future versions. (string value)
1949 #kombu_compression = <None>
1950
1951 # How long to wait a missing client before abandoning to send it its replies.
1952 # This value should not be longer than rpc_response_timeout. (integer value)
1953 # Deprecated group/name - [oslo_messaging_rabbit]/kombu_reconnect_timeout
1954 #kombu_missing_consumer_retry_timeout = 60
1955
1956 # Determines how the next RabbitMQ node is chosen in case the one we are
1957 # currently connected to becomes unavailable. Takes effect only if more than
1958 # one RabbitMQ node is provided in config. (string value)
1959 # Possible values:
1960 # round-robin - <No description provided>
1961 # shuffle - <No description provided>
1962 #kombu_failover_strategy = round-robin
1963
1964 # DEPRECATED: The RabbitMQ broker address where a single node is used. (string
1965 # value)
1966 # This option is deprecated for removal.
1967 # Its value may be silently ignored in the future.
1968 # Reason: Replaced by [DEFAULT]/transport_url
1969 #rabbit_host = localhost
1970
1971 # DEPRECATED: The RabbitMQ broker port where a single node is used. (port
1972 # value)
1973 # Minimum value: 0
1974 # Maximum value: 65535
1975 # This option is deprecated for removal.
1976 # Its value may be silently ignored in the future.
1977 # Reason: Replaced by [DEFAULT]/transport_url
1978 #rabbit_port = 5672
1979
1980 # DEPRECATED: RabbitMQ HA cluster host:port pairs. (list value)
1981 # This option is deprecated for removal.
1982 # Its value may be silently ignored in the future.
1983 # Reason: Replaced by [DEFAULT]/transport_url
1984 #rabbit_hosts = $rabbit_host:$rabbit_port
1985
1986 # DEPRECATED: The RabbitMQ userid. (string value)
1987 # This option is deprecated for removal.
1988 # Its value may be silently ignored in the future.
1989 # Reason: Replaced by [DEFAULT]/transport_url
1990 #rabbit_userid = guest
1991
1992 # DEPRECATED: The RabbitMQ password. (string value)
1993 # This option is deprecated for removal.
1994 # Its value may be silently ignored in the future.
1995 # Reason: Replaced by [DEFAULT]/transport_url
1996 #rabbit_password = guest
1997
1998 # The RabbitMQ login method. (string value)
1999 # Possible values:
2000 # PLAIN - <No description provided>
2001 # AMQPLAIN - <No description provided>
2002 # RABBIT-CR-DEMO - <No description provided>
2003 #rabbit_login_method = AMQPLAIN
2004
2005 # DEPRECATED: The RabbitMQ virtual host. (string value)
2006 # This option is deprecated for removal.
2007 # Its value may be silently ignored in the future.
2008 # Reason: Replaced by [DEFAULT]/transport_url
2009 #rabbit_virtual_host = /
2010
2011 # How frequently to retry connecting with RabbitMQ. (integer value)
2012 #rabbit_retry_interval = 1
2013
2014 # How long to backoff for between retries when connecting to RabbitMQ. (integer
2015 # value)
2016 #rabbit_retry_backoff = 2
2017
2018 # Maximum interval of RabbitMQ connection retries. Default is 30 seconds.
2019 # (integer value)
2020 #rabbit_interval_max = 30
2021
2022 # DEPRECATED: Maximum number of RabbitMQ connection retries. Default is 0
2023 # (infinite retry count). (integer value)
2024 # This option is deprecated for removal.
2025 # Its value may be silently ignored in the future.
2026 #rabbit_max_retries = 0
2027
2028 # Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this
2029 # option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring
2030 # is no longer controlled by the x-ha-policy argument when declaring a queue.
2031 # If you just want to make sure that all queues (except those with auto-
2032 # generated names) are mirrored across all nodes, run: "rabbitmqctl set_policy
2033 # HA '^(?!amq\.).*' '{"ha-mode": "all"}' " (boolean value)
2034 #rabbit_ha_queues = false
2035
2036 # Positive integer representing duration in seconds for queue TTL (x-expires).
2037 # Queues which are unused for the duration of the TTL are automatically
2038 # deleted. The parameter affects only reply and fanout queues. (integer value)
2039 # Minimum value: 1
2040 #rabbit_transient_queues_ttl = 1800
2041
2042 # Specifies the number of messages to prefetch. Setting to zero allows
2043 # unlimited messages. (integer value)
2044 #rabbit_qos_prefetch_count = 0
2045
2046 # Number of seconds after which the Rabbit broker is considered down if
2047 # heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL (integer
2048 # value)
2049 #heartbeat_timeout_threshold = 60
2050
2051 # How often times during the heartbeat_timeout_threshold we check the
2052 # heartbeat. (integer value)
2053 #heartbeat_rate = 2
2054
2055 # Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake (boolean value)
2056 #fake_rabbit = false
2057
2058 # Maximum number of channels to allow (integer value)
2059 #channel_max = <None>
2060
2061 # The maximum byte size for an AMQP frame (integer value)
2062 #frame_max = <None>
2063
2064 # How often to send heartbeats for consumer's connections (integer value)
2065 #heartbeat_interval = 3
2066
2067 # Arguments passed to ssl.wrap_socket (dict value)
2068 #ssl_options = <None>
2069
2070 # Set socket timeout in seconds for connection's socket (floating point value)
2071 #socket_timeout = 0.25
2072
2073 # Set TCP_USER_TIMEOUT in seconds for connection's socket (floating point
2074 # value)
2075 #tcp_user_timeout = 0.25
2076
2077 # Set delay for reconnection to some host which has connection error (floating
2078 # point value)
2079 #host_connection_reconnect_delay = 0.25
2080
2081 # Connection factory implementation (string value)
2082 # Possible values:
2083 # new - <No description provided>
2084 # single - <No description provided>
2085 # read_write - <No description provided>
2086 #connection_factory = single
2087
2088 # Maximum number of connections to keep queued. (integer value)
2089 #pool_max_size = 30
2090
2091 # Maximum number of connections to create above `pool_max_size`. (integer
2092 # value)
2093 #pool_max_overflow = 0
2094
2095 # Default number of seconds to wait for a connections to available (integer
2096 # value)
2097 #pool_timeout = 30
2098
2099 # Lifetime of a connection (since creation) in seconds or None for no
2100 # recycling. Expired connections are closed on acquire. (integer value)
2101 #pool_recycle = 600
2102
2103 # Threshold at which inactive (since release) connections are considered stale
2104 # in seconds or None for no staleness. Stale connections are closed on acquire.
2105 # (integer value)
2106 #pool_stale = 60
2107
2108 # Default serialization mechanism for serializing/deserializing
2109 # outgoing/incoming messages (string value)
2110 # Possible values:
2111 # json - <No description provided>
2112 # msgpack - <No description provided>
2113 #default_serializer_type = json
2114
2115 # Persist notification messages. (boolean value)
2116 #notification_persistence = false
2117
2118 # Exchange name for sending notifications (string value)
2119 #default_notification_exchange = ${control_exchange}_notification
2120
2121 # Max number of not acknowledged message which RabbitMQ can send to
2122 # notification listener. (integer value)
2123 #notification_listener_prefetch_count = 100
2124
2125 # Reconnecting retry count in case of connectivity problem during sending
2126 # notification, -1 means infinite retry. (integer value)
2127 #default_notification_retry_attempts = -1
2128
2129 # Reconnecting retry delay in case of connectivity problem during sending
2130 # notification message (floating point value)
2131 #notification_retry_delay = 0.25
2132
2133 # Time to live for rpc queues without consumers in seconds. (integer value)
2134 #rpc_queue_expiration = 60
2135
2136 # Exchange name for sending RPC messages (string value)
2137 #default_rpc_exchange = ${control_exchange}_rpc
2138
2139 # Exchange name for receiving RPC replies (string value)
2140 #rpc_reply_exchange = ${control_exchange}_rpc_reply
2141
2142 # Max number of not acknowledged message which RabbitMQ can send to rpc
2143 # listener. (integer value)
2144 #rpc_listener_prefetch_count = 100
2145
2146 # Max number of not acknowledged message which RabbitMQ can send to rpc reply
2147 # listener. (integer value)
2148 #rpc_reply_listener_prefetch_count = 100
2149
2150 # Reconnecting retry count in case of connectivity problem during sending
2151 # reply. -1 means infinite retry during rpc_timeout (integer value)
2152 #rpc_reply_retry_attempts = -1
2153
2154 # Reconnecting retry delay in case of connectivity problem during sending
2155 # reply. (floating point value)
2156 #rpc_reply_retry_delay = 0.25
2157
2158 # Reconnecting retry count in case of connectivity problem during sending RPC
2159 # message, -1 means infinite retry. If actual retry attempts in not 0 the rpc
2160 # request could be processed more than one time (integer value)
2161 #default_rpc_retry_attempts = -1
2162
2163 # Reconnecting retry delay in case of connectivity problem during sending RPC
2164 # message (floating point value)
2165 #rpc_retry_delay = 0.25
2166
2167
2168 [oslo_messaging_zmq]
2169
2170 #
2171 # From oslo.messaging
2172 #
2173
2174 # ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP.
2175 # The "host" option should point or resolve to this address. (string value)
2176 #rpc_zmq_bind_address = *
2177
2178 # MatchMaker driver. (string value)
2179 # Possible values:
2180 # redis - <No description provided>
2181 # sentinel - <No description provided>
2182 # dummy - <No description provided>
2183 #rpc_zmq_matchmaker = redis
2184
2185 # Number of ZeroMQ contexts, defaults to 1. (integer value)
2186 #rpc_zmq_contexts = 1
2187
2188 # Maximum number of ingress messages to locally buffer per topic. Default is
2189 # unlimited. (integer value)
2190 #rpc_zmq_topic_backlog = <None>
2191
2192 # Directory for holding IPC sockets. (string value)
2193 #rpc_zmq_ipc_dir = /var/run/openstack
2194
2195 # Name of this node. Must be a valid hostname, FQDN, or IP address. Must match
2196 # "host" option, if running Nova. (string value)
2197 #rpc_zmq_host = localhost
2198
2199 # Number of seconds to wait before all pending messages will be sent after
2200 # closing a socket. The default value of -1 specifies an infinite linger
2201 # period. The value of 0 specifies no linger period. Pending messages shall be
2202 # discarded immediately when the socket is closed. Positive values specify an
2203 # upper bound for the linger period. (integer value)
2204 # Deprecated group/name - [DEFAULT]/rpc_cast_timeout
2205 #zmq_linger = -1
2206
2207 # The default number of seconds that poll should wait. Poll raises timeout
2208 # exception when timeout expired. (integer value)
2209 #rpc_poll_timeout = 1
2210
2211 # Expiration timeout in seconds of a name service record about existing target
2212 # ( < 0 means no timeout). (integer value)
2213 #zmq_target_expire = 300
2214
2215 # Update period in seconds of a name service record about existing target.
2216 # (integer value)
2217 #zmq_target_update = 180
2218
2219 # Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. (boolean
2220 # value)
2221 #use_pub_sub = false
2222
2223 # Use ROUTER remote proxy. (boolean value)
2224 #use_router_proxy = false
2225
2226 # This option makes direct connections dynamic or static. It makes sense only
2227 # with use_router_proxy=False which means to use direct connections for direct
2228 # message types (ignored otherwise). (boolean value)
2229 #use_dynamic_connections = false
2230
2231 # How many additional connections to a host will be made for failover reasons.
2232 # This option is actual only in dynamic connections mode. (integer value)
2233 #zmq_failover_connections = 2
2234
2235 # Minimal port number for random ports range. (port value)
2236 # Minimum value: 0
2237 # Maximum value: 65535
2238 #rpc_zmq_min_port = 49153
2239
2240 # Maximal port number for random ports range. (integer value)
2241 # Minimum value: 1
2242 # Maximum value: 65536
2243 #rpc_zmq_max_port = 65536
2244
2245 # Number of retries to find free port number before fail with ZMQBindError.
2246 # (integer value)
2247 #rpc_zmq_bind_port_retries = 100
2248
2249 # Default serialization mechanism for serializing/deserializing
2250 # outgoing/incoming messages (string value)
2251 # Possible values:
2252 # json - <No description provided>
2253 # msgpack - <No description provided>
2254 #rpc_zmq_serialization = json
2255
2256 # This option configures round-robin mode in zmq socket. True means not keeping
2257 # a queue when server side disconnects. False means to keep queue and messages
2258 # even if server is disconnected, when the server appears we send all
2259 # accumulated messages to it. (boolean value)
2260 #zmq_immediate = true
2261
2262 # Enable/disable TCP keepalive (KA) mechanism. The default value of -1 (or any
2263 # other negative value) means to skip any overrides and leave it to OS default;
2264 # 0 and 1 (or any other positive value) mean to disable and enable the option
2265 # respectively. (integer value)
2266 #zmq_tcp_keepalive = -1
2267
2268 # The duration between two keepalive transmissions in idle condition. The unit
2269 # is platform dependent, for example, seconds in Linux, milliseconds in Windows
2270 # etc. The default value of -1 (or any other negative value and 0) means to
2271 # skip any overrides and leave it to OS default. (integer value)
2272 #zmq_tcp_keepalive_idle = -1
2273
2274 # The number of retransmissions to be carried out before declaring that remote
2275 # end is not available. The default value of -1 (or any other negative value
2276 # and 0) means to skip any overrides and leave it to OS default. (integer
2277 # value)
2278 #zmq_tcp_keepalive_cnt = -1
2279
2280 # The duration between two successive keepalive retransmissions, if
2281 # acknowledgement to the previous keepalive transmission is not received. The
2282 # unit is platform dependent, for example, seconds in Linux, milliseconds in
2283 # Windows etc. The default value of -1 (or any other negative value and 0)
2284 # means to skip any overrides and leave it to OS default. (integer value)
2285 #zmq_tcp_keepalive_intvl = -1
2286
2287 # Maximum number of (green) threads to work concurrently. (integer value)
2288 #rpc_thread_pool_size = 100
2289
2290 # Expiration timeout in seconds of a sent/received message after which it is
2291 # not tracked anymore by a client/server. (integer value)
2292 #rpc_message_ttl = 300
2293
2294 # Wait for message acknowledgements from receivers. This mechanism works only
2295 # via proxy without PUB/SUB. (boolean value)
2296 #rpc_use_acks = false
2297
2298 # Number of seconds to wait for an ack from a cast/call. After each retry
2299 # attempt this timeout is multiplied by some specified multiplier. (integer
2300 # value)
2301 #rpc_ack_timeout_base = 15
2302
2303 # Number to multiply base ack timeout by after each retry attempt. (integer
2304 # value)
2305 #rpc_ack_timeout_multiplier = 2
2306
2307 # Default number of message sending attempts in case of any problems occurred:
2308 # positive value N means at most N retries, 0 means no retries, None or -1 (or
2309 # any other negative values) mean to retry forever. This option is used only if
2310 # acknowledgments are enabled. (integer value)
2311 #rpc_retry_attempts = 3
2312
2313 # List of publisher hosts SubConsumer can subscribe on. This option has higher
2314 # priority then the default publishers list taken from the matchmaker. (list
2315 # value)
2316 #subscribe_on =
2317
2318
2319 [oslo_middleware]
2320
2321 #
2322 # From oslo.middleware
2323 #
2324
2325 # The maximum body size for each  request, in bytes. (integer value)
2326 # Deprecated group/name - [DEFAULT]/osapi_max_request_body_size
2327 # Deprecated group/name - [DEFAULT]/max_request_body_size
2328 #max_request_body_size = 114688
2329
2330 # DEPRECATED: The HTTP Header that will be used to determine what the original
2331 # request protocol scheme was, even if it was hidden by a SSL termination
2332 # proxy. (string value)
2333 # This option is deprecated for removal.
2334 # Its value may be silently ignored in the future.
2335 #secure_proxy_ssl_header = X-Forwarded-Proto
2336
2337 # Whether the application is behind a proxy or not. This determines if the
2338 # middleware should parse the headers or not. (boolean value)
2339 #enable_proxy_headers_parsing = false
2340
2341
2342 [oslo_policy]
2343
2344 #
2345 # From oslo.policy
2346 #
2347
2348 # This option controls whether or not to enforce scope when evaluating
2349 # policies. If ``True``, the scope of the token used in the request is compared
2350 # to the ``scope_types`` of the policy being enforced. If the scopes do not
2351 # match, an ``InvalidScope`` exception will be raised. If ``False``, a message
2352 # will be logged informing operators that policies are being invoked with
2353 # mismatching scope. (boolean value)
2354 #enforce_scope = false
2355
2356 # The file that defines policies. (string value)
2357 #policy_file = policy.json
2358
2359 # Default rule. Enforced when a requested rule is not found. (string value)
2360 #policy_default_rule = default
2361
2362 # Directories where policy configuration files are stored. They can be relative
2363 # to any directory in the search path defined by the config_dir option, or
2364 # absolute paths. The file defined by policy_file must exist for these
2365 # directories to be searched.  Missing or empty directories are ignored. (multi
2366 # valued)
2367 #policy_dirs = policy.d
2368
2369 # Content Type to send and receive data for REST based policy check (string
2370 # value)
2371 # Possible values:
2372 # application/x-www-form-urlencoded - <No description provided>
2373 # application/json - <No description provided>
2374 #remote_content_type = application/x-www-form-urlencoded
2375
2376 # server identity verification for REST based policy check (boolean value)
2377 #remote_ssl_verify_server_crt = false
2378
2379 # Absolute path to ca cert file for REST based policy check (string value)
2380 #remote_ssl_ca_crt_file = <None>
2381
2382 # Absolute path to client cert for REST based policy check (string value)
2383 #remote_ssl_client_crt_file = <None>
2384
2385 # Absolute path client key file REST based policy check (string value)
2386 #remote_ssl_client_key_file = <None>
2387
2388
2389 [policy]
2390
2391 #
2392 # From keystone
2393 #
2394
2395 # Entry point for the policy backend driver in the `keystone.policy` namespace.
2396 # Supplied drivers are `rules` (which does not support any CRUD operations for
2397 # the v3 policy API) and `sql`. Typically, there is no reason to set this
2398 # option unless you are providing a custom entry point. (string value)
2399 #driver = sql
2400
2401 # Maximum number of entities that will be returned in a policy collection.
2402 # (integer value)
2403 #list_limit = <None>
2404
2405
2406 [profiler]
2407
2408 #
2409 # From osprofiler
2410 #
2411
2412 #
2413 # Enables the profiling for all services on this node. Default value is False
2414 # (fully disable the profiling feature).
2415 #
2416 # Possible values:
2417 #
2418 # * True: Enables the feature
2419 # * False: Disables the feature. The profiling cannot be started via this
2420 # project
2421 # operations. If the profiling is triggered by another project, this project
2422 # part
2423 # will be empty.
2424 #  (boolean value)
2425 # Deprecated group/name - [profiler]/profiler_enabled
2426 #enabled = false
2427
2428 #
2429 # Enables SQL requests profiling in services. Default value is False (SQL
2430 # requests won't be traced).
2431 #
2432 # Possible values:
2433 #
2434 # * True: Enables SQL requests profiling. Each SQL query will be part of the
2435 # trace and can the be analyzed by how much time was spent for that.
2436 # * False: Disables SQL requests profiling. The spent time is only shown on a
2437 # higher level of operations. Single SQL queries cannot be analyzed this
2438 # way.
2439 #  (boolean value)
2440 #trace_sqlalchemy = false
2441
2442 #
2443 # Secret key(s) to use for encrypting context data for performance profiling.
2444 # This string value should have the following format:
2445 # <key1>[,<key2>,...<keyn>],
2446 # where each key is some random string. A user who triggers the profiling via
2447 # the REST API has to set one of these keys in the headers of the REST API call
2448 # to include profiling results of this node for this particular project.
2449 #
2450 # Both "enabled" flag and "hmac_keys" config options should be set to enable
2451 # profiling. Also, to generate correct profiling information across all
2452 # services
2453 # at least one key needs to be consistent between OpenStack projects. This
2454 # ensures it can be used from client side to generate the trace, containing
2455 # information from all possible resources. (string value)
2456 #hmac_keys = SECRET_KEY
2457
2458 #
2459 # Connection string for a notifier backend. Default value is messaging:// which
2460 # sets the notifier to oslo_messaging.
2461 #
2462 # Examples of possible values:
2463 #
2464 # * messaging://: use oslo_messaging driver for sending notifications.
2465 # * mongodb://127.0.0.1:27017 : use mongodb driver for sending notifications.
2466 # * elasticsearch://127.0.0.1:9200 : use elasticsearch driver for sending
2467 # notifications.
2468 #  (string value)
2469 #connection_string = messaging://
2470
2471 #
2472 # Document type for notification indexing in elasticsearch.
2473 #  (string value)
2474 #es_doc_type = notification
2475
2476 #
2477 # This parameter is a time value parameter (for example: es_scroll_time=2m),
2478 # indicating for how long the nodes that participate in the search will
2479 # maintain
2480 # relevant resources in order to continue and support it.
2481 #  (string value)
2482 #es_scroll_time = 2m
2483
2484 #
2485 # Elasticsearch splits large requests in batches. This parameter defines
2486 # maximum size of each batch (for example: es_scroll_size=10000).
2487 #  (integer value)
2488 #es_scroll_size = 10000
2489
2490 #
2491 # Redissentinel provides a timeout option on the connections.
2492 # This parameter defines that timeout (for example: socket_timeout=0.1).
2493 #  (floating point value)
2494 #socket_timeout = 0.1
2495
2496 #
2497 # Redissentinel uses a service name to identify a master redis service.
2498 # This parameter defines the name (for example:
2499 # sentinal_service_name=mymaster).
2500 #  (string value)
2501 #sentinel_service_name = mymaster
2502
2503
2504 [receipt]
2505
2506 #
2507 # From keystone
2508 #
2509
2510 # The amount of time that a receipt should remain valid (in seconds). This
2511 # value should always be very short, as it represents how long a user has to
2512 # reattempt auth with the missing auth methods. (integer value)
2513 # Minimum value: 0
2514 # Maximum value: 86400
2515 #expiration = 300
2516
2517 # Entry point for the receipt provider in the `keystone.receipt.provider`
2518 # namespace. The receipt provider controls the receipt construction and
2519 # validation operations. Keystone includes just the `fernet` receipt provider
2520 # for now. `fernet` receipts do not need to be persisted at all, but require
2521 # that you run `keystone-manage fernet_setup` (also see the `keystone-manage
2522 # fernet_rotate` command). (string value)
2523 #provider = fernet
2524
2525 # Toggle for caching receipt creation and validation data. This has no effect
2526 # unless global caching is enabled, or if cache_on_issue is disabled as we only
2527 # cache receipts on issue. (boolean value)
2528 #caching = true
2529
2530 # The number of seconds to cache receipt creation and validation data. This has
2531 # no effect unless both global and `[receipt] caching` are enabled. (integer
2532 # value)
2533 # Minimum value: 0
2534 #cache_time = 300
2535
2536 # Enable storing issued receipt data to receipt validation cache so that first
2537 # receipt validation doesn't actually cause full validation cycle. This option
2538 # has no effect unless global caching and receipt caching are enabled. (boolean
2539 # value)
2540 #cache_on_issue = true
2541
2542
2543 [resource]
2544
2545 #
2546 # From keystone
2547 #
2548
2549 # DEPRECATED: Entry point for the resource driver in the `keystone.resource`
2550 # namespace. Only a `sql` driver is supplied by keystone. Unless you are
2551 # writing proprietary drivers for keystone, you do not need to set this option.
2552 # (string value)
2553 # This option is deprecated for removal since P.
2554 # Its value may be silently ignored in the future.
2555 # Reason: Non-SQL resource cannot be used with SQL Identity and has been unable
2556 # to be used since Ocata. SQL Resource backend is a requirement as of Pike.
2557 # Setting this option no longer has an effect on how Keystone operates.
2558 #driver = sql
2559
2560 # Toggle for resource caching. This has no effect unless global caching is
2561 # enabled. (boolean value)
2562 # Deprecated group/name - [assignment]/caching
2563 #caching = true
2564
2565 # Time to cache resource data in seconds. This has no effect unless global
2566 # caching is enabled. (integer value)
2567 # Deprecated group/name - [assignment]/cache_time
2568 #cache_time = <None>
2569
2570 # Maximum number of entities that will be returned in a resource collection.
2571 # (integer value)
2572 # Deprecated group/name - [assignment]/list_limit
2573 #list_limit = <None>
2574
2575 # Name of the domain that owns the `admin_project_name`. If left unset, then
2576 # there is no admin project. `[resource] admin_project_name` must also be set
2577 # to use this option. (string value)
2578 #admin_project_domain_name = <None>
2579
2580 # This is a special project which represents cloud-level administrator
2581 # privileges across services. Tokens scoped to this project will contain a true
2582 # `is_admin_project` attribute to indicate to policy systems that the role
2583 # assignments on that specific project should apply equally across every
2584 # project. If left unset, then there is no admin project, and thus no explicit
2585 # means of cross-project role assignments. `[resource]
2586 # admin_project_domain_name` must also be set to use this option. (string
2587 # value)
2588 #admin_project_name = <None>
2589
2590 # This controls whether the names of projects are restricted from containing
2591 # URL-reserved characters. If set to `new`, attempts to create or update a
2592 # project with a URL-unsafe name will fail. If set to `strict`, attempts to
2593 # scope a token with a URL-unsafe project name will fail, thereby forcing all
2594 # project names to be updated to be URL-safe. (string value)
2595 # Possible values:
2596 # off - <No description provided>
2597 # new - <No description provided>
2598 # strict - <No description provided>
2599 #project_name_url_safe = off
2600
2601 # This controls whether the names of domains are restricted from containing
2602 # URL-reserved characters. If set to `new`, attempts to create or update a
2603 # domain with a URL-unsafe name will fail. If set to `strict`, attempts to
2604 # scope a token with a URL-unsafe domain name will fail, thereby forcing all
2605 # domain names to be updated to be URL-safe. (string value)
2606 # Possible values:
2607 # off - <No description provided>
2608 # new - <No description provided>
2609 # strict - <No description provided>
2610 #domain_name_url_safe = off
2611
2612
2613 [revoke]
2614
2615 #
2616 # From keystone
2617 #
2618
2619 # Entry point for the token revocation backend driver in the `keystone.revoke`
2620 # namespace. Keystone only provides a `sql` driver, so there is no reason to
2621 # set this option unless you are providing a custom entry point. (string value)
2622 #driver = sql
2623
2624 # The number of seconds after a token has expired before a corresponding
2625 # revocation event may be purged from the backend. (integer value)
2626 # Minimum value: 0
2627 #expiration_buffer = 1800
2628
2629 # Toggle for revocation event caching. This has no effect unless global caching
2630 # is enabled. (boolean value)
2631 #caching = true
2632
2633 # Time to cache the revocation list and the revocation events (in seconds).
2634 # This has no effect unless global and `[revoke] caching` are both enabled.
2635 # (integer value)
2636 # Deprecated group/name - [token]/revocation_cache_time
2637 #cache_time = 3600
2638
2639
2640 [role]
2641
2642 #
2643 # From keystone
2644 #
2645
2646 # Entry point for the role backend driver in the `keystone.role` namespace.
2647 # Keystone only provides a `sql` driver, so there's no reason to change this
2648 # unless you are providing a custom entry point. (string value)
2649 #driver = <None>
2650
2651 # Toggle for role caching. This has no effect unless global caching is enabled.
2652 # In a typical deployment, there is no reason to disable this. (boolean value)
2653 #caching = true
2654
2655 # Time to cache role data, in seconds. This has no effect unless both global
2656 # caching and `[role] caching` are enabled. (integer value)
2657 #cache_time = <None>
2658
2659 # Maximum number of entities that will be returned in a role collection. This
2660 # may be useful to tune if you have a large number of discrete roles in your
2661 # deployment. (integer value)
2662 #list_limit = <None>
2663
2664
2665 [saml]
2666
2667 #
2668 # From keystone
2669 #
2670
2671 # Determines the lifetime for any SAML assertions generated by keystone, using
2672 # `NotOnOrAfter` attributes. (integer value)
2673 #assertion_expiration_time = 3600
2674
2675 # Name of, or absolute path to, the binary to be used for XML signing. Although
2676 # only the XML Security Library (`xmlsec1`) is supported, it may have a non-
2677 # standard name or path on your system. If keystone cannot find the binary
2678 # itself, you may need to install the appropriate package, use this option to
2679 # specify an absolute path, or adjust keystone's PATH environment variable.
2680 # (string value)
2681 #xmlsec1_binary = xmlsec1
2682
2683 # Absolute path to the public certificate file to use for SAML signing. The
2684 # value cannot contain a comma (`,`). (string value)
2685 #certfile = /etc/keystone/ssl/certs/signing_cert.pem
2686
2687 # Absolute path to the private key file to use for SAML signing. The value
2688 # cannot contain a comma (`,`). (string value)
2689 #keyfile = /etc/keystone/ssl/private/signing_key.pem
2690
2691 # This is the unique entity identifier of the identity provider (keystone) to
2692 # use when generating SAML assertions. This value is required to generate
2693 # identity provider metadata and must be a URI (a URL is recommended). For
2694 # example: `https://keystone.example.com/v3/OS-FEDERATION/saml2/idp`. (uri
2695 # value)
2696 #idp_entity_id = <None>
2697
2698 # This is the single sign-on (SSO) service location of the identity provider
2699 # which accepts HTTP POST requests. A value is required to generate identity
2700 # provider metadata. For example: `https://keystone.example.com/v3/OS-
2701 # FEDERATION/saml2/sso`. (uri value)
2702 #idp_sso_endpoint = <None>
2703
2704 # This is the language used by the identity provider's organization. (string
2705 # value)
2706 #idp_lang = en
2707
2708 # This is the name of the identity provider's organization. (string value)
2709 #idp_organization_name = SAML Identity Provider
2710
2711 # This is the name of the identity provider's organization to be displayed.
2712 # (string value)
2713 #idp_organization_display_name = OpenStack SAML Identity Provider
2714
2715 # This is the URL of the identity provider's organization. The URL referenced
2716 # here should be useful to humans. (uri value)
2717 #idp_organization_url = https://example.com/
2718
2719 # This is the company name of the identity provider's contact person. (string
2720 # value)
2721 #idp_contact_company = Example, Inc.
2722
2723 # This is the given name of the identity provider's contact person. (string
2724 # value)
2725 #idp_contact_name = SAML Identity Provider Support
2726
2727 # This is the surname of the identity provider's contact person. (string value)
2728 #idp_contact_surname = Support
2729
2730 # This is the email address of the identity provider's contact person. (string
2731 # value)
2732 #idp_contact_email = support@example.com
2733
2734 # This is the telephone number of the identity provider's contact person.
2735 # (string value)
2736 #idp_contact_telephone = +1 800 555 0100
2737
2738 # This is the type of contact that best describes the identity provider's
2739 # contact person. (string value)
2740 # Possible values:
2741 # technical - <No description provided>
2742 # support - <No description provided>
2743 # administrative - <No description provided>
2744 # billing - <No description provided>
2745 # other - <No description provided>
2746 #idp_contact_type = other
2747
2748 # Absolute path to the identity provider metadata file. This file should be
2749 # generated with the `keystone-manage saml_idp_metadata` command. There is
2750 # typically no reason to change this value. (string value)
2751 #idp_metadata_path = /etc/keystone/saml2_idp_metadata.xml
2752
2753 # The prefix of the RelayState SAML attribute to use when generating enhanced
2754 # client and proxy (ECP) assertions. In a typical deployment, there is no
2755 # reason to change this value. (string value)
2756 #relay_state_prefix = ss:mem:
2757
2758
2759 [security_compliance]
2760
2761 #
2762 # From keystone
2763 #
2764
2765 # The maximum number of days a user can go without authenticating before being
2766 # considered "inactive" and automatically disabled (locked). This feature is
2767 # disabled by default; set any value to enable it. This feature depends on the
2768 # `sql` backend for the `[identity] driver`. When a user exceeds this threshold
2769 # and is considered "inactive", the user's `enabled` attribute in the HTTP API
2770 # may not match the value of the user's `enabled` column in the user table.
2771 # (integer value)
2772 # Minimum value: 1
2773 #disable_user_account_days_inactive = <None>
2774
2775 # The maximum number of times that a user can fail to authenticate before the
2776 # user account is locked for the number of seconds specified by
2777 # `[security_compliance] lockout_duration`. This feature is disabled by
2778 # default. If this feature is enabled and `[security_compliance]
2779 # lockout_duration` is not set, then users may be locked out indefinitely until
2780 # the user is explicitly enabled via the API. This feature depends on the `sql`
2781 # backend for the `[identity] driver`. (integer value)
2782 # Minimum value: 1
2783 #lockout_failure_attempts = <None>
2784
2785 # The number of seconds a user account will be locked when the maximum number
2786 # of failed authentication attempts (as specified by `[security_compliance]
2787 # lockout_failure_attempts`) is exceeded. Setting this option will have no
2788 # effect unless you also set `[security_compliance] lockout_failure_attempts`
2789 # to a non-zero value. This feature depends on the `sql` backend for the
2790 # `[identity] driver`. (integer value)
2791 # Minimum value: 1
2792 #lockout_duration = 1800
2793
2794 # The number of days for which a password will be considered valid before
2795 # requiring it to be changed. This feature is disabled by default. If enabled,
2796 # new password changes will have an expiration date, however existing passwords
2797 # would not be impacted. This feature depends on the `sql` backend for the
2798 # `[identity] driver`. (integer value)
2799 # Minimum value: 1
2800 #password_expires_days = <None>
2801
2802 # This controls the number of previous user password iterations to keep in
2803 # history, in order to enforce that newly created passwords are unique. The
2804 # total number which includes the new password should not be greater or equal
2805 # to this value. Setting the value to zero (the default) disables this feature.
2806 # Thus, to enable this feature, values must be greater than 0. This feature
2807 # depends on the `sql` backend for the `[identity] driver`. (integer value)
2808 # Minimum value: 0
2809 #unique_last_password_count = 0
2810
2811 # The number of days that a password must be used before the user can change
2812 # it. This prevents users from changing their passwords immediately in order to
2813 # wipe out their password history and reuse an old password. This feature does
2814 # not prevent administrators from manually resetting passwords. It is disabled
2815 # by default and allows for immediate password changes. This feature depends on
2816 # the `sql` backend for the `[identity] driver`. Note: If
2817 # `[security_compliance] password_expires_days` is set, then the value for this
2818 # option should be less than the `password_expires_days`. (integer value)
2819 # Minimum value: 0
2820 #minimum_password_age = 0
2821
2822 # The regular expression used to validate password strength requirements. By
2823 # default, the regular expression will match any password. The following is an
2824 # example of a pattern which requires at least 1 letter, 1 digit, and have a
2825 # minimum length of 7 characters: ^(?=.*\d)(?=.*[a-zA-Z]).{7,}$ This feature
2826 # depends on the `sql` backend for the `[identity] driver`. (string value)
2827 #password_regex = <None>
2828
2829 # Describe your password regular expression here in language for humans. If a
2830 # password fails to match the regular expression, the contents of this
2831 # configuration variable will be returned to users to explain why their
2832 # requested password was insufficient. (string value)
2833 #password_regex_description = <None>
2834
2835 # Enabling this option requires users to change their password when the user is
2836 # created, or upon administrative reset. Before accessing any services,
2837 # affected users will have to change their password. To ignore this requirement
2838 # for specific users, such as service users, set the `options` attribute
2839 # `ignore_change_password_upon_first_use` to `True` for the desired user via
2840 # the update user API. This feature is disabled by default. This feature is
2841 # only applicable with the `sql` backend for the `[identity] driver`. (boolean
2842 # value)
2843 #change_password_upon_first_use = false
2844
2845
2846 [shadow_users]
2847
2848 #
2849 # From keystone
2850 #
2851
2852 # Entry point for the shadow users backend driver in the
2853 # `keystone.identity.shadow_users` namespace. This driver is used for
2854 # persisting local user references to externally-managed identities (via
2855 # federation, LDAP, etc). Keystone only provides a `sql` driver, so there is no
2856 # reason to change this option unless you are providing a custom entry point.
2857 # (string value)
2858 #driver = sql
2859
2860
2861 [signing]
2862
2863 #
2864 # From keystone
2865 #
2866
2867 # DEPRECATED: Absolute path to the public certificate file to use for signing
2868 # responses to revocation lists requests. Set this together with `[signing]
2869 # keyfile`. For non-production environments, you may be interested in using
2870 # `keystone-manage pki_setup` to generate self-signed certificates. (string
2871 # value)
2872 # This option is deprecated for removal since P.
2873 # Its value may be silently ignored in the future.
2874 # Reason: `keystone-manage pki_setup` was deprecated in Mitaka and removed in
2875 # Pike. These options remain for backwards compatibility.
2876 #certfile = /etc/keystone/ssl/certs/signing_cert.pem
2877
2878 # DEPRECATED: Absolute path to the private key file to use for signing
2879 # responses to revocation lists requests. Set this together with `[signing]
2880 # certfile`. (string value)
2881 # This option is deprecated for removal since P.
2882 # Its value may be silently ignored in the future.
2883 # Reason: `keystone-manage pki_setup` was deprecated in Mitaka and removed in
2884 # Pike. These options remain for backwards compatibility.
2885 #keyfile = /etc/keystone/ssl/private/signing_key.pem
2886
2887 # DEPRECATED: Absolute path to the public certificate authority (CA) file to
2888 # use when creating self-signed certificates with `keystone-manage pki_setup`.
2889 # Set this together with `[signing] ca_key`. There is no reason to set this
2890 # option unless you are requesting revocation lists in a non-production
2891 # environment. Use a `[signing] certfile` issued from a trusted certificate
2892 # authority instead. (string value)
2893 # This option is deprecated for removal since P.
2894 # Its value may be silently ignored in the future.
2895 # Reason: `keystone-manage pki_setup` was deprecated in Mitaka and removed in
2896 # Pike. These options remain for backwards compatibility.
2897 #ca_certs = /etc/keystone/ssl/certs/ca.pem
2898
2899 # DEPRECATED: Absolute path to the private certificate authority (CA) key file
2900 # to use when creating self-signed certificates with `keystone-manage
2901 # pki_setup`. Set this together with `[signing] ca_certs`. There is no reason
2902 # to set this option unless you are requesting revocation lists in a non-
2903 # production environment. Use a `[signing] certfile` issued from a trusted
2904 # certificate authority instead. (string value)
2905 # This option is deprecated for removal since P.
2906 # Its value may be silently ignored in the future.
2907 # Reason: `keystone-manage pki_setup` was deprecated in Mitaka and removed in
2908 # Pike. These options remain for backwards compatibility.
2909 #ca_key = /etc/keystone/ssl/private/cakey.pem
2910
2911 # DEPRECATED: Key size (in bits) to use when generating a self-signed token
2912 # signing certificate. There is no reason to set this option unless you are
2913 # requesting revocation lists in a non-production environment. Use a `[signing]
2914 # certfile` issued from a trusted certificate authority instead. (integer
2915 # value)
2916 # Minimum value: 1024
2917 # This option is deprecated for removal since P.
2918 # Its value may be silently ignored in the future.
2919 # Reason: `keystone-manage pki_setup` was deprecated in Mitaka and removed in
2920 # Pike. These options remain for backwards compatibility.
2921 #key_size = 2048
2922
2923 # DEPRECATED: The validity period (in days) to use when generating a self-
2924 # signed token signing certificate. There is no reason to set this option
2925 # unless you are requesting revocation lists in a non-production environment.
2926 # Use a `[signing] certfile` issued from a trusted certificate authority
2927 # instead. (integer value)
2928 # This option is deprecated for removal since P.
2929 # Its value may be silently ignored in the future.
2930 # Reason: `keystone-manage pki_setup` was deprecated in Mitaka and removed in
2931 # Pike. These options remain for backwards compatibility.
2932 #valid_days = 3650
2933
2934 # DEPRECATED: The certificate subject to use when generating a self-signed
2935 # token signing certificate. There is no reason to set this option unless you
2936 # are requesting revocation lists in a non-production environment. Use a
2937 # `[signing] certfile` issued from a trusted certificate authority instead.
2938 # (string value)
2939 # This option is deprecated for removal since P.
2940 # Its value may be silently ignored in the future.
2941 # Reason: `keystone-manage pki_setup` was deprecated in Mitaka and removed in
2942 # Pike. These options remain for backwards compatibility.
2943 #cert_subject = /C=US/ST=Unset/L=Unset/O=Unset/CN=www.example.com
2944
2945
2946 [token]
2947
2948 #
2949 # From keystone
2950 #
2951
2952 # The amount of time that a token should remain valid (in seconds). Drastically
2953 # reducing this value may break "long-running" operations that involve multiple
2954 # services to coordinate together, and will force users to authenticate with
2955 # keystone more frequently. Drastically increasing this value will increase the
2956 # number of tokens that will be simultaneously valid. Keystone tokens are also
2957 # bearer tokens, so a shorter duration will also reduce the potential security
2958 # impact of a compromised token. (integer value)
2959 # Minimum value: 0
2960 # Maximum value: 9223372036854775807
2961 #expiration = 3600
2962
2963 # Entry point for the token provider in the `keystone.token.provider`
2964 # namespace. The token provider controls the token construction, validation,
2965 # and revocation operations. Supported upstream providers are `fernet` and
2966 # `jws`. Neither `fernet` or `jws` tokens require persistence and both require
2967 # additional setup. If using `fernet`, you're required to run `keystone-manage
2968 # fernet_setup`, which creates symmetric keys used to encrypt tokens. If using
2969 # `jws`, you're required to generate an ECDSA keypair using a SHA-256 hash
2970 # algorithm for signing and validating token, which can be done with `keystone-
2971 # manage create_jws_keypair`. Note that `fernet` tokens are encrypted and `jws`
2972 # tokens are only signed. Please be sure to consider this if your deployment
2973 # has security requirements regarding payload contents used to generate token
2974 # IDs. (string value)
2975 #provider = fernet
2976
2977 # Toggle for caching token creation and validation data. This has no effect
2978 # unless global caching is enabled. (boolean value)
2979 #caching = true
2980
2981 # The number of seconds to cache token creation and validation data. This has
2982 # no effect unless both global and `[token] caching` are enabled. (integer
2983 # value)
2984 # Minimum value: 0
2985 # Maximum value: 9223372036854775807
2986 #cache_time = <None>
2987
2988 # This toggles support for revoking individual tokens by the token identifier
2989 # and thus various token enumeration operations (such as listing all tokens
2990 # issued to a specific user). These operations are used to determine the list
2991 # of tokens to consider revoked. Do not disable this option if you're using the
2992 # `kvs` `[revoke] driver`. (boolean value)
2993 #revoke_by_id = true
2994
2995 # This toggles whether scoped tokens may be re-scoped to a new project or
2996 # domain, thereby preventing users from exchanging a scoped token (including
2997 # those with a default project scope) for any other token. This forces users to
2998 # either authenticate for unscoped tokens (and later exchange that unscoped
2999 # token for tokens with a more specific scope) or to provide their credentials
3000 # in every request for a scoped token to avoid re-scoping altogether. (boolean
3001 # value)
3002 #allow_rescope_scoped_token = true
3003
3004 # DEPRECATED: This controls whether roles should be included with tokens that
3005 # are not directly assigned to the token's scope, but are instead linked
3006 # implicitly to other role assignments. (boolean value)
3007 # This option is deprecated for removal since R.
3008 # Its value may be silently ignored in the future.
3009 # Reason: Default roles depend on a chain of implied role assignments. Ex: an
3010 # admin user will also have the reader and member role. By ensuring that all
3011 # these roles will always appear on the token validation response, we can
3012 # improve the simplicity and readability of policy files.
3013 #infer_roles = true
3014
3015 # DEPRECATED: Enable storing issued token data to token validation cache so
3016 # that first token validation doesn't actually cause full validation cycle.
3017 # This option has no effect unless global caching is enabled and will still
3018 # cache tokens even if `[token] caching = False`. (boolean value)
3019 # This option is deprecated for removal since S.
3020 # Its value may be silently ignored in the future.
3021 # Reason: Keystone already exposes a configuration option for caching tokens.
3022 # Having a separate configuration option to cache tokens when they are issued
3023 # is redundant, unnecessarily complicated, and is misleading if token caching
3024 # is disabled because tokens will still be pre-cached by default when they are
3025 # issued. The ability to pre-cache tokens when they are issued is going to rely
3026 # exclusively on the ``keystone.conf [token] caching`` option in the future.
3027 #cache_on_issue = true
3028
3029 # This controls the number of seconds that a token can be retrieved for beyond
3030 # the built-in expiry time. This allows long running operations to succeed.
3031 # Defaults to two days. (integer value)
3032 #allow_expired_window = 172800
3033
3034
3035 [tokenless_auth]
3036
3037 #
3038 # From keystone
3039 #
3040
3041 # The list of distinguished names which identify trusted issuers of client
3042 # certificates allowed to use X.509 tokenless authorization. If the option is
3043 # absent then no certificates will be allowed. The format for the values of a
3044 # distinguished name (DN) must be separated by a comma and contain no spaces.
3045 # Furthermore, because an individual DN may contain commas, this configuration
3046 # option may be repeated multiple times to represent multiple values. For
3047 # example, keystone.conf would include two consecutive lines in order to trust
3048 # two different DNs, such as `trusted_issuer = CN=john,OU=keystone,O=openstack`
3049 # and `trusted_issuer = CN=mary,OU=eng,O=abc`. (multi valued)
3050 #trusted_issuer =
3051
3052 # The federated protocol ID used to represent X.509 tokenless authorization.
3053 # This is used in combination with the value of `[tokenless_auth]
3054 # issuer_attribute` to find a corresponding federated mapping. In a typical
3055 # deployment, there is no reason to change this value. (string value)
3056 #protocol = x509
3057
3058 # The name of the WSGI environment variable used to pass the issuer of the
3059 # client certificate to keystone. This attribute is used as an identity
3060 # provider ID for the X.509 tokenless authorization along with the protocol to
3061 # look up its corresponding mapping. In a typical deployment, there is no
3062 # reason to change this value. (string value)
3063 #issuer_attribute = SSL_CLIENT_I_DN
3064
3065
3066 [trust]
3067
3068 #
3069 # From keystone
3070 #
3071
3072 # Allows authorization to be redelegated from one user to another, effectively
3073 # chaining trusts together. When disabled, the `remaining_uses` attribute of a
3074 # trust is constrained to be zero. (boolean value)
3075 #allow_redelegation = false
3076
3077 # Maximum number of times that authorization can be redelegated from one user
3078 # to another in a chain of trusts. This number may be reduced further for a
3079 # specific trust. (integer value)
3080 #max_redelegation_count = 3
3081
3082 # Entry point for the trust backend driver in the `keystone.trust` namespace.
3083 # Keystone only provides a `sql` driver, so there is no reason to change this
3084 # unless you are providing a custom entry point. (string value)
3085 #driver = sql
3086
3087
3088 [unified_limit]
3089
3090 #
3091 # From keystone
3092 #
3093
3094 # Entry point for the unified limit backend driver in the
3095 # `keystone.unified_limit` namespace. Keystone only provides a `sql` driver, so
3096 # there's no reason to change this unless you are providing a custom entry
3097 # point. (string value)
3098 #driver = sql
3099
3100 # Toggle for unified limit caching. This has no effect unless global caching is
3101 # enabled. In a typical deployment, there is no reason to disable this.
3102 # (boolean value)
3103 #caching = true
3104
3105 # Time to cache unified limit data, in seconds. This has no effect unless both
3106 # global caching and `[unified_limit] caching` are enabled. (integer value)
3107 #cache_time = <None>
3108
3109 # Maximum number of entities that will be returned in a role collection. This
3110 # may be useful to tune if you have a large number of unified limits in your
3111 # deployment. (integer value)
3112 #list_limit = <None>
3113
3114 # The enforcement model to use when validating limits associated to projects.
3115 # Enforcement models will behave differently depending on the existing limits,
3116 # which may result in backwards incompatible changes if a model is switched in
3117 # a running deployment. (string value)
3118 # Possible values:
3119 # flat - <No description provided>
3120 # strict_two_level - <No description provided>
3121 #enforcement_model = flat
3122
3123
3124 [wsgi]
3125
3126 #
3127 # From keystone
3128 #
3129
3130 # If set to true, this enables the oslo debug middleware in Keystone. This
3131 # Middleware prints a lot of information about the request and the response. It
3132 # is useful for getting information about the data on the wire (decoded) and
3133 # passed to the WSGI application pipeline. This middleware has no effect on the
3134 # "debug" setting in the [DEFAULT] section of the config file or setting
3135 # Keystone's log-level to "DEBUG"; it is specific to debugging the WSGI data as
3136 # it enters and leaves Keystone (specific request-related data). This option is
3137 # used for introspection on the request and response data between the web
3138 # server (apache, nginx, etc) and Keystone.  This middleware is inserted as the
3139 # first element in the middleware chain and will show the data closest to the
3140 # wire.  WARNING: NOT INTENDED FOR USE IN PRODUCTION. THIS MIDDLEWARE CAN AND
3141 # WILL EMIT SENSITIVE/PRIVILEGED DATA. (boolean value)
3142 #debug_middleware = false