| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| admin_mode = False | +(BoolOpt) Activate privileged endpoints. | +
| daemon = False | +(BoolOpt) Run Zaqar server in the background. | +
| disable_process_locking = False | +(BoolOpt) Enables or disables inter-process locks. | +
| lock_path = None | +(StrOpt) Directory to use for lock files. | +
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| memcached_servers = None | +(ListOpt) Memcached servers or None for in process cache. | +
| [keystone_authtoken] | +|
| admin_password = None | +(StrOpt) Keystone account password | +
| admin_tenant_name = admin | +(StrOpt) Keystone service account tenant name to validate user tokens | +
| admin_token = None | +(StrOpt) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use `admin_user` and `admin_password` instead. | +
| admin_user = None | +(StrOpt) Keystone account username | +
| auth_admin_prefix = | +(StrOpt) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. | +
| auth_host = 127.0.0.1 | +(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_port = 35357 | +(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri. | +
| auth_protocol = https | +(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri. | +
| auth_uri = None | +(StrOpt) Complete public Identity API endpoint | +
| auth_version = None | +(StrOpt) API version of the admin Identity API endpoint | +
| cache = None | +(StrOpt) Env key for the swift cache | +
| cafile = None | +(StrOpt) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. | +
| certfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| check_revocations_for_cached = False | +(BoolOpt) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the Keystone server. | +
| delay_auth_decision = False | +(BoolOpt) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components | +
| enforce_token_bind = permissive | +(StrOpt) Used to control the use and type of token binding. Can be set to: "disabled" to not check token binding. "permissive" (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. "strict" like "permissive" but if the bind type is unknown the token will be rejected. "required" any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. | +
| hash_algorithms = md5 | +(ListOpt) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. | +
| http_connect_timeout = None | +(BoolOpt) Request timeout value for communicating with Identity API server. | +
| http_request_max_retries = 3 | +(IntOpt) How many times are we trying to reconnect when communicating with Identity API Server. | +
| identity_uri = None | +(StrOpt) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ | +
| include_service_catalog = True | +(BoolOpt) (optional) indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. | +
| insecure = False | +(BoolOpt) Verify HTTPS connections. | +
| keyfile = None | +(StrOpt) Required if Keystone server requires client certificate | +
| memcache_secret_key = None | +(StrOpt) (optional, mandatory if memcache_security_strategy is defined) this string is used for key derivation. | +
| memcache_security_strategy = None | +(StrOpt) (optional) if defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. | +
| memcached_servers = None | +(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. | +
| revocation_cache_time = 10 | +(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance. | +
| signing_dir = None | +(StrOpt) Directory used to cache files related to PKI tokens | +
| token_cache_time = 300 | +(IntOpt) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. | +
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| auth_strategy = | +(StrOpt) Backend to use for authentication. For no auth, keep it empty. Existing strategies: keystone. See also the keystone_authtoken section below | +
| Configuration option = Default value | +Description | +
|---|---|
| [drivers] | +|
| storage = sqlite | +(StrOpt) Storage driver to use. | +
| transport = wsgi | +(StrOpt) Transport driver to use. | +
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| debug = False | +(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level). | +
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN | +(ListOpt) List of logger=LEVEL pairs. | +
| fatal_deprecations = False | +(BoolOpt) Enables or disables fatal status of deprecations. | +
| instance_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance that is passed with the log message. | +
| instance_uuid_format = "[instance: %(uuid)s] " | +(StrOpt) The format for an instance UUID that is passed with the log message. | +
| log_config_append = None | +(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. | +
| log_date_format = %Y-%m-%d %H:%M:%S | +(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . | +
| log_dir = None | +(StrOpt) (Optional) The base directory used for relative --log-file paths. | +
| log_file = None | +(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. | +
| log_format = None | +(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. | +
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages with context. | +
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | +(StrOpt) Data to append to log format when level is DEBUG. | +
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | +(StrOpt) Format string to use for log messages without context. | +
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s | +(StrOpt) Prefix each line of exception output with this format. | +
| publish_errors = False | +(BoolOpt) Enables or disables publication of error events. | +
| syslog_log_facility = LOG_USER | +(StrOpt) Syslog facility to receive log lines. | +
| use_stderr = True | +(BoolOpt) Log output to standard error. | +
| use_syslog = False | +(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424. | +
| use_syslog_rfc_format = False | +(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J. | +
| verbose = False | +(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level). | +
| Configuration option = Default value | +Description | +
|---|---|
| [drivers:storage:mongodb] | +|
| database = zaqar | +(StrOpt) Database name. | +
| max_attempts = 1000 | +(IntOpt) Maximum number of times to retry a failed operation. Currently only used for retrying a message post. | +
| max_reconnect_attempts = 10 | +(IntOpt) Maximum number of times to retry an operation that failed due to a primary node failover. | +
| max_retry_jitter = 0.005 | +(FloatOpt) Maximum jitter interval, to be added to the sleep interval, in order to decrease probability that parallel requests will retry at the same instant. | +
| max_retry_sleep = 0.1 | +(FloatOpt) Maximum sleep interval between retries (actual sleep time increases linearly according to number of attempts performed). | +
| partitions = 2 | +(IntOpt) Number of databases across which to partition message data, in order to reduce writer lock %. DO NOT change this setting after initial deployment. It MUST remain static. Also, you should not need a large number of partitions to improve performance, esp. if deploying MongoDB on SSD storage. | +
| reconnect_sleep = 0.02 | +(FloatOpt) Base sleep interval between attempts to reconnect after a primary node failover. The actual sleep time increases exponentially (power of 2) each time the operation is retried. | +
| ssl_ca_certs = None | +(StrOpt) The ca_certs file contains a set of concatenated "certification authority" certificates, which are used to validate certificates passed from the other end of the connection. | +
| ssl_cert_reqs = CERT_REQUIRED | +(StrOpt) Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. It must be one of the three values ``CERT_NONE``(certificates ignored), ``CERT_OPTIONAL``(not required, but validated if provided), or ``CERT_REQUIRED``(required and validated). If the value of this parameter is not ``CERT_NONE``, then the ``ssl_ca_cert`` parameter must point to a file of CA certificates. | +
| ssl_certfile = None | +(StrOpt) The certificate file used to identify the local connection against mongod. | +
| ssl_keyfile = None | +(StrOpt) The private keyfile used to identify the local connection against mongod. If included with the ``certifle`` then only the ``ssl_certfile`` is needed. | +
| uri = None | +(StrOpt) Mongodb Connection URI. If ssl connection enabled, then ``ssl_keyfile``, ``ssl_certfile``, ``ssl_cert_reqs``, ``ssl_ca_certs`` need to be set accordingly. | +
| Configuration option = Default value | +Description | +
|---|---|
| [DEFAULT] | +|
| pooling = False | +(BoolOpt) ('Enable pooling across multiple storage backends. ', 'If pooling is enabled, the storage driver ', 'configuration is used to determine where the ', 'catalogue/control plane data is kept.') | +
| Configuration option = Default value | +Description | +
|---|---|
| [storage] | +|
| claim_pipeline = | +(ListOpt) Pipeline to use for processing claim operations. This pipeline will be consumed before calling the storage driver's controller methods. | +
| message_pipeline = | +(ListOpt) Pipeline to use for processing message operations. This pipeline will be consumed before calling the storage driver's controller methods. | +
| queue_pipeline = | +(ListOpt) Pipeline to use for processing queue operations. This pipeline will be consumed before calling the storage driver's controller methods. | +
| Configuration option = Default value | +Description | +
|---|---|
| [transport] | +|
| default_claim_grace = 60 | +(IntOpt) No help text available for this option. | +
| default_claim_ttl = 300 | +(IntOpt) No help text available for this option. | +
| default_message_ttl = 3600 | +(IntOpt) No help text available for this option. | +
| max_claim_grace = 43200 | +(IntOpt) No help text available for this option. | +
| max_claim_ttl = 43200 | +(IntOpt) No help text available for this option. | +
| max_message_size = 262144 | +(IntOpt) No help text available for this option. | +
| max_message_ttl = 1209600 | +(IntOpt) No help text available for this option. | +
| max_messages_per_claim_or_pop = 20 | +(IntOpt) The maximum number of messages that can be claimed (OR) popped in a single request | +
| max_messages_per_page = 20 | +(IntOpt) No help text available for this option. | +
| max_queue_metadata = 65536 | +(IntOpt) No help text available for this option. | +
| max_queues_per_page = 20 | +(IntOpt) No help text available for this option. | +
| Configuration option = Default value | +Description | +
|---|---|
| [drivers:transport:wsgi] | +|
| bind = 127.0.0.1 | +(StrOpt) Address on which the self-hosting server will listen. | +
| port = 8888 | +(IntOpt) Port on which the self-hosting server will listen. | +