第 10 章 组件和功能配置字段


Component 和 Feature Configuration 部分描述了可在各种子系统中微调 Red Hat Quay 的可配置字段。这些字段允许管理员自定义 registry 行为,启用或禁用特定功能,并与外部服务和基础架构集成。虽然基本部署不需要,但这些选项支持与安全性、自动化、可扩展性、合规性和性能相关的高级用例。

10.1. 核心配置概述

使用这些核心字段配置 registry 的基本行为,包括主机名、协议、身份验证设置等。

10.1.1. registry 品牌和身份字段

以下配置字段允许您修改 Red Hat Quay 部署中显示的品牌、身份和联系信息。使用这些字段,您可以通过指定在 UI 中显示的标题、标头、页脚和机构联系人链接来自定义 registry 如何出现在用户。

注意

Red Hat Quay v2 UI 中不提供以下部分。

Expand
表 10.1. registry 品牌和身份配置字段
字段类型描述

REGISTRY_TITLE

字符串

如果指定,则 registry 的长格式标题。在 Red Hat Quay 部署的前端中显示,例如在机构的登录页面中。不应超过 35 个字符。
默认:
Red Hat Quay

REGISTRY_TITLE_SHORT

字符串

如果指定,则 registry 的短格式标题。标题显示在您的机构各个页面中,例如,作为您所在机构的 教程 页面上的标题。
默认:
Red Hat Quay

CONTACT_INFO

String 数组

如果指定,在联系页面中要显示的联系信息。如果只指定了单一联系人信息,联系页脚将直接链接。

[0]

字符串

添加发送电子邮件的链接。

Pattern:
^mailto: (.)+$
Example:
mailto:support@quay.io

[1]

字符串

添加访问 IRC chat room 的链接。

Pattern:
^irc://(.)+$
Example:
irc://chat.freenode.net:6665/quay

[2]

字符串

添加链接来调用电话号码。

Pattern:
^tel: (.)+$
示例:
tel:+1-888-930-3475

[3]

字符串

添加指向定义的 URL 的链接。

Pattern:
^http (s)?://(.)+$
Example:
https://twitter.com/quayio

Expand
表 10.2. 品牌配置字段
字段类型描述

品牌

对象

Red Hat Quay UI 中的徽标和 URL 的自定义品牌。

.logo
(必需)

字符串

主徽标镜像 URL。

标头徽标默认为 205x30 PX。Web UI 的屏幕上的 Red Hat Quay 登录表格徽标默认为 356.5x39.7 PX。
示例:
/static/img/quay-horizontal-color.svg

.footer_img

字符串

UI footer 的徽标。默认为 144x34 PX.

Example:
/static/img/rhacm.svg

.footer_url

字符串

footer 镜像的链接。

示例:
https://redhat.com

Expand
表 10.3. footer 链接配置字段
字段类型描述

FOOTER_LINKS

对象

在 Red Hat Quay 的 UI 中启用自定义页脚链接以进行以前的安装。

.TERMS_OF_SERVICE_URL

字符串

用于 on-prem 安装的自定义服务术语。


https://index.hr

.PRIVACY_POLICY_URL

字符串

用于 on-prem 安装的自定义隐私策略。


https://example.hr

.SECURITY_URL

字符串

用于 on-prem 安装的自定义安全页面。


https://example.hr

.ABOUT_URL

字符串

针对 on-prem 安装的自定义页。


https://example.hr

registry 品牌和身份示例 YAML

# ...
REGISTRY_TITLE: "Example Container Registry"
REGISTRY_TITLE_SHORT: "Example Quay"
CONTACT_INFO:
  - mailto:support@example.io
  - irc://chat.freenode.net:6665/examplequay
  - tel:+1-800-555-1234
  - https://support.example.io
BRANDING:
    logo: https://www.mend.io/wp-content/media/2020/03/5-tips_small.jpg
    footer_img: https://www.mend.io/wp-content/media/2020/03/5-tips_small.jpg
    footer_url: https://opensourceworld.org/
FOOTER_LINKS:
  "TERMS_OF_SERVICE_URL": "https://www.index.hr"
  "PRIVACY_POLICY_URL": "https://www.example.hr"
  "SECURITY_URL": "https://www.example.hr"
  "ABOUT_URL": "https://www.example.hr"
# ...
Copy to Clipboard Toggle word wrap

10.1.2. SSL/TLS 配置字段

本节论述了在 Red Hat Quay 部署中启用和管理 SSL/TLS 加密的可用配置字段。

Expand
表 10.4. SSL 配置字段
字段类型描述

PREFERRED_URL_SCHEME

字符串

httphttps 中的一个。请注意,用户只有在客户端到 Quay 的通信路径中没有 TLS 加密时,用户只能将其 PREFERRED_URL_SCHEME 设置为 http
在使用 TLS 终止负载均衡器、反向代理(如 Nginx)或者使用带有自定义 SSL 证书的 Quay 时,用户必须将其 PREFERRED_URL_SCHEME' 设置为 'https。在大多数情况下,PREFERRED_URL_SCHEME 应该为 https
默认: http

SERVER_HOSTNAME
(必需)

字符串

Red Hat Quay 可访问的 URL,没有方案

示例:
quay-server.example.com

SSL_CIPHERS

String 数组

如果指定了,用于启用和禁用的 SSL 密码的 nginx 定义列表

示例:
[ECDHE-RSA-AES128-GCM-SHA256,ECDHE-ECDSA-AES128-GCM-SHA256,ECDHE-RSA-AES256-GCM-SHA384,ECDHE-ECDSA-AES256-GCM-SHA384, DHE-RSA-AES128-GCM-SHA256,DHE-DSS-AES128-GCM-SHA256,kEDH+AESGCM,ECDHE-RSA-AES128-SHA256,ECDHE-ECDSA-AES128-SHA256,ECDHE-RSA-AES128-SHA, ECDHE-ECDSA-AES128-SHA,ECDHE-RSA-aes256-SHA384,ECDHE-ECDSA-aes256-SHA384, ECDHE-RSA-aes256-SHA,ECDHE-ECDSA-aes256-SHA,DHE-RSA-aes128-SHA256,DHE-RSA-aes128-SHA, , DHE-DSS-aes128-SHA256,DHE-RSA-aes256-SHA256 , DHE-DSS-aes256-SHA ,DHE-DSS-aes256-SHA, aes128-GCM-sha256, aes256-GCM-SHA 384 , aes128-SHA256 , aes128-SHA256, aes128-GCM-sha256 , aes256-GCM- SHA256, AES256-SHA256,AES128-SHA,AES256-SHA,AES,!3DES", !aNULL,!eNULL,!EXPORT,DES,!RC4, MD5 ,MD5, !PSK,!aECDH,!EDH-DSS-DES-CBC3-SHA,!EDH-RSA-DES-CBC3-SHA,!KRB5-DES-CBC3-SHA]

SSL_PROTOCOLS

String 数组

如果指定,则 nginx 配置为启用列表中定义的 SSL 协议列表。从列表中删除 SSL 协议会禁用 Red Hat Quay 启动过程中的协议。

Example:
['TLSv1','TLSv1.1','TLSv1.2', 'TLSv1.3]'

SESSION_COOKIE_SECURE

布尔值

是否应在会话 Cookie 上设置 secure 属性

Default:
False

Recommendation:
Set to True

EXTERNAL_TLS_TERMINATION

布尔值

如果支持 TLS,则设置为 True,但会在 Quay 之前的层终止。当 Quay 使用自己的 SSL 证书运行时,并直接接收 TLS 流量时,设置为 False

SSL 配置示例 YAML

# ...
PREFERRED_URL_SCHEME: https
SERVER_HOSTNAME: quay-server.example.com
SSL_CIPHERS:
  - ECDHE-RSA-AES128-GCM-SHA256
SSL_PROTOCOLS:
  - TLSv1.3
SESSION_COOKIE_SECURE: true
EXTERNAL_TLS_TERMINATION: true
# ...
Copy to Clipboard Toggle word wrap

10.1.3. IPv6 配置字段

您可以使用 FEATURE_LISTEN_IP_VERSION 配置字段来指定 Red Hat Quay 应该侦听的 IP 协议系列:IPv4、IPv6 或两者(dual-stack)。在 registry 必须在 IPv6 或双栈网络上运行时,此字段至关重要。

Expand
表 10.5. IPv6 配置字段
字段类型描述

FEATURE_LISTEN_IP_VERSION

字符串

启用 IPv4、IPv6 或双栈协议系列。必须正确设置此配置字段,否则 Red Hat Quay 无法启动。默认: IPv4其他配置: IPv6双栈

IPv6 示例 YAML

# ...
FEATURE_LISTEN_IP_VERSION: dual-stack
# ...
Copy to Clipboard Toggle word wrap

10.1.4. 日志记录和调试变量

以下变量控制 Red Hat Quay 日志事件、公开调试信息并与系统健康检查进行交互。这些设置对于对 registry 的故障排除和监控很有用

Expand
表 10.6. 日志记录和调试配置变量
变量类型描述

DEBUGLOG

布尔值

是否启用或禁用调试日志。

用户_DEBUG

整数.01

用于在明文中调试 LDAP 操作,包括密码。必须与 DEBUGLOG=TRUE 一起使用。

重要

设置 192.168.1.0/24_DEBUG=1 以明文形式公开凭据。在调试后,应该从 Red Hat Quay 部署中删除此变量。此环境变量生成的日志文件应该被修改,在发送到其他用户前应删除密码。请谨慎使用。

ALLOW_PULLS_WITHOUT_STRICT_LOGGING

布尔值

如果为 true,则即使无法写入拉取审计日志条目,拉取仍会成功。如果数据库处于只读状态,且需要拉取以便在那个时间内继续,则这非常有用。

默认 : False

ENABLE_HEALTH_DEBUG_SECRET

字符串

如果指定,可提供给健康端点的 secret,以便在不以超级用户身份验证时查看完整的调试信息

HEALTH_CHECKER

字符串

配置的健康检查

示例: ('RDSAwareHealthCheck', {'access_key': 'foo', 'secret_key': 'bar'})

FEATURE_AGGREGATED_LOG_COUNT_RETRIEVAL

布尔值

是否允许检索聚合的日志计数

Default: True

日志记录和调试示例 YAML

#...
DEBUGLOG: true
USERS_DEBUG: 1
ALLOW_PULLS_WITHOUT_STRICT_LOGGING: "true"
ENABLE_HEALTH_DEBUG_SECRET: "<secret_value>"
HEALTH_CHECKER: "('RDSAwareHealthCheck', {'access_key': 'foo', 'secret_key': 'bar'})"
FEATURE_AGGREGATED_LOG_COUNT_RETRIEVAL: true
# ...
Copy to Clipboard Toggle word wrap

10.1.5. registry 状态和系统行为配置字段

以下配置字段控制 Red Hat Quay registry 的操作状态及其如何与外部系统交互。这些设置允许管理员将 registry 置于受限只读模式下进行维护,并通过阻止 webhook 的目标特定主机名来强制实施额外的安全性。

Expand
表 10.7. registry 状态和系统行为配置字段
字段类型描述

REGISTRY_STATE

字符串

registry 的状态

值: normalread-only

WEBHOOK_HOSTNAME_BLACKLIST

String 数组

在除 localhost 外验证时,从 Webhook 中禁止的主机名集合

registry 状态和系统行为示例 YAML

# ...
REGISTRY_STATE: normal
WEBHOOK_HOSTNAME_BLACKLIST:
  - "169.254.169.254"
  - "internal.example.com"
  - "127.0.0.2"
# ...
Copy to Clipboard Toggle word wrap

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat