Config Documentation¶
以下是 Designate 中所有可用配置的概述。有关示例配置文件，请参阅 designate.conf。
默认值¶
- run_external_periodic_tasks¶
- 类型:
布尔值
- 默认值:
True
某些周期性任务可以在单独的进程中运行。我们是否应该在这里运行它们？
- 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’ 选项已弃用，将在未来的版本中删除。
- 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¶
- 类型:
列表
- 默认值:
['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=INFO', 'oslo_messaging=INFO', 'iso8601=WARN', 'requests.packages.urllib3.connectionpool=WARN', 'urllib3.connectionpool=WARN', 'websocket=WARN', 'requests.packages.urllib3.util.retry=WARN', 'urllib3.util.retry=WARN', 'keystonemiddleware=WARN', 'routes.middleware=WARN', 'stevedore=WARN', 'taskflow=WARN', 'keystoneauth=WARN', 'oslo.cache=INFO', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO', 'kazoo.client=WARN', 'keystone=INFO', 'oslo_service.loopingcall=WARN']
包日志级别列表，格式为 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
启用或禁用弃用信息的致命状态。
- host¶
- 类型:
字符串
- 默认值:
current_hostname
此选项有一个示例默认值，这意味着其实际默认值可能与上述文档值不同。
此节点的名称
- pybasedir¶
- 类型:
字符串
- 默认值:
<Path>
此选项有一个示例默认值，这意味着其实际默认值可能与上述文档值不同。
安装 designate python 模块的目录
- state_path¶
- 类型:
字符串
- 默认值:
/var/lib/designate
维护 designate 状态的顶级目录
- allowed_remote_exmods¶
- 类型:
列表
- 默认值:
[]
包含允许的 RPC 异常的额外模块。
已弃用的变体¶ Group
名称
DEFAULT
allowed_rpc_exception_modules
- default_ttl¶
- 类型:
整数
- 默认值:
3600
TTL 值
- default_soa_refresh_min¶
- 类型:
整数
- 默认值:
3500
SOA refresh-min 值
已弃用的变体¶ Group
名称
DEFAULT
default_soa_refresh
- default_soa_refresh_max¶
- 类型:
整数
- 默认值:
3600
SOA max 值
- default_soa_retry¶
- 类型:
整数
- 默认值:
600
SOA retry
- default_soa_expire¶
- 类型:
整数
- 默认值:
86400
SOA expire
- default_soa_minimum¶
- 类型:
整数
- 默认值:
3600
SOA minimum 值
- supported_record_type¶
- 类型:
列表
- 默认值:
['A', 'AAAA', 'CNAME', 'MX', 'SRV', 'TXT', 'SPF', 'NS', 'PTR', 'SSHFP', 'SOA', 'NAPTR', 'CAA', 'CERT', 'HTTPS', 'SVCB']
支持的记录类型
- backlog¶
- 类型:
整数
- 默认值:
4096
配置套接字的回退请求数
- root_helper¶
- 类型:
字符串
- 默认值:
sudo designate-rootwrap /etc/designate/rootwrap.conf
designate-rootwrap 配置
- network_api¶
- 类型:
字符串
- 默认值:
neutron
要使用的 API。
- notify_api_faults¶
- 类型:
布尔值
- 默认值:
False
发送 API 中发生故障的通知。
- notification_plugin¶
- 类型:
字符串
- 默认值:
default
要使用的通知插件
- quota_driver¶
- 类型:
字符串
- 默认值:
storage
要使用的配额驱动程序
- quota_zones¶
- 类型:
整数
- 默认值:
10
每个租户允许的区域数
- quota_zone_recordsets¶
- 类型:
整数
- 默认值:
500
每个区域允许的记录集数
- quota_zone_records¶
- 类型:
整数
- 默认值:
500
每个区域允许的记录数
- quota_recordset_records¶
- 类型:
整数
- 默认值:
20
每个记录集允许的记录数
- quota_api_export_size¶
- 类型:
整数
- 默认值:
1000
区域导出中允许的记录集数
- 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¶
- 类型:
字符串
- 默认值:
designate
主题的作用域所在的默认交换机。可以通过 transport_url 选项中指定的交换机名称覆盖。
- rpc_ping_enabled¶
- 类型:
布尔值
- 默认值:
False
添加一个端点来响应 ping 调用。端点命名为 oslo_rpc_server_ping
backend:dynect¶
- job_timeout¶
- 类型:
整数
- 默认值:
30
在 DynECT 中拉取作业的超时时间，以秒为单位。
- timeout¶
- 类型:
整数
- 默认值:
10
API 请求的超时时间，以秒为单位。
- timings¶
- 类型:
布尔值
- 默认值:
False
测量请求时间。
coordination¶
- backend_url¶
- 类型:
字符串
- 默认值:
<None>
用于分布式协调的后端 URL。如果未设置，需要协调的服务将作为独立服务运行。这是一个 tooz URL - 请参阅 https://docs.openstack.org/tooz/2025.2/user/compatibility.html
- heartbeat_interval¶
- 类型:
浮点数
- 默认值:
5.0
分布式协调的心跳间隔，以秒为单位。
- run_watchers_interval¶
- 类型:
浮点数
- 默认值:
10.0
检查组 membership 是否更改的间隔，以秒为单位
cors¶
- allowed_origin¶
- 类型:
列表
- 默认值:
<None>
指示是否允许与请求“origin”标头中接收到的域共享此资源。格式：“<protocol>://<host>[:<port>]”，不带尾部斜杠。示例：https://horizon.example.com
- allow_credentials¶
- 类型:
布尔值
- 默认值:
True
指示实际请求是否可以包含用户凭据
- expose_headers¶
- 类型:
列表
- 默认值:
['X-OpenStack-Request-ID', 'Host']
指示哪些标头可以安全地暴露给 API。默认值为 HTTP 简单标头。
- max_age¶
- 类型:
整数
- 默认值:
3600
CORS 预检请求的最大缓存时间。
- allow_methods¶
- 类型:
列表
- 默认值:
['GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD']
指示实际请求期间可以使用哪些方法。
- allow_headers¶
- 类型:
列表
- 默认值:
['X-Auth-Token', 'X-Auth-Sudo-Tenant-ID', 'X-Auth-Sudo-Project-ID', 'X-Auth-All-Projects', 'X-Designate-Edit-Managed-Records', 'X-Designate-Hard-Delete', 'OpenStack-DNS-Hide-Counts']
指示实际请求期间可以使用哪些标头字段名称。
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¶m2=value2&…
handler:neutron_floatingip¶
- notification_topics¶
- 类型:
列表
- 默认值:
['notifications']
来自 neutron 的任何通知
- control_exchange¶
- 类型:
字符串
- 默认值:
neutron
neutron 通知控制交换机
- zone_id¶
- 类型:
字符串
- 默认值:
<None>
每个通知的区域 ID
- formatv4¶
- 类型:
多值
- 默认值:
''
IPv4 格式
- format¶
- 类型:
多值
- 默认值:
''
被 formatv4/formatv6 替换的格式
警告
此选项已弃用，将来可能会被静默忽略。
- 原因:
被 ‘formatv4/formatv6’ 替换
- formatv6¶
- 类型:
多值
- 默认值:
''
IPv6 格式
handler:nova_fixed¶
- notification_topics¶
- 类型:
列表
- 默认值:
['notifications']
来自 nova 的任何通知
- control_exchange¶
- 类型:
字符串
- 默认值:
nova
nova 通知控制交换机
- zone_id¶
- 类型:
字符串
- 默认值:
<None>
每个通知的区域 ID
- formatv4¶
- 类型:
多值
- 默认值:
''
IPv4 格式
- format¶
- 类型:
多值
- 默认值:
''
被 formatv4/formatv6 替换的格式
警告
此选项已弃用，将来可能会被静默忽略。
- 原因:
被 ‘formatv4/formatv6’ 替换
- formatv6¶
- 类型:
多值
- 默认值:
''
IPv6 格式
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 插件使用。
heartbeat_emitter¶
- heartbeat_interval¶
- 类型:
浮点数
- 默认值:
10.0
报告状态的心跳间隔，以秒为单位
- emitter_type¶
- 类型:
字符串
- 默认值:
rpc
要使用的 Emitter
keystone¶
- service_type¶
- 类型:
字符串
- 默认值:
<None>
用于端点 URL 发现的默认 service_type。
- service_name¶
- 类型:
字符串
- 默认值:
<None>
用于端点 URL 发现的默认 service_name。
- valid_interfaces¶
- 类型:
列表
- 默认值:
<None>
端点 URL 的接口列表，按优先级顺序排列。
- region_name¶
- 类型:
字符串
- 默认值:
<None>
用于端点 URL 发现的默认 region_name。
- endpoint_override¶
- 类型:
字符串
- 默认值:
<None>
始终将此端点 URL 用于此客户端的请求。注意：应在此处指定未版本化的端点；要请求特定的 API 版本，请使用 version、min-version 和/或 max-version 选项。
- version¶
- 类型:
字符串
- 默认值:
<None>
给定 Major API 版本内端点 URL 发现的最小 Major API 版本。与 min_version 和 max_version 互斥
- min_version¶
- 类型:
字符串
- 默认值:
<None>
给定 API 的最小主版本，旨在用作与 max_version 范围的下限。与 version 互斥。如果提供了 min_version 但没有 max_version，则 max 版本就像“最新”一样。
- max_version¶
- 类型:
字符串
- 默认值:
<None>
给定 API 的最大主版本，旨在用作与 min_version 范围的上限。与 version 互斥。
- connect_retries¶
- 类型:
整数
- 默认值:
<None>
应尝试的连接错误的重试次数上限。
- connect_retry_delay¶
- 类型:
浮点数
- 默认值:
<None>
连接错误的两次重试之间的延迟（以秒为单位）。如果未设置，则从 0.5 秒开始，最大 60 秒的指数重试将被使用。
- status_code_retries¶
- 类型:
整数
- 默认值:
<None>
应尝试的可重试 HTTP 状态代码的重试次数上限。
- status_code_retry_delay¶
- 类型:
浮点数
- 默认值:
<None>
可重试状态代码的两次重试之间的延迟（以秒为单位）。如果未设置，则从 0.5 秒开始，最大 60 秒的指数重试将被使用。
- retriable_status_codes¶
- 类型:
列表
- 默认值:
<None>
应重试的可重试 HTTP 状态代码列表。如果未设置，则默认为 [503]
- interface¶
- 类型:
字符串
- 默认值:
<None>
用于端点 URL 发现的默认接口。
警告
此选项已弃用，将来可能会被静默忽略。
- 原因:
使用 valid-interfaces 更好，因为它能够接受一个可能的接口列表。
- cafile¶
- 类型:
字符串
- 默认值:
<None>
在验证 HTTPS 连接时使用的 PEM 编码的证书颁发机构。
- certfile¶
- 类型:
字符串
- 默认值:
<None>
PEM 编码的客户端证书文件
- keyfile¶
- 类型:
字符串
- 默认值:
<None>
PEM 编码的客户端证书密钥文件
- insecure¶
- 类型:
布尔值
- 默认值:
False
验证 HTTPS 连接。
- timeout¶
- 类型:
整数
- 默认值:
<None>
http 请求的超时值
- collect_timing¶
- 类型:
布尔值
- 默认值:
False
收集每个 API 调用的计时信息。
- split_loggers¶
- 类型:
布尔值
- 默认值:
False
将请求记录到多个记录器。
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_section¶
- 类型:
未知类型
- 默认值:
<None>
从中加载插件特定选项的配置节
network_api:neutron¶
- endpoints¶
- 类型:
列表
- 默认值:
<None>
如果在请求上下文中传递的服务目录中为 None，则使用的 URL。格式：<region>|<url>
- endpoint_type¶
- 类型:
字符串
- 默认值:
publicURL
要使用的端点类型
- timeout¶
- 类型:
整数
- 默认值:
30
连接到 neutron 的超时值（秒）
- insecure¶
- 类型:
布尔值
- 默认值:
False
如果设置，则忽略任何 SSL 验证问题
- ca_certificates_file¶
- 类型:
字符串
- 默认值:
<None>
用于 neutron 客户端请求的 ca 证书文件的位置。
- client_certificate_file¶
- 类型:
字符串
- 默认值:
<None>
用于 neutron 客户端请求的客户端证书文件的位置。
oslo_concurrency¶
- disable_process_locking¶
- 类型:
布尔值
- 默认值:
False
启用或禁用进程间锁。
- lock_path¶
- 类型:
字符串
- 默认值:
$state_path
用于锁文件的目录。出于安全考虑，指定的目录应仅由需要锁定的进程运行的用户可写。默认值为环境变量 OSLO_LOCK_PATH。如果使用外部锁，则必须设置锁路径。
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_middleware¶
- max_request_body_size¶
- 类型:
整数
- 默认值:
114688
每个请求的最大正文大小，以字节为单位。
- enable_proxy_headers_parsing¶
- 类型:
布尔值
- 默认值:
False
应用程序是否位于代理之后。这决定了中间件是否应该解析标头。
- http_basic_auth_user_file¶
- 类型:
字符串
- 默认值:
/etc/htpasswd
HTTP 基本身份验证密码文件。
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 的策略检查的超时时间（秒）
oslo_reports¶
- log_dir¶
- 类型:
字符串
- 默认值:
<None>
创建文件的日志目录的路径
- file_event_handler¶
- 类型:
字符串
- 默认值:
<None>
监视文件更改以触发报告的路径，而不是信号。设置此选项会禁用报告的信号触发器。如果应用程序作为 WSGI 应用程序运行，建议使用此方法而不是信号。
- file_event_handler_interval¶
- 类型:
整数
- 默认值:
1
当设置 file_event_handler 时，轮询之间的秒数
oslo_versionedobjects¶
- fatal_exception_format_errors¶
- 类型:
布尔值
- 默认值:
False
将异常消息格式错误视为致命错误
producer_task:delayed_notify¶
- interval¶
- 类型:
整数
- 默认值:
5
运行间隔（秒）
- per_page¶
- 类型:
整数
- 默认值:
100
每页返回的默认结果数
- batch_size¶
- 类型:
整数
- 默认值:
100
每次运行接收 NOTIFY 的区域数量
producer_task:periodic_exists¶
- interval¶
- 类型:
整数
- 默认值:
3600
运行间隔（秒）
- per_page¶
- 类型:
整数
- 默认值:
100
每页返回的默认结果数
producer_task:periodic_secondary_refresh¶
- interval¶
- 类型:
整数
- 默认值:
3600
运行间隔（秒）
- per_page¶
- 类型:
整数
- 默认值:
100
每页返回的默认结果数
producer_task:worker_periodic_recovery¶
- interval¶
- 类型:
整数
- 默认值:
120
运行间隔（秒）
- per_page¶
- 类型:
整数
- 默认值:
100
每页返回的默认结果数
producer_task:zone_purge¶
- interval¶
- 类型:
整数
- 默认值:
3600
运行间隔（秒）
- per_page¶
- 类型:
整数
- 默认值:
100
每页返回的默认结果数
- time_threshold¶
- 类型:
整数
- 默认值:
604800
已删除区域（deleted_at）的年龄，以秒为单位，才能被清除
- batch_size¶
- 类型:
整数
- 默认值:
100
每次运行要清除的区域数量
proxy¶
- http_proxy¶
- 类型:
字符串
- 默认值:
<None>
通过此代理代理 HTTP 请求。
- https_proxy¶
- 类型:
字符串
- 默认值:
<None>
通过此代理代理 HTTPS 请求
- no_proxy¶
- 类型:
列表
- 默认值:
[]
不应通过代理处理这些地址
service:api¶
- workers¶
- 类型:
整数
- 默认值:
<None>
要生成 api worker 进程的数量
- threads¶
- 类型:
整数
- 默认值:
1000
要生成 api greenthreads 的数量
- enable_host_header¶
- 类型:
布尔值
- 默认值:
True
启用主机请求标头
- api_base_uri¶
- 类型:
字符串
- 默认值:
http://127.0.0.1:9001/
用作所有 API 响应基础的 URL。这应包括方案（http/https）、主机名、端口以及添加到 Designate URL 的任何路径。例如 http://dns.openstack.example.com/dns
- listen¶
- 类型:
列表
- 默认值:
['0.0.0.0:9001']
API 要侦听的主机：端口对
- api_paste_config¶
- 类型:
字符串
- 默认值:
api-paste.ini
designate-api 的 paste.deploy 配置文件名
- auth_strategy¶
- 类型:
字符串
- 默认值:
keystone
用于身份验证的策略。支持 noauth 或 keystone
- enable_api_v2¶
- 类型:
布尔值
- 默认值:
True
启用 Designate V2 API
- enable_api_admin¶
- 类型:
布尔值
- 默认值:
False
enable-api-admin
- pecan_debug¶
- 类型:
布尔值
- 默认值:
False
Pecan HTML 调试界面
- enabled_extensions_v2¶
- 类型:
列表
- 默认值:
[]
V2 API 的已启用 API 扩展
- default_limit_v2¶
- 类型:
整数
- 默认值:
20
V2 API 的默认每页限制，值为 None 表示默认显示所有结果
- max_limit_v2¶
- 类型:
整数
- 默认值:
1000
V2 API 的最大每页限制
- quotas_verify_project_id¶
- 类型:
布尔值
- 默认值:
False
验证配额目标请求的项目 ID 是否是 Keystone 中的有效项目。
- allow_empty_secrets_for_tsig¶
- 类型:
布尔值
- 默认值:
True
允许使用空密钥创建 tsig。虽然从理论上讲，空字符串对 tsig 密钥有效，但强烈不建议这样做
- enabled_extensions_admin¶
- 类型:
列表
- 默认值:
[]
已启用的 Admin API 扩展
- default_limit_admin¶
- 类型:
整数
- 默认值:
20
Admin API 的默认每页限制，值为 None 表示默认显示所有结果
- max_limit_admin¶
- 类型:
整数
- 默认值:
1000
Admin API 的最大每页限制
- maintenance_mode¶
- 类型:
布尔值
- 默认值:
False
启用 API 维护模式
- maintenance_mode_role¶
- 类型:
字符串
- 默认值:
admin（管理员）
允许绕过维护模式的角色
service:central¶
- workers¶
- 类型:
整数
- 默认值:
<None>
要生成 central worker 进程的数量
- threads¶
- 类型:
整数
- 默认值:
1000
要生成 central greenthreads 的数量
- max_zone_name_len¶
- 类型:
整数
- 默认值:
255
最大区域名称长度
- managed_resource_email¶
- 类型:
字符串
- 默认值:
hostmaster@example.com
托管资源的电子邮件
- managed_resource_tenant_id¶
- 类型:
字符串
- 默认值:
00000000-0000-0000-0000-000000000000
将拥有任何托管资源的租户 ID。
- min_ttl¶
- 类型:
整数
- 默认值:
0
允许的最小 TTL
- default_pool_id¶
- 类型:
字符串
- 默认值:
794ccc2c-d751-44fe-b57f-8894c9f5c842
默认池的名称
- topic¶
- 类型:
字符串
- 默认值:
central
central 的 RPC 主题名称
- scheduler_filters¶
- 类型:
列表
- 默认值:
['default_pool']
启用的池调度过滤器
service:mdns¶
- workers¶
- 类型:
整数
- 默认值:
<None>
要生成 mDNS worker 进程的数量
- threads¶
- 类型:
整数
- 默认值:
1000
要生成的 mDNS green线程的数量
- listen¶
- 类型:
列表
- 默认值:
['0.0.0.0:5354']
要监听的 mDNS 主机:端口对
- tcp_backlog¶
- 类型:
整数
- 默认值:
100
mDNS TCP Backlog
- tcp_keepidle¶
- 类型:
整数
- 默认值:
<None>
mDNS TCP Keepidle，单位为秒
- tcp_recv_timeout¶
- 类型:
浮点数
- 默认值:
0.5
mDNS TCP 接收超时，单位为秒
- query_enforce_tsig¶
- 类型:
布尔值
- 默认值:
False
强制所有传入查询（包括 AXFR）都经过 TSIG 签名
- max_message_size¶
- 类型:
整数
- 默认值:
65535
允许发出的最大消息大小
service:producer¶
- workers¶
- 类型:
整数
- 默认值:
<None>
要生成的 Producer worker 进程数量
- threads¶
- 类型:
整数
- 默认值:
1000
要生成的 Producer green线程数量
- enabled_tasks¶
- 类型:
列表
- 默认值:
<None>
要运行的已启用任务
- export_synchronous¶
- 类型:
布尔值
- 默认值:
True
是否允许同步区域导出
警告
此选项已弃用，将来可能会被静默忽略。
- 原因:
迁移到 designate-worker
- topic¶
- 类型:
字符串
- 默认值:
producer
Producer 的 RPC 主题名称
service:sink¶
- workers¶
- 类型:
整数
- 默认值:
<None>
要生成的 sink worker 进程数量
- threads¶
- 类型:
整数
- 默认值:
1000
要生成的 sink green线程数量
- enabled_notification_handlers¶
- 类型:
列表
- 默认值:
[]
已启用的通知处理程序
- listener_pool_name¶
- 类型:
字符串
- 默认值:
<None>
用于 oslo.messaging 通知监听器的池名称。请注意，并非所有 oslo.messaging 驱动程序都支持监听器池。
service:worker¶
- workers¶
- 类型:
整数
- 默认值:
<None>
要生成的 Worker worker 进程数量
- threads¶
- 类型:
整数
- 默认值:
200
每个进程要生成的 Worker 线程数量
- threshold_percentage¶
- 类型:
整数
- 默认值:
100
为了使域更改被视为活动状态，需要成功更新的服务器百分比
- poll_timeout¶
- 类型:
整数
- 默认值:
30
等待服务器响应的时间
- poll_retry_interval¶
- 类型:
整数
- 默认值:
15
重试发送请求并等待服务器响应之间的时间
- poll_max_retries¶
- 类型:
整数
- 默认值:
10
重试发送请求并等待服务器响应的最大次数
- poll_delay¶
- 类型:
整数
- 默认值:
5
在向服务器发送第一个请求之前等待的时间
- export_synchronous¶
- 类型:
布尔值
- 默认值:
True
是否允许同步区域导出
- topic¶
- 类型:
字符串
- 默认值:
worker
Worker 的 RPC 主题名称
- xfr_timeout¶
- 类型:
整数
- 默认值:
10
XFR 的超时时间，单位为秒。
- serial_max_retries¶
- 类型:
整数
- 默认值:
3
重试获取区域序列号的最大次数。
- serial_retry_delay¶
- 类型:
整数
- 默认值:
1
重试区域序列号请求之前等待的时间。
- serial_timeout¶
- 类型:
整数
- 默认值:
1
放弃获取区域序列号之前的超时时间，单位为秒。
- all_tcp¶
- 类型:
布尔值
- 默认值:
False
通过 TCP 发送所有流量
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’ 选项已弃用，将在未来的版本中删除。
storage:sqlalchemy¶
- 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¶m2=value2&…
