ironic-inspector.conf¶

DEFAULT¶

debug¶

Type: boolean
Default: False
Mutable: This option can be changed without restarting.

If set to true, the logging level will be set to DEBUG instead of the default INFO level.

log_config_append¶

Type: string
Default: <None>
Mutable: This option can be changed without restarting.

The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).

Deprecated Variations¶
Group	Name
DEFAULT	log-config
DEFAULT	log_config

log_date_format¶

Type: string
Default: %Y-%m-%d %H:%M:%S

Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.

log_file¶

Type: string
Default: <None>

(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.

Deprecated Variations¶
Group	Name
DEFAULT	logfile

log_dir¶

Type: string
Default: <None>

(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.

Deprecated Variations¶
Group	Name
DEFAULT	logdir

watch_log_file¶

Type: boolean
Default: False

Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

use_syslog¶

Type: boolean
Default: False

Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.

use_journal¶

Type: boolean
Default: False

Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.

syslog_log_facility¶

Type: string
Default: LOG_USER

Syslog facility to receive log lines. This option is ignored if log_config_append is set.

use_json¶

Type: boolean
Default: False

Use JSON formatting for logging. This option is ignored if log_config_append is set.

use_stderr¶

Type: boolean
Default: False

Log output to standard error. This option is ignored if log_config_append is set.

use_eventlog¶

Type: boolean
Default: False

Log output to Windows Event Log.

log_rotate_interval¶

Type: integer
Default: 1

The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.

log_rotate_interval_type¶

Type: string
Default: days
Valid Values: Seconds, Minutes, Hours, Days, Weekday, Midnight

Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.

max_logfile_count¶

Type: integer
Default: 30

Maximum number of rotated log files.

max_logfile_size_mb¶

Type: integer
Default: 200

Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.

log_rotation_type¶

Type: string
Default: none
Valid Values: interval, size, none

Log rotation type.

Possible values

interval: Rotate logs at predefined time intervals.
size: Rotate logs once they reach a predefined size.
none: Do not rotate log files.

logging_context_format_string¶

Type: string
Default: %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(global_request_id)s %(request_id)s %(user_identity)s] %(instance)s%(message)s

Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter

logging_default_format_string¶

Type: string
Default: %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter

logging_debug_format_suffix¶

Type: string
Default: %(funcName)s %(pathname)s:%(lineno)d

Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter

logging_exception_prefix¶

Type: string
Default: %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter

logging_user_identity_format¶

Type: string
Default: %(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s

Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter

default_log_levels¶

Type: list
Default: ['sqlalchemy=WARNING', 'iso8601=WARNING', 'requests=WARNING', 'urllib3.connectionpool=WARNING', 'keystonemiddleware=WARNING', 'keystoneauth=WARNING', 'ironicclient=WARNING', 'amqp=WARNING', 'amqplib=WARNING', 'oslo.messaging=WARNING', 'oslo_messaging=WARNING']

List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.

publish_errors¶

Type: boolean
Default: False

Enables or disables publication of error events.

instance_format¶

Type: string
Default: "[instance: %(uuid)s] "

The format for an instance that is passed with the log message.

instance_uuid_format¶

Type: string
Default: "[instance: %(uuid)s] "

The format for an instance UUID that is passed with the log message.

rate_limit_interval¶

Type: integer
Default: 0

Interval, number of seconds, of log rate limiting.

rate_limit_burst¶

Type: integer
Default: 0

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level¶

Type: string
Default: CRITICAL

Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.

fatal_deprecations¶

Type: boolean
Default: False

Enables or disables fatal status of deprecations.

listen_address¶

Type: string
Default: ::

IP to listen on.

listen_port¶

Type: port number
Default: 5050
Minimum Value: 0
Maximum Value: 65535

Port to listen on.

listen_unix_socket¶

Type: string
Default: <None>

Unix socket to listen on. Disables listen_address and listen_port.

listen_unix_socket_mode¶

Type: unknown type
Default: <None>

File mode (an octal number) of the unix socket to listen on. Ignored if listen_unix_socket is not set.

host¶

Type: string
Default: localhost

This option has a sample default set, which means that its actual default value may vary from the one documented above.

Name of this node. This can be an opaque identifier. It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address.

auth_strategy¶

Type: string
Default: keystone
Valid Values: noauth, keystone, http_basic

Authentication method used on the ironic-inspector API. “noauth”, “keystone” or “http_basic” are valid options. “noauth” will disable all authentication.

Possible values

noauth: no authentication
keystone: use the Identity service for authentication
http_basic: HTTP basic authentication

http_basic_auth_user_file¶

Type: string
Default: /etc/ironic-inspector/htpasswd

Path to Apache format user authentication file used when auth_strategy=http_basic

timeout¶

Type: integer
Default: 3600
Maximum Value: 315576000

Timeout after which introspection is considered failed, set to 0 to disable.

clean_up_period¶

Type: integer
Default: 60
Minimum Value: 0

Amount of time in seconds, after which repeat clean up of timed out nodes and old nodes status information. WARNING: If set to a value of 0, then the periodic task is disabled and inspector will not sync with ironic to complete the internal clean-up process. Not advisable if the deployment uses a PXE filter, and will result in the ironic-inspector ceasing periodic cleanup activities.

leader_election_interval¶

Type: integer
Default: 10

Interval (in seconds) between leader elections.

use_ssl¶

Type: boolean
Default: False

SSL Enabled/Disabled

max_concurrency¶

Type: integer
Default: 1000
Minimum Value: 2

The green thread pool size.

introspection_delay¶

Type: integer
Default: 5

Delay (in seconds) between two introspections. Only applies when boot is managed by ironic-inspector (i.e. manage_boot==True).

ipmi_address_fields¶

Type: list
Default: ['redfish_address', 'ilo_address', 'drac_host', 'drac_address', 'ibmc_address']

Ironic driver_info fields that are equivalent to ipmi_address.

rootwrap_config¶

Type: string
Default: /etc/ironic-inspector/rootwrap.conf

Path to the rootwrap configuration file to use for running commands as root

api_max_limit¶

Type: integer
Default: 1000
Minimum Value: 1

Limit the number of elements an API list-call returns

can_manage_boot¶

Type: boolean
Default: True

Whether the current installation of ironic-inspector can manage PXE booting of nodes. If set to False, the API will reject introspection requests with manage_boot missing or set to True.

enable_mdns¶

Type: boolean
Default: False

Whether to enable publishing the ironic-inspector API endpoint via multicast DNS.

standalone¶

Type: boolean
Default: True

Whether to run ironic-inspector as a standalone service. It’s EXPERIMENTAL to set to False.

rpc_conn_pool_size¶

Type: integer
Default: 30
Minimum Value: 1

Size of RPC connection pool.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_conn_pool_size

conn_pool_min_size¶

Type: integer
Default: 2

The pool size limit for connections expiration policy

conn_pool_ttl¶

Type: integer
Default: 1200

The time-to-live in sec of idle connections in the pool

executor_thread_pool_size¶

Type: integer
Default: 64

Size of executor thread pool when executor is threading or eventlet.

Deprecated Variations¶
Group	Name
DEFAULT	rpc_thread_pool_size

rpc_response_timeout¶

Type: integer
Default: 60

Seconds to wait for a response from a call.

transport_url¶

Type: string
Default: rabbit://

The network address and optional user credentials for connecting to the messaging backend, in URL format. The expected format is:

driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query

Example: rabbit://rabbitmq:password@127.0.0.1:5672//

For full details on the fields in the URL see the documentation of oslo_messaging.TransportURL at https://docs.openstack.org/oslo.messaging/latest/reference/transport.html

control_exchange¶

Type: string
Default: openstack

The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.

rpc_ping_enabled¶

Type: boolean
Default: False

Add an endpoint to answer to ping calls. Endpoint is named oslo_rpc_server_ping

backdoor_port¶

Type: string
Default: <None>

Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service’s log file.

backdoor_socket¶

Type: string
Default: <None>

Enable eventlet backdoor, using the provided path as a unix socket that can receive connections. This option is mutually exclusive with ‘backdoor_port’ in that only one should be provided. If both are provided then the existence of this option overrides the usage of that option. Inside the path {pid} will be replaced with the PID of the current process.

log_options¶

Type: boolean
Default: True

Enables or disables logging values of all registered options when starting a service (at DEBUG level).

graceful_shutdown_timeout¶

Type: integer
Default: 60

Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.

api_paste_config¶

Type: string
Default: api-paste.ini

File name for the paste.deploy config for api service

wsgi_log_format¶

Type: string
Default: %(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f

A python format string that is used as the template to generate log lines. The following values can beformatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.

tcp_keepidle¶

Type: integer
Default: 600

Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.

wsgi_default_pool_size¶

Type: integer
Default: 100

Size of the pool of greenthreads used by wsgi

max_header_line¶

Type: integer
Default: 16384

Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated when keystone is configured to use PKI tokens with big service catalogs).

wsgi_keep_alive¶

Type: boolean
Default: True

If False, closes the client socket connection explicitly.

client_socket_timeout¶

Type: integer
Default: 900

Timeout for client connections’ socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of ‘0’ means wait forever.

wsgi_server_debug¶

Type: boolean
Default: False

True if the server should send exception tracebacks to the clients on 500 errors. If False, the server will respond with empty bodies.

capabilities¶

boot_mode¶

Type: boolean
Default: False

Whether to store the boot mode (BIOS or UEFI).

cpu_flags¶

Type: dict
Default: {'vmx': 'cpu_vt', 'svm': 'cpu_vt', 'aes': 'cpu_aes', 'pse': 'cpu_hugepages', 'pdpe1gb': 'cpu_hugepages_1g', 'smx': 'cpu_txt'}

Mapping between a CPU flag and a capability to set if this flag is present.

coordination¶

backend_url¶

Type: string
Default: memcached://localhost:11211

The backend URL to use for distributed coordination. EXPERIMENTAL.

cors¶

allowed_origin¶

Type: list
Default: <None>

Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com

allow_credentials¶

Type: boolean
Default: True

Indicate that the actual request can include user credentials

expose_headers¶

Type: list
Default: []

Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.

max_age¶

Type: integer
Default: 3600

Maximum cache age of CORS preflight requests.

allow_methods¶

Type: list
Default: ['GET', 'POST', 'PUT', 'HEAD', 'PATCH', 'DELETE', 'OPTIONS']

Indicate which methods can be used during the actual request.

allow_headers¶

Type: list
Default: ['X-Auth-Token', 'X-OpenStack-Ironic-Inspector-API-Minimum-Version', 'X-OpenStack-Ironic-Inspector-API-Maximum-Version', 'X-OpenStack-Ironic-Inspector-API-Version']

Indicate which header field names may be used during the actual request.

database¶

sqlite_synchronous¶

Type: boolean
Default: True

If True, SQLite uses synchronous mode.

Deprecated Variations¶
Group	Name
DEFAULT	sqlite_synchronous

backend¶

Type: string
Default: sqlalchemy

The back end to use for the database.

Deprecated Variations¶
Group	Name
DEFAULT	db_backend

connection¶

Type: string
Default: <None>

The SQLAlchemy connection string to use to connect to the database.

Deprecated Variations¶
Group	Name
DEFAULT	sql_connection
DATABASE	sql_connection
sql	connection

slave_connection¶

Type: string
Default: <None>

The SQLAlchemy connection string to use to connect to the slave database.

mysql_sql_mode¶

Type: string
Default: TRADITIONAL

The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=

mysql_wsrep_sync_wait¶

Type: integer
Default: <None>

For Galera only, configure wsrep_sync_wait causality checks on new connections. Default is None, meaning don’t configure any setting.

mysql_enable_ndb¶

Type: boolean
Default: False

If True, transparently enables support for handling MySQL Cluster (NDB).

Warning

This option is deprecated for removal since 12.1.0. Its value may be silently ignored in the future.

Reason: Support for the MySQL NDB Cluster storage engine has been deprecated and will be removed in a future release.

connection_recycle_time¶

Type: integer
Default: 3600

Connections which have been present in the connection pool longer than this number of seconds will be replaced with a new one the next time they are checked out from the pool.

max_pool_size¶

Type: integer
Default: 5

Maximum number of SQL connections to keep open in a pool. Setting a value of 0 indicates no limit.

max_retries¶

Type: integer
Default: 10

Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.

Deprecated Variations¶
Group	Name
DEFAULT	sql_max_retries
DATABASE	sql_max_retries

retry_interval¶

Type: integer
Default: 10

Interval between retries of opening a SQL connection.

Deprecated Variations¶
Group	Name
DEFAULT	sql_retry_interval
DATABASE	reconnect_interval

max_overflow¶

Type: integer
Default: 50

If set, use this value for max_overflow with SQLAlchemy.

Deprecated Variations¶
Group	Name
DEFAULT	sql_max_overflow
DATABASE	sqlalchemy_max_overflow

connection_debug¶

Type: integer
Default: 0
Minimum Value: 0
Maximum Value: 100

Verbosity of SQL debugging information: 0=None, 100=Everything.

Deprecated Variations¶
Group	Name
DEFAULT	sql_connection_debug

connection_trace¶

Type: boolean
Default: False

Add Python stack traces to SQL as comment strings.

Deprecated Variations¶
Group	Name
DEFAULT	sql_connection_trace

pool_timeout¶

Type: integer
Default: <None>

If set, use this value for pool_timeout with SQLAlchemy.

Deprecated Variations¶
Group	Name
DATABASE	sqlalchemy_pool_timeout

use_db_reconnect¶

Type: boolean
Default: False

Enable the experimental use of database reconnect on connection lost.

db_retry_interval¶

Type: integer
Default: 1

Seconds between retries of a database transaction.

db_inc_retry_interval¶

Type: boolean
Default: True

If True, increases the interval between retries of a database operation up to db_max_retry_interval.

db_max_retry_interval¶

Type: integer
Default: 10

If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.

db_max_retries¶

Type: integer
Default: 20

Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.

connection_parameters¶

Type: string
Default: ''

Optional URL parameters to append onto the connection URL at connect time; specify as param1=value1&param2=value2&…

discovery¶

enroll_node_driver¶

Type: string
Default: fake-hardware

The name of the Ironic driver used by the enroll hook when creating a new node in Ironic.

enroll_node_fields¶

Type: dict
Default: {}

Additional fields to set on newly discovered nodes.

enabled_bmc_address_version¶

Type: list
Default: ['4', '6']

IP version of BMC address that will be used when enrolling a new node in Ironic. Defaults to “4,6”. Could be “4” (use v4 address only), “4,6” (v4 address have higher priority and if both addresses found v6 version is ignored), “6,4” (v6 is desired but fall back to v4 address for BMCs having v4 address, opposite to “4,6”), “6” (use v6 address only and ignore v4 version).

dnsmasq_pxe_filter¶

dhcp_hostsdir¶

Type: string
Default: /var/lib/ironic-inspector/dhcp-hostsdir

The MAC address cache directory, exposed to dnsmasq.This directory is expected to be in exclusive control of the driver.

purge_dhcp_hostsdir¶

Type: boolean
Default: True

Purge the hostsdir upon driver initialization. Setting to false should only be performed when the deployment of inspector is such that there are multiple processes executing inside of the same host and namespace. In this case, the Operator is responsible for setting up a custom cleaning facility.

dnsmasq_start_command¶

Type: string
Default: ''

A (shell) command line to start the dnsmasq service upon filter initialization. Default: don’t start.

dnsmasq_stop_command¶

Type: string
Default: ''

A (shell) command line to stop the dnsmasq service upon inspector (error) exit. Default: don’t stop.

extra_hardware¶

strict¶

Type: boolean
Default: False

If True, refuse to parse extra data if at least one record is too short. Additionally, remove the incoming “data” even if parsing failed.

healthcheck¶

enabled¶

Type: boolean
Default: False

Enable the health check endpoint at /healthcheck. Note that this is unauthenticated. More information is available at https://docs.openstack.org/oslo.middleware/latest/reference/healthcheck_plugins.html.

path¶

Type: string
Default: /healthcheck

The path to respond to healtcheck requests on.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

detailed¶

Type: boolean
Default: False

Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies.

backends¶

Type: list
Default: []

Additional backends that can perform health checks and report that information back as part of a request.

disable_by_file_path¶

Type: string
Default: <None>

Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.

disable_by_file_paths¶

Type: list
Default: []

Check the presence of a file based on a port to determine if an application is running on a port. Expects a “port:path” list of strings. Used by DisableByFilesPortsHealthcheck plugin.

iptables¶

dnsmasq_interface¶

Type: string
Default: br-ctlplane

Interface on which dnsmasq listens, the default is for VM’s.

firewall_chain¶

Type: string
Default: ironic-inspector

iptables chain name to use.

ethoib_interfaces¶

Type: list
Default: []

List of Ethernet Over InfiniBand interfaces on the Inspector host which are used for physical access to the DHCP network. Multiple interfaces would be attached to a bond or bridge specified in dnsmasq_interface. The MACs of the InfiniBand nodes which are not in desired state are going to be blocked based on the list of neighbor MACs on these interfaces.

ip_version¶

Type: string
Default: 4
Valid Values: 4, 6

The IP version that will be used for iptables filter. Defaults to 4.

Possible values

4: IPv4
6: IPv6

ironic¶

auth_url¶

Type: unknown type
Default: <None>

Authentication URL

auth_type¶

Type: unknown type
Default: <None>

Authentication type to load

Deprecated Variations¶
Group	Name
ironic	auth_plugin

cafile¶

Type: string
Default: <None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile¶

Type: string
Default: <None>

PEM encoded client certificate cert file

collect_timing¶

Type: boolean
Default: False

Collect per-API call timing information.

connect_retries¶

Type: integer
Default: <None>

The maximum number of retries that should be attempted for connection errors.

connect_retry_delay¶

Type: floating point
Default: <None>

Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used.

default_domain_id¶

Type: unknown type
Default: <None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name¶

Type: unknown type
Default: <None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain_id¶

Type: unknown type
Default: <None>

Domain ID to scope to

domain_name¶

Type: unknown type
Default: <None>

Domain name to scope to

endpoint_override¶

Type: string
Default: <None>

Always use this endpoint URL for requests for this client. NOTE: The unversioned endpoint should be specified here; to request a particular API version, use the version, min-version, and/or max-version options.

insecure¶

Type: boolean
Default: False

Verify HTTPS connections.

keyfile¶

Type: string
Default: <None>

PEM encoded client certificate key file

max_version¶

Type: string
Default: <None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

max_retries¶

Type: integer
Default: 30

Maximum number of retries in case of conflict error (HTTP 409).

min_version¶

Type: string
Default: <None>

The minimum major version of a given API, intended to be used as the lower bound of a range with max_version. Mutually exclusive with version. If min_version is given with no max_version it is as if max version is “latest”.

password¶

Type: unknown type
Default: <None>

User’s password

project_domain_id¶

Type: unknown type
Default: <None>

Domain ID containing project

project_domain_name¶

Type: unknown type
Default: <None>

Domain name containing project

project_id¶

Type: unknown type
Default: <None>

Project ID to scope to

Deprecated Variations¶
Group	Name
ironic	tenant-id
ironic	tenant_id

project_name¶

Type: unknown type
Default: <None>

Project name to scope to

Deprecated Variations¶
Group	Name
ironic	tenant-name
ironic	tenant_name

region_name¶

Type: string
Default: <None>

The default region_name for endpoint URL discovery.

retry_interval¶

Type: integer
Default: 2

Interval between retries in case of conflict error (HTTP 409).

service_name¶

Type: string
Default: <None>

The default service_name for endpoint URL discovery.

service_type¶

Type: string
Default: baremetal

The default service_type for endpoint URL discovery.

split_loggers¶

Type: boolean
Default: False

Log requests to multiple loggers.

status_code_retries¶

Type: integer
Default: <None>

The maximum number of retries that should be attempted for retriable HTTP status codes.

status_code_retry_delay¶

Type: floating point
Default: <None>

Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used.

system_scope¶

Type: unknown type
Default: <None>

Scope for system operations

tenant_id¶

Type: unknown type
Default: <None>

Tenant ID

tenant_name¶

Type: unknown type
Default: <None>

Tenant Name

timeout¶

Type: integer
Default: <None>

Timeout value for http requests

trust_id¶

Type: unknown type
Default: <None>

ID of the trust to use as a trustee use

user_domain_id¶

Type: unknown type
Default: <None>

User’s domain id

user_domain_name¶

Type: unknown type
Default: <None>

User’s domain name

user_id¶

Type: unknown type
Default: <None>

User id

username¶

Type: unknown type
Default: <None>

Username

Deprecated Variations¶
Group	Name
ironic	user-name
ironic	user_name

valid_interfaces¶

Type: list
Default: ['internal', 'public']

List of interfaces, in order of preference, for endpoint URL.

version¶

Type: string
Default: <None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

keystone_authtoken¶

www_authenticate_uri¶

Type: string
Default: <None>

Complete “public” Identity API endpoint. This endpoint should not be an “admin” endpoint, as it should be accessible by all end users. Unauthenticated clients are redirected to this endpoint to authenticate. Although this endpoint should ideally be unversioned, client support in the wild varies. If you’re using a versioned v2 endpoint here, then this should not be the same endpoint the service user utilizes for validating tokens, because normal end users may not be able to reach that endpoint.

Deprecated Variations¶
Group	Name
keystone_authtoken	auth_uri

auth_uri¶

Type: string
Default: <None>

Warning

This option is deprecated for removal since Queens. Its value may be silently ignored in the future.

Reason: The auth_uri option is deprecated in favor of www_authenticate_uri and will be removed in the S release.

auth_version¶

Type: string
Default: <None>

API version of the Identity API endpoint.

interface¶

Type: string
Default: internal

Interface to use for the Identity API endpoint. Valid values are “public”, “internal” (default) or “admin”.

delay_auth_decision¶

Type: boolean
Default: False

Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components.

http_connect_timeout¶

Type: integer
Default: <None>

Request timeout value for communicating with Identity API server.

http_request_max_retries¶

Type: integer
Default: 3

How many times are we trying to reconnect when communicating with Identity API Server.

cache¶

Type: string
Default: <None>

Request environment key where the Swift cache object is stored. When auth_token middleware is deployed with a Swift cache, use this option to have the middleware share a caching backend with swift. Otherwise, use the memcached_servers option instead.

certfile¶

Type: string
Default: <None>

Required if identity server requires client certificate

keyfile¶

Type: string
Default: <None>

Required if identity server requires client certificate

cafile¶

Type: string
Default: <None>

A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs.

insecure¶

Type: boolean
Default: False

Verify HTTPS connections.

region_name¶

Type: string
Default: <None>

The region in which the identity server can be found.

memcached_servers¶

Type: list
Default: <None>

Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.

Deprecated Variations¶
Group	Name
keystone_authtoken	memcache_servers

token_cache_time¶

Type: integer
Default: 300

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.

memcache_security_strategy¶

Type: string
Default: None
Valid Values: None, MAC, ENCRYPT

(Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.

memcache_secret_key¶

Type: string
Default: <None>

(Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.

memcache_pool_dead_retry¶

Type: integer
Default: 300

(Optional) Number of seconds memcached server is considered dead before it is tried again.

memcache_pool_maxsize¶

Type: integer
Default: 10

(Optional) Maximum total number of open connections to every memcached server.

memcache_pool_socket_timeout¶

Type: integer
Default: 3

(Optional) Socket timeout in seconds for communicating with a memcached server.

memcache_pool_unused_timeout¶

Type: integer
Default: 60

(Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.

memcache_pool_conn_get_timeout¶

Type: integer
Default: 10

(Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.

memcache_use_advanced_pool¶

Type: boolean
Default: True

(Optional) Use the advanced (eventlet safe) memcached client pool.

include_service_catalog¶

Type: boolean
Default: True

(Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header.

enforce_token_bind¶

Type: string
Default: permissive

Used to control the use and type of token binding. Can be set to: “disabled” to not check token binding. “permissive” (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. “strict” like “permissive” but if the bind type is unknown the token will be rejected. “required” any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens.

service_token_roles¶

Type: list
Default: ['service']

A choice of roles that must be present in a service token. Service tokens are allowed to request that an expired token can be used and so this check should tightly control that only actual services should be sending this token. Roles here are applied as an ANY check so any role in this list must be present. For backwards compatibility reasons this currently only affects the allow_expired check.

service_token_roles_required¶

Type: boolean
Default: False

For backwards compatibility reasons we must let valid service tokens pass that don’t pass the service_token_roles check as valid. Setting this true will become the default in a future release and should be enabled if possible.

service_type¶

Type: string
Default: <None>

The name or type of the service as it appears in the service catalog. This is used to validate tokens that have restricted access rules.

auth_type¶

Type: unknown type
Default: <None>

Authentication type to load

Deprecated Variations¶
Group	Name
keystone_authtoken	auth_plugin

auth_section¶

Type: unknown type
Default: <None>

Config Section from which to load plugin specific options

mdns¶

registration_attempts¶

Type: integer
Default: 5
Minimum Value: 1

Number of attempts to register a service. Currently has to be larger than 1 because of race conditions in the zeroconf library.

lookup_attempts¶

Type: integer
Default: 3
Minimum Value: 1

Number of attempts to lookup a service.

params¶

Type: unknown type
Default: {}

Additional parameters to pass for the registered service.

interfaces¶

Type: list
Default: <None>

List of IP addresses of interfaces to use for mDNS. Defaults to all interfaces on the system.

oslo_messaging_amqp¶

container_name¶

Type: string
Default: <None>

Name for the AMQP container. must be globally unique. Defaults to a generated UUID

Deprecated Variations¶
Group	Name
amqp1	container_name

idle_timeout¶

Type: integer
Default: 0

Timeout for inactive connections (in seconds)

Deprecated Variations¶
Group	Name
amqp1	idle_timeout

trace¶

Type: boolean
Default: False

Debug: dump AMQP frames to stdout

Deprecated Variations¶
Group	Name
amqp1	trace

ssl¶

Type: boolean
Default: False

Attempt to connect via SSL. If no other ssl-related parameters are given, it will use the system’s CA-bundle to verify the server’s certificate.

ssl_ca_file¶

Type: string
Default: ''

CA certificate PEM file used to verify the server’s certificate

Deprecated Variations¶
Group	Name
amqp1	ssl_ca_file

ssl_cert_file¶

Type: string
Default: ''

Self-identifying certificate PEM file for client authentication

Deprecated Variations¶
Group	Name
amqp1	ssl_cert_file

ssl_key_file¶

Type: string
Default: ''

Private key PEM file used to sign ssl_cert_file certificate (optional)

Deprecated Variations¶
Group	Name
amqp1	ssl_key_file

ssl_key_password¶

Type: string
Default: <None>

Password for decrypting ssl_key_file (if encrypted)

Deprecated Variations¶
Group	Name
amqp1	ssl_key_password

ssl_verify_vhost¶

Type: boolean
Default: False

By default SSL checks that the name in the server’s certificate matches the hostname in the transport_url. In some configurations it may be preferable to use the virtual hostname instead, for example if the server uses the Server Name Indication TLS extension (rfc6066) to provide a certificate per virtual host. Set ssl_verify_vhost to True if the server’s SSL certificate uses the virtual host name instead of the DNS name.

sasl_mechanisms¶

Type: string
Default: ''

Space separated list of acceptable SASL mechanisms

Deprecated Variations¶
Group	Name
amqp1	sasl_mechanisms

sasl_config_dir¶

Type: string
Default: ''

Path to directory that contains the SASL configuration

Deprecated Variations¶
Group	Name
amqp1	sasl_config_dir

sasl_config_name¶

Type: string
Default: ''

Name of configuration file (without .conf suffix)

Deprecated Variations¶
Group	Name
amqp1	sasl_config_name

sasl_default_realm¶

Type: string
Default: ''

SASL realm to use if no realm present in username

connection_retry_interval¶

Type: integer
Default: 1
Minimum Value: 1

Seconds to pause before attempting to re-connect.

connection_retry_backoff¶

Type: integer
Default: 2
Minimum Value: 0

Increase the connection_retry_interval by this many seconds after each unsuccessful failover attempt.

connection_retry_interval_max¶

Type: integer
Default: 30
Minimum Value: 1

Maximum limit for connection_retry_interval + connection_retry_backoff

link_retry_delay¶

Type: integer
Default: 10
Minimum Value: 1

Time to pause between re-connecting an AMQP 1.0 link that failed due to a recoverable error.

default_reply_retry¶

Type: integer
Default: 0
Minimum Value: -1

The maximum number of attempts to re-send a reply message which failed due to a recoverable error.

default_reply_timeout¶

Type: integer
Default: 30
Minimum Value: 5

The deadline for an rpc reply message delivery.

default_send_timeout¶

Type: integer
Default: 30
Minimum Value: 5

The deadline for an rpc cast or call message delivery. Only used when caller does not provide a timeout expiry.

default_notify_timeout¶

Type: integer
Default: 30
Minimum Value: 5

The deadline for a sent notification message delivery. Only used when caller does not provide a timeout expiry.

default_sender_link_timeout¶

Type: integer
Default: 600
Minimum Value: 1

The duration to schedule a purge of idle sender links. Detach link after expiry.

addressing_mode¶

Type: string
Default: dynamic

Indicates the addressing mode used by the driver. Permitted values: ‘legacy’ - use legacy non-routable addressing ‘routable’ - use routable addresses ‘dynamic’ - use legacy addresses if the message bus does not support routing otherwise use routable addressing

pseudo_vhost¶

Type: boolean
Default: True

Enable virtual host support for those message buses that do not natively support virtual hosting (such as qpidd). When set to true the virtual host name will be added to all message bus addresses, effectively creating a private ‘subnet’ per virtual host. Set to False if the message bus supports virtual hosting using the ‘hostname’ field in the AMQP 1.0 Open performative as the name of the virtual host.

server_request_prefix¶

Type: string
Default: exclusive

address prefix used when sending to a specific server

Deprecated Variations¶
Group	Name
amqp1	server_request_prefix

broadcast_prefix¶

Type: string
Default: broadcast

address prefix used when broadcasting to all servers

Deprecated Variations¶
Group	Name
amqp1	broadcast_prefix

group_request_prefix¶

Type: string
Default: unicast

address prefix when sending to any server in group

Deprecated Variations¶
Group	Name
amqp1	group_request_prefix

rpc_address_prefix¶

Type: string
Default: openstack.org/om/rpc

Address prefix for all generated RPC addresses

notify_address_prefix¶

Type: string
Default: openstack.org/om/notify

Address prefix for all generated Notification addresses

multicast_address¶

Type: string
Default: multicast

Appended to the address prefix when sending a fanout message. Used by the message bus to identify fanout messages.

unicast_address¶

Type: string
Default: unicast

Appended to the address prefix when sending to a particular RPC/Notification server. Used by the message bus to identify messages sent to a single destination.

anycast_address¶

Type: string
Default: anycast

Appended to the address prefix when sending to a group of consumers. Used by the message bus to identify messages that should be delivered in a round-robin fashion across consumers.

default_notification_exchange¶

Type: string
Default: <None>

Exchange name used in notification addresses. Exchange name resolution precedence: Target.exchange if set else default_notification_exchange if set else control_exchange if set else ‘notify’

default_rpc_exchange¶

Type: string
Default: <None>

Exchange name used in RPC addresses. Exchange name resolution precedence: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else ‘rpc’

reply_link_credit¶

Type: integer
Default: 200
Minimum Value: 1

Window size for incoming RPC Reply messages.

rpc_server_credit¶

Type: integer
Default: 100
Minimum Value: 1

Window size for incoming RPC Request messages

notify_server_credit¶

Type: integer
Default: 100
Minimum Value: 1

Window size for incoming Notification messages

pre_settled¶

Type: multi-valued
Default: rpc-cast
Default: rpc-reply

Send messages of this type pre-settled. Pre-settled messages will not receive acknowledgement from the peer. Note well: pre-settled messages may be silently discarded if the delivery fails. Permitted values: ‘rpc-call’ - send RPC Calls pre-settled ‘rpc-reply’- send RPC Replies pre-settled ‘rpc-cast’ - Send RPC Casts pre-settled ‘notify’ - Send Notifications pre-settled

oslo_messaging_kafka¶

kafka_max_fetch_bytes¶

Type: integer
Default: 1048576

Max fetch bytes of Kafka consumer

kafka_consumer_timeout¶

Type: floating point
Default: 1.0

Default timeout(s) for Kafka consumers

pool_size¶

Type: integer
Default: 10

Pool Size for Kafka Consumers

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason: Driver no longer uses connection pool.

conn_pool_min_size¶

Type: integer
Default: 2

The pool size limit for connections expiration policy

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason: Driver no longer uses connection pool.

conn_pool_ttl¶

Type: integer
Default: 1200

The time-to-live in sec of idle connections in the pool

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason: Driver no longer uses connection pool.

consumer_group¶

Type: string
Default: oslo_messaging_consumer

Group id for Kafka consumer. Consumers in one group will coordinate message consumption

producer_batch_timeout¶

Type: floating point
Default: 0.0

Upper bound on the delay for KafkaProducer batching in seconds

producer_batch_size¶

Type: integer
Default: 16384

Size of batch for the producer async send

compression_codec¶

Type: string
Default: none
Valid Values: none, gzip, snappy, lz4, zstd

The compression codec for all data generated by the producer. If not set, compression will not be used. Note that the allowed values of this depend on the kafka version

enable_auto_commit¶

Type: boolean
Default: False

Enable asynchronous consumer commits

max_poll_records¶

Type: integer
Default: 500

The maximum number of records returned in a poll call

security_protocol¶

Type: string
Default: PLAINTEXT
Valid Values: PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL

Protocol used to communicate with brokers

sasl_mechanism¶

Type: string
Default: PLAIN

Mechanism when security protocol is SASL

ssl_cafile¶

Type: string
Default: ''

CA certificate PEM file used to verify the server certificate

ssl_client_cert_file¶

Type: string
Default: ''

Client certificate PEM file used for authentication.

ssl_client_key_file¶

Type: string
Default: ''

Client key PEM file used for authentication.

ssl_client_key_password¶

Type: string
Default: ''

Client key password file used for authentication.

oslo_messaging_notifications¶

driver¶

Type: multi-valued
Default: ''

The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop

Deprecated Variations¶
Group	Name
DEFAULT	notification_driver

transport_url¶

Type: string
Default: <None>

A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC.

Deprecated Variations¶
Group	Name
DEFAULT	notification_transport_url

topics¶

Type: list
Default: ['notifications']

AMQP topic used for OpenStack notifications.

Deprecated Variations¶
Group	Name
rpc_notifier2	topics
DEFAULT	notification_topics

retry¶

Type: integer
Default: -1

The maximum number of attempts to re-send a notification message which failed to be delivered due to a recoverable error. 0 - No retry, -1 - indefinite

oslo_messaging_rabbit¶

amqp_durable_queues¶

Type: boolean
Default: False

Use durable queues in AMQP. If rabbit_quorum_queue is enabled, queues will be durable and this value will be ignored.

amqp_auto_delete¶

Type: boolean
Default: False

Auto-delete queues in AMQP.

Deprecated Variations¶
Group	Name
DEFAULT	amqp_auto_delete

ssl¶

Type: boolean
Default: False

Connect over SSL.

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	rabbit_use_ssl

ssl_version¶

Type: string
Default: ''

SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_ssl_version

ssl_key_file¶

Type: string
Default: ''

SSL key file (valid only if SSL enabled).

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_ssl_keyfile

ssl_cert_file¶

Type: string
Default: ''

SSL cert file (valid only if SSL enabled).

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_ssl_certfile

ssl_ca_file¶

Type: string
Default: ''

SSL certification authority file (valid only if SSL enabled).

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_ssl_ca_certs

ssl_enforce_fips_mode¶

Type: boolean
Default: False

Global toggle for enforcing the OpenSSL FIPS mode. This feature requires Python support. This is available in Python 3.9 in all environments and may have been backported to older Python versions on select environments. If the Python executable used does not support OpenSSL FIPS mode, an exception will be raised.

heartbeat_in_pthread¶

Type: boolean
Default: False

Run the health check heartbeat thread through a native python thread by default. If this option is equal to False then the health check heartbeat will inherit the execution model from the parent process. For example if the parent process has monkey patched the stdlib by using eventlet/greenlet then the heartbeat will be run through a green thread. This option should be set to True only for the wsgi services.

kombu_reconnect_delay¶

Type: floating point
Default: 1.0
Minimum Value: 0.0
Maximum Value: 4.5

How long to wait (in seconds) before reconnecting in response to an AMQP consumer cancel notification.

Deprecated Variations¶
Group	Name
DEFAULT	kombu_reconnect_delay

kombu_compression¶

Type: string
Default: <None>

EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may not be available in future versions.

kombu_missing_consumer_retry_timeout¶

Type: integer
Default: 60

How long to wait a missing client before abandoning to send it its replies. This value should not be longer than rpc_response_timeout.

Deprecated Variations¶
Group	Name
oslo_messaging_rabbit	kombu_reconnect_timeout

kombu_failover_strategy¶

Type: string
Default: round-robin
Valid Values: round-robin, shuffle

Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config.

rabbit_login_method¶

Type: string
Default: AMQPLAIN
Valid Values: PLAIN, AMQPLAIN, EXTERNAL, RABBIT-CR-DEMO

The RabbitMQ login method.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_login_method

rabbit_retry_interval¶

Type: integer
Default: 1

How frequently to retry connecting with RabbitMQ.

rabbit_retry_backoff¶

Type: integer
Default: 2

How long to backoff for between retries when connecting to RabbitMQ.

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_retry_backoff

rabbit_interval_max¶

Type: integer
Default: 30

Maximum interval of RabbitMQ connection retries. Default is 30 seconds.

rabbit_ha_queues¶

Type: boolean
Default: False

Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “

Deprecated Variations¶
Group	Name
DEFAULT	rabbit_ha_queues

rabbit_quorum_queue¶

Type: boolean
Default: False

Use quorum queues in RabbitMQ (x-queue-type: quorum). The quorum queue is a modern queue type for RabbitMQ implementing a durable, replicated FIFO queue based on the Raft consensus algorithm. It is available as of RabbitMQ 3.8.0. If set this option will conflict with the HA queues (rabbit_ha_queues) aka mirrored queues, in other words the HA queues should be disabled, quorum queues durable by default so the amqp_durable_queues opion is ignored when this option enabled.

rabbit_quorum_delivery_limit¶

Type: integer
Default: 0

Each time a message is redelivered to a consumer, a counter is incremented. Once the redelivery count exceeds the delivery limit the message gets dropped or dead-lettered (if a DLX exchange has been configured) Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.

rabbit_quroum_max_memory_length¶

Type: integer
Default: 0

By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of messages in the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.

rabbit_quroum_max_memory_bytes¶

Type: integer
Default: 0

By default all messages are maintained in memory if a quorum queue grows in length it can put memory pressure on a cluster. This option can limit the number of memory bytes used by the quorum queue. Used only when rabbit_quorum_queue is enabled, Default 0 which means dont set a limit.

rabbit_transient_queues_ttl¶

Type: integer
Default: 1800
Minimum Value: 1

Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues.

rabbit_qos_prefetch_count¶

Type: integer
Default: 0

Specifies the number of messages to prefetch. Setting to zero allows unlimited messages.

heartbeat_timeout_threshold¶

Type: integer
Default: 60

Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disables heartbeat).

heartbeat_rate¶

Type: integer
Default: 2

How often times during the heartbeat_timeout_threshold we check the heartbeat.

direct_mandatory_flag¶

Type: boolean
Default: True

(DEPRECATED) Enable/Disable the RabbitMQ mandatory flag for direct send. The direct send is used as reply, so the MessageUndeliverable exception is raised in case the client queue does not exist.MessageUndeliverable exception will be used to loop for a timeout to lets a chance to sender to recover.This flag is deprecated and it will not be possible to deactivate this functionality anymore

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

Reason: Mandatory flag no longer deactivable.

enable_cancel_on_failover¶

Type: boolean
Default: False

Enable x-cancel-on-ha-failover flag so that rabbitmq server will cancel and notify consumerswhen queue is down

oslo_policy¶

enforce_scope¶

Type: boolean
Default: False

This option controls whether or not to enforce scope when evaluating policies. If True, the scope of the token used in the request is compared to the scope_types of the policy being enforced. If the scopes do not match, an InvalidScope exception will be raised. If False, a message will be logged informing operators that policies are being invoked with mismatching scope.

enforce_new_defaults¶

Type: boolean
Default: False

This option controls whether or not to use old deprecated defaults when evaluating policies. If True, the old deprecated defaults are not going to be evaluated. This means if any existing token is allowed for old defaults but is disallowed for new defaults, it will be disallowed. It is encouraged to enable this flag along with the enforce_scope flag so that you can get the benefits of new defaults and scope_type together. If False, the deprecated policy check string is logically OR’d with the new policy check string, allowing for a graceful upgrade experience between releases with new policies, which is the default behavior.

policy_file¶

Type: string
Default: policy.yaml

The relative or absolute path of a file that maps roles to permissions for a given service. Relative paths must be specified in relation to the configuration file setting this option.

Deprecated Variations¶
Group	Name
DEFAULT	policy_file

policy_default_rule¶

Type: string
Default: default

Default rule. Enforced when a requested rule is not found.

Deprecated Variations¶
Group	Name
DEFAULT	policy_default_rule

policy_dirs¶

Type: multi-valued
Default: policy.d

Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.

Deprecated Variations¶
Group	Name
DEFAULT	policy_dirs

remote_content_type¶

Type: string
Default: application/x-www-form-urlencoded
Valid Values: application/x-www-form-urlencoded, application/json

Content Type to send and receive data for REST based policy check

remote_ssl_verify_server_crt¶

Type: boolean
Default: False

server identity verification for REST based policy check

remote_ssl_ca_crt_file¶

Type: string
Default: <None>

Absolute path to ca cert file for REST based policy check

remote_ssl_client_crt_file¶

Type: string
Default: <None>

Absolute path to client cert for REST based policy check

remote_ssl_client_key_file¶

Type: string
Default: <None>

Absolute path client key file REST based policy check

pci_devices¶

alias¶

Type: multi-valued
Default: ''

An alias for PCI device identified by ‘vendor_id’ and ‘product_id’ fields. Format: {“vendor_id”: “1234”, “product_id”: “5678”, “name”: “pci_dev1”}

port_physnet¶

cidr_map¶

Type: list
Default: 10.10.10.0/24:physnet_a,2001:db8::/64:physnet_b

This option has a sample default set, which means that its actual default value may vary from the one documented above.

Mapping of IP subnet CIDR to physical network. When the physnet_cidr_map processing hook is enabled the physical_network property of baremetal ports is populated based on this mapping.

processing¶

add_ports¶

Type: string
Default: pxe
Valid Values: all, active, pxe, disabled

Which MAC addresses to add as ports during introspection. Possible values: all (all MAC addresses), active (MAC addresses of NIC with IP addresses), pxe (only MAC address of NIC node PXE booted from, falls back to “active” if PXE MAC is not supplied by the ramdisk).

keep_ports¶

Type: string
Default: all
Valid Values: all, present, added

Which ports (already present on a node) to keep after introspection. Possible values: all (do not delete anything), present (keep ports which MACs were present in introspection data), added (keep only MACs that we added during introspection).

overwrite_existing¶

Type: boolean
Default: True

Whether to overwrite existing values in node database. Disable this option to make introspection a non-destructive operation.

default_processing_hooks¶

Type: string
Default: ramdisk_error,root_disk_selection,scheduler,validate_interfaces,capabilities,pci_devices

Comma-separated list of default hooks for processing pipeline. Hook ‘scheduler’ updates the node with the minimum properties required by the Nova scheduler. Hook ‘validate_interfaces’ ensures that valid NIC data was provided by the ramdisk. Do not exclude these two unless you really know what you’re doing.

processing_hooks¶

Type: string
Default: $default_processing_hooks

Comma-separated list of enabled hooks for processing pipeline. The default for this is $default_processing_hooks, hooks can be added before or after the defaults like this: “prehook,$default_processing_hooks,posthook”.

ramdisk_logs_dir¶

Type: string
Default: <None>

If set, logs from ramdisk will be stored in this directory.

always_store_ramdisk_logs¶

Type: boolean
Default: False

Whether to store ramdisk logs even if it did not return an error message (dependent upon “ramdisk_logs_dir” option being set).

node_not_found_hook¶

Type: string
Default: <None>

The name of the hook to run when inspector receives inspection information from a node it isn’t already aware of. This hook is ignored by default.

store_data¶

Type: string
Default: none

The storage backend for storing introspection data. Possible values are: ‘none’, ‘database’ and ‘swift’. If set to ‘none’, introspection data will not be stored.

disk_partitioning_spacing¶

Type: boolean
Default: True

Whether to leave 1 GiB of disk size untouched for partitioning. Only has effect when used with the IPA as a ramdisk, for older ramdisk local_gb is calculated on the ramdisk side.

ramdisk_logs_filename_format¶

Type: string
Default: {uuid}_{dt:%Y%m%d-%H%M%S.%f}.tar.gz

File name template for storing ramdisk logs. The following replacements can be used: {uuid} - node UUID or “unknown”, {bmc} - node BMC address or “unknown”, {dt} - current UTC date and time, {mac} - PXE booting MAC or “unknown”.

power_off¶

Type: boolean
Default: True

Whether to power off a node after introspection. Nodes in active or rescue states which submit introspection data will be left on if the feature is enabled via the ‘permit_active_introspection’ configuration option.

permit_active_introspection¶

Type: boolean
Default: False

Whether to process nodes that are in running states.

update_pxe_enabled¶

Type: boolean
Default: True

Whether to update the pxe_enabled value according to the introspection data. This option has no effect if [processing]overwrite_existing is set to False

pxe_filter¶

driver¶

Type: string
Default: iptables

PXE boot filter driver to use, possible filters are: “iptables”, “dnsmasq” and “noop”. Set “noop ” to disable the firewall filtering.

sync_period¶

Type: integer
Default: 15
Minimum Value: 0

Amount of time in seconds, after which repeat periodic update of the filter.

deny_unknown_macs¶

Type: boolean
Default: False

By default inspector will open the DHCP server for any node when introspection is active. Opening DHCP for unknown MAC addresses when introspection is active allow for users to add nodes with no ports to ironic and have ironic-inspector enroll ports based on node introspection results. NOTE: If this option is True, nodes must have at least one enrolled port prior to introspection.

service_catalog¶

auth_url¶

Type: unknown type
Default: <None>

Authentication URL

auth_type¶

Type: unknown type
Default: <None>

Authentication type to load

Deprecated Variations¶
Group	Name
service_catalog	auth_plugin

cafile¶

Type: string
Default: <None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile¶

Type: string
Default: <None>

PEM encoded client certificate cert file

collect_timing¶

Type: boolean
Default: False

Collect per-API call timing information.

connect_retries¶

Type: integer
Default: <None>

The maximum number of retries that should be attempted for connection errors.

connect_retry_delay¶

Type: floating point
Default: <None>

Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used.

default_domain_id¶

Type: unknown type
Default: <None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name¶

Type: unknown type
Default: <None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

domain_id¶

Type: unknown type
Default: <None>

Domain ID to scope to

domain_name¶

Type: unknown type
Default: <None>

Domain name to scope to

endpoint_override¶

Type: string
Default: <None>

insecure¶

Type: boolean
Default: False

Verify HTTPS connections.

keyfile¶

Type: string
Default: <None>

PEM encoded client certificate key file

max_version¶

Type: string
Default: <None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

min_version¶

Type: string
Default: <None>

password¶

Type: unknown type
Default: <None>

User’s password

project_domain_id¶

Type: unknown type
Default: <None>

Domain ID containing project

project_domain_name¶

Type: unknown type
Default: <None>

Domain name containing project

project_id¶

Type: unknown type
Default: <None>

Project ID to scope to

Deprecated Variations¶
Group	Name
service_catalog	tenant-id
service_catalog	tenant_id

project_name¶

Type: unknown type
Default: <None>

Project name to scope to

Deprecated Variations¶
Group	Name
service_catalog	tenant-name
service_catalog	tenant_name

region_name¶

Type: string
Default: <None>

The default region_name for endpoint URL discovery.

service_name¶

Type: string
Default: <None>

The default service_name for endpoint URL discovery.

service_type¶

Type: string
Default: baremetal-introspection

The default service_type for endpoint URL discovery.

split_loggers¶

Type: boolean
Default: False

Log requests to multiple loggers.

status_code_retries¶

Type: integer
Default: <None>

The maximum number of retries that should be attempted for retriable HTTP status codes.

status_code_retry_delay¶

Type: floating point
Default: <None>

Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used.

system_scope¶

Type: unknown type
Default: <None>

Scope for system operations

tenant_id¶

Type: unknown type
Default: <None>

Tenant ID

tenant_name¶

Type: unknown type
Default: <None>

Tenant Name

timeout¶

Type: integer
Default: <None>

Timeout value for http requests

trust_id¶

Type: unknown type
Default: <None>

ID of the trust to use as a trustee use

user_domain_id¶

Type: unknown type
Default: <None>

User’s domain id

user_domain_name¶

Type: unknown type
Default: <None>

User’s domain name

user_id¶

Type: unknown type
Default: <None>

User id

username¶

Type: unknown type
Default: <None>

Username

Deprecated Variations¶
Group	Name
service_catalog	user-name
service_catalog	user_name

valid_interfaces¶

Type: list
Default: ['internal', 'public']

List of interfaces, in order of preference, for endpoint URL.

version¶

Type: string
Default: <None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

ssl¶

ca_file¶

Type: string
Default: <None>

CA certificate file to use to verify connecting clients.

Deprecated Variations¶
Group	Name
DEFAULT	ssl_ca_file

cert_file¶

Type: string
Default: <None>

Certificate file to use when starting the server securely.

Deprecated Variations¶
Group	Name
DEFAULT	ssl_cert_file

key_file¶

Type: string
Default: <None>

Private key file to use when starting the server securely.

Deprecated Variations¶
Group	Name
DEFAULT	ssl_key_file

version¶

Type: string
Default: <None>

SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.

ciphers¶

Type: string
Default: <None>

Sets the list of available ciphers. value should be a string in the OpenSSL cipher list format.

swift¶

auth_url¶

Type: unknown type
Default: <None>

Authentication URL

auth_type¶

Type: unknown type
Default: <None>

Authentication type to load

Deprecated Variations¶
Group	Name
swift	auth_plugin

cafile¶

Type: string
Default: <None>

PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile¶

Type: string
Default: <None>

PEM encoded client certificate cert file

collect_timing¶

Type: boolean
Default: False

Collect per-API call timing information.

connect_retries¶

Type: integer
Default: <None>

The maximum number of retries that should be attempted for connection errors.

connect_retry_delay¶

Type: floating point
Default: <None>

Delay (in seconds) between two retries for connection errors. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used.

container¶

Type: string
Default: ironic-inspector

Default Swift container to use when creating objects.

default_domain_id¶

Type: unknown type
Default: <None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name¶

Type: unknown type
Default: <None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

delete_after¶

Type: integer
Default: 0

Number of seconds that the Swift object will last before being deleted. (set to 0 to never delete the object).

domain_id¶

Type: unknown type
Default: <None>

Domain ID to scope to

domain_name¶

Type: unknown type
Default: <None>

Domain name to scope to

endpoint_override¶

Type: string
Default: <None>

insecure¶

Type: boolean
Default: False

Verify HTTPS connections.

keyfile¶

Type: string
Default: <None>

PEM encoded client certificate key file

max_version¶

Type: string
Default: <None>

The maximum major version of a given API, intended to be used as the upper bound of a range with min_version. Mutually exclusive with version.

min_version¶

Type: string
Default: <None>

password¶

Type: unknown type
Default: <None>

User’s password

project_domain_id¶

Type: unknown type
Default: <None>

Domain ID containing project

project_domain_name¶

Type: unknown type
Default: <None>

Domain name containing project

project_id¶

Type: unknown type
Default: <None>

Project ID to scope to

Deprecated Variations¶
Group	Name
swift	tenant-id
swift	tenant_id

project_name¶

Type: unknown type
Default: <None>

Project name to scope to

Deprecated Variations¶
Group	Name
swift	tenant-name
swift	tenant_name

region_name¶

Type: string
Default: <None>

The default region_name for endpoint URL discovery.

service_name¶

Type: string
Default: <None>

The default service_name for endpoint URL discovery.

service_type¶

Type: string
Default: object-store

The default service_type for endpoint URL discovery.

split_loggers¶

Type: boolean
Default: False

Log requests to multiple loggers.

status_code_retries¶

Type: integer
Default: <None>

The maximum number of retries that should be attempted for retriable HTTP status codes.

status_code_retry_delay¶

Type: floating point
Default: <None>

Delay (in seconds) between two retries for retriable status codes. If not set, exponential retry starting with 0.5 seconds up to a maximum of 60 seconds is used.

system_scope¶

Type: unknown type
Default: <None>

Scope for system operations

tenant_id¶

Type: unknown type
Default: <None>

Tenant ID

tenant_name¶

Type: unknown type
Default: <None>

Tenant Name

timeout¶

Type: integer
Default: <None>

Timeout value for http requests

trust_id¶

Type: unknown type
Default: <None>

ID of the trust to use as a trustee use

user_domain_id¶

Type: unknown type
Default: <None>

User’s domain id

user_domain_name¶

Type: unknown type
Default: <None>

User’s domain name

user_id¶

Type: unknown type
Default: <None>

User id

username¶

Type: unknown type
Default: <None>

Username

Deprecated Variations¶
Group	Name
swift	user-name
swift	user_name

valid_interfaces¶

Type: list
Default: ['internal', 'public']

List of interfaces, in order of preference, for endpoint URL.

version¶

Type: string
Default: <None>

Minimum Major API version within a given Major API version for endpoint URL discovery. Mutually exclusive with min_version and max_version

ironic-inspector.conf

ironic-inspector.conf¶

DEFAULT¶

capabilities¶

coordination¶

cors¶

database¶

discovery¶

dnsmasq_pxe_filter¶

extra_hardware¶

healthcheck¶

iptables¶

ironic¶

keystone_authtoken¶

mdns¶

oslo_messaging_amqp¶

oslo_messaging_kafka¶

oslo_messaging_notifications¶

oslo_messaging_rabbit¶

oslo_policy¶

pci_devices¶

port_physnet¶

processing¶

pxe_filter¶

service_catalog¶

ssl¶

swift¶

ironic-inspector 11.4.1.dev7

Page Contents