第 1 章 barbican
下面的章节包含有关 barbican
服务中的配置选项的信息。
1.1. barbican.conf
本节包含 /etc/barbican/barbican.conf
文件的选项。
1.1.1. DEFAULT
下表概述了 /etc/barbican/barbican.conf
文件中的 [DEFAULT]
组下可用的选项。
.
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | 用于识别经过身份验证的用户的角色。 |
| 布尔值 | 允许未经身份验证的用户访问具有只读权限的 API。这只适用于使用 ContextMiddleware。 |
| 字符串值 | api 服务的 paste.deploy 配置的文件名 |
| 字符串值 | 启用 eventlet backdoor。可接受值为 0、<port> 和 <start>:<end>,其中 0 会导致侦听一个随机的 tcp 端口号;<port> 会导致侦听指定的端口号(如果该端口正在使用),并且 <start>:<end> 会导致在指定端口号范围内侦听最小未使用的端口号。所选端口显示在服务的日志文件中。 |
| 字符串值 | 启用 eventlet backdoor,使用提供的路径作为可接收连接的 unix 套接字。这个选项与 backdoor_port 相互排斥,其中只能提供一个。如果同时提供了这两个选项,则此选项存在会覆盖该选项的使用。在路径 {pid} 中,路径将被当前进程的 PID 替换。 |
| 整数值 | 客户端连接套接字操作的超时。如果传入的连接闲置了这个秒数,它将被关闭。值 0 表示等待(ever)。 |
| 整数值 | 连接过期策略的池大小限制 |
| 整数值 | 池中闲置连接的生存时间 |
| 字符串值 | 主题范围的默认交换。可以被 transport_url 选项中指定的交换名称覆盖。 |
| 布尔值 | 在服务启动时创建 Barbican 数据库。 |
| 布尔值 | 如果设置为 true,则日志级别将设为 DEBUG,而不是默认的 INFO 级别。 |
| 整数值 | 限制 分页 URL 参数的默认页面大小。 |
| 列出值 | 以 logger=LEVEL 的形式列出软件包日志级别列表。如果设置了 log_config_append,则忽略这个选项。 |
| 整数值 | 当 executor 为 threading 或 eventle 时,executor 线程池的大小。 |
| 布尔值 | 启用或禁用弃用的严重状态。 |
| 整数值 | 指定一个超时,之后安全关闭服务器将退出。零值表示无限等待。 |
| 字符串值 | 主机名,用于 HATEOAS 风格参考 注意:这通常是客户端用来与该服务通信的负载平衡端点。如果部署希望从 wsgi 请求中获取主机,请将此留空。需要空白来覆盖默认配置值 http://localhost:9311 |
`instance_format = [instance: %(uuid)s] ` | 字符串值 | 通过日志消息传递的实例格式。 |
`instance_uuid_format = [instance: %(uuid)s] ` | 字符串值 | 通过日志消息传递的实例 UUID 格式。 |
| 字符串值 | 日志配置文件的名称。此文件附加到任何现有日志记录配置文件中。有关日志记录配置文件的详情,请查看 Python 日志记录模块文档。请注意,当使用日志记录配置文件时,会在配置文件中设置所有日志记录配置,并忽略其他日志记录配置选项(例如 log-date-format)。 |
| 字符串值 | 在日志记录中定义 %%(asctime) s 的格式字符串。默认: %(default) s。如果设置了 log_config_append,则忽略这个选项。 |
| 字符串值 | (可选)用于相对 log_file 路径的基础目录。如果设置了 log_config_append,则忽略这个选项。 |
| 字符串值 | (可选)要将日志输出发送到的日志文件名称。如果没有设置默认值,日志记录将进入由 use_stderr 定义的 stderr。如果设置了 log_config_append,则忽略这个选项。 |
| 布尔值 | 启动服务( DEBUG 级别)时,启用或禁用所有注册选项的日志记录值。 |
| 整数值 | 轮转日志文件前的时间长度。除非 log_rotation_type 设为 "interval",否则此选项会被忽略。 |
| 字符串值 | 轮转间隔类型。调度下一个轮转时使用上次文件更改(或服务启动时的时间)。 |
| 字符串值 | 日志轮转类型。 |
| 字符串值 | 用于带有上下文的日志消息的格式字符串。由 oslo_log.formatters.ContextFormatter 使用 |
| 字符串值 | 当消息的日志记录级别为 DEBUG 时,要附加到日志消息的额外数据。由 oslo_log.formatters.ContextFormatter 使用 |
| 字符串值 | 上下文未定义时用于日志消息的格式字符串。由 oslo_log.formatters.ContextFormatter 使用 |
| 字符串值 | 使用这种格式为每行例外输出加上前缀。由 oslo_log.formatters.ContextFormatter 使用 |
| 字符串值 | 定义 logging_context_format_string 中使用的 %(user_identity) s 格式字符串。由 oslo_log.formatters.ContextFormatter 使用 |
| 整数值 | 针对 barbican-api 允许的最大 http 请求大小。 |
| 整数值 | 允许的最大 secret 大小(以字节为单位)。 |
| 整数值 | 要接受的最大消息标头大小。在使用大型令牌时,可能需要增加 max_header_line (通常在 keystone 被配置为将 PKI 令牌配置为将 PKI 令牌与大型服务目录搭配使用时生成的)。 |
| 整数值 | 限制 分页 URL 参数的最大页面大小。 |
| 整数值 | 轮转日志文件的最大数量。 |
| 整数值 | 日志文件的最大大小(以 MB 为单位)。如果 "log_rotation_type" 没有设置为 "size",则忽略这个选项。 |
| 布尔值 | 启用或禁用错误事件的发布。 |
| 整数值 | 每个 rate_limit_interval 的最大日志信息数。 |
| 字符串值 | 通过速率限制使用的日志级别名称:CRITICAL、ERROR、INFO、WARNING、DEBUG 或空字符串。不过滤级别大于或等于 rate_limit_except_level 的日志。空字符串表示过滤所有级别。 |
| 整数值 | 日志速率限制的时间间隔、秒数。 |
| 整数值 | RPC 连接池的大小。 |
| 布尔值 | 添加端点以回答 ping 调用。端点名为 oslo_rpc_server_ping |
| 整数值 | 等待来自调用的响应的秒数。 |
| 布尔值 | 某些定期任务可以在单独的进程中运行。我们是否应该在此处运行? |
| 字符串值 | 用于引用实施 registry 服务器的 sqlalchemy 连接字符串。任何有效的 SQLAlchemy 连接字符串都是正常的。请参阅 :http://www.sqlalchemy.org/docs/05/reference/sqlalchemy/connections.html#sqlalchemy.create_engine。注意:对于绝对地址,请在 sqlite 后使用 //// 斜杠: |
| 整数值 |
SQLAlchemy 应该重新建立与数据库的连接的时间(以秒为单位)。MySQL 使用默认的 |
| 整数值 | 在启动过程中重试数据库连接的最大数量。设置为 -1 以指定无限重试计数。 |
| 字符串值 | 接受从 sqlalchemy.pool 模块导入的类,并处理为您构建池的详细信息。如果注释掉,SQLAlchemy 将根据数据库分离进行选择。其他选项有 QueuePool (用于 SQLAlchemy 管理的连接)和 NullPool (用于禁用连接的 SQLAlchemy 管理)。See http://docs.sqlalchemy.org/en/latest/core/pooling.html for more details |
| 布尔值 | 如果指定,在日志中显示 SQLAlchemy 池相关的调试输出(设置 DEBUG 日志级别输出)。 |
| 整数值 | SQLAlchemy 使用的池的最大溢出大小。当检查的连接数量达到 sql_pool_size 中设置的大小时,额外的连接将返回到这个限制。然后,池允许的连接总数为 sql_pool_size + sql_pool_max_overflow。可以设置为 -1 来指示没有溢出限制,因此不会将限制放在并发连接总数中。注释掉以允许 SQLAlchemy 选择默认值。 |
| 整数值 | SQLAlchemy 使用的池大小。这是池中永久保留的最大连接数。可以设置为 0 以指示没有大小限制。要禁用池,请使用带有 sql_pool_class 的 NullPool。注释掉以允许 SQLAlchemy 选择默认值。 |
| 整数值 | 打开 SQL 连接之间的间隔。 |
| 字符串值 | syslog 工具可接收日志行。如果设置了 log_config_append,则忽略这个选项。 |
| 整数值 | 设置每个服务器套接字的 TCP_KEEPIDLE 的值(以秒为单位)。OS X 不支持。 |
| 字符串值 | 用于连接到消息传递后端的网络地址和可选用户凭证,采用 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 |
| 布尔值 | 为日志记录启用 journald。如果在 systemd 环境中运行,您可能需要启用日志支持。这样做将使用日志原生协议,该协议包括日志消息外的结构化元数据。如果设置了 log_config_append,则忽略此选项。 |
| 布尔值 | 使用 JSON 格式进行日志记录。如果设置了 log_config_append,则忽略这个选项。 |
| 布尔值 | 使用 syslog 进行日志记录。现有 syslog 格式为 DEPRECATED,稍后将更改为遵循 RFC5424。如果设置了 log_config_append,则忽略这个选项。 |
| 布尔值 | 日志输出到 Windows 事件日志。 |
| 布尔值 | 将日志输出到标准错误。如果设置了 log_config_append,则忽略这个选项。 |
| 布尔值 | 使用旨在监视文件系统的日志记录处理程序。当移动或删除日志文件时,此处理程序将立即打开具有指定路径的新日志文件。只有在指定了 log_file 选项并使用 Linux 平台时才有意义。如果设置了 log_config_append,则忽略这个选项。 |
| 整数值 | wsgi 使用的 greenthreads 池的大小 |
| 布尔值 | 如果为 False,请明确关闭客户端套接字连接。 |
| 字符串值 | 用作模板的 python 格式字符串,用于生成日志行。以下值可以格式化到其中: client_ip, date_time, request_line, status_code, body_length, wall_seconds。 |
| 布尔值 | 如果服务器应在 500 错误时向客户端发送异常回溯,则为 true。如果 False,服务器将以空正文来响应。 |
1.1.2. audit_middleware_notifications
下表概述了 /etc/barbican/barbican.conf
文件中的 [audit_middleware_notifications]
组下可用的选项。
配置选项 = 默认值 | 类型 | 描述 |
---|---|---|
| 字符串值 | 处理发送通知的驱动程序。可能的值有 messaging, messagingv2, routing, log, test, noop。如果没有指定,则使用 oslo_messaging_notifications conf 部分中的值。 |
| 列出值 | 用于 OpenStack 通知的 AMQP 主题列表。如果没有指定,则使用 oslo_messaging_notifications conf 部分中的值。 |
| 字符串值 | 代表用于通知的消息传递驱动程序的 URL。如果没有指定,我们回退到用于 RPC 的同一配置。 |
| 布尔值 | 指明是否使用 oslo_messaging 作为通知程序。如果设置为 False,则本地日志记录器将用作通知程序。如果设置为 True,还必须存在 oslo_messaging 软件包。否则,将使用本地。 |
1.1.3. certificate
下表概述了 /etc/barbican/barbican.conf
文件中的 [certificate]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 多值 | 要载入的证书插件列表。 |
| 字符串值 | 扩展命名空间以搜索插件。 |
1.1.4. certificate_event
下表概述了 /etc/barbican/barbican.conf
文件中的 [certificate_event]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 多值 | 要载入的证书插件列表。 |
| 字符串值 | 扩展命名空间以搜索事件插件。 |
1.1.5. CORS
下表概述了 /etc/barbican/barbican.conf
文件中的 [cors]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 布尔值 | 指明实际请求可以包含用户凭证 |
| 列出值 | 指定在实际请求过程中可以使用哪些标头字段名称。 |
| 列出值 | 指明哪些方法可以在实际请求期间使用。 |
| 列出值 | 指明此资源是否可以与请求"origin"标头中收到的域共享。格式:"<protocol>://<host>[:<port>]",没有结尾的斜杠。示例 :https://horizon.example.com |
| 列出值 | 指明向 API 公开哪些标头是安全的。默认为 HTTP Simple Headers。 |
| 整数值 | CORS preflight 请求的最大缓存期限。 |
1.1.6. crypto
下表概述了 /etc/barbican/barbican.conf
文件中的 [crypto]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 多值 | 要载入的加密插件列表。 |
| 字符串值 | 扩展命名空间以搜索插件。 |
1.1.7. dogtag_plugin
下表概述了 /etc/barbican/barbican.conf
文件中的 [dogtag_plugin]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | 自动批准的注册配置集列表 |
| 整数值 | CA 条目过期的时间(以天为单位) |
| 字符串值 | Dogtag 实例的主机名 |
| 端口值 | Dogtag 实例的端口 |
| 字符串值 | NSS 证书数据库的路径 |
| 字符串值 | NSS 证书数据库的密码 |
| 字符串值 | 用于身份验证的 PEM 文件的路径 |
| 字符串值 | 用户友好插件名称 |
| 字符串值 | Dogtag 插件的工作目录 |
| 整数值 | 在存储或生成 secret 时重试 |
| 字符串值 | 简单 CMC 请求的配置文件 |
1.1.8. healthcheck
下表概述了 /etc/barbican/barbican.conf
文件中的 [healthcheck]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 列出值 | 可以执行健康检查的额外后端,并报告信息作为请求的一部分。 |
| 布尔值 | 作为响应的一部分,显示更详细的信息。安全备注:启用此选项可能会公开有关被监控服务的敏感详情。务必验证它是否不会违反您的安全策略。 |
| 字符串值 | 检查是否存在文件,以确定应用程序是否在端口上运行。由 DisableByFileHealthcheck 插件使用。 |
| 列出值 | 根据端口检查是否存在文件,以确定应用程序是否在端口上运行。需要一个字符串的 "port:path" 列表。由 DisableByFilesPortsHealthcheck 插件使用。 |
| 字符串值 | 响应 healtcheck 请求的路径。 |
1.1.9. keystone_authtoken
下表概述了 /etc/barbican/barbican.conf
文件中的 [keystone_authtoken]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | 加载插件特定选项的配置部分 |
| 字符串值 | 要载入的身份验证类型 |
| 字符串值 | 完成"公共"身份 API 端点。此端点不应是一个 "admin" 端点,因为它应该可以被所有最终用户访问。未经身份验证的客户端重定向到此端点以进行身份验证。虽然此端点应该是未指定版本的,但通配符中的客户端支持会有所不同。如果您在此处使用版本化的 v2 端点,则不 应该与服务用户用来验证令牌的端点相同,因为普通的最终用户可能无法到达该端点。这个选项已弃用,使用 www_authenticate_uri,并将在 S 发行版本中删除。弃用自: Queens *reason:* auth_uri 选项已弃用,使用 www_authenticate_uri,并将在 S 发行版本中删除。 |
| 字符串值 | Identity API 端点的 API 版本。 |
| 字符串值 |
请求存储 Swift 缓存对象的环境密钥。当使用 Swift 缓存部署 auth_token 中间件时,请使用此选项使中间件与 swift 共享缓存后端。否则,改为使用 |
| 字符串值 | 在验证 HTTP 连接时使用 PEM 编码的证书颁发机构。默认为系统 CA。 |
| 字符串值 | 如果身份服务器需要客户端证书,则需要此项 |
| 布尔值 | 不要处理中间件中的授权请求,但将授权决定委派给下游 WSGI 组件。 |
| 字符串值 | 用于控制令牌绑定的使用和类型。可以设置为:"disabled"不检查令牌绑定。如果绑定类型是针对服务器已知的形式,则"permissive" (默认)无法验证绑定信息,如果不是,则忽略它。如"permissive",但如果绑定类型未知,令牌将被拒绝。"必需"格式的任何令牌绑定格式是允许的。最后,令牌中必须存在的绑定方法的名称。 |
| 整数值 | 请求超时值与 Identity API 服务器通信。 |
| 整数值 | 与身份 API 服务器通信时,我们尝试重新连接的次数。 |
| 布尔值 | (可选)指示是否设置 X-Service-Catalog 标头。如果 False,中间件将不会要求在令牌验证时请求服务目录,也不会设置 X-Service-Catalog 标头。 |
| 布尔值 | 验证 HTTPS 连接。 |
| 字符串值 | 用于 Identity API 端点的接口。有效值为 "public", "internal" (默认)或 "admin"。 |
| 字符串值 | 如果身份服务器需要客户端证书,则需要此项 |
| 整数值 | (可选)操作等待从池中获取 memcached 客户端连接的秒数。 |
| 整数值 | (可选)在 memcached 服务器再次尝试前,memcached 服务器被视为死服务器的秒数。 |
| 整数值 | (可选)到每个 memcached 服务器的最大打开连接总数。 |
| 整数值 | (可选)与 memcached 服务器通信的套接字超时(以秒为单位)。 |
| 整数值 | (可选)在关闭到 memcached 前,与 memcached 的连接数的秒数。 |
| 字符串值 | (可选,如果定义了 memcache_security_strategy,则此字符串用于密钥派生。 |
| 字符串值 | (可选)如果定义,指定令牌数据是否应该经过身份验证或经过身份验证并加密。如果 MAC,令牌数据在缓存中进行身份验证(使用 HMAC)。如果 ENCRYPT,令牌数据将在缓存中加密和验证。如果该值不是这些选项之一或为空,则 auth_token 会在初始化时引发异常。 |
| 布尔值 | (可选)使用 advanced (eventlet 安全) memcached 客户端池。 |
| 列出值 | (可选)指定要用于缓存的 memcached 服务器列表。如果未定义,令牌将会被缓存在进程中。 |
| 字符串值 | 找到身份服务器的区域。 |
| 列出值 | 需要出现在服务令牌中的角色。允许服务令牌请求可以使用已过期的令牌,因此此检查应严格控制仅应发送此令牌的实际服务。此处的角色被应用为 ANY 检查,因此此列表中的任何角色都必须存在。出于向后兼容的原因,目前仅影响 allow_expired 检查。 |
| 布尔值 | 出于向后兼容的原因,我们必须使有效的服务令牌传递没有将 service_token_roles 检查传递给有效。在以后的发行版本中,设置此 true 将成为默认设置,并应启用。 |
| 字符串值 | 服务的名称或类型出现在服务目录中。这用于验证具有受限访问规则的令牌。 |
| 整数值 | 为了防止过度工作量验证令牌,中间件缓存之前在可配置的持续时间内(以秒为单位)中是以前的令牌。设置为 -1 以完全禁用缓存。 |
| 字符串值 | 完成"公共"身份 API 端点。此端点不应是一个 "admin" 端点,因为它应该可以被所有最终用户访问。未经身份验证的客户端重定向到此端点以进行身份验证。虽然此端点应该是未指定版本的,但通配符中的客户端支持会有所不同。如果您在此处使用版本化的 v2 端点,则不 应该与服务用户用来验证令牌的端点相同,因为普通的最终用户可能无法到达该端点。 |
1.1.10. keystone_notifications
下表概述了 /etc/barbican/barbican.conf
文件中的 [keystone_notifications]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 布尔值 | true 在通知处理错误时启用 requeue 功能。仅在底层传输支持此功能时启用此功能。 |
| 字符串值 | 主题范围的默认交换。可以被 transport_url 选项中指定的交换名称覆盖。 |
| 布尔值 | true 启用 keystone 通知监听程序功能。 |
| 字符串值 | 通知监听器的池名称。把它设置为不同的值,允许 barbican 通知监听程序从主题接收自己的所有消息副本,而无需干扰侦听同一主题的其他服务。只有某些 oslo.messaging 后端(在 rabbitmq 的一部分)支持此功能,而对于这些功能,最好使用它,而不是 barbican 单独通知主题。 |
| 整数值 | 定义用于通知服务器处理功能的最大线程数。 |
| 字符串值 | Keystone 通知队列主题名称。此名称需要匹配 Keystone 部署的 notification_topics 配置中提到的值之一,如 notification_topics=notifications, barbican_notificationsMultiple 服务器可能会侦听一个主题,消息将以 round-robin 方法分配给其中一个服务器。这就是 Barbican 服务应具有自己的专用通知队列的原因,以便它接收所有 Keystone 通知。或者,如果所选的 oslo.messaging 后端支持侦听器池(如 rabbitmq),则应首选设置非默认 pool_name 选项。 |
| 字符串值 | 通过通知调用的任务版本 |
1.1.11. kmip_plugin
下表概述了 /etc/barbican/barbican.conf
文件中的 [kmip_plugin]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | 连接"认证机构"证书的文件路径 |
| 字符串值 | 本地客户端证书的文件路径 |
| 字符串值 | KMIP 服务器的地址 |
| 字符串值 | 本地客户端证书 keyfile 的文件路径 |
| 字符串值 | 用于通过 KMIP 服务器进行身份验证的密码 |
| 布尔值 | 仅支持非对称密钥的 PKCS81 编码 |
| 字符串值 | 用户友好插件名称 |
| 端口值 | KMIP 服务器的端口 |
| 字符串值 | SSL 版本,映射到模块 ssl 的常量 |
| 字符串值 | 用于通过 KMIP 服务器进行身份验证的用户名 |
1.1.12. oslo_messaging_amqp
下表概述了 /etc/barbican/barbican.conf
文件中的 [oslo_messaging_amqp]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | 表示驱动程序使用的寻址模式。允许的值: legacy - 使用旧的不可路由寻址;routable - 使用可路由地址;dynamic - 如果消息总线不支持路由,使用 legacy,如果支持,使用 routable。 |
| 字符串值 | 在发送到一组消费者时,附加到地址前缀中。由消息总线使用来识别应以轮循方式传送的消息。 |
| 字符串值 | 广播到所有服务器时使用的地址前缀 |
| 整数值 | 在每次失败故障转移尝试失败后,增加 connection_retry_interval。 |
| 整数值 | 在尝试重新连接前需要暂停的秒数。 |
| 整数值 | connection_retry_interval + connection_retry_backoff 的最大限制 |
| 字符串值 | AMQP 容器的名称。必须全局唯一。默认为生成的 UUID |
| 字符串值 | 通知地址中使用的交换名称。Exchange name resolution priority: Target.exchange if set else default_notification_exchange if set else control_exchange if set else notify |
| 整数值 | 发送通知消息发送的截止时间。仅在调用者不提供超时到期时使用。 |
| 整数值 | 因可恢复错误而重新发送失败的回复消息的最大尝试次数。 |
| 整数值 | rpc 回复消息发送的截止时间。 |
| 字符串值 | RPC 地址中使用的交换名称。Exchange name resolution priority: Target.exchange if set else default_rpc_exchange if set else control_exchange if set else rpc |
| 整数值 | rpc cast 或调用消息发送的截止时间。仅在调用者不提供超时到期时使用。 |
| 整数值 | 调度闲置发送方链接的清除持续时间。在到期后分离链接。 |
| 字符串值 | 发送到组中任何服务器的地址前缀 |
| 整数值 | 不活跃连接的超时时间(以秒为单位) |
| 整数值 | 重新连接因为可恢复的错误而失败的 AMQP 1.0 链接之间暂停的时间。 |
| 字符串值 | 在发送 fanout 消息时附加到地址前缀中。由消息总线用来识别 fanout 消息。 |
| 字符串值 | 所有生成的通知地址的地址前缀 |
| 整数值 | 传入通知消息的窗口大小 |
| 多值 | 发送此类类型的消息。预先修改的消息将不会接收来自对等点的确认。注意:如果发送失败,则预先修改的消息可能会静默丢弃。允许的值: rpc-call - send RPC Calls pre-settled rpc-reply- send RPC Replies pre-settled rpc-cast - Send RPC Casts pre-settled notify - Send Notifications pre-settled |
| 布尔值 | 为那些不支持原生支持虚拟主机(如 qpidd)的消息总线启用虚拟主机支持。当设置为 true 时,虚拟主机名将添加到所有消息总线地址中,从而有效地为每个虚拟主机 创建专用子网。如果消息总线使用 AMQP 1.0 Open performative 作为虚拟主机名称中的 hostname 字段,则设置为 False。 |
| 整数值 | 传入 RPC Reply 消息的窗口大小。 |
| 字符串值 | 所有生成的 RPC 地址的地址前缀 |
| 整数值 | 传入 RPC 请求消息的窗口大小 |
`sasl_config_dir = ` | 字符串值 | 包含 SASL 配置的目录路径 |
`sasl_config_name = ` | 字符串值 | 配置文件的名称(不带 .conf 后缀) |
`sasl_default_realm = ` | 字符串值 | 如果用户名中没有域,则将使用 SASL 域 |
`sasl_mechanisms = ` | 字符串值 | 可接受的 SASL 机制的空格分隔列表 |
| 字符串值 | 发送到特定服务器时使用的地址前缀 |
| 布尔值 | 尝试通过 SSL 连接。如果没有指定其他与 ssl 相关的参数,它将使用系统的 CA-bundle 来验证服务器证书。 |
`ssl_ca_file = ` | 字符串值 | 用于验证服务器证书的 CA 证书 PEM 文件 |
`ssl_cert_file = ` | 字符串值 | 自我识别用于客户端身份验证的证书 PEM 文件 |
`ssl_key_file = ` | 字符串值 | 用于为 ssl_cert_file 证书签名的私钥 PEM 文件(可选) |
| 字符串值 | 用于解密 ssl_key_file 的密码(如果加密) |
| 布尔值 | 默认情况下,SSL 检查服务器证书中的名称是否与 transport_url 中的主机名匹配。在某些配置中,可能最好使用虚拟主机名,例如,如果服务器使用 Server Name Indication TLS 扩展(rfc6066)为每个虚拟主机提供证书。如果服务器的 SSL 证书使用虚拟主机名称而不是 DNS 名称,则将 ssl_verify_vhost 设置为 True。 |
| 布尔值 | debug:将 AMQP 帧转储到 stdout |
| 字符串值 | 在发送到特定的 RPC/Notification 服务器时,附加到地址前缀中。由消息总线用来识别发送到单个目的地的消息。 |
1.1.13. oslo_messaging_kafka
下表概述了 /etc/barbican/barbican.conf
文件中的 [oslo_messaging_kafka]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | 生成者生成的所有数据的压缩码c。如果没有设置,则不会使用压缩。请注意,这允许的值取决于 kafka 版本 |
| 整数值 | 连接过期策略的池大小限制 |
| 整数值 | 池中闲置连接的生存时间 |
| 字符串值 | Kafka 消费者的组 ID。一个组中的消费者将协调消息消耗 |
| 布尔值 | 启用异步消费者提交 |
| 浮点值 | Kafka 用户的默认超时 |
| 整数值 | Kafka 使用者的最大获取字节数 |
| 整数值 | 轮询调用中返回的最大记录数 |
| 整数值 | Kafka Consumers 的池大小 |
| 整数值 | producer async 发送的批处理大小 |
| 浮点值 | KafkaProducer batching 的延迟上限(以秒为单位) |
| 字符串值 | 安全协议是 SASL 的机制 |
| 字符串值 | 用于与代理通信的协议 |
`ssl_cafile = ` | 字符串值 | 用于验证服务器证书的 CA 证书 PEM 文件 |
`ssl_client_cert_file = ` | 字符串值 | 用于身份验证的客户端证书 PEM 文件。 |
`ssl_client_key_file = ` | 字符串值 | 用于身份验证的客户端密钥 PEM 文件。 |
`ssl_client_key_password = ` | 字符串值 | 用于身份验证的客户端密钥密码文件。 |
1.1.14. oslo_messaging_notifications
下表概述了 /etc/barbican/barbican.conf
文件中的 [oslo_messaging_notifications]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 多值 | 处理发送通知的驱动程序。可能的值有 messaging, messagingv2, routing, log, test, noop |
| 整数值 | 因可恢复的错误而发送失败的通知消息的最大尝试次数。0 - no retry, -1 - indefinite |
| 列出值 | 用于 OpenStack 通知的 AMQP 主题。 |
| 字符串值 | 代表用于通知的消息传递驱动程序的 URL。如果没有设置,我们回退到用于 RPC 的同一配置。 |
1.1.15. oslo_messaging_rabbit
下表概述了 /etc/barbican/barbican.conf
文件中的 [oslo_messaging_rabbit]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 布尔值 | AMQP 中的自动删除队列。 |
| 布尔值 | 在 AMQP 中使用持久队列。如果启用了 rabbit_quorum_queue,则队列将具有持久性,并且此值将被忽略。 |
| 布尔值 | (DEPRECATED)为直接发送启用/禁用 RabbitMQ 强制标记。直接发送用作回复,因此当客户端队列不存在时,会引发 MessageUndeliverable 异常。MessageUndeliverable 异常将用于对超时进行循环,以便发送者有机会恢复该标志,且无法停用此功能。 |
| 布尔值 | 启用 x-cancel-on-ha-failover 标志,rabbitmq 服务器将取消和通知消费者何时队列停机 |
| 布尔值 | 默认情况下,通过原生 python 线程运行健康检查心跳线程。如果此选项等于 False,则健康检查心跳将从父进程继承执行模型。例如,如果父进程使用 eventlet/greenlet 对 stdlib 进行补丁,则 heartbeat 将通过绿色线程运行。这个选项应只针对 wsgi 服务设置为 True。 |
| 整数值 | heartbeat_timeout_threshold 中检查心跳的频率。 |
| 整数值 | 如果 heartbeat 的 keep-alive 失败(0 禁用心跳)失败,则 Rabbit 代理被视为 down 的秒数。 |
| 字符串值 | EXPERIMENTAL:可能的值为 gzip, bz2。如果没有设置压缩,则不会使用。这个选项可能在以后的版本中不可用。 |
| 字符串值 | 确定在当前连接到的 RabbitMQ 节点不可用时如何选择下一个 RabbitMQ 节点。只有在配置中提供了多个 RabbitMQ 节点时,才会生效。 |
| 整数值 | 在放弃向其回复发送之前,等待缺少客户端的时间。这个值不应超过 rpc_response_timeout。 |
| 浮点值 | 在响应 AMQP 消费者取消通知前等待(以秒为单位)等待(以秒为单位)。 |
| 布尔值 | 尝试在 RabbitMQ 中使用 HA 队列(x-ha-policy: all)。如果更改这个选项,您必须擦除 RabbitMQ 数据库。在 RabbitMQ 3.0 中,在声明队列时,x-ha-policy 参数不再控制队列镜像。如果您只想确保所有队列(除自动生成的名称除外)都已镜像到所有节点,请运行:"rabbitmqctl set_policy HA ^(?!amq\.) commands {"ha-mode": "all"} " |
| 整数值 | RabbitMQ 连接重试的最大间隔。默认值为 30 秒。 |
| 字符串值 | RabbitMQ 登录方法。 |
| 整数值 | 指定要预先抓取的消息数量。将 设为零可允许无限消息。 |
| 整数值 | 每次消息被重新设计为消费者时,计数器都会递增。当重新传送计数超过交付限制后,消息将被丢弃或死信(如果配置了 DLX 交换)仅在启用 rabbit_quorum_queue 时使用,默认 0 代表没有设置限制。 |
| 整数值 | 默认情况下,如果仲裁队列增加,则所有消息都会在内存中维护,这会给集群造成内存压力。这个选项可以限制仲裁队列使用的内存字节数。仅在启用 rabbit_quorum_queue 时使用,默认 0 代表 dont 设置限制。 |
| 整数值 | 默认情况下,如果仲裁队列增加,则所有消息都会在内存中维护,这会给集群造成内存压力。这个选项可以限制仲裁队列中的消息数量。仅在启用 rabbit_quorum_queue 时使用,默认 0 代表 dont 设置限制。 |
| 布尔值 |
在 RabbitMQ 中使用仲裁队列(x-queue-type: quorum)。仲裁队列是基于 Raft 共识算法的 RabbitMQ 实施持久复制 FIFO 队列的现代队列类型。它从 RabbitMQ 3.8.0 开始提供。如果设置此选项将与 HA 队列( |
| 整数值 | 连接到 RabbitMQ 时,在重试之间会多长时间进行 backoff。 |
| 整数值 | 使用 RabbitMQ 重试连接的频率。 |
| 整数值 | 正整数,代表队列 TTL (x-expires)的持续时间(以秒为单位)。TTL 期间未使用的队列将自动删除。参数仅影响回复和 fanout 队列。 |
| 布尔值 | 通过 SSL 连接。 |
`ssl_ca_file = ` | 字符串值 | SSL 证书颁发机构文件(仅在启用 SSL 时才评估)。 |
`ssl_cert_file = ` | 字符串值 | SSL 证书文件(仅在启用 SSL 时才评估)。 |
| 布尔值 | 强制 OpenSSL FIPS 模式的全局切换。此功能需要 Python 支持。这在所有环境中的 Python 3.9 中都可用,并可能已向后移植到所选环境中的旧的 Python 版本。如果使用的 Python 可执行文件不支持 OpenSSL FIPS 模式,则会引发异常。 |
`ssl_key_file = ` | 字符串值 | SSL 密钥文件(仅在启用 SSL 时才评估)。 |
`ssl_version = ` | 字符串值 | 要使用的 SSL 版本(仅在启用 SSL 时验证)。有效值为 TLSv1 和 SSLv23。在某些发行版中可能会提供 SSLv2、SSLv3、TLSv1_1 和 TLSv1_2。 |
1.1.16. oslo_middleware
下表概述了 /etc/barbican/barbican.conf
文件中的 [oslo_middleware]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 布尔值 | 应用程序是否位于代理后面。这决定了中间件是否应该解析标头。 |
1.1.17. oslo_policy
下表概述了 /etc/barbican/barbican.conf
文件中的 [oslo_policy]
组下可用的选项。
配置选项 = 默认值 | 类型 | 描述 |
---|---|---|
| 布尔值 |
这个选项控制在评估策略时是否使用旧的已弃用默认值。如果为 |
| 布尔值 |
此选项控制在评估策略时是否强制执行范围。如果为 |
| 字符串值 | 默认规则。未找到请求的规则时强制执行。 |
| 多值 | 存储策略配置文件的目录。它们可以相对于 config_dir 选项定义的搜索路径中的任何目录,也可以是绝对路径。必须存在由 policy_file 定义的文件,才能搜索这些目录。缺失或空目录将被忽略。 |
| 字符串值 | 文件相对或绝对路径,用于将角色映射到给定服务的权限。必须根据配置文件设置此选项指定相对路径。 |
| 字符串值 | 用于发送和接收基于 REST 策略检查的数据的内容类型 |
| 字符串值 | 基于 REST 的策略检查的 ca 证书文件的绝对路径 |
| 字符串值 | 基于 REST 的策略检查的客户端证书的绝对路径 |
| 字符串值 | 绝对路径客户端密钥文件 REST 基于策略检查 |
| 布尔值 | 基于 REST 策略检查的服务器身份验证 |
1.1.18. p11_crypto_plugin
下表概述了 /etc/barbican/barbican.conf
文件中的 [p11_crypto_plugin]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 布尔值 | 为 CKM_AES_GCM 机制生成 IV。 |
| 布尔值 | 始终设置 CKA_SENSITIVE=CK_TRUE,包括 CKA_EXTRACTABLE=CK_TRUE 密钥。 |
| 字符串值 | Secret 加密机制 |
| 字符串值 | HMAC 密钥类型 |
| 字符串值 | HMAC 密钥生成算法用于创建主 HMAC 密钥。 |
| 字符串值 | Master HMAC Key 标签(存储在 HSM 中) |
| 字符串值 | 用于签署加密数据的 HMAC 算法。 |
| 布尔值 | 为密钥封装机制生成 IV。 |
| 字符串值 | 用于嵌套项目 KEK 的关键封装算法。 |
| 字符串值 | vendor PKCS11 库的路径 |
| 字符串值 | password (PIN)以登录到 PKCS11 会话 |
| 字符串值 | Master KEK 标签(存储在 HSM 中) |
| 整数值 | Master KEK 长度(以字节为单位)。 |
| 布尔值 | 在初始化 PKCSredfish 客户端库时启用 CKF_OS_LOCKING_OK 标志。 |
| 整数值 | 项目 KEK Cache Item 限制 |
| 整数值 | 项目 KEK 缓存时间到 Live,以秒为单位 |
| 整数值 | 项目 KEK 长度(以字节为单位)。 |
| 字符串值 | 用户友好插件名称 |
| 布尔值 | 读取/写会话的标记 |
`seed_file = ` | 字符串值 | 用于拉取有关 seeding RNG 的熵的文件 |
| 整数值 | 从文件中读取的数据量 |
| 整数值 | (可选)包含要使用的令牌设备的 HSM Slot ID。 |
| 字符串值 | DEPRECATED: 使用 token_labels 替代。用于识别要使用的令牌的令牌标签。 |
| 列出值 | 要使用的一个或多个令牌的标签列表。通常,这是一个标签,但有些 HSM 设备可能需要多个标签进行负载平衡或高可用性配置。 |
| 字符串值 | 用于识别要使用的令牌的令牌序列号。 |
1.1.19. queue
下表概述了 /etc/barbican/barbican.conf
文件中的 [queue]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 整数值 | 异步 worker 进程数量 |
| 布尔值 | true 启用排队,False 会同步调用 worker |
| 字符串值 | 队列命名空间 |
| 字符串值 | RPC 任务处理服务器的服务器名称 |
| 字符串值 | 队列主题名称 |
| 字符串值 | 通过队列调用的任务版本 |
1.1.20. 配额
下表概述了 /etc/barbican/barbican.conf
文件中的 [quotas]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 整数值 | 每个项目允许的 CA 数量 |
| 整数值 | 每个项目允许的消费者数 |
| 整数值 | 每个项目允许的容器数量 |
| 整数值 | 每个项目允许的顺序数 |
| 整数值 | 每个项目允许的 secret 数量 |
1.1.21. retry_scheduler
下表概述了 /etc/barbican/barbican.conf
文件中的 [retry_scheduler]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 浮点值 | 在开始重试调度程序前等待的秒数(浮点) |
| 浮点值 | 在定期调度事件之间等待的秒数 |
1.1.22. secretstore
下表概述了 /etc/barbican/barbican.conf
文件中的 [secretstore]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 布尔值 | 启用多个 secret 存储插件后端的标志。默认为 False |
| 多值 | 要加载的 secret 存储插件列表。 |
| 字符串值 | 扩展命名空间以搜索插件。 |
| 列出值 | 用于查找多个后端支持的插件的后缀列表。 |
1.1.23. simple_crypto_plugin
下表概述了 /etc/barbican/barbican.conf
文件中的 [simple_crypto_plugin]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | Simple Crypto 插件使用的密钥加密密钥 |
| 字符串值 | 用户友好插件名称 |
1.1.24. snakeoil_ca_plugin
下表概述了 /etc/barbican/barbican.conf
文件中的 [snakeoil_ca_plugin]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | CA 证书链文件的路径 |
| 字符串值 | CA 证书密钥文件的路径 |
| 字符串值 | CA 证书文件的路径 |
| 字符串值 | CA chain pkcs7 文件的路径 |
| 字符串值 | 为 subcas 保存证书/密钥的目录 |
1.1.25. ssl
下表概述了 /etc/barbican/barbican.conf
文件中的 [ssl]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | 用于验证连接的客户端的 CA 证书文件。 |
| 字符串值 | 安全启动服务器时要使用的证书文件。 |
| 字符串值 | 设置可用密码列表。值应该是 OpenSSL 密码列表格式的字符串。 |
| 字符串值 | 安全启动服务器时要使用的私钥文件。 |
| 字符串值 | 要使用的 SSL 版本(仅在启用 SSL 时验证)。有效值为 TLSv1 和 SSLv23。在某些发行版中可能会提供 SSLv2、SSLv3、TLSv1_1 和 TLSv1_2。 |
1.1.26. vault_plugin
下表概述了 /etc/barbican/barbican.conf
文件中的 [vault_plugin]
组下可用的选项。
配置选项 = 默认值 | 类型 | Description |
---|---|---|
| 字符串值 | Approle role_id 用于使用 vault 进行身份验证 |
| 字符串值 | Approle secret_id 用于使用 vault 进行身份验证 |
| 字符串值 | Vault 中要使用的 KV 存储的挂载点,例如:secret |
| 字符串值 | vault 的 root 令牌 |
| 字符串值 | ca 证书文件的绝对路径 |
| 布尔值 | SSL Enabled/Disabled |
| 字符串值 | 使用此端点连接到 Vault,例如:"http://127.0.0.1:8200" |