搜索

第 1 章 barbican

download PDF

下面的章节包含有关 barbican 服务中的配置选项的信息。

1.1. barbican.conf

本节包含 /etc/barbican/barbican.conf 文件的选项。

1.1.1. DEFAULT

下表概述了 /etc/barbican/barbican.conf 文件中的 [DEFAULT] 组下可用的选项。

.

配置选项 = 默认值类型Description

admin_role = admin

字符串值

用于将经过身份验证的用户标识为 administrator 的角色。

allow_anonymous_access = False

布尔值

允许未经身份验证的用户访问具有只读权限的 API。这只适用于使用 ContextMiddleware。

api_paste_config = api-paste.ini

字符串值

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

backdoor_port = None

字符串值

启用事件程序后端。可接受的值为 0、<port> 和 <start>:<end>,其中 0 会导致侦听随机的 tcp 端口号;<port> 会导致监听指定的端口号(如果正在使用该端口,则不会启用 backdoor);<start>:<end> 会在指定的端口号范围内侦听最小未使用的端口号。所选端口显示在服务的日志文件中。

backdoor_socket = None

字符串值

启用 eventlet 后端,使用提供的路径作为可接收连接的 unix 套接字。这个选项与 中的 backdoor_port 相互排斥,该选项只应提供一个。如果提供这两个选项,则此选项的存在会覆盖该选项的使用。在路径 {pid} 中将被当前进程的 PID 替换。

client_socket_timeout = 900

整数值

客户端连接的套接字操作的超时。如果传入的连接闲置了这个秒数,它将被关闭。值 0 表示等待永久。

conn_pool_min_size = 2

整数值

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

conn_pool_ttl = 1200

整数值

池中闲置连接的时间延迟

control_exchange = openstack

字符串值

默认交换,哪些主题在哪些方面有范围。可以被 transport_url 选项指定的交换名称覆盖。

db_auto_create = False

布尔值

在服务启动时创建 Barbican 数据库。

debug = False

布尔值

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

default_limit_paging = 10

整数值

限制 分页 URL 参数的默认页面大小。

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,则忽略此选项。

executor_thread_pool_size = 64

整数值

当 executor 为 threading 或 eventle 时,executor 线程池的大小。

fatal_deprecations = False

布尔值

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

host_href = http://localhost:9311

字符串值

主机名,用于 HATEOAS 式参考。请注意,这是客户端用来与此服务通信的负载平衡端点。如果部署希望从 wsgi 请求中派生主机,则将此设置为空白。需要为空来覆盖默认配置值,即 http://localhost:9311

`instance_format = [instance: %(uuid)s] `

字符串值

通过日志消息传递的实例格式。

`instance_uuid_format = [instance: %(uuid)s] `

字符串值

通过日志消息传递的实例 UUID 的格式。

log-config-append = None

字符串值

日志记录配置文件的名称。此文件附加到任何现有日志记录配置文件中。有关日志记录配置文件的详情,请查看 Python 日志记录模块文档。请注意,当使用日志记录配置文件时,所有日志记录配置都会在配置文件中设置,其他日志记录配置选项将被忽略(如 log-date-format)。

log-date-format = %Y-%m-%d %H:%M:%S

字符串值

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

log-dir = None

字符串值

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

log-file = None

字符串值

(可选)要将日志输出发送到的日志文件名称。如果没有设置默认值,日志记录将进入由 use_stderr 定义的 stderr。如果设置了 log_config_append,则忽略此选项。

log_rotate_interval = 1

整数值

轮转日志文件前的时间长度。除非将 log_rotation_type 设置为 "interval",否则此选项将被忽略。

log_rotate_interval_type = days

字符串值

轮转间隔类型。在调度下一个轮转时,将使用上次文件更改的时间(或服务启动的时间)。

log_rotation_type = none

字符串值

日志轮转类型。

logging_context_format_string = %(asctime) s.%(msecs) 03d %(process) d %(levelname) s %(name) s [%(request_id) s %(user_identity) 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_default_format_string = %(asctime) s.%(msecs) 03d %(process) d %(levelname) s %(name) s [-] %(instance) s%(message) s

字符串值

上下文未定义时用于日志消息的字符串。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 %(tenant) s %(domain) s %(user_domain) s %(project_domain) s

字符串值

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

max_allowed_request_size_in_bytes = 25000

整数值

针对 barbican-api 的最大允许 http 请求大小。

max_allowed_secret_in_bytes = 20000

整数值

允许的最大 secret 大小(以字节为单位)。

max_header_line = 16384

整数值

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

max_limit_paging = 100

整数值

限制 分页 URL 参数的最大页面大小。

max_logfile_count = 30

整数值

轮转日志文件的最大数量。

max_logfile_size_mb = 200

整数值

日志文件最大大小(以 MB 为单位)。如果 "log_rotation_type" 没有设置为 "size",则忽略这个选项。

publish_errors = False

布尔值

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

rate_limit_burst = 0

整数值

每个 rate_limit_interval 的最大日志信息数。

rate_limit_except_level = CRITICAL

字符串值

速率限制使用的日志级别名称:CRITICAL、ERROR、INFO、WARNING、DEBUG 或空字符串。大于或等于 rate_limit_except_level 的日志不会被过滤。空字符串表示过滤所有级别。

rate_limit_interval = 0

整数值

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

rpc_conn_pool_size = 30

整数值

RPC 连接池的大小。

rpc_ping_enabled = False

布尔值

添加端点以回答 ping 调用。端点名为 oslo_rpc_server_ping

rpc_response_timeout = 60

整数值

从调用等待响应的秒数。

run_external_periodic_tasks = True

布尔值

某些定期任务可以在单独的进程中运行。我们是否应该在此处运行?

sql_connection = sqlite:///barbican.sqlite

字符串值

用于参考实现 registry 服务器的 sqlalchemy 连接字符串。任何有效的 SQLAlchemy 连接字符串都是正常的。请参阅 :http://www.sqlalchemy.org/docs/05/reference/sqlalchemy/connections.html#sqlalchemy.create_engine。注意:对于绝对地址,请在 sqlite 后使用 //// 斜杠:

sql_idle_timeout = 3600

整数值

SQLAlchemy 应该重新建立与数据库的连接的时间(以秒为单位)。MySQL 使用默认的 wait_timeout 8 小时,它将丢弃闲置连接。这可能导致 MySQL Gone Away 例外。如果注意到这个值,您可以降低这个值来确保在 MySQL 可以丢弃连接前 SQLAlchemy 重新连接。

sql_max_retries = 60

整数值

启动期间数据库连接重试的最大数量。设置为 -1 以指定无限重试计数。

sql_pool_class = QueuePool

字符串值

接受从 sqlalchemy.pool 模块导入的类,并处理为您构建池的详细信息。如果注释掉,SQLAlchemy 将根据数据库划分来选择。其他选项包括 QueuePool (用于 SQLAlchemy 连接)和 NullPool (禁用的 SQLAlchemy 连接管理)。详情请查看 http://docs.sqlalchemy.org/en/latest/core/pooling.html

sql_pool_logging = False

布尔值

在日志中显示 SQLAlchemy 池相关的调试输出(如果指定,则显示 DEBUG 日志级别输出)。

sql_pool_max_overflow = 10

整数值

SQLAlchemy 使用的池的最大溢出大小。当签出的连接数量达到 sql_pool_size 中设置的大小时,会将额外的连接返回到这个限制。然后,池允许的同时连接总数为 sql_pool_size + sql_pool_max_overflow。可以设置为 -1 以表示没有溢出限制,因此不会将限制放在并发连接总数中。注释掉允许 SQLAlchemy 选择默认值。

sql_pool_size = 5

整数值

SQLAlchemy 使用的池大小。这是永久保留在池中的最大连接数。可以设置为 0 以表示没有大小限制。要禁用池,请使用带有 sql_pool_class 的 NullPool。注释掉允许 SQLAlchemy 选择默认值。

sql_retry_interval = 1

整数值

重新尝试打开 SQL 连接之间的间隔。

syslog-log-facility = LOG_USER

字符串值

syslog 工具接收日志行。如果设置了 log_config_append,则忽略此选项。

tcp_keepidle = 600

整数值

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

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/latest/reference/transport.html

use-journal = False

布尔值

为日志记录启用 journald。如果在 systemd 环境中运行,您可能需要启用日志支持。这样做将使用日志原生协议,该协议除日志消息之外还包含结构化元数据。如果设置了 log_config_append,此选项将被忽略。

use-json = False

布尔值

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

use-syslog = False

布尔值

使用 syslog 进行日志记录。现有的 syslog 格式是 DEPRECATED,稍后将更改为遵循 RFC5424。如果设置了 log_config_append,则忽略此选项。

use_eventlog = False

布尔值

日志输出到 Windows 事件日志.

use_stderr = False

布尔值

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

watch-log-file = False

布尔值

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

wsgi_default_pool_size = 100

整数值

wsgi 使用的 greenthreads 池的大小

wsgi_keep_alive = True

布尔值

如果为 False,请明确关闭客户端套接字连接。

wsgi_log_format = %(client_ip) s "%(request_line) s" status: %(status_code) s len: %(body_length) s time: %(wall_seconds).7f

字符串值

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

wsgi_server_debug = False

布尔值

如果服务器应该将异常回溯发送到客户端 500 错误,则为 true。如果为 False,服务器将响应空正文。

1.1.2. certificate

下表概述了 /etc/barbican/barbican.conf 文件中的 [certificate] 组下可用的选项。

表 1.1. certificate
配置选项 = 默认值类型Description

enabled_certificate_plugins = ['simple_certificate']

多值

要加载的证书插件列表。

namespace = barbican.certificate.plugin

字符串值

扩展命名空间以搜索插件。

1.1.3. certificate_event

下表概述了 /etc/barbican/barbican.conf 文件中的 [certificate_event] 组下可用的选项。

表 1.2. certificate_event
配置选项 = 默认值类型Description

enabled_certificate_event_plugins = ['simple_certificate_event']

多值

要加载的证书插件列表。

namespace = barbican.certificate.event.plugin

字符串值

扩展命名空间以搜索事件插件。

1.1.4. CORS

下表概述了 /etc/barbican/barbican.conf 文件中的 [cors] 组下可用的选项。

表 1.3. CORS
配置选项 = 默认值类型Description

allow_credentials = True

布尔值

指明实际请求可以包含用户凭证

allow_headers = ['X-Auth-Token', 'X-Openstack-Request-Id', 'X-Project-Id', 'X-Identity-Status', 'X-User-Id', 'X-Storage-Token', 'X-Domain-Id', 'X-User-Domain-Id', 'X-Project-Domain-Id', 'X-Roles']

列表值

指定在实际请求过程中可以使用哪些标头字段名称。

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

列表值

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

allowed_origin = None

列表值

指明此资源是否可以与请求"origin"标头中收到的域共享。格式:"<protocol>://<host>[:<port>]",没有尾部斜杠。示例 :https://horizon.example.com

expose_headers = ['X-Auth-Token', 'X-Openstack-Request-Id', 'X-Project-Id', 'X-Identity-Status', 'X-User-Id', 'X-Storage-Token', 'X-Domain-Id', 'X-User-Domain-Id', 'X-Project-Domain-Id', 'X-Roles']

列表值

指明哪些标头可以安全地公开给 API。默认为 HTTP Simple Headers。

max_age = 3600

整数值

CORS preflight 请求的最大缓存期限。

1.1.5. crypto

下表概述了 /etc/barbican/barbican.conf 文件中的 [crypto] 组下可用的选项。

表 1.4. crypto
配置选项 = 默认值类型Description

enabled_crypto_plugins = ['simple_crypto']

多值

要载入的加密插件列表。

namespace = barbican.crypto.plugin

字符串值

扩展命名空间以搜索插件。

1.1.6. dogtag_plugin

下表概述了 /etc/barbican/barbican.conf 文件中的 [dogtag_plugin] 组下可用的选项。

表 1.5. dogtag_plugin
配置选项 = 默认值类型Description

auto_approved_profiles = caServerCert

字符串值

自动批准的注册配置文件列表

ca_expiration_time = 1

整数值

CA 条目过期的时间

dogtag_host = localhost

字符串值

Dogtag 实例的主机名

dogtag_port = 8443

端口值

Dogtag 实例的端口

nss_db_path = /etc/barbican/alias

字符串值

NSS 证书数据库的路径

nss_password = None

字符串值

NSS 证书数据库的密码

pem_path = /etc/barbican/kra_admin_cert.pem

字符串值

PEM 文件的路径进行验证

plugin_name = Dogtag KRA

字符串值

用户友好插件名称

plugin_working_dir = /etc/barbican/dogtag

字符串值

Dogtag 插件的工作目录

retries = 3

整数值

在存储或生成 secret 时重试

simple_cmc_profile = caOtherCert

字符串值

简单 CMC 请求的配置集

1.1.7. keystone_authtoken

下表概述了 /etc/barbican/barbican.conf 文件中的 [keystone_authtoken] 组下可用的选项。

表 1.6. keystone_authtoken
配置选项 = 默认值类型Description

auth_section = None

字符串值

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

auth_type = None

字符串值

要加载的身份验证类型

auth_uri = None

字符串值

完整的"公共"身份 API 端点。此端点不应是一个 "admin" 端点,因为它应该可以被所有最终用户访问。未经身份验证的客户端重定向到此端点以进行身份验证。虽然理想情况下,这个端点应该被未指定版本,但通配符中的客户端支持会有所不同。如果您在这里使用版本化的 v2 端点,则该服务用户不应该用于验证令牌的端点,因为普通用户可能无法访问该端点。这个选项已弃用,现在使用 www_authenticate_uri,并将在 S 发行版本中删除。弃用自: Queens

*reason:* auth_uri 选项已弃用,现在使用 www_authenticate_uri,并将在 S 发行版本中删除。

auth_version = None

字符串值

Identity API 端点的 API 版本。

cache = None

字符串值

存储 Swift 缓存对象的请求环境密钥。当使用 Swift 缓存部署 auth_token 中间件时,请使用此选项使中间件共享具有 swift 的缓存后端。否则,使用 memcached_servers 选项。

cafile = None

字符串值

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

certFile = None

字符串值

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

delay_auth_decision = False

布尔值

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

enforce_token_bind = permissive

字符串值

用于控制令牌绑定的使用和类型。可以设置为 "disabled" 以不检查令牌绑定。如果绑定类型是已知服务器的绑定类型,则验证绑定信息,并忽略它(如 "permissive" ),但如果绑定类型未知,则令牌将被拒绝。"必需"令牌绑定需要允许任何形式的令牌绑定。最后,令牌中必须存在的绑定方法名称。

http_connect_timeout = None

整数值

请求超时值与身份 API 服务器通信。

http_request_max_retries = 3

整数值

与身份 API 服务器通信时,我们尝试重新连接的次数。

include_service_catalog = True

布尔值

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

insecure = False

布尔值

验证 HTTPS 连接。

interface = internal

字符串值

用于 Identity API 端点的接口。有效值为 "public", "internal" (默认)或 "admin"。

keyfile = None

字符串值

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

memcache_pool_conn_get_timeout = 10

整数值

(可选)操作等待从池中获取 memcached 客户端连接的秒数。

memcache_pool_dead_retry = 300

整数值

(可选)在再次尝试前 memcached 服务器被视为 dead 的秒数。

memcache_pool_maxsize = 10

整数值

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

memcache_pool_socket_timeout = 3

整数值

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

memcache_pool_unused_timeout = 60

整数值

(可选)与 memcached 的连接在池关闭前未使用的秒数。

memcache_secret_key = None

字符串值

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

memcache_security_strategy = None

字符串值

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

memcache_use_advanced_pool = False

布尔值

(可选)使用 advanced (事件安全)memcached 客户端池。高级池只能在 python 2.x 下工作。

memcached_servers = None

列表值

(可选)指定要用于缓存的 memcached 服务器列表。如果未定义,令牌将会被缓存在进程中。

region_name = None

字符串值

找到身份服务器的区域。

service_token_roles = ['service']

列表值

需要出现在服务令牌中的角色。服务令牌可以请求可以使用过期的令牌,因此此检查应严格控制只有实际服务应发送此令牌。此处的角色作为 ANY 检查应用,因此此列表中的任何角色都必须存在。为了向后兼容的原因,这目前只会影响 allow_expired 检查。

service_token_roles_required = False

布尔值

为了向后兼容的原因,我们必须允许有效的服务令牌传递,但不允许将 service_token_roles 检查视为有效。在以后的发行版本中设置此 true 将成为默认设置,并应启用(如果可能)。

service_type = None

字符串值

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

token_cache_time = 300

整数值

为了防止过度努力验证令牌,中间件会缓存之前可预见的令牌(以秒为单位)。设置为 -1 可完全禁用缓存。

www_authenticate_uri = None

字符串值

完整的"公共"身份 API 端点。此端点不应是一个 "admin" 端点,因为它应该可以被所有最终用户访问。未经身份验证的客户端重定向到此端点以进行身份验证。虽然理想情况下,这个端点应该被未指定版本,但通配符中的客户端支持会有所不同。如果您在这里使用版本化的 v2 端点,则该服务用户不应该用于验证令牌的端点,因为普通用户可能无法访问该端点。

1.1.8. keystone_notifications

下表概述了 /etc/barbican/barbican.conf 文件中的 [keystone_notifications] 组下可用的选项。

表 1.7. keystone_notifications
配置选项 = 默认值类型Description

allow_requeue = False

布尔值

true 在通知处理错误时启用 requeue 功能。仅在底层传输支持此功能时启用此功能。

control_exchange = keystone

字符串值

默认交换,哪些主题在哪些方面有范围。可以被 transport_url 选项指定的交换名称覆盖。

enable = False

布尔值

true 启用 keystone 通知监听程序功能。

pool_name = None

字符串值

通知监听程序的池名称。把它设置为不同的值将允许 barbican 通知监听程序从主题接收其自身所有消息的副本,而不会干扰侦听同一主题的其他服务。此功能仅受某些 oslo.messaging 后端(由rabbitmq 的 particilar 中)支持,对于那些最好使用这个功能,而不是单独的 barbican 通知主题。

thread_pool_size = 10

整数值

定义用于通知服务器处理功能的最大线程数量。

topic = notification

字符串值

Keystone 通知队列主题名称。此名称需要匹配 Keystone 部署的 notification_topics 配置中提到的其中一个值,例如 notification_topics=notifications, barbican_notificationsMultiple 服务器可以侦听一个主题,消息将以轮循方式分配给其中一个服务器。这就是 Barbican 服务应拥有自己的专用通知队列的原因,以便它接收所有 Keystone 通知。或者,如果所选的 oslo.messaging 后端支持侦听器池(如 rabbitmq),则应首选设置非默认 pool_name 选项。

version = 1.0

字符串值

通过通知调用的任务版本

1.1.9. kmip_plugin

下表概述了 /etc/barbican/barbican.conf 文件中的 [kmip_plugin] 组下可用的选项。

表 1.8. kmip_plugin
配置选项 = 默认值类型Description

ca_certs = None

字符串值

串联"认证机构"证书的文件路径

certFile = None

字符串值

到本地客户端证书的文件路径

host = localhost

字符串值

KMIP 服务器的地址

keyfile = None

字符串值

到本地客户端证书密钥文件的文件路径

password = None

字符串值

使用 KMIP 服务器进行身份验证的密码

pkcs1_only = False

布尔值

只支持非对称密钥的 PKCS#1 编码

plugin_name = KMIP HSM

字符串值

用户友好插件名称

port = 5696

端口值

KMIP 服务器的端口

ssl_version = PROTOCOL_TLSv1_2

字符串值

SSL 版本,映射到模块的 ssl 常数

username = None

字符串值

使用 KMIP 服务器进行身份验证的用户名

1.1.10. oslo_messaging_amqp

下表概述了 /etc/barbican/barbican.conf 文件中的 [oslo_messaging_amqp] 组下可用的选项。

表 1.9. oslo_messaging_amqp
配置选项 = 默认值类型Description

addressing_mode = dynamic

字符串值

表示驱动程序使用的寻址模式。允许的值: legacy - 使用旧的不可路由寻址;routable - 使用可路由地址;dynamic - 如果消息总线不支持路由,使用 legacy,如果支持,使用 routable。

anycast_address = anycast

字符串值

在发送到一组消费者时附加到地址前缀。消息总线用来识别应在消费者之间以轮循方式发送的消息。

broadcast_prefix = broadcast

字符串值

广播到所有服务器时使用的地址前缀

connection_retry_backoff = 2

整数值

每次失败故障转移尝试后,将 connection_retry_interval 增加到这秒数。

connection_retry_interval = 1

整数值

尝试重新连接前暂停的秒数。

connection_retry_interval_max = 30

整数值

connection_retry_interval + connection_retry_backoff 的最大限制

container_name = None

字符串值

AMQP 容器的名称必须全局唯一。默认为生成的 UUID

default_notification_exchange = None

字符串值

通知地址中使用的交换名称。Exchange name resolution priority: Target.exchange if set default_notification_exchange if set else control_exchange if set else notify

default_notify_timeout = 30

整数值

发送通知消息发送的截止时间。仅在调用者不提供超时到期时使用。

default_reply_retry = 0

整数值

重新发送回复消息的最大尝试次数,因为可恢复错误而失败。

default_reply_timeout = 30

整数值

rpc 回复消息发送的截止时间。

default_rpc_exchange = None

字符串值

RPC 地址中使用的交换名称。Exchange name resolution priority: Target.exchange if set default_rpc_exchange if set other control_exchange if set else rpc

default_send_timeout = 30

整数值

rpc cast 或调用消息发送的截止时间。仅在调用者不提供超时到期时使用。

default_sender_link_timeout = 600

整数值

调度闲置发送者链接清除的持续时间。过期后分离链接。

group_request_prefix = unicast

字符串值

发送到组中任何服务器时的地址前缀

idle_timeout = 0

整数值

不活跃连接的超时时间(以秒为单位)

link_retry_delay = 10

整数值

重新连接 AMQP 1.0 链接之间的暂停时间,该链接因为可恢复的错误而失败。

multicast_address = multicast

字符串值

在发送异常消息时,附加到地址前缀。消息总线用来识别 fanout 消息。

notify_address_prefix = openstack.org/om/notify

字符串值

所有生成的通知地址的地址前缀

notify_server_credit = 100

整数值

传入通知消息的窗口大小

pre_settled = ['rpc-cast', 'rpc-reply']

多值

发送此类型的消息预先组装。预先设置的消息不会接收来自 peer 的确认信息。请注意:如果发送失败,则预先设置的消息可能会被静默丢弃。允许的值: rpc-call - 发送 RPC Calls pre-settled rpc-reply- 发送 RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled

pseudo_vhost = True

布尔值

为不支持虚拟主机的消息总线启用虚拟主机支持(如 qpidd)。当设置为 true 时,虚拟主机名将添加到所有消息总线地址中,从而有效地为每个虚拟主机 创建专用子网。如果消息总线支持使用 AMQP 1.0 Open performative 中的 hostname 字段作为虚拟主机的名称,设置为 False。

reply_link_credit = 200

整数值

传入 RPC 消息的窗口大小。

rpc_address_prefix = openstack.org/om/rpc

字符串值

所有生成的 RPC 地址的地址前缀

rpc_server_credit = 100

整数值

传入 RPC Request 消息的窗口大小

`sasl_config_dir = `

字符串值

包含 SASL 配置的目录路径

`sasl_config_name = `

字符串值

配置文件名称(不带 .conf 后缀)

`sasl_default_realm = `

字符串值

如果用户名中没有 realm,则要使用的 SASL 域

`sasl_mechanisms = `

字符串值

可接受的 SASL 机制的以空格分隔的列表

server_request_prefix = exclusive

字符串值

发送到特定服务器时使用的地址前缀

ssl = False

布尔值

尝试通过 SSL 连接。如果没有给出其他与 ssl 相关的参数,它将使用系统的 CA-bundle 来验证服务器证书。

`ssl_ca_file = `

字符串值

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

`ssl_cert_file = `

字符串值

自我标识用于客户端身份验证的证书 PEM 文件

`ssl_key_file = `

字符串值

用于为 ssl_cert_file 证书签名的私钥 PEM 文件(可选)

ssl_key_password = None

字符串值

用于解密 ssl_key_file 的密码(如果加密)

ssl_verify_vhost = False

布尔值

默认情况下,SSL 检查服务器证书中的名称与 transport_url 中的主机名匹配。在某些配置中,最好使用虚拟主机名。例如,如果服务器使用 Server Name Indication TLS extension (rfc6066)来为每个虚拟主机提供证书。如果服务器的 SSL 证书使用虚拟主机名称而不是 DNS 名称,则将 ssl_verify_vhost 设置为 True。

trace = False

布尔值

debug :将 AMQP 帧转储到 stdout

unicast_address = unicast

字符串值

在发送到特定 RPC/Notification 服务器时,附加到地址前缀。消息总线用来识别发送到单个目的地的消息。

1.1.11. oslo_messaging_kafka

下表概述了 /etc/barbican/barbican.conf 文件中的 [oslo_messaging_kafka] 组下可用的选项。

表 1.10. oslo_messaging_kafka
配置选项 = 默认值类型Description

compression_codec = none

字符串值

producer 生成的所有数据的压缩 codec。如果没有设置,则不会使用压缩。请注意,这允许的值取决于 kafka 版本

conn_pool_min_size = 2

整数值

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

conn_pool_ttl = 1200

整数值

池中闲置连接的时间延迟

consumer_group = oslo_messaging_consumer

字符串值

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

enable_auto_commit = False

布尔值

启用异步消费者提交

kafka_consumer_timeout = 1.0

浮点值

Kafka 用户的默认超时

kafka_max_fetch_bytes = 1048576

整数值

Kafka consumer 的最大获取字节数

max_poll_records = 500

整数值

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

pool_size = 10

整数值

Kafka Consumers 的池大小

producer_batch_size = 16384

整数值

producer async 发送的批处理大小

producer_batch_timeout = 0.0

浮点值

以秒为单位的 KafkaProducer 批处理延迟上限

sasl_mechanism = PLAIN

字符串值

当安全协议是 SASL 时的机制

security_protocol = PLAINTEXT

字符串值

用于与代理通信的协议

`ssl_cafile = `

字符串值

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

`ssl_client_cert_file = `

字符串值

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

`ssl_client_key_file = `

字符串值

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

`ssl_client_key_password = `

字符串值

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

1.1.12. oslo_messaging_notifications

下表概述了 /etc/barbican/barbican.conf 文件中的 [oslo_messaging_notifications] 组下可用的选项。

表 1.11. oslo_messaging_notifications
配置选项 = 默认值类型Description

driver = []

多值

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

retry = -1

整数值

重新发送因为可恢复错误而发送失败的通知消息的最大尝试次数。0 - 不重试,-1 - indefinite

topics = ['notifications']

列表值

用于 OpenStack 通知的 AMQP 主题。

transport_url = None

字符串值

代表用于通知的消息传递驱动程序的 URL。如果没有设置,我们回退到用于 RPC 的同一配置。

1.1.13. oslo_messaging_rabbit

下表概述了 /etc/barbican/barbican.conf 文件中的 [oslo_messaging_rabbit] 组下可用的选项。

表 1.12. oslo_messaging_rabbit
配置选项 = 默认值类型Description

amqp_auto_delete = False

布尔值

AMQP 中的自动删除队列。

amqp_durable_queues = False

布尔值

在 AMQP 中使用持久队列。

direct_mandatory_flag = True

布尔值

(DEPRECATED)为直接发送启用/禁用 RabbitMQ 强制标记。直接发送用作回复,因此在客户端队列不存在时引发 MessageUndeliverable 异常。MessageUndeliverable 异常将用于循环使发送者恢复。此标志已弃用,且无法停用此功能

enable_cancel_on_failover = False

布尔值

启用 x-cancel-on-ha-failover 标志,使 rabbitmq 服务器将取消并通知 consumerswhen 队列停机

heartbeat_in_pthread = False

布尔值

默认情况下,通过原生 python 线程运行健康检查心跳线程。如果此选项等于 False,则健康检查 heartbeat 将继承父进程的执行模型。例如,如果父进程使用 eventlet/greenlet 对 stdlib 进行补丁,则心跳将通过绿色线程运行。这个选项应该只针对 wsgi 服务设置为 True。

heartbeat_rate = 2

整数值

heartbeat_timeout_threshold 期间的时间我们检查心跳的频率。

heartbeat_timeout_threshold = 60

整数值

如果 heartbeat 的 keep-alive 失败(0 禁用 heartbeat),则 Rabbit 代理被视为 down 的秒数。

kombu_compression = None

字符串值

EXPERIMENTAL: Possible 值为:gzip、bz2。如果没有设置压缩,则不会使用。这个选项可能在以后的版本中不可用。

kombu_failover_strategy = round-robin

字符串值

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

kombu_missing_consumer_retry_timeout = 60

整数值

在放弃发送其回复前等待缺少的客户端的时间。这个值不应比 rpc_response_timeout 长。

kombu_reconnect_delay = 1.0

浮点值

响应 AMQP 消费者取消通知前等待多久。

rabbit_ha_queues = False

布尔值

尝试在 RabbitMQ 中使用 HA 队列(x-ha-policy: all)。如果更改这个选项,您必须擦除 RabbitMQ 数据库。在 RabbitMQ 3.0 中,在声明队列时,x-ha-policy 参数不再控制队列镜像。如果您只想确保所有队列(带有自动生成的名称的队列除外)都在所有节点上进行镜像,请运行:"rabbitmqctl set_policy HA ^(?!amq\.) gem {"ha-mode": "all"} "

rabbit_interval_max = 30

整数值

RabbitMQ 连接重试的最大间隔。默认值为 30 秒。

rabbit_login_method = AMQPLAIN

字符串值

RabbitMQ 登录方法。

rabbit_qos_prefetch_count = 0

整数值

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

rabbit_retry_backoff = 2

整数值

连接到 RabbitMQ 时重试之间的 backoff 时长。

rabbit_retry_interval = 1

整数值

使用 RabbitMQ 重试连接的频率。

rabbit_transient_queues_ttl = 1800

整数值

正整数代表队列 TTL (x-expires)的持续时间(以秒为单位)。TTL 期间未使用的队列将被自动删除。参数仅影响 reply 和 fanout 队列。

ssl = False

布尔值

通过 SSL 连接。

`ssl_ca_file = `

字符串值

SSL 证书颁发机构文件(仅在启用了 SSL 时评估)。

`ssl_cert_file = `

字符串值

SSL 证书文件(仅在启用了 SSL 时评估)。

`ssl_key_file = `

字符串值

SSL 密钥文件(仅在启用了 SSL 时valid)。

`ssl_version = `

字符串值

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

1.1.14. oslo_middleware

下表概述了 /etc/barbican/barbican.conf 文件中的 [oslo_middleware] 组下可用的选项。

表 1.13. oslo_middleware
配置选项 = 默认值类型Description

enable_proxy_headers_parsing = False

布尔值

应用程序是否在代理后面。这决定了中间件是否应该解析标头。

1.1.15. oslo_policy

下表概述了 /etc/barbican/barbican.conf 文件中的 [oslo_policy] 组下可用的选项。

表 1.14. oslo_policy
配置选项 = 默认值类型描述

enforce_new_defaults = False

布尔值

这个选项控制在评估策略时是否使用旧的弃用默认值。如果为 True,则不会评估旧的已弃用的默认值。这意味着,如果旧默认值允许任何现有令牌,但不允许使用新默认值,它将被禁止。我们鼓励启用此标志以及 enforce_scope 标志,以便您可以同时获得新默认值和 scope_type 的好处

enforce_scope = False

布尔值

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

policy_default_rule = default

字符串值

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

policy_dirs = ['policy.d']

多值

存储策略配置文件的目录。它们可以相对于 config_dir 选项或绝对路径定义的搜索路径中的任何目录。由 policy_file 定义的文件必须存在,才能搜索这些目录。缺少或空目录将被忽略。

policy_file = policy.yaml

字符串值

将角色映射到给定服务权限的文件的相对或绝对路径。必须使用与配置文件设置相关的相对路径。

remote_content_type = application/x-www-form-urlencoded

字符串值

用于发送和接收基于 REST 策略检查的数据的内容类型

remote_ssl_ca_crt_file = None

字符串值

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

remote_ssl_client_crt_file = None

字符串值

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

remote_ssl_client_key_file = None

字符串值

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

remote_ssl_verify_server_crt = False

布尔值

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

1.1.16. p11_crypto_plugin

下表概述了 /etc/barbican/barbican.conf 文件中的 [p11_crypto_plugin] 组下可用的选项。

表 1.15. p11_crypto_plugin
配置选项 = 默认值类型Description

aes_gcm_generate_iv = True

布尔值

为 CKM_AES_GCM 机制生成 IVs。

always_set_cka_sensitive = True

布尔值

始终设置 CKA_SENSITIVE=CK_TRUE 包括 CKA_EXTRACTABLE=CK_TRUE 密钥。

encryption_mechanism = CKM_AES_CBC

字符串值

Secret 加密机制

hmac_key_type = CKK_AES

字符串值

HMAC 密钥类型

hmac_keygen_mechanism = CKM_AES_KEY_GEN

字符串值

HMAC 密钥生成算法

hmac_keywrap_mechanism = CKM_SHA256_HMAC

字符串值

HMAC 键 wrap 机制

hmac_label = None

字符串值

Master HMAC Key 标签(如 HSM 中存储的)

library_path = None

字符串值

供应商 PKCS11 库的路径

login = None

字符串值

登录到 PKCS11 会话的密码

mkek_label = None

字符串值

Master KEK 标签(存储在 HSM 中)

mkek_length = None

整数值

master KEK 长度(以字节为单位)。

os_locking_ok = False

布尔值

初始化 PKCS facilities 客户端库时,启用 CKF_OS_LOCKING_OK 标志。

pkek_cache_limit = 100

整数值

项目 KEK Cache Item Limit

pkek_cache_ttl = 900

整数值

项目 KEK Cache Time To Live,以秒为单位

pkek_length = 32

整数值

项目 KEK 长度(以字节为单位)。

plugin_name = PKCS11 HSM

字符串值

用户友好插件名称

rw_session = True

布尔值

读/写会话的标记

`seed_file = `

字符串值

用于拉取有关 seeding RNG 的熵的文件

seed_length = 32

整数值

从文件读取的数据量用于 seed

slot_id = 1

整数值

(可选)包含要使用的令牌设备的 HSM Slot ID。

token_label = None

字符串值

DEPRECATED :改为使用 token_labels。用于识别要使用的令牌的令牌标签。

token_labels = None

列表值

要使用的一个或多个令牌的标签列表。通常,这是一个标签,但有些 HSM 设备可能需要多个标签用于负载平衡或高可用性配置。

token_serial_number = None

字符串值

用于识别要使用的令牌的令牌序列号。

1.1.17. queue

下表概述了 /etc/barbican/barbican.conf 文件中的 [queue] 组下可用的选项。

表 1.16. queue
配置选项 = 默认值类型Description

asynchronous_workers = 1

整数值

异步 worker 进程数量

enable = False

布尔值

true 启用排队,False 同步调用 worker

namespace = barbican

字符串值

队列命名空间

server_name = barbican.queue

字符串值

RPC 任务处理服务器的服务器名称

topic = barbican.workers

字符串值

队列主题名称

version = 1.1

字符串值

通过队列调用的任务版本

1.1.18. quotas

下表概述了 /etc/barbican/barbican.conf 文件中的 [quotas] 组下可用的选项。

表 1.17. quotas
配置选项 = 默认值类型Description

quota_cas = -1

整数值

每个项目允许的 CA 数量

quota_consumers = -1

整数值

每个项目允许的消费者数量

quota_containers = -1

整数值

每个项目允许的容器数量

quota_orders = -1

整数值

每个项目允许的订购数

quota_secrets = -1

整数值

每个项目允许的 secret 数量

1.1.19. retry_scheduler

下表概述了 /etc/barbican/barbican.conf 文件中的 [retry_scheduler] 组下可用的选项。

表 1.18. retry_scheduler
配置选项 = 默认值类型Description

initial_delay_seconds = 10.0

浮点值

启动重试调度程序前要等待的秒数(浮点数)

periodic_interval_max_seconds = 10.0

浮点值

在定期调度事件之间等待的秒数(浮点)

1.1.20. secretstore

下表概述了 /etc/barbican/barbican.conf 文件中的 [secretstore] 组下可用的选项。

表 1.19. secretstore
配置选项 = 默认值类型Description

enable_multiple_secret_stores = False

布尔值

启用多个 secret 存储插件后端的标志。默认为 False

enabled_secretstore_plugins = ['store_crypto']

多值

要加载的机密存储插件列表。

namespace = barbican.secretstore.plugin

字符串值

扩展命名空间以搜索插件。

stores_lookup_suffix = None

列表值

用于查找支持多个后端支持的插件的后缀列表。

1.1.21. simple_crypto_plugin

下表概述了 /etc/barbican/barbican.conf 文件中的 [simple_crypto_plugin] 组下可用的选项。

表 1.20. simple_crypto_plugin
配置选项 = 默认值类型Description

kek = dGhpcnR5X3R3b19ieXRlX2tleWJsYWhibGFoYmxhaGg=

字符串值

Simple Crypto Plugin 使用的密钥加密密钥

plugin_name = Software Only Crypto

字符串值

用户友好插件名称

1.1.22. snakeoil_ca_plugin

下表概述了 /etc/barbican/barbican.conf 文件中的 [snakeoil_ca_plugin] 组下可用的选项。

表 1.21. snakeoil_ca_plugin
配置选项 = 默认值类型Description

ca_cert_chain_path = None

字符串值

CA 证书链文件的路径

ca_cert_key_path = None

字符串值

CA 证书密钥文件的路径

ca_cert_path = None

字符串值

CA 证书文件的路径

ca_cert_pkcs7_path = None

字符串值

CA 链 pkcs7 文件的路径

subca_cert_key_directory = /etc/barbican/snakeoil-cas

字符串值

为 subcas 保存证书/密钥的目录

1.1.23. ssl

下表概述了 /etc/barbican/barbican.conf 文件中的 [ssl] 组下可用的选项。

表 1.22. ssl
配置选项 = 默认值类型Description

ca_file = None

字符串值

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

cert_file = None

字符串值

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

密码 = None

字符串值

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

key_file = None

字符串值

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

version = None

字符串值

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

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.