Orchestration 服务配置选项

以下选项可以在 /etc/heat/heat.conf 配置文件中设置。 也可以使用 示例配置文件

默认值

host
类型:

字符串

默认值:

<主机名>

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

引擎节点的名称。 这可以是任何不透明的标识符,不一定是主机名、FQDN 或 IP 地址。

plugin_dirs
类型:

列表

默认值:

['/usr/lib64/heat', '/usr/lib/heat', '/usr/local/lib/heat', '/usr/local/lib64/heat']

搜索插件的目录列表。

environment_dir
类型:

字符串

默认值:

/etc/heat/environment.d

搜索环境文件的目录。

template_dir
类型:

字符串

默认值:

/etc/heat/templates

搜索模板文件的目录。

deferred_auth_method
类型:

字符串

默认值:

trusts

有效值:

password, trusts

选择延迟认证方法,存储的密码或 trusts。

警告

此选项自 9.0.0 起已弃用,未来可能会被静默忽略。

原因:

当与 keystone v3 一起使用时,基于存储密码的延迟认证已损坏且不受支持。

reauthentication_auth_method
类型:

字符串

默认值:

''

有效值:

‘’, trusts

允许在令牌过期时重新认证,以便长时间运行的任务可以完成。 请注意,这会破坏任何提供的用户令牌的过期时间。

allow_trusts_redelegation
类型:

布尔值

默认值:

False

创建具有启用 redelegation 的 trusts。 仅当 reauthentication_auth_method 设置为“trusts”时,才使用此选项。 请注意,启用此选项确实具有安全隐患,因为 Heat 创建的所有 trusts 都将使用启用 impersonation 和 redelegation。 仅在其他服务需要从 Heat 用于访问它们的令牌创建 trusts 时才启用它,例如 Aodh 和配置为也使用 trusts 的另一个区域的 Heat。

trusts_delegated_roles
类型:

列表

默认值:

[]

要委托给 heat 的 trustor 角色的子集。 如果未设置,则用户的所有角色都将委托给 heat 在创建 stack 时。

max_resources_per_stack
类型:

整数

默认值:

1000

顶级 stack 允许的最大资源数。 -1 表示无限制。

max_stacks_per_tenant
类型:

整数

默认值:

512

一个租户一次可以拥有的最大 stack 数量。 -1 表示无限制。

max_software_configs_per_tenant
类型:

整数

默认值:

4096

一个租户一次可以拥有的最大软件配置数量。 -1 表示无限制。

max_software_deployments_per_tenant
类型:

整数

默认值:

4096

一个租户一次可以拥有的最大软件部署数量。-1 表示无限制。

max_snapshots_per_stack
类型:

整数

默认值:

32

一个 stack 一次可以拥有的最大快照数量。 -1 表示无限制。

action_retry_limit
类型:

整数

默认值:

5

将资源带到非错误状态的重试次数。 设置为 0 以禁用重试。

client_retry_limit
类型:

整数

默认值:

2

客户端遇到预期间歇性错误时重试的次数。 设置为 0 以禁用重试。

max_server_name_length
类型:

整数

默认值:

53

最大值:

53

要在 nova 中使用的服务器名称的最大长度。

max_interface_check_attempts
类型:

整数

默认值:

10

最小值:

1

检查接口是否已附加或分离的次数。

max_nova_api_microversion
类型:

字符串

默认值:

<None>

客户端插件的 nova API 版本的最大值。 借助此限制,nova 支持的微版本号高于 max_nova_api_microversion 的任何 nova 功能将不可用。

max_cinder_api_microversion
类型:

字符串

默认值:

<None>

客户端插件的 cinder API 版本的最大值。 借助此限制,cinder 支持的微版本号高于 max_cinder_api_microversion 的任何 cinder 功能将不可用。

max_ironic_api_microversion
类型:

字符串

默认值:

<None>

客户端插件的 ironic API 版本的最大值。 借助此限制,ironic 支持的微版本号高于 max_ironic_api_microversion 的任何 ironic 功能将不可用。

event_purge_batch_size
类型:

整数

默认值:

200

最小值:

1

控制在清除 stack 的事件时将删除多少个事件。 将此值设置得较低可以保留更多事件,但会增加清除频率。

max_events_per_stack
类型:

整数

默认值:

1000

每个 stack 可用的最大事件数量。 实际事件数量可能会略高,因为清除检查会随机进行 event_purge_batch_size 百分之 200 的时间。 在清除事件时,会删除较旧的事件。 设置为 0 以获得每个 stack 的无限事件数。

stack_action_timeout
类型:

整数

默认值:

3600

stack 操作(例如创建或更新)的超时时间,以秒为单位。

error_wait_time
类型:

整数

默认值:

240

在发生错误后,任务在被取消之前可以继续运行的时间量,以秒为单位。

engine_life_check_timeout
类型:

整数

默认值:

2

用于 stack 锁定的引擎生存能力检查的 RPC 超时时间。

enable_stack_abandon
类型:

布尔值

默认值:

False

启用预览 Stack Abandon 功能。

警告

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

原因:

收敛引擎不支持 Stack abandon。

enable_stack_adopt
类型:

布尔值

默认值:

False

启用预览 Stack Adopt 功能。

警告

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

原因:

收敛引擎不支持 Stack adopt。

convergence_engine
类型:

布尔值

默认值:

True

启用具有收敛架构的引擎。 使用此选项创建的所有 stack 都将使用收敛引擎创建。

警告

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

原因:

已弃用 Legacy 引擎。

observe_on_update
类型:

布尔值

默认值:

False

在更新时,启用 heat 收集来自现实的现有资源属性并收敛到更新的模板。

default_software_config_transport
类型:

字符串

默认值:

POLL_SERVER_CFN

有效值:

POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE

服务器应接收软件配置所需的元数据的默认模板。 POLL_SERVER_CFN 允许调用使用提供的密钥对签名的 CFN API 操作 DescribeStackResource(需要启用的 heat-api-cfn)。 POLL_SERVER_HEAT 允许调用使用提供的 keystone 凭据进行的 Heat API resource-show(需要 keystone v3 API 和配置的 stack_user_* 配置选项)。 POLL_TEMP_URL 将创建一个填充了元数据的 Swift TempURL 以进行轮询(需要支持 TempURL 的对象存储端点)。ZAQAR_MESSAGE 将创建一个专用的 zaqar 队列以发布元数据进行轮询。

default_deployment_signal_transport
类型:

字符串

默认值:

CFN_SIGNAL

有效值:

CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, ZAQAR_SIGNAL

服务器应使用部署输出值向 heat 发出信号的默认模板。 CFN_SIGNAL 允许使用提供的密钥对签名的 CFN URL 进行 HTTP POST(需要启用的 heat-api-cfn)。 TEMP_URL_SIGNAL 将创建一个 Swift TempURL 以通过 HTTP PUT 发出信号(需要支持 TempURL 的对象存储端点)。 HEAT_SIGNAL 允许使用提供的 keystone 凭据调用 Heat API resource-signal。 ZAQAR_SIGNAL 将创建一个专用的 zaqar 队列以使用提供的 keystone 凭据发出信号。

default_user_data_format
类型:

字符串

默认值:

HEAT_CFNTOOLS

有效值:

HEAT_CFNTOOLS, RAW, SOFTWARE_CONFIG

服务器的 user_data 格式的默认模板。 对于 HEAT_CFNTOOLS,user_data 作为 heat-cfntools cloud-init 启动配置数据的一部分捆绑在一起。 对于 RAW,user_data 将未经修改地传递给 Nova。 对于 SOFTWARE_CONFIG,user_data 作为软件配置数据的一部分捆绑在一起,并且元数据来自任何关联的 SoftwareDeployment 资源。

hidden_stack_tags
类型:

列表

默认值:

[]

包含这些标签名称的 stack 将被隐藏。 多个标签应以逗号分隔的列表给出(例如 hidden_stack_tags=hide_me,me_too)。

stack_scheduler_hints
类型:

布尔值

默认值:

False

当此功能启用时,用于通过 heat 资源类型 OS::Cinder::Volume、OS::Nova::Server 和 AWS::EC2::Instance 进行创建的调度器提示,会将 heat stack 上下文标识传递给配置的 nova 和 cinder 调度器。 heat_root_stack_id 将设置为资源的根 stack 的 ID,heat_stack_id 将设置为资源的父 stack 的 ID,heat_stack_name 将设置为资源的父 stack 的名称,heat_path_in_stack 将设置为 stackresourcename 和 stackname 的逗号分隔字符串列表,其中 list[0] 为“rootstackname”,heat_resource_name 将设置为资源的名称,heat_resource_uuid 将设置为资源的编排 ID。

encrypt_parameters_and_properties
类型:

布尔值

默认值:

False

加密标记为隐藏的模板参数以及在数据库中存储之前的所有资源属性。

metadata_put_timeout
类型:

浮点数

默认值:

60

最小值:

0

软件部署的元数据更新超时时间,以秒为单位

periodic_interval
类型:

整数

默认值:

60

运行周期性任务之间的秒数。

heat_metadata_server_url
类型:

URI

默认值:

<None>

Heat 元数据服务器的 URL。 注意:仅当需要实例使用与 keystone 目录中不同的端点时,才需要设置此项。

heat_waitcondition_server_url
类型:

URI

默认值:

<None>

Heat waitcondition 服务器的 URL。

instance_connection_is_secure
类型:

字符串

默认值:

0

通过 https 进行的实例连接到 CFN/CW API。

instance_connection_https_validate_certificates
类型:

字符串

默认值:

1

如果使用 SSL,则实例连接到 CFN/CW API 验证证书。

region_name_for_services
类型:

字符串

默认值:

<None>

用于获取服务端点的默认区域名称。

region_name_for_shared_services
类型:

字符串

默认值:

<None>

共享服务的区域名称。

shared_services_types
类型:

列表

默认值:

['image', 'volumev3']

位于其他区域的共享服务。 必须设置 region_name_for_shared_services 选项才能生效。

heat_stack_user_role
类型:

字符串

默认值:

heat_stack_user

模板定义的 keystone 角色的 heat 用户。

stack_user_domain_id
类型:

字符串

默认值:

<None>

Keystone域ID,包含heat模板定义的的用户。如果设置了此选项,stack_user_domain_name选项将被忽略。

已弃用的变体

Group

名称

DEFAULT

stack_user_domain

stack_user_domain_name
类型:

字符串

默认值:

<None>

Keystone域名称,包含heat模板定义的的用户。如果设置了stack_user_domain_id选项,此选项将被忽略。

stack_domain_admin
类型:

字符串

默认值:

<None>

Keystone用户名,该用户拥有在stack_user_domain中管理用户和项目所需的权限。

stack_domain_admin_password
类型:

字符串

默认值:

<None>

stack_domain_admin用户的Keystone密码。

max_template_size
类型:

整数

默认值:

524288

任何模板的最大原始字节大小。

max_nested_stack_depth
类型:

整数

默认值:

5

使用嵌套堆栈时允许的最大深度。

template_fetch_timeout
类型:

浮点数

默认值:

60

最小值:

0

模板下载的超时时间,单位为秒。

num_engine_workers
类型:

整数

默认值:

<None>

要fork和运行的heat-engine进程数。默认值为4或主机上的CPU数量,取两者中较大的值。

server_keystone_endpoint_type
类型:

字符串

默认值:

''

有效值:

‘’, public, internal, admin

如果设置,则用于控制用户控制的服务器通过调用Heat时使用的认证端点。如果未设置,则使用www_authenticate_uri。

auth_encryption_key
类型:

字符串

默认值:

notgood but just long enough i t

用于加密数据库中认证信息的密钥。此密钥的长度必须为32个字符。

max_json_body_size
类型:

整数

默认值:

1048576

JSON请求体的最大原始字节大小。应大于max_template_size。

cloud_backend
类型:

字符串

默认值:

heat.engine.clients.OpenStackClients

用作客户端后端的完全限定类名。

keystone_backend
类型:

字符串

默认值:

heat.engine.clients.os.keystone.heat_keystoneclient.KsClientWrapper

用作keystone后端的完全限定类名。

default_notification_level
类型:

字符串

默认值:

INFO

传出通知的默认通知级别。

default_publisher_id
类型:

字符串

默认值:

<None>

传出通知的默认publisher_id。

loadbalancer_template
类型:

字符串

默认值:

<None>

内置负载均衡器嵌套堆栈的自定义模板。

log_options
类型:

布尔值

默认值:

True

可变:

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

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

graceful_shutdown_timeout
类型:

整数

默认值:

60

可变:

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

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

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
类型:

列表

默认值:

['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']

包日志级别列表,格式为 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

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

auth_password

multi_cloud
类型:

布尔值

默认值:

False

允许编排多个云。

allowed_auth_uris
类型:

列表

默认值:

[]

启用multi_cloud时,auth_uri允许的keystone端点。至少需要指定一个端点。

cache

config_prefix
类型:

字符串

默认值:

cache.oslo

用于构建缓存区域配置字典的前缀。除非有另一个 dogpile.cache 区域使用相同的配置名称,否则不需要更改此项。

expiration_time
类型:

整数

默认值:

600

最小值:

1

默认 TTL(秒),适用于 dogpile.cache 区域中的任何缓存项。这适用于任何没有为其定义显式缓存过期时间的缓存方法。

backend_expiration_time
类型:

整数

默认值:

<None>

最小值:

1

在缓存后端中自动清除过期记录的过期时间。此值应大于 expiration_time 和所有 cache_time 选项

backend
类型:

字符串

默认值:

dogpile.cache.null

有效值:

oslo_cache.memcache_pool, oslo_cache.dict, oslo_cache.mongo, oslo_cache.etcd3gw, dogpile.cache.pymemcache, dogpile.cache.memcached, dogpile.cache.pylibmc, dogpile.cache.bmemcached, dogpile.cache.dbm, dogpile.cache.redis, dogpile.cache.redis_sentinel, dogpile.cache.memory, dogpile.cache.memory_pickle, dogpile.cache.null

缓存后端模块。对于基于 eventlet 的环境或具有数百个线程服务器的环境,建议使用带有池化的 Memcache (oslo_cache.memcache_pool)。对于具有少于 100 个线程服务器的环境,建议使用 Memcached (dogpile.cache.memcached) 或 Redis (dogpile.cache.redis)。测试环境可以使用单个服务器实例使用 dogpile.cache.memory 后端。

backend_argument
类型:

多值

默认值:

''

传递给后端模块的参数。对于要传递给 dogpile.cache 后端的每个参数,指定此选项一次。示例格式:“<argname>:<value>”。

proxies
类型:

列表

默认值:

[]

要导入的代理类,它们会影响 dogpile.cache 后端的运作方式。请参阅 dogpile.cache 文档中关于 changing-backend-behavior 的内容。

enabled
类型:

布尔值

默认值:

False

全局缓存开关。

debug_cache_backend
类型:

布尔值

默认值:

False

来自缓存后端的额外调试信息(缓存键、get/set/delete/等调用)。只有在需要查看带有键/值的特定缓存后端 get/set/delete 调用时,此选项才真正有用。通常应将其设置为 false。

memcache_servers
类型:

列表

默认值:

['localhost:11211']

Memcache服务器的格式为“host:port”。这由依赖于Memcached的后端使用。如果使用dogpile.cache.memcachedoslo_cache.memcache_pool,并且给定的主机引用IPv6或给定的域名引用IPv6,则应使用地址族(inet6)前缀给定的地址(例如inet6:[::1]:11211inet6:[fd12:3456:789a:1::1]:11211inet6:[controller-0.internalapi]:11211)。如果未给出地址族,则这些后端将使用默认的inet地址族,它对应于IPv4

memcache_dead_retry
类型:

整数

默认值:

300

在再次尝试之前,Memcached 服务器被认为已死的时间(秒)。(仅适用于 dogpile.cache.memcache 和 oslo_cache.memcache_pool 后端)。

memcache_socket_timeout
类型:

浮点数

默认值:

1.0

每次调用服务器的超时时间(秒)。(仅适用于 dogpile.cache.memcache 和 oslo_cache.memcache_pool 后端)。

memcache_pool_maxsize
类型:

整数

默认值:

10

每个 Memcached 服务器的最大开放连接数。(仅适用于 oslo_cache.memcache_pool 后端)。

memcache_pool_unused_timeout
类型:

整数

默认值:

60

连接在池中未被使用之前保持打开状态的秒数。(仅适用于 oslo_cache.memcache_pool 后端)。

memcache_pool_connection_get_timeout
类型:

整数

默认值:

10

获取 Memcache 客户端连接的操作等待的秒数。

memcache_pool_flush_on_reconnect
类型:

布尔值

默认值:

False

全局切换,确定是否在重新连接时刷新 Memcache。(仅适用于 oslo_cache.memcache_pool 后端)。

memcache_sasl_enabled
类型:

布尔值

默认值:

False

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

memcache_username
类型:

字符串

默认值:

<None>

启用 SASL 的 Memcached 的用户名

memcache_password
类型:

字符串

默认值:

<None>

启用 SASL 的 Memcached 的密码

redis_server
类型:

字符串

默认值:

localhost:6379

Redis 服务器的格式为“host:port”

redis_db
类型:

整数

默认值:

0

最小值:

0

Redis 服务器中的数据库 ID

redis_username
类型:

字符串

默认值:

<None>

redis 的用户名

redis_password
类型:

字符串

默认值:

<None>

redis 的密码

redis_sentinels
类型:

列表

默认值:

['localhost:26379']

Redis sentinel 服务器的格式为“host:port”

redis_socket_timeout
类型:

浮点数

默认值:

1.0

每次调用服务器的超时时间(秒)。(仅适用于 dogpile.cache.redis 和 dogpile.cache.redis_sentinel 后端)。

redis_sentinel_service_name
类型:

字符串

默认值:

mymaster

Redis sentinel 集群的服务名称。

tls_enabled
类型:

布尔值

默认值:

False

与缓存服务器通信时使用 TLS 的全局切换。目前受 dogpile.cache.bmemcachedogpile.cache.pymemcacheoslo_cache.memcache_pooldogpile.cache.redisdogpile.cache.redis_sentinel 支持。

tls_cafile
类型:

字符串

默认值:

<None>

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

tls_certfile
类型:

字符串

默认值:

<None>

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

tls_keyfile
类型:

字符串

默认值:

<None>

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

tls_allowed_ciphers
类型:

字符串

默认值:

<None>

设置使用 TLS 上下文创建的套接字的可用密码。它应该是 OpenSSL 密码列表格式的字符串。如果未指定,将提供所有 OpenSSL 启用的密码。目前受 dogpile.cache.bmemcachedogpile.cache.pymemcacheoslo_cache.memcache_pool 支持。

enable_socket_keepalive
类型:

布尔值

默认值:

False

dogpile 的 pymemcache 后端的套接字保活的全局切换

socket_keepalive_idle
类型:

整数

默认值:

1

最小值:

0

连接在开始发送保活探测之前需要保持空闲的时间(秒)。应该是一个大于零的正整数。

socket_keepalive_interval
类型:

整数

默认值:

1

最小值:

0

各个保活探测之间的时间(秒)。应该是一个大于零的正整数。

socket_keepalive_count
类型:

整数

默认值:

1

最小值:

0

TCP 在放弃连接之前应该发送的最大保活探测次数。应该是一个大于零的正整数。

enable_retry_client
类型:

布尔值

默认值:

False

启用重试客户端机制以处理故障。这些机制可用于包装所有类型的 pymemcache 客户端。该包装器允许您定义重试次数以及尝试之间的等待时间。

retry_attempts
类型:

整数

默认值:

2

最小值:

1

在失败之前尝试操作的次数。

retry_delay
类型:

浮点数

默认值:

0

每次尝试之间的睡眠秒数。

hashclient_retry_attempts
类型:

整数

默认值:

2

最小值:

1

在 HashClient 的内部机制中,客户端应该尝试的次数,然后将其标记为已死并从池中删除。

hashclient_retry_delay
类型:

浮点数

默认值:

1

HashClient 的内部机制中,重试尝试之间应该经过的秒数。

dead_timeout
类型:

浮点数

默认值:

60

在 HashClient 的内部机制中,在尝试将节点放回池中之前应该经过的时间(秒)。

enforce_fips_mode
类型:

布尔值

默认值:

False

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

clients

endpoint_type
类型:

字符串

默认值:

publicURL

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

False

如果设置,则不会验证服务器的证书。

clients_aodh

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_barbican

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_cinder

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

http_log_debug
类型:

布尔值

默认值:

False

允许客户端的调试日志输出。

clients_designate

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_glance

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_heat

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

url
类型:

URI

默认值:

<None>

可选的heat url,格式如http://127.0.0.1:8004/v1/%(tenant_id)s

clients_keystone

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

auth_uri
类型:

URI

默认值:

<None>

未版本化的keystone url,格式如http://127.0.0.1:5000

clients_magnum

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_manila

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_mistral

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_neutron

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_nova

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

http_log_debug
类型:

布尔值

默认值:

False

允许客户端的调试日志输出。

clients_octavia

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_swift

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_trove

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_vitrage

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

clients_zaqar

endpoint_type
类型:

字符串

默认值:

<None>

用于与OpenStack服务通信的Identity服务目录中的端点类型。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

insecure
类型:

布尔值

默认值:

<None>

如果设置,则不会验证服务器的证书。

constraint_validation_cache

expiration_time
类型:

整数

默认值:

60

缓存失效时间,以秒为单位,用于缓存验证约束的 dogpile.cache 区域中的任何项目。

caching
类型:

布尔值

默认值:

True

在 Orchestration Engine 验证堆栈的属性约束时,启用/禁用缓存的切换。在具有约束的属性验证期间,Orchestration Engine 会缓存对其他 OpenStack 服务的请求。请注意,必须启用全局切换 oslo.cache(enabled=True 在 [cache] 组中) 才能使用此功能。

cors

allowed_origin
类型:

列表

默认值:

<None>

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

allow_credentials
类型:

布尔值

默认值:

True

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

expose_headers
类型:

列表

默认值:

['X-Auth-Token', 'X-Subject-Token', 'X-Service-Token', 'X-OpenStack-Request-ID']

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

max_age
类型:

整数

默认值:

3600

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

allow_methods
类型:

列表

默认值:

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

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

allow_headers
类型:

列表

默认值:

['X-Auth-Token', 'X-Identity-Status', 'X-Roles', 'X-Service-Catalog', 'X-User-Id', 'X-Tenant-Id', 'X-OpenStack-Request-ID']

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

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&…

ec2authtoken

auth_uri
类型:

URI

默认值:

<None>

身份验证端点 URI。

multi_cloud
类型:

布尔值

默认值:

False

允许编排多个云。

clouds
类型:

列表

默认值:

[]

当启用多云时,云的名称列表。启用多云时,应定义至少一个名称。对于每个名称,必须有一个包含 keystone 身份验证设置的 [ec2authtoken.<name>] 部分。

allowed_auth_uris
类型:

列表

默认值:

[]

启用multi_cloud时,auth_uri允许的keystone端点。至少需要指定一个端点。

cert_file
类型:

字符串

默认值:

<None>

可选的PEM格式的证书链文件。

key_file
类型:

字符串

默认值:

<None>

包含私钥的可选PEM格式的文件。

ca_file
类型:

字符串

默认值:

<None>

在SSL连接中使用的可选CA证书文件。

auth_type
类型:

未知类型

默认值:

<None>

要加载的身份验证类型

已弃用的变体

Group

名称

ec2authtoken

auth_plugin

auth_section
类型:

未知类型

默认值:

<None>

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

auth_url
类型:

未知类型

默认值:

<None>

认证 URL

system_scope
类型:

未知类型

默认值:

<None>

系统操作的作用域

domain_id
类型:

未知类型

默认值:

<None>

作用域的域 ID

domain_name
类型:

未知类型

默认值:

<None>

作用域的域名称

project_id
类型:

未知类型

默认值:

<None>

作用域的项目 ID

project_name
类型:

未知类型

默认值:

<None>

作用域的项目名称

project_domain_id
类型:

未知类型

默认值:

<None>

包含项目的域 ID

project_domain_name
类型:

未知类型

默认值:

<None>

包含项目的域名称

trust_id
类型:

未知类型

默认值:

<None>

用作受托人的信任 ID

user_id
类型:

未知类型

默认值:

<None>

用户的用户 ID

username
类型:

未知类型

默认值:

<None>

用户的用户名

已弃用的变体

Group

名称

ec2authtoken

user-name

ec2authtoken

user_name

user_domain_id
类型:

未知类型

默认值:

<None>

用户的域 ID

user_domain_name
类型:

未知类型

默认值:

<None>

用户的域名称

password
类型:

未知类型

默认值:

<None>

用户的密码

cafile
类型:

字符串

默认值:

<None>

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

certfile
类型:

字符串

默认值:

<None>

PEM 编码的客户端证书文件

keyfile
类型:

字符串

默认值:

<None>

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

insecure
类型:

布尔值

默认值:

False

验证 HTTPS 连接。

timeout
类型:

整数

默认值:

<None>

http 请求的超时值

collect_timing
类型:

布尔值

默认值:

False

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

split_loggers
类型:

布尔值

默认值:

False

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

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 版本,请使用 versionmin-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 更好,因为它能够接受一个可能的接口列表。

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 插件使用。

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>

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

noauth

token_response
类型:

字符串

默认值:

''

包含 noauth 中间件返回的内容的 JSON 文件。

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

将异常消息格式错误视为致命错误

paste_deploy

flavor
类型:

字符串

默认值:

<None>

要使用的 flavor。

api_paste_config
类型:

字符串

默认值:

api-paste.ini

要使用的 API paste 配置文件。

profiler

enabled
类型:

布尔值

默认值:

False

启用此节点上所有服务的分析。

默认值为 False(完全禁用分析功能)。

可能的值

  • True:启用该功能

  • False:禁用该功能。无法通过此项目操作启动分析。如果分析由另一个项目触发,则此项目部分将为空。

已弃用的变体

Group

名称

profiler

profiler_enabled

trace_sqlalchemy
类型:

布尔值

默认值:

False

在服务中启用 SQL 请求分析。

默认值为 False(SQL 请求不会被跟踪)。

可能的值

  • True:启用 SQL 请求分析。每个 SQL 查询都将成为跟踪的一部分,并可以分析花费的时间。

  • False:禁用 SQL 请求分析。花费的时间仅在较高层次的操作上显示。无法以这种方式分析单个 SQL 查询。

trace_requests
类型:

布尔值

默认值:

False

启用 python requests 包分析。

支持的驱动程序:jaeger+otlp

默认值为 False。

可能的值

  • True:启用请求分析。

  • False:禁用请求分析。

hmac_keys
类型:

字符串

默认值:

SECRET_KEY

用于加密性能分析上下文数据的密钥。

此字符串值应具有以下格式:<key1>[,<key2>,…<keyn>],其中每个密钥都是一些随机字符串。通过 REST API 触发分析的用户必须在 REST API 调用中设置这些密钥之一,才能将此节点的分析结果包含到该特定项目中。

应设置“enabled”标志和“hmac_keys”配置选项才能启用分析。此外,为了生成所有服务之间的正确分析信息,至少有一个密钥需要在 OpenStack 项目之间保持一致。这确保了客户端可以使用它来生成包含所有可能资源的跟踪。

connection_string
类型:

字符串

默认值:

messaging://

通知后端连接字符串。

默认值为 messaging://,它将通知程序设置为 oslo_messaging。

可能的示例值

  • messaging:// - 使用 oslo_messaging 驱动程序发送跨度。

  • redis://127.0.0.1:6379 - 使用 redis 驱动程序发送跨度。

  • mongodb://127.0.0.1:27017 - 使用 mongodb 驱动程序发送跨度。

  • elasticsearch://127.0.0.1:9200 - 使用 elasticsearch 驱动程序发送跨度。

  • jaeger://127.0.0.1:6831 - 使用 jaeger 跟踪作为驱动程序发送跨度。

es_doc_type
类型:

字符串

默认值:

notification

在 elasticsearch 中进行通知索引的文档类型。

es_scroll_time
类型:

字符串

默认值:

2m

此参数是一个时间值参数(例如:es_scroll_time=2m),指示参与搜索的节点将保持相关资源多长时间,以便继续并支持它。

es_scroll_size
类型:

整数

默认值:

10000

Elasticsearch 将大型请求拆分为批处理。此参数定义每个批处理的最大大小(例如:es_scroll_size=10000)。

socket_timeout
类型:

浮点数

默认值:

0.1

Redissentinel 在连接上提供超时选项。此参数定义该超时(例如:socket_timeout=0.1)。

sentinel_service_name
类型:

字符串

默认值:

mymaster

Redissentinel 使用服务名称来标识主 redis 服务。此参数定义该名称(例如:sentinal_service_name=mymaster)。

filter_error_trace
类型:

布尔值

默认值:

False

启用将包含错误/异常的跟踪过滤到单独的位置。

默认值为 False。

可能的值

  • True:启用过滤包含错误/异常的跟踪。

  • False:禁用过滤器。

profiler_jaeger

service_name_prefix
类型:

字符串

默认值:

<None>

将服务名称前缀设置为 Jaeger 服务名称。

process_tags
类型:

dict

默认值:

{}

设置进程跟踪器标签。

profiler_otlp

service_name_prefix
类型:

字符串

默认值:

<None>

将服务名称前缀设置为 OTLP 导出器。

resource_finder_cache

expiration_time
类型:

整数

默认值:

3600

缓存失效时间,以秒为单位,用于缓存 OpenStack 服务查找函数的 dogpile.cache 区域中的任何项目。

caching
类型:

布尔值

默认值:

True

在 Orchestration Engine 使用名称或 ID 查找其他 OpenStack 服务资源时,启用/禁用缓存的切换。请注意,必须启用全局切换 oslo.cache(enabled=True 在 [cache] 组中) 才能使用此功能。

revision

heat_revision
类型:

字符串

默认值:

未知

Heat 构建修订版本。如果您希望单独管理构建修订版本,可以将此部分移动到另一个文件,并将其作为另一个配置选项添加。

service_extension_cache

expiration_time
类型:

整数

默认值:

3600

缓存失效时间,以秒为单位,用于缓存服务扩展的 dogpile.cache 区域中的任何项目。

caching
类型:

布尔值

默认值:

True

在 Orchestration Engine 从其他 OpenStack 服务检索扩展时,启用/禁用缓存的切换。请注意,必须启用全局切换 oslo.cache(enabled=True 在 [cache] 组中) 才能使用此功能。

trustee

auth_type
类型:

未知类型

默认值:

<None>

要加载的身份验证类型

已弃用的变体

Group

名称

trustee

auth_plugin

auth_section
类型:

未知类型

默认值:

<None>

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

auth_url
类型:

未知类型

默认值:

<None>

认证 URL

system_scope
类型:

未知类型

默认值:

<None>

系统操作的作用域

domain_id
类型:

未知类型

默认值:

<None>

作用域的域 ID

domain_name
类型:

未知类型

默认值:

<None>

作用域的域名称

project_id
类型:

未知类型

默认值:

<None>

作用域的项目 ID

已弃用的变体

Group

名称

trustee

tenant-id

trustee

tenant_id

project_name
类型:

未知类型

默认值:

<None>

作用域的项目名称

已弃用的变体

Group

名称

trustee

tenant-name

trustee

tenant_name

project_domain_id
类型:

未知类型

默认值:

<None>

包含项目的域 ID

project_domain_name
类型:

未知类型

默认值:

<None>

包含项目的域名称

trust_id
类型:

未知类型

默认值:

<None>

用作受托人的信任 ID

default_domain_id
类型:

未知类型

默认值:

<None>

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

default_domain_name
类型:

未知类型

默认值:

<None>

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

user_id
类型:

未知类型

默认值:

<None>

用户 ID

username
类型:

未知类型

默认值:

<None>

用户名

已弃用的变体

Group

名称

trustee

user-name

trustee

user_name

user_domain_id
类型:

未知类型

默认值:

<None>

用户域 ID

user_domain_name
类型:

未知类型

默认值:

<None>

用户的域名称

password
类型:

未知类型

默认值:

<None>

用户的密码

backups_enabled
类型:

布尔值

默认值:

True

指示 cinder-backup 服务是否已启用。这是临时的解决方法,直到 cinder-backup 服务可以被发现,请参阅 LP#1334856。

yaql

limit_iterators
类型:

整数

默认值:

200

集合表达式在评估时可以包含的最大元素数量。

memory_quota
类型:

整数

默认值:

10000

表达式在评估时可以使用的最大内存大小(以字节为单位)。