ironic-inspector.conf

默认值

executor_thread_pool_size
类型:

整数

默认值:

64

当 executor 是 threading 或 eventlet 时,executor 线程池的大小。

已弃用的变体

Group

名称

DEFAULT

rpc_thread_pool_size

rpc_response_timeout
类型:

整数

默认值:

60

等待调用响应的秒数。

transport_url
类型:

字符串

默认值:

rabbit://

用于连接消息传递后端,包括网络地址和可选的用户凭据,格式为 URL。

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

示例:rabbit://rabbitmq:password@127.0.0.1:5672//

有关 URL 中字段的完整详细信息,请参阅 oslo_messaging.TransportURL 的文档:https://docs.openstack.org/oslo.messaging/2025.2/reference/transport.html

control_exchange
类型:

字符串

默认值:

openstack

主题的作用域所在的默认交换机。可以通过 transport_url 选项中指定的交换机名称覆盖。

rpc_ping_enabled
类型:

布尔值

默认值:

False

添加一个端点来响应 ping 调用。端点命名为 oslo_rpc_server_ping

debug
类型:

布尔值

默认值:

False

可变:

此选项可以在不重启的情况下更改。

如果设置为 true,日志级别将被设置为 DEBUG,而不是默认的 INFO 级别。

log_config_append
类型:

字符串

默认值:

<None>

可变:

此选项可以在不重启的情况下更改。

日志配置文件的名称。此文件将附加到任何现有的日志配置文件。有关日志配置文件的详细信息,请参阅 Python 日志模块文档。请注意,当使用日志配置文件时,所有日志配置都设置在配置文件中,并且其他日志配置选项将被忽略(例如,log-date-format)。

已弃用的变体

Group

名称

DEFAULT

log-config

DEFAULT

log_config

log_date_format
类型:

字符串

默认值:

%Y-%m-%d %H:%M:%S

定义日志记录中的 %(asctime)s 的格式字符串。默认值:上述值。如果设置了 log_config_append,则此选项将被忽略。

log_file
类型:

字符串

默认值:

<None>

(可选) 将日志输出发送到的日志文件名。如果没有设置默认值,日志将输出到 stderr,如 use_stderr 中定义的那样。如果设置了 log_config_append,则此选项将被忽略。

已弃用的变体

Group

名称

DEFAULT

logfile

log_dir
类型:

字符串

默认值:

<None>

(可选) 用于相对 log_file 路径的基本目录。如果设置了 log_config_append,则此选项将被忽略。

已弃用的变体

Group

名称

DEFAULT

logdir

watch_log_file
类型:

布尔值

默认值:

False

使用设计为监视文件系统的日志记录处理程序。当日志文件被移动或删除时,此处理程序将立即使用指定的路径打开新的日志文件。只有在指定了 log_file 选项并且使用 Linux 平台时才有意义。如果设置了 log_config_append,则此选项将被忽略。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

已知此功能长期存在问题,并且依赖于未维护的库

use_syslog
类型:

布尔值

默认值:

False

使用 syslog 进行日志记录。现有的 syslog 格式已弃用,以后将更改为符合 RFC5424。如果设置了 log_config_append,则此选项将被忽略。

use_journal
类型:

布尔值

默认值:

False

启用 journald 进行日志记录。如果正在 systemd 环境中运行,您可能希望启用 journal 支持。这样做将使用 journal 本机协议,其中包括结构化元数据以及日志消息。如果设置了 log_config_append,则此选项将被忽略。

syslog_log_facility
类型:

字符串

默认值:

LOG_USER

接收日志行的 syslog facility。如果设置了 log_config_append,则此选项将被忽略。

use_json
类型:

布尔值

默认值:

False

使用 JSON 格式进行日志记录。如果设置了 log_config_append,则此选项将被忽略。

use_stderr
类型:

布尔值

默认值:

False

将日志输出记录到标准错误。如果设置了 log_config_append,则此选项将被忽略。

log_color
类型:

布尔值

默认值:

False

(可选) 根据日志级别设置“color”键。此选项仅在将日志记录到 stderr 或 stdout 时生效。如果设置了 log_config_append,则此选项将被忽略。

log_rotate_interval
类型:

整数

默认值:

1

日志文件轮换前的时间量。如果未设置 log_rotation_type 为“interval”,则此选项将被忽略。

log_rotate_interval_type
类型:

字符串

默认值:

days

有效值:

秒、分钟、小时、天、星期几、午夜

轮换间隔类型。在安排下一次轮换时,使用上次文件更改时间(或服务启动时间)。

max_logfile_count
类型:

整数

默认值:

30

最大轮换日志文件数。

max_logfile_size_mb
类型:

整数

默认值:

200

日志文件最大大小(MB)。如果“log_rotation_type”未设置为“size”,则此选项将被忽略。

log_rotation_type
类型:

字符串

默认值:

none

有效值:

interval, size, none

日志轮换类型。

可能的值

interval

以预定义的时间间隔轮换日志。

size

当日志达到预定义的大小后轮换日志。

none

不轮换日志文件。

logging_context_format_string
类型:

字符串

默认值:

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

用于带有上下文的日志消息的格式字符串。由 oslo_log.formatters.ContextFormatter 使用

logging_default_format_string
类型:

字符串

默认值:

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

当上下文未定义时,用于日志消息的格式字符串。由 oslo_log.formatters.ContextFormatter 使用

logging_debug_format_suffix
类型:

字符串

默认值:

%(funcName)s %(pathname)s:%(lineno)d

当消息的日志级别为 DEBUG 时,附加到日志消息的额外数据。由 oslo_log.formatters.ContextFormatter 使用

logging_exception_prefix
类型:

字符串

默认值:

%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

将此格式作为异常输出的每一行的前缀。由 oslo_log.formatters.ContextFormatter 使用

logging_user_identity_format
类型:

字符串

默认值:

%(user)s %(project)s %(domain)s %(system_scope)s %(user_domain)s %(project_domain)s

定义 logging_context_format_string 中使用的 %(user_identity)s 的格式字符串。由 oslo_log.formatters.ContextFormatter 使用

default_log_levels
类型:

列表

默认值:

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

包日志级别列表,格式为 logger=LEVEL 对。如果设置了 log_config_append,则此选项将被忽略。

publish_errors
类型:

布尔值

默认值:

False

启用或禁用错误事件的发布。

instance_format
类型:

字符串

默认值:

"[instance: %(uuid)s] "

与日志消息一起传递的实例的格式。

instance_uuid_format
类型:

字符串

默认值:

"[instance: %(uuid)s] "

与日志消息一起传递的实例 UUID 的格式。

rate_limit_interval
类型:

整数

默认值:

0

日志速率限制的间隔,秒数。

rate_limit_burst
类型:

整数

默认值:

0

每 rate_limit_interval 允许记录的最大消息数。

rate_limit_except_level
类型:

字符串

默认值:

CRITICAL

有效值:

CRITICAL, ERROR, INFO, WARNING, DEBUG, ‘’

速率限制使用的日志级别。日志级别大于或等于 rate_limit_except_level 的日志不会被过滤。空字符串表示所有级别都不会被过滤。

fatal_deprecations
类型:

布尔值

默认值:

False

启用或禁用弃用信息的致命状态。

backdoor_port
类型:

字符串

默认值:

<None>

启用 eventlet 后门。可接受的值为 0、<端口> 和 <开始>:<结束>,其中 0 将导致监听随机 tcp 端口号;<端口> 将导致监听指定的端口号(如果该端口正在使用则不启用后门);<开始>:<结束> 将导致监听指定端口号范围内未使用的最小端口号。所选端口将显示在服务的日志文件中。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘backdoor_port’ 选项已弃用,将在未来的版本中删除。

backdoor_socket
类型:

字符串

默认值:

<None>

启用 eventlet 后门,使用提供的路径作为可以接收连接的 unix 套接字。此选项与 ‘backdoor_port’ 互斥,即只能提供一个。如果同时提供两者,则此选项的存在优先于该选项的使用。在路径内部,{pid} 将被替换为当前进程的 PID。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘backdoor_socket’ 选项已弃用,将在未来的版本中删除。

log_options
类型:

布尔值

默认值:

True

启用或禁用在服务启动时(DEBUG 级别)记录所有已注册选项的值。

graceful_shutdown_timeout
类型:

整数

默认值:

60

指定优雅关闭服务器在退出之前等待的超时时间。值为零表示无限期等待。

api_paste_config
类型:

字符串

默认值:

api-paste.ini

api 服务的 paste.deploy 配置文件名

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘api_paste_config’ 选项已弃用,将在未来的版本中删除。

wsgi_log_format
类型:

字符串

默认值:

%(client_ip)s "%(request_line)s" 状态: %(status_code)s  长度: %(body_length)s 时间: %(wall_seconds).7f

用于生成日志行的 python 格式字符串。以下值可以格式化到其中:client_ip、date_time、request_line、status_code、body_length、wall_seconds。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘wsgi_log_format’ 选项已弃用,将在未来的版本中删除。

tcp_keepidle
类型:

整数

默认值:

600

为每个服务器套接字设置 TCP_KEEPIDLE 的值(以秒为单位)。不支持在 OS X 上。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘tcp_keepidle’ 选项已弃用,将在未来的版本中删除。

wsgi_default_pool_size
类型:

整数

默认值:

100

wsgi 使用的绿线程池的大小

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘wsgi_default_pool_size’ 选项已弃用,将在未来的版本中删除。

max_header_line
类型:

整数

默认值:

16384

接受的消息标头的最大行大小。当使用大型令牌时(通常是在配置为使用 PKI 令牌和大型服务目录的 keystone 时),可能需要增加 max_header_line。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘max_header_line’ 选项已弃用,将在未来的版本中删除。

wsgi_keep_alive
类型:

布尔值

默认值:

True

如果为 False,则显式关闭客户端套接字连接。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘wsgi_keep_alive’ 选项已弃用,将在未来的版本中删除。

client_socket_timeout
类型:

整数

默认值:

900

客户端连接套接字操作的超时时间。如果传入连接处于空闲状态的时间超过此秒数,则将关闭该连接。值为“0”表示无限期等待。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘client_socket_timeout’ 选项已弃用,将在未来的版本中删除。

wsgi_server_debug
类型:

布尔值

默认值:

False

如果为 True,服务器将在 500 错误时将异常堆栈跟踪发送给客户端。如果为 False,服务器将用空主体响应。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘wsgi_server_debug’ 选项已弃用,将在未来的版本中删除。

listen_address
类型:

字符串

默认值:

::

监听的 IP 地址。

listen_port
类型:

端口号

默认值:

5050

最小值:

0

最大值:

65535

监听的端口。

listen_unix_socket
类型:

字符串

默认值:

<None>

监听的 Unix 套接字。禁用 listen_address 和 listen_port。

listen_unix_socket_mode
类型:

未知类型

默认值:

<None>

Unix 套接字的文件模式(八进制数)。如果未设置 listen_unix_socket,则忽略。

host
类型:

字符串

默认值:

localhost

此选项有一个示例默认值,这意味着其实际默认值可能与上述文档值不同。

此节点的名称。这可以是任何不透明的标识符。它不一定是主机名、FQDN 或 IP 地址。但是,节点名称必须在 AMQP 密钥中有效。

auth_strategy
类型:

字符串

默认值:

keystone

有效值:

noauth, keystone, http_basic

ironic-inspector API 上使用的身份验证方法。“noauth”、“keystone”或“http_basic”是有效选项。“noauth”将禁用所有身份验证。

可能的值

noauth

无身份验证

keystone

使用 Identity 服务进行身份验证

http_basic

HTTP 基本身份验证

http_basic_auth_user_file
类型:

字符串

默认值:

/etc/ironic-inspector/htpasswd

当 auth_strategy=http_basic 时使用的 Apache 格式用户身份验证文件的路径

timeout
类型:

整数

默认值:

3600

最大值:

315576000

内省被认为失败后的超时时间,设置为 0 以禁用。

clean_up_period
类型:

整数

默认值:

60

最小值:

0

清理超时节点和旧节点状态信息的重复周期(秒)。警告:如果设置为 0,则将禁用周期性任务,并且 inspector 将不会与 ironic 同步以完成内部清理过程。如果部署使用 PXE 过滤器,则不建议这样做,并且会导致 ironic-inspector 停止定期清理活动。

leader_election_interval
类型:

整数

默认值:

10

领导者选举之间的间隔(秒)。

use_ssl
类型:

布尔值

默认值:

False

SSL 已启用/禁用

max_concurrency
类型:

整数

默认值:

1000

最小值:

2

绿色线程池的大小。

introspection_delay
类型:

整数

默认值:

5

两次内省之间的延迟(秒)。仅当由 ironic-inspector 管理引导(即 manage_boot==True)时才适用。

ipmi_address_fields
类型:

列表

默认值:

['redfish_address', 'ilo_address', 'drac_host', 'drac_address', 'ibmc_address']

Ironic driver_info 字段,等效于 ipmi_address。

rootwrap_config
类型:

字符串

默认值:

/etc/ironic-inspector/rootwrap.conf

用于以 root 身份运行命令的 rootwrap 配置文件路径

api_max_limit
类型:

整数

默认值:

1000

最小值:

1

限制 API list-call 返回的元素数量

can_manage_boot
类型:

布尔值

默认值:

True

当前 ironic-inspector 安装是否可以管理节点的 PXE 引导。如果设置为 False,API 将拒绝带有 manage_boot 缺失或设置为 True 的内省请求。

enable_mdns
类型:

布尔值

默认值:

False

是否启用通过多播 DNS 发布 ironic-inspector API 端点。

standalone
类型:

布尔值

默认值:

True

是否将 ironic-inspector 作为独立服务运行。设置为 False 是实验性的。

capabilities

boot_mode
类型:

布尔值

默认值:

False

是否存储引导模式(BIOS 或 UEFI)。

cpu_flags
类型:

dict

默认值:

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

CPU 标志与要设置的功能之间的映射,如果存在此标志。

coordination

backend_url
类型:

字符串

默认值:

memcached://:11211

用于分布式协调的后端 URL。实验性的。

cors

allowed_origin
类型:

列表

默认值:

<None>

指示是否允许与请求“origin”标头中接收到的域共享此资源。格式:“<protocol>://<host>[:<port>]”,不带尾部斜杠。示例:https://horizon.example.com

allow_credentials
类型:

布尔值

默认值:

True

指示实际请求是否可以包含用户凭据

expose_headers
类型:

列表

默认值:

[]

指示哪些标头可以安全地暴露给 API。默认值为 HTTP 简单标头。

max_age
类型:

整数

默认值:

3600

CORS 预检请求的最大缓存时间。

allow_methods
类型:

列表

默认值:

['GET', 'POST', 'PUT', 'HEAD', 'PATCH', 'DELETE', 'OPTIONS']

指示实际请求期间可以使用哪些方法。

allow_headers
类型:

列表

默认值:

['X-Auth-Token', 'X-OpenStack-Ironic-Inspector-API-Minimum-Version', 'X-OpenStack-Ironic-Inspector-API-Maximum-Version', 'X-OpenStack-Ironic-Inspector-API-Version']

指示实际请求期间可以使用哪些标头字段名称。

database

sqlite_synchronous
类型:

布尔值

默认值:

True

如果为 True,SQLite 使用同步模式。

backend
类型:

字符串

默认值:

sqlalchemy

用于数据库的后端。

connection
类型:

字符串

默认值:

<None>

用于连接到数据库的 SQLAlchemy 连接字符串。

slave_connection
类型:

字符串

默认值:

<None>

用于连接到从数据库的 SQLAlchemy 连接字符串。

asyncio_connection
类型:

字符串

默认值:

<None>

用于连接到数据库的 SQLAlchemy asyncio 连接字符串。

asyncio_slave_connection
类型:

字符串

默认值:

<None>

用于连接到从数据库的 SQLAlchemy asyncio 连接字符串。

mysql_sql_mode
类型:

字符串

默认值:

TRADITIONAL

为 MySQL 会话使用的 SQL 模式。此选项(包括默认值)会覆盖服务器设置的任何 SQL 模式。要使用服务器配置设置的任何 SQL 模式,请将其设置为无值。示例:mysql_sql_mode=

mysql_wsrep_sync_wait
类型:

整数

默认值:

<None>

仅适用于 Galera,配置新连接上的 wsrep_sync_wait 因果关系检查。默认值为 None,表示不配置任何设置。

connection_recycle_time
类型:

整数

默认值:

3600

连接在连接池中存在的时间超过此秒数后,将在下次从池中检出时替换为新的连接。

max_pool_size
类型:

整数

默认值:

5

保持在池中打开的 SQL 连接的最大数量。将值设置为 0 表示没有限制。

max_retries
类型:

整数

默认值:

10

启动期间打开数据库连接的最大重试次数。设置为 -1 表示无限重试次数。

retry_interval
类型:

整数

默认值:

10

重试打开 SQL 连接的间隔时间。

max_overflow
类型:

整数

默认值:

50

如果设置,则使用此值作为 SQLAlchemy 的 max_overflow。

connection_debug
类型:

整数

默认值:

0

最小值:

0

最大值:

100

SQL 调试信息的详细程度:0=无,100=全部。

connection_trace
类型:

布尔值

默认值:

False

将 Python 堆栈跟踪作为注释字符串添加到 SQL。

pool_timeout
类型:

整数

默认值:

<None>

如果设置,则使用此值作为 SQLAlchemy 的 pool_timeout。

use_db_reconnect
类型:

布尔值

默认值:

False

启用实验性的数据库重新连接功能,在连接丢失时使用。

db_retry_interval
类型:

整数

默认值:

1

数据库事务重试之间的秒数。

db_inc_retry_interval
类型:

布尔值

默认值:

True

如果为 True,则增加数据库操作重试之间的间隔,直到达到 db_max_retry_interval。

db_max_retry_interval
类型:

整数

默认值:

10

如果设置了 db_inc_retry_interval,则数据库操作重试之间的最大秒数。

db_max_retries
类型:

整数

默认值:

20

在出现连接错误或死锁错误之前,数据库重试的最大次数。设置为 -1 表示无限重试次数。

connection_parameters
类型:

字符串

默认值:

''

可选的 URL 参数,用于在连接时附加到连接 URL,格式为 param1=value1&param2=value2&…

discovery

enroll_node_driver
类型:

字符串

默认值:

fake-hardware

在创建 Ironic 中的新节点时,enroll hook 使用的 Ironic 驱动程序的名称。

enroll_node_fields
类型:

dict

默认值:

{}

设置在新发现的节点上的其他字段。

enabled_bmc_address_version
类型:

列表

默认值:

['4', '6']

在 Ironic 中注册新节点时将使用的 BMC 地址的 IP 版本。默认为“4,6”。可以是“4”(仅使用 v4 地址)、“4,6”(v4 地址优先级更高,如果同时找到 v6 地址则忽略 v6 版本)、“6,4”(v6 是首选,但回退到具有 v4 地址的 BMC 的 v4 地址,与“4,6”相反)或“6”(仅使用 v6 地址并忽略 v4 版本)。

dnsmasq_pxe_filter

dhcp_hostsdir
类型:

字符串

默认值:

/var/lib/ironic-inspector/dhcp-hostsdir

暴露给 dnsmasq 的 MAC 地址缓存目录。预计此目录由驱动程序独占控制。

purge_dhcp_hostsdir
类型:

布尔值

默认值:

True

在驱动程序初始化时清除 hostsdir。设置为 false 仅在 inspector 的部署方式是在同一主机和命名空间内执行多个进程时才应执行。在这种情况下,Operator 负责设置自定义清理设施。

dnsmasq_start_command
类型:

字符串

默认值:

''

在过滤器初始化时启动 dnsmasq 服务的 shell 命令行。默认:不启动。

dnsmasq_stop_command
类型:

字符串

默认值:

''

在 inspector 退出(错误)时停止 dnsmasq 服务的 shell 命令行。默认:不停止。

exception

fatal_exception_format_errors
类型:

布尔值

默认值:

False

如果生成异常消息时存在格式错误(编程错误),则使用。如果为 True,则引发异常;如果为 False,则使用未格式化的消息。

已弃用的变体

Group

名称

ironic_lib

fatal_exception_format_errors

extra_hardware

strict
类型:

布尔值

默认值:

False

如果为 True,则拒绝解析额外数据,如果至少有一个记录太短。此外,即使解析失败,也会删除传入的“data”。

healthcheck

path
类型:

字符串

默认值:

/healthcheck

响应 healthcheck 请求的路径。

警告

此选项已弃用,将来可能会被静默忽略。

detailed
类型:

布尔值

默认值:

False

在响应中显示更多详细信息。安全说明:启用此选项可能会暴露有关正在监视的服务敏感详细信息。请确保验证它不会违反您的安全策略。

backends
类型:

列表

默认值:

[]

可以执行 healthcheck 并将该信息作为请求的一部分返回的其他后端。

allowed_source_ranges
类型:

列表

默认值:

[]

用于限制允许访问 healthcheck 信息的源 IP 的网络地址列表。来自这些网络地址之外的任何请求将被忽略。

ignore_proxied_requests
类型:

布尔值

默认值:

False

忽略带有代理标头的请求。

disable_by_file_path
类型:

字符串

默认值:

<None>

检查文件的存在情况,以确定应用程序是否正在端口上运行。由 DisableByFileHealthcheck 插件使用。

disable_by_file_paths
类型:

列表

默认值:

[]

检查基于端口的文件是否存在情况,以确定应用程序是否正在端口上运行。期望一个“port:path”字符串列表。由 DisableByFilesPortsHealthcheck 插件使用。

enable_by_file_paths
类型:

列表

默认值:

[]

检查文件的存在情况。由 EnableByFilesHealthcheck 插件使用。

enabled
类型:

布尔值

默认值:

False

启用 /healthcheck 处的健康检查端点。请注意,此端点未经过身份验证。有关更多信息,请参见 https://docs.openstack.org/oslo.middleware/2025.2/reference/healthcheck_plugins.html

iptables

dnsmasq_interface
类型:

字符串

默认值:

br-ctlplane

dnsmasq 侦听的接口,默认情况下用于 VM。

firewall_chain
类型:

字符串

默认值:

ironic-inspector

要使用的 iptables 链名称。

ethoib_interfaces
类型:

列表

默认值:

[]

Inspector 主机上的以太网 over InfiniBand 接口列表,用于物理访问 DHCP 网络。多个接口将被附加到 dnsmasq_interface 中指定的 bond 或 bridge。处于非期望状态的 InfiniBand 节点的 MAC 地址将基于这些接口上的邻居 MAC 列表被阻止。

ip_version
类型:

字符串

默认值:

4

有效值:

4, 6

用于 iptables 过滤器的 IP 版本。默认为 4。

可能的值

4

IPv4

6

IPv6

ironic

auth_url
类型:

未知类型

默认值:

<None>

认证 URL

auth_type
类型:

未知类型

默认值:

<None>

要加载的身份验证类型

已弃用的变体

Group

名称

ironic

auth_plugin

cafile
类型:

字符串

默认值:

<None>

在验证 HTTPS 连接时使用的 PEM 编码的证书颁发机构。

certfile
类型:

字符串

默认值:

<None>

PEM 编码的客户端证书文件

collect_timing
类型:

布尔值

默认值:

False

收集每个 API 调用的计时信息。

connect_retries
类型:

整数

默认值:

<None>

应尝试的连接错误的重试次数上限。

connect_retry_delay
类型:

浮点数

默认值:

<None>

连接错误的两次重试之间的延迟(以秒为单位)。如果未设置,则从 0.5 秒开始,最大 60 秒的指数重试将被使用。

default_domain_id
类型:

未知类型

默认值:

<None>

与 v3 和 v2 参数一起使用的可选域 ID。它将在 v3 中用于用户域和项目域,并在 v2 身份验证中忽略。

default_domain_name
类型:

未知类型

默认值:

<None>

与 v3 API 和 v2 参数一起使用的可选域名称。它将在 v3 中用于用户域和项目域,并在 v2 身份验证中忽略。

domain_id
类型:

未知类型

默认值:

<None>

作用域的域 ID

domain_name
类型:

未知类型

默认值:

<None>

作用域的域名称

endpoint_override
类型:

字符串

默认值:

<None>

始终将此端点 URL 用于此客户端的请求。注意:应在此处指定未版本化的端点;要请求特定的 API 版本,请使用 versionmin-version 和/或 max-version 选项。

insecure
类型:

布尔值

默认值:

False

验证 HTTPS 连接。

keyfile
类型:

字符串

默认值:

<None>

PEM 编码的客户端证书密钥文件

max_version
类型:

字符串

默认值:

<None>

给定 API 的最大主版本,旨在用作与 min_version 范围的上限。与 version 互斥。

max_retries
类型:

整数

默认值:

30

发生冲突错误(HTTP 409)时的最大重试次数。

min_version
类型:

字符串

默认值:

<None>

给定 API 的最小主版本,旨在用作与 max_version 范围的下限。与 version 互斥。如果提供了 min_version 但没有 max_version,则 max 版本就像“最新”一样。

password
类型:

未知类型

默认值:

<None>

用户的密码

project_domain_id
类型:

未知类型

默认值:

<None>

包含项目的域 ID

project_domain_name
类型:

未知类型

默认值:

<None>

包含项目的域名称

project_id
类型:

未知类型

默认值:

<None>

作用域的项目 ID

已弃用的变体

Group

名称

ironic

tenant-id

ironic

tenant_id

project_name
类型:

未知类型

默认值:

<None>

作用域的项目名称

已弃用的变体

Group

名称

ironic

tenant-name

ironic

tenant_name

region_name
类型:

字符串

默认值:

<None>

用于端点 URL 发现的默认 region_name。

retriable_status_codes
类型:

列表

默认值:

<None>

应重试的可重试 HTTP 状态代码列表。如果未设置,则默认为 [503]

retry_interval
类型:

整数

默认值:

2

发生冲突错误(HTTP 409)时的重试间隔。

service_name
类型:

字符串

默认值:

<None>

用于端点 URL 发现的默认 service_name。

service_type
类型:

字符串

默认值:

baremetal

用于端点 URL 发现的默认 service_type。

split_loggers
类型:

布尔值

默认值:

False

将请求记录到多个记录器。

status_code_retries
类型:

整数

默认值:

<None>

应尝试的可重试 HTTP 状态代码的重试次数上限。

status_code_retry_delay
类型:

浮点数

默认值:

<None>

可重试状态代码的两次重试之间的延迟(以秒为单位)。如果未设置,则从 0.5 秒开始,最大 60 秒的指数重试将被使用。

system_scope
类型:

未知类型

默认值:

<None>

系统操作的作用域

tenant_id
类型:

未知类型

默认值:

<None>

租户 ID

tenant_name
类型:

未知类型

默认值:

<None>

租户名称

timeout
类型:

整数

默认值:

<None>

http 请求的超时值

trust_id
类型:

未知类型

默认值:

<None>

用作受托人的信任 ID

user_domain_id
类型:

未知类型

默认值:

<None>

用户域 ID

user_domain_name
类型:

未知类型

默认值:

<None>

用户的域名称

user_id
类型:

未知类型

默认值:

<None>

用户 ID

username
类型:

未知类型

默认值:

<None>

用户名

已弃用的变体

Group

名称

ironic

user-name

ironic

user_name

valid_interfaces
类型:

列表

默认值:

['internal', 'public']

端点 URL 的接口列表,按优先级顺序排列。

version
类型:

字符串

默认值:

<None>

给定 Major API 版本内端点 URL 发现的最小 Major API 版本。与 min_version 和 max_version 互斥

keystone_authtoken

www_authenticate_uri
类型:

字符串

默认值:

<None>

完整的“公共”身份 API 端点。此端点不应是“admin”端点,因为它应可供所有最终用户访问。未经身份验证的客户端将被重定向到此端点以进行身份验证。虽然此端点理想情况下应该是未版本化的,但实际客户端支持各不相同。如果您在此处使用版本化的 v2 端点,则不应与服务用户用于验证令牌的端点相同,因为普通最终用户可能无法访问该端点。

已弃用的变体

Group

名称

keystone_authtoken

auth_uri

auth_uri
类型:

字符串

默认值:

<None>

完整的“公共”身份 API 端点。此端点不应是“admin”端点,因为它应可供所有最终用户访问。未经身份验证的客户端将被重定向到此端点以进行身份验证。虽然此端点理想情况下应该是未版本化的,但实际客户端支持各不相同。如果您在此处使用版本化的 v2 端点,则不应与服务用户用于验证令牌的端点相同,因为普通最终用户可能无法访问该端点。此选项已被弃用,以支持 www_authenticate_uri,并且将在 S 版本中删除。

警告

此选项已弃用以供删除,自 Queens 以来。其值将来可能会被默默地忽略。

原因:

auth_uri 选项已被弃用,以支持 www_authenticate_uri,并且将在 S 版本中删除。

auth_version
类型:

字符串

默认值:

<None>

身份 API 端点的 API 版本。

interface
类型:

字符串

默认值:

internal

用于身份 API 端点的接口。有效值为“public”、“internal”(默认)或“admin”。

delay_auth_decision
类型:

布尔值

默认值:

False

不在中间件中处理授权请求,而是将授权决策委托给下游 WSGI 组件。

http_connect_timeout
类型:

整数

默认值:

<None>

与 Identity API 服务器通信的请求超时值。

http_request_max_retries
类型:

整数

默认值:

3

与 Identity API 服务器通信时,我们尝试重新连接多少次。

cache
类型:

字符串

默认值:

<None>

请求环境键,其中存储了 Swift 缓存对象。当 auth_token 中间件与 Swift 缓存一起部署时,使用此选项与 swift 共享缓存后端。否则,请改用 memcached_servers 选项。

certfile
类型:

字符串

默认值:

<None>

如果身份服务器需要客户端证书,则需要

keyfile
类型:

字符串

默认值:

<None>

如果身份服务器需要客户端证书,则需要

cafile
类型:

字符串

默认值:

<None>

在验证 HTTPS 连接时使用的 PEM 编码的证书颁发机构。默认值为系统 CA。

insecure
类型:

布尔值

默认值:

False

验证 HTTPS 连接。

region_name
类型:

字符串

默认值:

<None>

可以找到身份服务器的区域。

memcached_servers
类型:

列表

默认值:

<None>

可选地指定要用于缓存的 memcached 服务器列表。如果未定义,则令牌将改为在进程内缓存。

已弃用的变体

Group

名称

keystone_authtoken

memcache_servers

token_cache_time
类型:

整数

默认值:

300

为了防止花费过多的精力来验证令牌,中间件将先前看到的令牌缓存配置的时间(以秒为单位)。设置为 -1 以完全禁用缓存。

memcache_security_strategy
类型:

字符串

默认值:

有效值:

None, MAC, ENCRYPT

(可选) 如果定义,指示是否应对缓存中的令牌数据进行身份验证或进行身份验证和加密。如果为 MAC,则令牌数据在缓存中进行身份验证(使用 HMAC)。如果为 ENCRYPT,则令牌数据在缓存中进行加密和身份验证。如果该值不是这些选项之一或为空,auth_token 将在初始化时引发异常。

memcache_secret_key
类型:

字符串

默认值:

<None>

(可选,如果定义了 memcache_security_strategy 则为必需) 此字符串用于密钥派生。

memcache_tls_enabled
类型:

布尔值

默认值:

False

(可选) 与缓存服务器通信时 TLS 使用的全局切换。

memcache_tls_cafile
类型:

字符串

默认值:

<None>

(可选) 建立缓存服务器身份所需的 PEM 格式的串联 CA 证书的文件路径。如果 tls_enabled 为 False,则忽略此选项。

memcache_tls_certfile
类型:

字符串

默认值:

<None>

(可选) 包含客户端证书以及建立证书身份所需的任何数量的 CA 证书的单个 PEM 格式的文件路径。仅当需要客户端身份验证时才需要此文件。如果 tls_enabled 为 False,则忽略此选项。

memcache_tls_keyfile
类型:

字符串

默认值:

<None>

(可选) 包含客户端私钥的单个文件。否则,私钥将从 tls_certfile 中指定的 文件中获取。如果 tls_enabled 为 False,则忽略此选项。

memcache_tls_allowed_ciphers
类型:

字符串

默认值:

<None>

(可选) 设置使用 TLS 上下文创建的套接字的可用密码。它应该是 OpenSSL 密码列表格式的字符串。如果未指定,将启用所有 OpenSSL 密码。

memcache_pool_dead_retry
类型:

整数

默认值:

300

(可选) memcached 服务器被认为已死并在重试之前的时间(以秒为单位)。

memcache_pool_maxsize
类型:

整数

默认值:

10

(可选) 到每个 memcached 服务器的最大打开连接数。

memcache_pool_socket_timeout
类型:

整数

默认值:

3

(可选) 与 memcached 服务器通信的套接字超时时间(以秒为单位)。

memcache_pool_unused_timeout
类型:

整数

默认值:

60

(可选) 连接在池中未使用的时间(以秒为单位),然后将其关闭。

memcache_pool_conn_get_timeout
类型:

整数

默认值:

10

(可选) 操作等待从池中获取 memcached 客户端连接的时间(以秒为单位)。

memcache_use_advanced_pool
类型:

布尔值

默认值:

True

(可选) 使用高级(eventlet 安全)memcached 客户端池。

include_service_catalog
类型:

布尔值

默认值:

True

(可选) 指示是否设置 X-Service-Catalog 标头。如果为 False,中间件不会要求在令牌验证时获取服务目录,也不会设置 X-Service-Catalog 标头。

enforce_token_bind
类型:

字符串

默认值:

permissive

用于控制令牌绑定使用和类型。可以设置为:“disabled”以不检查令牌绑定。“permissive”(默认)如果绑定类型是服务器已知的一种形式,则验证绑定信息,如果不是则忽略它。“strict”类似于“permissive”,但如果绑定类型未知,则拒绝该令牌。“required”需要任何形式的令牌绑定才能被允许。最后,是必须出现在令牌中的绑定方法的名称。

service_token_roles
类型:

列表

默认值:

['service']

服务令牌中必须存在的一组角色选择。服务令牌允许请求可以使用过期的令牌,因此此检查应严格控制只有实际的服务才能发送此令牌。此处的角色作为 ANY 检查应用,因此列表中任何角色都必须存在。出于向后兼容的原因,这目前仅影响 allow_expired 检查。

service_token_roles_required
类型:

布尔值

默认值:

False

出于向后兼容的原因,我们必须允许通过 service_token_roles 检查但未通过有效服务令牌。将此设置为 true 将在未来的版本中成为默认设置,如果可能,应启用它。

service_type
类型:

字符串

默认值:

<None>

服务目录中出现的服务的名称或类型。这用于验证具有受限访问规则的令牌。

memcache_sasl_enabled
类型:

布尔值

默认值:

False

如果 SASL_enable 为 true,则启用 SASL(简单身份验证和安全层),否则禁用。

memcache_username
类型:

字符串

默认值:

''

SASL 的用户名

memcache_password
类型:

字符串

默认值:

''

SASL 的用户名密码

auth_type
类型:

未知类型

默认值:

<None>

要加载的身份验证类型

已弃用的变体

Group

名称

keystone_authtoken

auth_plugin

auth_section
类型:

未知类型

默认值:

<None>

从中加载插件特定选项的配置节

mdns

registration_attempts
类型:

整数

默认值:

5

最小值:

1

注册服务的尝试次数。目前必须大于 1,因为 zeroconf 库中存在竞争条件。

lookup_attempts
类型:

整数

默认值:

3

最小值:

1

服务查找尝试次数。

params
类型:

未知类型

默认值:

{}

注册服务时传递的附加参数。

interfaces
类型:

列表

默认值:

<None>

用于 mDNS 的接口的 IP 地址列表。默认情况下使用系统上的所有接口。

oslo_messaging_kafka

kafka_max_fetch_bytes
类型:

整数

默认值:

1048576

Kafka 消费者最大获取字节数

kafka_consumer_timeout
类型:

浮点数

默认值:

1.0

Kafka 消费者的默认超时时间(秒)

consumer_group
类型:

字符串

默认值:

oslo_messaging_consumer

Kafka 消费者的组 ID。同一组中的消费者将协调消息消费

producer_batch_timeout
类型:

浮点数

默认值:

0.0

KafkaProducer 批量处理延迟的上限(秒)

producer_batch_size
类型:

整数

默认值:

16384

生产者异步发送的批处理大小

compression_codec
类型:

字符串

默认值:

none

有效值:

none, gzip, snappy, lz4, zstd

生产者生成的所有数据的压缩编解码器。如果未设置,则不使用压缩。请注意,允许的值取决于 kafka 版本

enable_auto_commit
类型:

布尔值

默认值:

False

启用异步消费者提交

max_poll_records
类型:

整数

默认值:

500

在轮询调用中返回的最大记录数

security_protocol
类型:

字符串

默认值:

PLAINTEXT

有效值:

PLAINTEXT, SASL_PLAINTEXT, SSL, SASL_SSL

用于与代理通信的协议

sasl_mechanism
类型:

字符串

默认值:

PLAIN

安全协议为 SASL 时的机制

ssl_cafile
类型:

字符串

默认值:

''

用于验证服务器证书的 CA 证书 PEM 文件

ssl_client_cert_file
类型:

字符串

默认值:

''

用于身份验证的客户端证书 PEM 文件。

ssl_client_key_file
类型:

字符串

默认值:

''

用于身份验证的客户端密钥 PEM 文件。

ssl_client_key_password
类型:

字符串

默认值:

''

用于身份验证的客户端密钥密码文件。

oslo_messaging_notifications

driver
类型:

多值

默认值:

''

处理发送通知的驱动程序。可能的值是 messaging、messagingv2、routing、log、test、noop

transport_url
类型:

字符串

默认值:

<None>

用于通知的消息驱动程序的 URL。如果未设置,我们将回退到用于 RPC 的相同配置。

topics
类型:

列表

默认值:

['notifications']

用于 OpenStack 通知 AMQP 主题。

retry
类型:

整数

默认值:

-1

由于可恢复错误而未能传递的通知消息重试的最大次数。0 - 不重试,-1 - 无限

oslo_messaging_rabbit

amqp_durable_queues
类型:

布尔值

默认值:

False

在 AMQP 中使用持久队列。如果启用了 rabbit_quorum_queue,则队列将是持久的,并且此值将被忽略。

amqp_auto_delete
类型:

布尔值

默认值:

False

在 AMQP 中自动删除队列。

rpc_conn_pool_size
类型:

整数

默认值:

30

最小值:

1

RPC 连接池的大小。

conn_pool_min_size
类型:

整数

默认值:

2

连接过期策略的池大小限制

conn_pool_ttl
类型:

整数

默认值:

1200

池中空闲连接的生存时间(秒)

ssl
类型:

布尔值

默认值:

False

通过 SSL 连接。

ssl_version
类型:

字符串

默认值:

''

要使用的 SSL 版本(仅在启用 SSL 时有效)。有效值为 TLSv1 和 SSLv23。某些发行版上可能可用 SSLv2、SSLv3、TLSv1_1 和 TLSv1_2。

ssl_key_file
类型:

字符串

默认值:

''

SSL 密钥文件(仅在启用 SSL 时有效)。

ssl_cert_file
类型:

字符串

默认值:

''

SSL 证书文件(仅在启用 SSL 时有效)。

ssl_ca_file
类型:

字符串

默认值:

''

用于验证服务器证书的 SSL 证书颁发机构文件(仅在启用 SSL 时有效)。

ssl_enforce_fips_mode
类型:

布尔值

默认值:

False

全局切换以强制执行 OpenSSL FIPS 模式。此功能需要 Python 支持。这在所有环境中的 Python 3.9 中可用,并且可能已回溯到旧版本的 Python。如果使用的 Python 可执行文件不支持 OpenSSL FIPS 模式,将引发异常。

heartbeat_in_pthread
类型:

布尔值

默认值:

False

(已弃用) 建议不再使用此选项。默认情况下,通过本机 python 线程运行健康检查心跳线程。如果此选项等于 False,则心跳将继承父进程的执行模型。例如,如果父进程通过使用 eventlet/greenlet 猴子补丁了 stdlib,则心跳将通过绿色线程运行。仅当使用 eventlet 作为核心服务框架的服务时,才应将此选项设置为 True。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

该选项与即将删除的 Eventlet 相关。此外,这从未像预期那样与使用 eventlet 作为核心服务框架的服务一起工作。

kombu_reconnect_delay
类型:

浮点数

默认值:

1.0

最小值:

0.0

最大值:

4.5

响应 AMQP 消费者取消通知后重新连接的等待时间(秒)。

kombu_reconnect_splay
类型:

浮点数

默认值:

0.0

最小值:

0.0

响应 AMQP 消费者取消通知后重新连接时随机等待时间。

kombu_compression
类型:

字符串

默认值:

<None>

实验性:可能的值是:gzip、bz2。如果未设置,则不使用压缩。此选项可能在未来版本中不可用。

kombu_missing_consumer_retry_timeout
类型:

整数

默认值:

60

在放弃向其发送回复之前等待缺失客户端的时间。此值不应大于 rpc_response_timeout。

已弃用的变体

Group

名称

oslo_messaging_rabbit

kombu_reconnect_timeout

kombu_failover_strategy
类型:

字符串

默认值:

round-robin

有效值:

round-robin, shuffle

确定在当前连接的 RabbitMQ 节点不可用时如何选择下一个 RabbitMQ 节点。仅当配置中提供多个 RabbitMQ 节点时才生效。

rabbit_login_method
类型:

字符串

默认值:

AMQPLAIN

有效值:

PLAIN, AMQPLAIN, EXTERNAL, RABBIT-CR-DEMO

RabbitMQ 登录方法。

rabbit_retry_interval
类型:

整数

默认值:

1

最小值:

1

与 RabbitMQ 重新连接的频率。

rabbit_retry_backoff
类型:

整数

默认值:

2

最小值:

0

在连接到 RabbitMQ 时重试之间的回退时间。

rabbit_interval_max
类型:

整数

默认值:

30

最小值:

1

RabbitMQ 连接重试的最大间隔。

rabbit_ha_queues
类型:

布尔值

默认值:

False

尝试在 RabbitMQ 中使用 HA 队列(x-ha-policy:all)。如果您更改此选项,则必须擦除 RabbitMQ 数据库。在 RabbitMQ 3.0 中,队列镜像不再由声明队列时的 x-ha-policy 参数控制。如果您只想确保所有队列(不包括具有自动生成名称的队列)在所有节点上镜像,请运行:“rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “

rabbit_quorum_queue
类型:

布尔值

默认值:

False

在 RabbitMQ 中使用 quorum 队列(x-queue-type:quorum)。quorum 队列是 RabbitMQ 的一种现代队列类型,它实现了一个基于 Raft 共识算法的持久、复制的 FIFO 队列。它从 RabbitMQ 3.8.0 开始可用。如果设置此选项,它将与 HA 队列(rabbit_ha_queues)即镜像队列冲突,换句话说,应禁用 HA 队列。Quorum 队列默认情况下也是持久的,因此启用此选项时会忽略 amqp_durable_queues 选项。

rabbit_transient_quorum_queue
类型:

布尔值

默认值:

False

在 RabbitMQ 中为瞬态队列使用 quorum 队列。启用此选项将确保这些队列也使用 quorum 类型的 rabbit 队列,这些队列默认情况下是 HA。

rabbit_quorum_delivery_limit
类型:

整数

默认值:

0

每次将消息重新传递给消费者时,都会递增计数器。一旦重新传递计数超过传递限制,该消息将被丢弃或死信(如果配置了 DLX 交换机)。仅当启用 rabbit_quorum_queue 时使用,默认值为 0,表示不设置限制。

rabbit_quorum_max_memory_length
类型:

整数

默认值:

0

默认情况下,所有消息都保存在内存中。如果 quorum 队列增长,可能会给集群带来内存压力。此选项可以限制 quorum 队列中的消息数量。仅当启用 rabbit_quorum_queue 时使用,默认值为 0,表示不设置限制。

rabbit_quorum_max_memory_bytes
类型:

整数

默认值:

0

默认情况下,所有消息都保存在内存中。如果 quorum 队列增长,可能会给集群带来内存压力。此选项可以限制 quorum 队列使用的内存字节数。仅在启用 rabbit_quorum_queue 时使用,默认值为 0,表示不设置限制。

rabbit_transient_queues_ttl
类型:

整数

默认值:

1800

最小值:

0

表示队列 TTL(x-expires)的秒数(正整数)。对于达到 TTL 持续时间的未使用的队列,将自动删除。该参数仅影响回复和扇出队列。将值设置为 0 将禁用 x-expires。如果这样做,请确保您拥有一个 rabbitmq 策略来删除队列,否则您的部署会随着时间的推移创建无限数量的队列。如果将 rabbit_stream_fanout 设置为 True,此选项将控制扇出队列中消息的数据保留策略(x-max-age),而不是队列持续时间本身。因此,一旦达到 TTL,流队列中最旧的数据将被丢弃。将设置为 0 将禁用流的 x-max-age,从而使流无限增长并填满磁盘空间

rabbit_qos_prefetch_count
类型:

整数

默认值:

0

指定要预取的消息数量。设置为零允许无限数量的消息。

heartbeat_timeout_threshold
类型:

整数

默认值:

60

如果心跳的 keep-alive 失败,则 Rabbit broker 被认为已关闭的时间(秒)。(0 禁用心跳)。

heartbeat_rate
类型:

整数

默认值:

3

在 heartbeat_timeout_threshold 期间检查心跳的频率。

direct_mandatory_flag
类型:

布尔值

默认值:

True

(已弃用)启用/禁用直接发送的 RabbitMQ mandatory 标志。直接发送用作回复,因此如果客户端队列不存在,则会引发 MessageUndeliverable 异常。MessageUndeliverable 异常将用于超时循环,以便让发送者有机会恢复。此标志已弃用,并且不再可以禁用此功能

警告

此选项已弃用,将来可能会被静默忽略。

原因:

Mandatory 标志不再可以禁用。

enable_cancel_on_failover
类型:

布尔值

默认值:

False

启用 x-cancel-on-ha-failover 标志,以便 rabbitmq 服务器在队列关闭时取消并通知消费者

use_queue_manager
类型:

布尔值

默认值:

False

我们应该使用一致的队列名称还是随机名称

hostname
类型:

字符串

默认值:

node1.example.com

此选项有一个示例默认值,这意味着其实际默认值可能与上述文档值不同。

队列管理器使用的主机名。默认值为 socket.gethostname() 返回的值。

processname
类型:

字符串

默认值:

nova-api

此选项有一个示例默认值,这意味着其实际默认值可能与上述文档值不同。

队列管理器使用的进程名称

rabbit_stream_fanout
类型:

布尔值

默认值:

False

在 RabbitMQ 中使用流队列(x-queue-type: stream)。流是 RabbitMQ 3.9.0 及更高版本中一种新的持久化和复制的数据结构(“队列类型”),它模拟了一个仅追加日志,具有非破坏性消费者语义。如果设置此选项,将用单个流队列替换所有扇出队列。

oslo_policy

enforce_scope
类型:

布尔值

默认值:

True

此选项控制在评估策略时是否强制执行范围。如果为 True,则将请求中使用的令牌的范围与正在强制执行的策略的 scope_types 进行比较。如果范围不匹配,将引发 InvalidScope 异常。如果为 False,将记录一条消息,告知操作员策略正在使用不匹配的范围调用。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

此配置是临时添加的,旨在促进顺利过渡到新的 RBAC。OpenStack 将始终强制执行范围检查。此配置选项已被弃用,将在 2025.2 版本周期中删除。

enforce_new_defaults
类型:

布尔值

默认值:

True

此选项控制在评估策略时是否使用旧的弃用默认值。如果为 True,则不会评估旧的弃用默认值。这意味着,如果任何现有的令牌允许使用旧的默认值,但对于新的默认值不允许,则将被禁止。鼓励启用此标志以及 enforce_scope 标志,以便同时获得新默认值和 scope_type 的好处。如果为 False,则逻辑上将弃用策略检查字符串与新的策略检查字符串进行 OR 运算,从而允许在具有新策略的发布版本之间实现平滑的升级体验,这是默认行为。

policy_file
类型:

字符串

默认值:

policy.yaml

将角色映射到给定服务权限的文件的相对或绝对路径。相对路径必须相对于设置此选项的配置文件指定。

policy_default_rule
类型:

字符串

默认值:

default

默认规则。在找不到请求的规则时强制执行。

policy_dirs
类型:

多值

默认值:

policy.d

存储策略配置文件目录。它们可以相对于 config_dir 选项定义的搜索路径中的任何目录,也可以是绝对路径。要搜索这些目录,必须存在 policy_file 中定义的的文件。忽略丢失或空的目录。

remote_content_type
类型:

字符串

默认值:

application/x-www-form-urlencoded

有效值:

application/x-www-form-urlencoded, application/json

用于基于 REST 的策略检查发送和接收数据的 Content Type

remote_ssl_verify_server_crt
类型:

布尔值

默认值:

False

基于 REST 的策略检查的服务器身份验证

remote_ssl_ca_crt_file
类型:

字符串

默认值:

<None>

基于 REST 的策略检查的 ca 证书文件的绝对路径

remote_ssl_client_crt_file
类型:

字符串

默认值:

<None>

基于 REST 的策略检查的客户端证书的绝对路径

remote_ssl_client_key_file
类型:

字符串

默认值:

<None>

基于 REST 的策略检查的客户端密钥文件的绝对路径

remote_timeout
类型:

浮点数

默认值:

60

最小值:

0

基于 REST 的策略检查的超时时间(秒)

pci_devices

alias
类型:

多值

默认值:

''

由“vendor_id”和“product_id”字段标识的 PCI 设备的别名。格式:{“vendor_id”: “1234”, “product_id”: “5678”, “name”: “pci_dev1”}

port_physnet

cidr_map
类型:

列表

默认值:

10.10.10.0/24:physnet_a,2001:db8::/64:physnet_b

此选项有一个示例默认值,这意味着其实际默认值可能与上述文档值不同。

IP 子网 CIDR 到物理网络的映射。当启用 physnet_cidr_map 处理钩子时,裸机端口的 physical_network 属性将基于此映射填充。

processing

add_ports
类型:

字符串

默认值:

pxe

有效值:

all, active, pxe, disabled

内省期间要添加为端口的 MAC 地址。可能的值:all(所有 MAC 地址),active(具有 IP 地址的 NIC 的 MAC 地址),pxe(仅 PXE 启动的 NIC 的 MAC 地址,如果 ramdisk 未提供 PXE MAC,则回退到“active”)。

keep_ports
类型:

字符串

默认值:

all

有效值:

all, present, added

在内省后要保留的端口(已存在于节点上)。可能的值:all(不删除任何内容),present(保留内省数据中存在的 MAC 的端口),added(仅保留内省期间添加的 MAC)。

overwrite_existing
类型:

布尔值

默认值:

True

是否覆盖节点数据库中的现有值。禁用此选项可使内省操作无破坏性。

default_processing_hooks
类型:

字符串

默认值:

ramdisk_error,root_disk_selection,scheduler,validate_interfaces,capabilities,pci_devices

处理管道的默认钩子列表,用逗号分隔。钩子“scheduler”使用 Nova 调度器所需的最小属性更新节点。钩子“validate_interfaces”确保 ramdisk 提供了有效的 NIC 数据。除非您真的知道自己在做什么,否则不要排除这两个钩子。

processing_hooks
类型:

字符串

默认值:

$default_processing_hooks

处理管道的启用钩子列表,用逗号分隔。此默认值为 $default_processing_hooks,钩子可以在默认值之前或之后添加,例如:“prehook,$default_processing_hooks,posthook”。

ramdisk_logs_dir
类型:

字符串

默认值:

<None>

如果设置,ramdisk 的日志将存储在此目录中。

always_store_ramdisk_logs
类型:

布尔值

默认值:

False

是否存储 ramdisk 日志,即使它没有返回错误消息(取决于是否设置了“ramdisk_logs_dir”选项)。

node_not_found_hook
类型:

字符串

默认值:

<None>

当 inspector 接收到来自尚未知晓的节点的内省信息时要运行的钩子名称。默认情况下忽略此钩子。

store_data
类型:

字符串

默认值:

none

存储内省数据的存储后端。可能的值是:“none”、“database”和“swift”。如果设置为“none”,则不会存储内省数据。

disk_partitioning_spacing
类型:

布尔值

默认值:

True

是否为分区保留 1 GiB 的磁盘空间。仅在使用 IPA 作为 ramdisk 时有效,对于旧的 ramdisk,local_gb 在 ramdisk 侧计算。

ramdisk_logs_filename_format
类型:

字符串

默认值:

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

存储 ramdisk 日志的文件名模板。可以使用以下替换:{uuid} - 节点 UUID 或“unknown”,{bmc} - 节点 BMC 地址或“unknown”,{dt} - 当前 UTC 日期和时间,{mac} - PXE 启动的 MAC 或“unknown”。

power_off
类型:

布尔值

默认值:

True

内省后是否关闭节点。如果通过“permit_active_introspection”配置选项启用了该功能,则处于活动或救援状态的节点在提交内省数据后将保持开启状态。

permit_active_introspection
类型:

布尔值

默认值:

False

是否处理处于运行状态的节点。

update_pxe_enabled
类型:

布尔值

默认值:

True

是否根据内省数据更新 pxe_enabled 值。如果将 [processing]overwrite_existing 设置为 False,则此选项无效。

pxe_filter

driver
类型:

字符串

默认值:

iptables

要使用的 PXE 启动过滤器驱动程序,可能的过滤器是:“iptables”、“dnsmasq”和“noop”。将“noop”设置为禁用防火墙过滤。

sync_period
类型:

整数

默认值:

15

最小值:

0

重复更新过滤器的秒数。

deny_unknown_macs
类型:

布尔值

默认值:

False

默认情况下,inspector 在内省处于活动状态时会为任何节点打开 DHCP 服务器。在内省处于活动状态时为未知 MAC 地址打开 DHCP 允许用户添加没有端口的节点到 ironic,并让 ironic-inspector 基于节点内省结果注册端口。注意:如果此选项为 True,则节点必须至少有一个已注册的端口才能进行内省。

service_catalog

auth_url
类型:

未知类型

默认值:

<None>

认证 URL

auth_type
类型:

未知类型

默认值:

<None>

要加载的身份验证类型

已弃用的变体

Group

名称

service_catalog

auth_plugin

cafile
类型:

字符串

默认值:

<None>

在验证 HTTPS 连接时使用的 PEM 编码的证书颁发机构。

certfile
类型:

字符串

默认值:

<None>

PEM 编码的客户端证书文件

collect_timing
类型:

布尔值

默认值:

False

收集每个 API 调用的计时信息。

connect_retries
类型:

整数

默认值:

<None>

应尝试的连接错误的重试次数上限。

connect_retry_delay
类型:

浮点数

默认值:

<None>

连接错误的两次重试之间的延迟(以秒为单位)。如果未设置,则从 0.5 秒开始,最大 60 秒的指数重试将被使用。

default_domain_id
类型:

未知类型

默认值:

<None>

与 v3 和 v2 参数一起使用的可选域 ID。它将在 v3 中用于用户域和项目域,并在 v2 身份验证中忽略。

default_domain_name
类型:

未知类型

默认值:

<None>

与 v3 API 和 v2 参数一起使用的可选域名称。它将在 v3 中用于用户域和项目域,并在 v2 身份验证中忽略。

domain_id
类型:

未知类型

默认值:

<None>

作用域的域 ID

domain_name
类型:

未知类型

默认值:

<None>

作用域的域名称

endpoint_override
类型:

字符串

默认值:

<None>

始终将此端点 URL 用于此客户端的请求。注意:应在此处指定未版本化的端点;要请求特定的 API 版本,请使用 versionmin-version 和/或 max-version 选项。

insecure
类型:

布尔值

默认值:

False

验证 HTTPS 连接。

keyfile
类型:

字符串

默认值:

<None>

PEM 编码的客户端证书密钥文件

max_version
类型:

字符串

默认值:

<None>

给定 API 的最大主版本,旨在用作与 min_version 范围的上限。与 version 互斥。

min_version
类型:

字符串

默认值:

<None>

给定 API 的最小主版本,旨在用作与 max_version 范围的下限。与 version 互斥。如果提供了 min_version 但没有 max_version,则 max 版本就像“最新”一样。

password
类型:

未知类型

默认值:

<None>

用户的密码

project_domain_id
类型:

未知类型

默认值:

<None>

包含项目的域 ID

project_domain_name
类型:

未知类型

默认值:

<None>

包含项目的域名称

project_id
类型:

未知类型

默认值:

<None>

作用域的项目 ID

已弃用的变体

Group

名称

service_catalog

tenant-id

service_catalog

tenant_id

project_name
类型:

未知类型

默认值:

<None>

作用域的项目名称

已弃用的变体

Group

名称

service_catalog

tenant-name

service_catalog

tenant_name

region_name
类型:

字符串

默认值:

<None>

用于端点 URL 发现的默认 region_name。

retriable_status_codes
类型:

列表

默认值:

<None>

应重试的可重试 HTTP 状态代码列表。如果未设置,则默认为 [503]

service_name
类型:

字符串

默认值:

<None>

用于端点 URL 发现的默认 service_name。

service_type
类型:

字符串

默认值:

baremetal-introspection

用于端点 URL 发现的默认 service_type。

split_loggers
类型:

布尔值

默认值:

False

将请求记录到多个记录器。

status_code_retries
类型:

整数

默认值:

<None>

应尝试的可重试 HTTP 状态代码的重试次数上限。

status_code_retry_delay
类型:

浮点数

默认值:

<None>

可重试状态代码的两次重试之间的延迟(以秒为单位)。如果未设置,则从 0.5 秒开始,最大 60 秒的指数重试将被使用。

system_scope
类型:

未知类型

默认值:

<None>

系统操作的作用域

tenant_id
类型:

未知类型

默认值:

<None>

租户 ID

tenant_name
类型:

未知类型

默认值:

<None>

租户名称

timeout
类型:

整数

默认值:

<None>

http 请求的超时值

trust_id
类型:

未知类型

默认值:

<None>

用作受托人的信任 ID

user_domain_id
类型:

未知类型

默认值:

<None>

用户域 ID

user_domain_name
类型:

未知类型

默认值:

<None>

用户的域名称

user_id
类型:

未知类型

默认值:

<None>

用户 ID

username
类型:

未知类型

默认值:

<None>

用户名

已弃用的变体

Group

名称

service_catalog

user-name

service_catalog

user_name

valid_interfaces
类型:

列表

默认值:

['internal', 'public']

端点 URL 的接口列表,按优先级顺序排列。

version
类型:

字符串

默认值:

<None>

给定 Major API 版本内端点 URL 发现的最小 Major API 版本。与 min_version 和 max_version 互斥

ssl

ca_file
类型:

字符串

默认值:

<None>

用于验证连接客户端的 CA 证书文件。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘ca_file’ 选项已弃用,将在未来的版本中删除。

cert_file
类型:

字符串

默认值:

<None>

在安全启动服务器时使用的证书文件。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘cert_file’ 选项已弃用,将在未来的版本中删除。

key_file
类型:

字符串

默认值:

<None>

在安全启动服务器时使用的私钥文件。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘key_file’ 选项已弃用,将在未来的版本中删除。

version
类型:

字符串

默认值:

<None>

要使用的 SSL 版本(仅在启用 SSL 时有效)。有效值为 TLSv1 和 SSLv23。某些发行版上可能可用 SSLv2、SSLv3、TLSv1_1 和 TLSv1_2。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘version’ 选项已弃用,将在未来的版本中删除。

ciphers
类型:

字符串

默认值:

<None>

设置可用的密码列表。该值应为 OpenSSL 密码列表格式的字符串。

警告

此选项已弃用,将来可能会被静默忽略。

原因:

‘ciphers’ 选项已弃用,将在未来的版本中删除。

swift

auth_url
类型:

未知类型

默认值:

<None>

认证 URL

auth_type
类型:

未知类型

默认值:

<None>

要加载的身份验证类型

已弃用的变体

Group

名称

swift

auth_plugin

cafile
类型:

字符串

默认值:

<None>

在验证 HTTPS 连接时使用的 PEM 编码的证书颁发机构。

certfile
类型:

字符串

默认值:

<None>

PEM 编码的客户端证书文件

collect_timing
类型:

布尔值

默认值:

False

收集每个 API 调用的计时信息。

connect_retries
类型:

整数

默认值:

<None>

应尝试的连接错误的重试次数上限。

connect_retry_delay
类型:

浮点数

默认值:

<None>

连接错误的两次重试之间的延迟(以秒为单位)。如果未设置,则从 0.5 秒开始,最大 60 秒的指数重试将被使用。

container
类型:

字符串

默认值:

ironic-inspector

创建对象时使用的默认 Swift 容器。

default_domain_id
类型:

未知类型

默认值:

<None>

与 v3 和 v2 参数一起使用的可选域 ID。它将在 v3 中用于用户域和项目域,并在 v2 身份验证中忽略。

default_domain_name
类型:

未知类型

默认值:

<None>

与 v3 API 和 v2 参数一起使用的可选域名称。它将在 v3 中用于用户域和项目域,并在 v2 身份验证中忽略。

delete_after
类型:

整数

默认值:

0

Swift 对象在被删除之前存在的秒数。(设置为 0 永不删除对象)。

domain_id
类型:

未知类型

默认值:

<None>

作用域的域 ID

domain_name
类型:

未知类型

默认值:

<None>

作用域的域名称

endpoint_override
类型:

字符串

默认值:

<None>

始终将此端点 URL 用于此客户端的请求。注意:应在此处指定未版本化的端点;要请求特定的 API 版本,请使用 versionmin-version 和/或 max-version 选项。

insecure
类型:

布尔值

默认值:

False

验证 HTTPS 连接。

keyfile
类型:

字符串

默认值:

<None>

PEM 编码的客户端证书密钥文件

max_version
类型:

字符串

默认值:

<None>

给定 API 的最大主版本,旨在用作与 min_version 范围的上限。与 version 互斥。

min_version
类型:

字符串

默认值:

<None>

给定 API 的最小主版本,旨在用作与 max_version 范围的下限。与 version 互斥。如果提供了 min_version 但没有 max_version,则 max 版本就像“最新”一样。

password
类型:

未知类型

默认值:

<None>

用户的密码

project_domain_id
类型:

未知类型

默认值:

<None>

包含项目的域 ID

project_domain_name
类型:

未知类型

默认值:

<None>

包含项目的域名称

project_id
类型:

未知类型

默认值:

<None>

作用域的项目 ID

已弃用的变体

Group

名称

swift

tenant-id

swift

tenant_id

project_name
类型:

未知类型

默认值:

<None>

作用域的项目名称

已弃用的变体

Group

名称

swift

tenant-name

swift

tenant_name

region_name
类型:

字符串

默认值:

<None>

用于端点 URL 发现的默认 region_name。

retriable_status_codes
类型:

列表

默认值:

<None>

应重试的可重试 HTTP 状态代码列表。如果未设置,则默认为 [503]

service_name
类型:

字符串

默认值:

<None>

用于端点 URL 发现的默认 service_name。

service_type
类型:

字符串

默认值:

object-store

用于端点 URL 发现的默认 service_type。

split_loggers
类型:

布尔值

默认值:

False

将请求记录到多个记录器。

status_code_retries
类型:

整数

默认值:

<None>

应尝试的可重试 HTTP 状态代码的重试次数上限。

status_code_retry_delay
类型:

浮点数

默认值:

<None>

可重试状态代码的两次重试之间的延迟(以秒为单位)。如果未设置,则从 0.5 秒开始,最大 60 秒的指数重试将被使用。

system_scope
类型:

未知类型

默认值:

<None>

系统操作的作用域

tenant_id
类型:

未知类型

默认值:

<None>

租户 ID

tenant_name
类型:

未知类型

默认值:

<None>

租户名称

timeout
类型:

整数

默认值:

<None>

http 请求的超时值

trust_id
类型:

未知类型

默认值:

<None>

用作受托人的信任 ID

user_domain_id
类型:

未知类型

默认值:

<None>

用户域 ID

user_domain_name
类型:

未知类型

默认值:

<None>

用户的域名称

user_id
类型:

未知类型

默认值:

<None>

用户 ID

username
类型:

未知类型

默认值:

<None>

用户名

已弃用的变体

Group

名称

swift

user-name

swift

user_name

valid_interfaces
类型:

列表

默认值:

['internal', 'public']

端点 URL 的接口列表,按优先级顺序排列。

version
类型:

字符串

默认值:

<None>

给定 Major API 版本内端点 URL 发现的最小 Major API 版本。与 min_version 和 max_version 互斥