配置 Red Hat Quay

Red Hat Quay 3.9

使用配置选项自定义 Red Hat Quay

Red Hat OpenShift Documentation Team

摘要

配置 Red Hat Quay

第 1 章 Red Hat Quay 配置入门

Red Hat Quay 可通过独立的配置或使用 OpenShift Container Platform Red Hat Quay Operator 部署。

如何创建、检索、更新和验证 Red Hat Quay 配置,具体取决于您使用的部署类型。但是,对于任一部署类型,核心配置选项都相同。核心配置可通过以下选项之一来设置:

  • 通过编辑 config.yaml 文件直接。如需更多信息,请参阅"编辑配置文件"。
  • 以编程方式使用配置 API。如需更多信息,请参阅"使用配置 API"。
  • 使用配置工具 UI 可视化显示。如需更多信息,请参阅"使用配置工具"。

对于 Red Hat Quay 的独立部署,您必须先提供最低配置参数,然后才能启动 registry。启动 Red Hat Quay registry 的最低要求可在"删除当前配置"部分中找到。

如果使用 Red Hat Quay Operator 在 OpenShift Container Platform 上安装 Red Hat Quay,则不需要提供配置参数,因为 Red Hat Quay Operator 提供了部署 registry 的默认信息。

使用所需配置部署 Red Hat Quay 后,您应该从部署中检索并保存完整的配置。完整配置包含重启或升级系统时可能需要的额外生成的值。

第 2 章 Red Hat Quay 配置声明器

在 Red Hat Quay Enterprise 中,某些功能和配置参数不会被主动使用或实施。因此,仅应谨慎修改红帽支持的文档,如启用或禁用某些功能的功能标记,以及未明确记录或请求的配置参数。未使用的功能或参数可能无法完全测试、支持或与 Red Hat Quay 兼容,并修改它们可能会导致您的部署出现意外问题或中断。

2.1. Red Hat Quay 3.9 的配置更新

以下小节详细介绍了 Red Hat Quay 3.9 中添加的新配置字段。

2.1.1. 操作日志审计配置

使用 Red Hat Quay 3.9 时,默认跟踪审计登录。

表 2.1. 审计日志配置字段

字段类型描述

ACTION_LOG_AUDIT_LOGINS

布尔值

当设置为 True 时,请跟踪高级事件,如登录和注销、UI 和使用 Docker 进行常规用户、机器人帐户以及特定于应用的令牌帐户。

默认: True

2.1.2. 添加 Splunk 操作日志

使用 Red Hat Quay 3.9,Splun 可以在 LOGS_MODEL 参数下配置。

表 2.2. Splunk 配置字段

字段类型描述

LOGS_MODEL

字符串

指定处理日志数据的首选方法。

值 : 一个数据库 ,transition_reads_both_writes_es,elasticsearch, mvapich
Default: database

2.1.2.1. LOGS_MODEL_CONFIG 添加

配置 Splunk 时提供了以下 LOGS_MODEL_CONFIG 选项。

  • LOGS_MODEL_CONFIG [object]: Logs model config for action logs

    • producer [string]: splunk
    • mvapich_config [object]: Splunk 操作日志的日志模型配置或 Splunk 集群配置

      • Host [string]: Splunk 集群端点。
      • port [integer]: Splunk 管理集群端点端口。
      • bearer_token [string]: Splunk 的 bearer 令牌。
      • verify_ssl [boolean]: 启用(True)或为 HTTPS 连接禁用 TLS/SSL 验证。
      • index_prefix [string]: Splunk 的索引前缀。
      • ssl_ca_path [字符串]:指向包含用于 SSL 验证的证书颁发机构(CA)的单个 .pem 文件的相对容器路径。

2.1.2.2. Splunk 的配置示例

以下 YAML 条目提供了 Splunk 的示例配置。

Splunk config.yaml 示例

---
LOGS_MODEL: splunk
LOGS_MODEL_CONFIG:
    producer: splunk
    splunk_config:
        host: http://<user_name>.remote.csb
        port: 8089
        bearer_token: <bearer_token>
        url_scheme: <http/https>
        verify_ssl: False
        index_prefix: <splunk_log_index_name>
        ssl_ca_path: <location_to_ssl-ca-cert.pem>
---

2.1.3. 配额管理配置字段

添加了以下配置字段来增强 Red Hat Quay 配额管理功能。

表 2.3. Red Hat Quay 3.9 配额管理配置字段

字段类型描述

QUOTA_BACKFILL

布尔值

启用配额回填 worker 来计算预先存在的 Blob 的大小。

Default:True

QUOTA_TOTAL_DELAY_SECONDS

字符串

启动配额回填的时间延迟。滚动部署可能会导致总部署不正确。此字段 必须设置为 超过滚动部署完成所需的时间。

默认 : 1800

PERMANENTLY_DELETE_TAGS

布尔值

启用与从时间窗中删除标签相关的功能。

默认 : False

RESET_CHILD_MANIFEST_EXPIRATION

布尔值

重置以子清单为目标的临时标签的过期。将这个功能设置为 True 时,子清单会立即收集垃圾回收。

默认:False

2.1.3.1. 可能的配额管理配置设置

下表说明了 Red Hat Quay 3.9 中可能的配额管理配置设置。

表 2.4. 配额管理配置选项

FEATURE_QUOTA_MANAGEMENTQUOTA_BACKFILL结果

true

true

将这些功能配置为 true 时,启用了配额管理,并适用于 Red Hat Quay 3.9。有关为 Red Hat Quay 3.9 配置配额管理的更多信息,请参阅"Red Hat Quay 3.9 的Quota 管理"。

true

false

FEATURE_QUOTA_MANAGEMENT 设置为 true 时,将 QUOTA_BACKFILL 设置为 false,配额管理功能已被启用。但是,来自以前的 Red Hat Quay 版本(N-1) y-stream 版本(例如 3.8)的预先存在的镜像必须被回填,然后才能继续配额计算。要回填镜像大小,请将 QUOTA_BACKFILL 设置为 true

false

false

将这些功能配置为 false 时,配额管理功能将被禁用。

false

true

FEATURE_QUOTA_MANAGEMENT 设置为 falseQUOTA_BACKFILL 设置为 true,配额管理功能被禁用。

2.1.3.2. 建议的配额管理配置设置

以下 YAML 是启用配额管理时推荐的配置。

建议的配额管理配置

FEATURE_QUOTA_MANAGEMENT: true
FEATURE_GARBAGE_COLLECTION: true
PERMANENTLY_DELETE_TAGS: true
QUOTA_TOTAL_DELAY_SECONDS: 1800
RESET_CHILD_MANIFEST_EXPIRATION: true

2.1.4. PostgreSQL PVC 备份环境变量

添加了以下环境变量来配置 Red Hat Quay 是否在从 3.8 → 3.9 升级时自动删除旧的持久性卷声明(PVC):

表 2.5. Red Hat Quay 3.9 PostgreSQL 备份环境变量

字段类型描述

POSTGRES_UPGRADE_RETAIN_BACKUP

布尔值

当设置为 True 时,来自 PostgreSQL 10 的持久性卷声明会被备份。

+ 默认:False

2.1.4.1. PostgreSQL PVC 备份配置示例

以下 Subscription 对象提供了一个备份 PostgreSQL 10 PVC 的示例配置。

PostgreSQL 10 PVC 的 订阅对象

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: quay-operator
  namespace: quay-enterprise
spec:
  channel: stable-3.8
  name: quay-operator
  source: redhat-operators
  sourceNamespace: openshift-marketplace
  config:
    env:
    - name: POSTGRES_UPGRADE_RETAIN_BACKUP
      value: "true"

2.2. 编辑配置文件

要部署独立的 Red Hat Quay 实例,您必须提供最少的配置信息。最小配置的要求可在"Red Hat Quay 最小配置"中找到。

提供必填字段后,您可以验证您的配置。如果有任何问题,则会突出显示它们。

注意

可以使用配置 API 来验证配置,但这需要在配置模式下启动 Quay 容器。如需更多信息,请参阅"使用配置工具"。

要使更改生效,必须重启 registry。

2.3. 独立部署中配置文件的位置

对于 Red Hat Quay 的独立部署,必须在启动 Red Hat Quay registry 时指定 config.yaml 文件。此文件位于配置卷中。例如,当使用以下命令部署 Red Hat Quay 时,配置文件位于 $QUAY/config/config.yaml 中:

$ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
   --name=quay \
   -v $QUAY/config:/conf/stack:Z \
   -v $QUAY/storage:/datastorage:Z \
   registry.redhat.io/quay/quay-rhel8:v3.9.6

2.4. 最小配置

独立部署 Red Hat Quay 需要以下配置选项:

  • 服务器主机名
  • HTTP 或 HTTPS
  • 身份验证类型,如 Database 或轻量级目录访问协议(LDAP)
  • 用于加密数据的 secret 密钥
  • 镜像存储
  • 元数据的数据库
  • 用于构建日志和用户事件的 Redis
  • 标签过期选项

2.4.1. 最小配置文件示例

以下示例显示了为镜像使用本地存储的最小配置文件示例:

AUTHENTICATION_TYPE: Database
BUILDLOGS_REDIS:
    host: quay-server.example.com
    password: strongpassword
    port: 6379
    ssl: false
DATABASE_SECRET_KEY: 0ce4f796-c295-415b-bf9d-b315114704b8
DB_URI: postgresql://quayuser:quaypass@quay-server.example.com:5432/quay
DEFAULT_TAG_EXPIRATION: 2w
DISTRIBUTED_STORAGE_CONFIG:
    default:
        - LocalStorage
        - storage_path: /datastorage/registry
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []
DISTRIBUTED_STORAGE_PREFERENCE:
    - default
PREFERRED_URL_SCHEME: http
SECRET_KEY: e8f9fe68-1f84-48a8-a05f-02d72e6eccba
SERVER_HOSTNAME: quay-server.example.com
SETUP_COMPLETE: true
TAG_EXPIRATION_OPTIONS:
    - 0s
    - 1d
    - 1w
    - 2w
    - 4w
USER_EVENTS_REDIS:
    host: quay-server.example.com
    port: 6379
    ssl: false
注意

SETUP_COMPLETE 字段表示配置已被验证。在启动 registry 前,您应该使用配置编辑器工具验证您的配置。

2.4.2. 本地存储

只有在部署 registry 以进行概念验证时,才建议使用本地存储进行镜像。

在配置本地存储时,会在启动 registry 时在命令行中指定存储。以下命令将本地目录 $QUAY/storage 映射到容器中的 datastorage 路径:

$ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
   --name=quay \
   -v $QUAY/config:/conf/stack:Z \
   -v $QUAY/storage:/datastorage:Z \
   registry.redhat.io/quay/quay-rhel8:v3.9.6

2.4.3. 云存储

存储配置在镜像存储部分中详细介绍。对于某些用户,比较 Google Cloud Platform 和本地存储配置之间的区别可能很有用。例如,以下 YAML 显示了一个 Google Cloud Platform 存储配置:

$QUAY/config/config.yaml

DISTRIBUTED_STORAGE_CONFIG:
    default:
        - GoogleCloudStorage
        - access_key: GOOGQIMFB3ABCDEFGHIJKLMN
          bucket_name: quay_bucket
          secret_key: FhDAYe2HeuAKfvZCAGyOioNaaRABCDEFGHIJKLMN
          storage_path: /datastorage/registry
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []
DISTRIBUTED_STORAGE_PREFERENCE:
    - default

使用云存储启动 registry 时,命令行不需要配置。例如:

$ sudo podman run -d --rm -p 80:8080 -p 443:8443 \
   --name=quay \
   -v $QUAY/config:/conf/stack:Z \
   registry.redhat.io/quay/quay-rhel8:v3.9.6

第 3 章 配置字段

本节论述了部署 Red Hat Quay 时所需的和可选配置字段。

3.1. 所需的配置字段

在以下部分中涵盖了配置 Red Hat Quay 所需的字段:

3.2. 自动化选项

以下小节描述了 Red Hat Quay 部署的可用自动化选项:

3.3. 可选的配置字段

Red Hat Quay 的可选字段可在以下部分中找到:

3.4. 常规必填字段

下表描述了 Red Hat Quay 部署所需的配置字段:

表 3.1. 常规必填字段

字段类型描述

AUTHENTICATION_TYPE
(Required)

字符串

用于凭证身份验证的身份验证引擎。


of Database,LDAP,JWT,Keystone,OIDC

Default: Database

PREFERRED_URL_SCHEME
(Required)

字符串

访问 Red Hat Quay 时使用的 URL 方案。

值:
以下之一 http, https

Default: http

SERVER_HOSTNAME
(Required)

字符串

可以访问 Red Hat Quay 的 URL,不包括网络协议。

例如:
quay-server.example.com

DATABASE_SECRET_KEY
(Required)

字符串

用于加密数据库中敏感字段的密钥。当设置后,不应更改这个值,否则所有依赖的字段(如存储库镜像用户名和密码配置)都无效。

SECRET_KEY
(Required)

字符串

用于加密数据库和运行时敏感字段的密钥。当设置后,不应更改这个值,否则所有依赖的字段(如加密的密码凭证)都无效。

SETUP_COMPLETE
(Required)

布尔值

这是一个来自较早版本的软件,目前 必须使用 true 指定它。

3.5. 数据库配置

本节论述了可用于 Red Hat Quay 部署的数据库配置字段。

3.5.1. 数据库 URI

在 Red Hat Quay 中,使用所需的 DB_URI 字段配置与数据库的连接。

下表描述了 DB_URI 配置字段:

表 3.2. 数据库 URI

字段类型描述

DB_URI
(Required)

字符串

用于访问数据库的 URI,包括任何凭据。

DB_URI 字段示例:

postgresql://quayuser:quaypass@quay-server.example.com:5432/quay

3.5.2. 数据库连接参数

可选的连接参数由 DB_CONNECTION_ARGS 参数配置。DB_CONNECTION_ARGS 下定义的一些键值对是通用的,另一些则特定于数据库。

下表描述了数据库连接参数:

表 3.3. 数据库连接参数

字段类型描述

DB_CONNECTION_ARGS

对象

数据库的可选连接参数,如超时和 SSL/TLS。

.autorollback

布尔值

是否使用线程本地连接。
应该始终为 true

.threadlocals

布尔值

是否使用自动回滚连接。
应该始终为 true

3.5.2.1. PostgreSQL SSL/TLS 连接参数

使用 SSL/TLS 时,配置取决于您部署的数据库。以下示例显示了 PostgreSQL SSL/TLS 配置:

DB_CONNECTION_ARGS:
  sslmode: verify-ca
  sslrootcert: /path/to/cacert

sslmode 选项决定是否与服务器协商安全 SSL/TLS TCP/IP 连接的优先级。有六个模式:

表 3.4. SSL/TLS 选项

模式描述

disable

您的配置只尝试非 SSL/TLS 连接。

allow

您的配置首先尝试非 SSL/TLS 连接。失败时,尝试 SSL/TLS 连接。

首选
(默认)

您的配置首先尝试 SSL/TLS 连接。失败时,尝试非 SSL/TLS 连接。

require

您的配置只尝试 SSL/TLS 连接。如果存在 root CA 文件,它会像指定 verify-ca 一样验证证书。

verify-ca

您的配置只尝试 SSL/TLS 连接,并验证服务器证书是否由可信证书颁发机构(CA)发布。

verify-full

仅尝试 SSL/TLS 连接,并验证服务器证书是否由可信 CA 发布,并且请求的服务器的主机名是否与证书中的匹配。

如需有关 PostgreSQL 有效参数的更多信息,请参阅 数据库连接控制功能

3.5.2.2. MySQL SSL/TLS 连接参数

以下示例显示了 MySQL SSL/TLS 配置示例:

DB_CONNECTION_ARGS:
  ssl:
    ca: /path/to/cacert

有关 MySQL 的有效连接参数的信息,请访问 使用类似URI的字符串或键-值对连接到服务器

3.6. 镜像存储

本节详细介绍了 Red Hat Quay 中提供的镜像存储功能和配置字段。

3.6.1. 镜像存储功能

下表描述了 Red Hat Quay 的镜像存储功能:

表 3.5. 存储配置功能

字段类型描述

FEATURE_REPO_MIRROR

布尔值

如果设置为 true,请启用存储库镜像。

默认: false

FEATURE_PROXY_STORAGE

布尔值

是否通过 NGINX 代理存储中的所有直接下载 URL。

默认: false

FEATURE_STORAGE_REPLICATION

布尔值

是否在存储引擎之间自动复制。

默认: false

3.6.2. 镜像存储配置字段

下表描述了 Red Hat Quay 的镜像存储配置字段:

表 3.6. 存储配置字段

字段类型描述

DISTRIBUTED_STORAGE_CONFIG
(Required)

对象

在 Red Hat Quay 中使用的存储引擎的配置。每个键代表存储引擎的唯一标识符。该值由一个元组(键、值)组成一个对象来描述存储引擎参数。

默认: []

DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS
(Required)

字符串数组

存储引擎列表(由 DISTRIBUTED_STORAGE_CONFIG中的 ID)应默认完全复制到所有其他存储引擎。

DISTRIBUTED_STORAGE_PREFERENCE
(Required)

字符串数组

要使用的首选存储引擎(按 DISTRIBUTED_STORAGE_CONFIG的 ID)。首选引擎表示首先检查拉取,并且镜像被推送(push)到其中。

默认: false

MAXIMUM_LAYER_SIZE

字符串

镜像层允许的最大值。

Pattern:^[0-9]+(G|M)$

示例:100G

Default: 20G

3.6.3. 本地存储

以下 YAML 显示了使用本地存储的示例配置:

DISTRIBUTED_STORAGE_CONFIG:
  default:
    - LocalStorage
    - storage_path: /datastorage/registry
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []
DISTRIBUTED_STORAGE_PREFERENCE:
    - default

3.6.4. OCS/NooBaa

以下 YAML 显示了一个使用 Open Container Storage/NooBaa 实例的配置示例:

DISTRIBUTED_STORAGE_CONFIG:
  rhocsStorage:
    - RHOCSStorage
    - access_key: access_key_here
      secret_key: secret_key_here
      bucket_name: quay-datastore-9b2108a3-29f5-43f2-a9d5-2872174f9a56
      hostname: s3.openshift-storage.svc.cluster.local
      is_secure: 'true'
      port: '443'
      storage_path: /datastorage/registry

3.6.5. Ceph/RadosGW 存储

以下示例显示了在使用 Ceph/RadosGW 时可能的两个 YAML 配置。

示例 A:使用带有 radosGWStorage 驱动程序的 RadosGWW

DISTRIBUTED_STORAGE_CONFIG:
  radosGWStorage:
    - RadosGWStorage
    - access_key: <access_key_here>
      secret_key: <secret_key_here>
      bucket_name: <bucket_name_here>
      hostname: <hostname_here>
      is_secure: true
      port: '443'
      storage_path: /datastorage/registry

示例 B:使用带有常规 s3 访问的 RadosGW

DISTRIBUTED_STORAGE_CONFIG:
  s3Storage: 1
    - RadosGWStorage
    - access_key: <access_key_here>
      bucket_name: <bucket_name_here>
      hostname: <hostname_here>
      is_secure: true
      secret_key: <secret_key_here>
      storage_path: /datastorage/registry

1
用于常规 s3 访问。请注意,一般的 s3 访问不严格仅限于 Amazon Web Services (AWS) 3,可用于 RadosGW 或其他存储服务。有关使用 AWS S3 驱动程序的常规 s3 访问示例,请参阅"AWS S3 存储"。

3.6.6. AWS S3 存储

以下 YAML 显示了使用 AWS S3 存储的示例配置。

DISTRIBUTED_STORAGE_CONFIG:
  default:
    - S3Storage 1
    - host: s3.us-east-2.amazonaws.com
      s3_access_key: ABCDEFGHIJKLMN
      s3_secret_key: OL3ABCDEFGHIJKLMN
      s3_bucket: quay_bucket
      storage_path: /datastorage/registry
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []
DISTRIBUTED_STORAGE_PREFERENCE:
    - s3Storage
1
S3Storage 存储驱动程序应该仅用于 AWS S3 存储桶。请注意,这与常规 S3 访问不同,可以使用 RadosGW 驱动程序或其他存储服务。例如,请参阅"示例 B: 使用 RadosGW 带有常规 S3 访问"。

3.6.7. Google Cloud Storage

以下 YAML 显示了使用 Google Cloud Storage 的示例配置:

DISTRIBUTED_STORAGE_CONFIG:
    googleCloudStorage:
        - GoogleCloudStorage
        - access_key: GOOGQIMFB3ABCDEFGHIJKLMN
          bucket_name: quay-bucket
          secret_key: FhDAYe2HeuAKfvZCAGyOioNaaRABCDEFGHIJKLMN
          storage_path: /datastorage/registry
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []
DISTRIBUTED_STORAGE_PREFERENCE:
    - googleCloudStorage

3.6.8. Azure Storage

以下 YAML 显示了一个使用 Azure Storage 的示例配置:

DISTRIBUTED_STORAGE_CONFIG:
  azureStorage:
    - AzureStorage
    - azure_account_name: azure_account_name_here
      azure_container: azure_container_here
      storage_path: /datastorage/registry
      azure_account_key: azure_account_key_here
      sas_token: some/path/
      endpoint_url: https://[account-name].blob.core.usgovcloudapi.net 1
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []
DISTRIBUTED_STORAGE_PREFERENCE:
    - azureStorage
1
Azure 存储的 endpoint_url 参数是可选的,可用于 Microsoft Azure Government (MAG)端点。如果留空,endpoint_url 将连接到普通的 Azure 区域。

从 Red Hat Quay 3.7 开始,您必须使用 MAG Blob 服务的主端点。使用 MAG Blob 服务的二级端点将导致以下错误: AuthenticationErrorDetail:Cannot find the claimed account when to getProperties for the account whusc8-secondary.

3.6.9. Swift 存储

以下 YAML 显示了一个使用 Swift 存储的示例配置:

DISTRIBUTED_STORAGE_CONFIG:
  swiftStorage:
    - SwiftStorage
    - swift_user: swift_user_here
      swift_password: swift_password_here
      swift_container: swift_container_here
      auth_url: https://example.org/swift/v1/quay
      auth_version: 1
      ca_cert_path: /conf/stack/swift.cert"
      storage_path: /datastorage/registry
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []
DISTRIBUTED_STORAGE_PREFERENCE:
    - swiftStorage

3.6.10. Nutanix 对象存储

以下 YAML 显示了使用 Nutanix 对象存储的示例配置。

DISTRIBUTED_STORAGE_CONFIG:
  nutanixStorage: #storage config name
    - RadosGWStorage #actual driver
    - access_key: access_key_here #parameters
      secret_key: secret_key_here
      bucket_name: bucket_name_here
      hostname: hostname_here
      is_secure: 'true'
      port: '443'
      storage_path: /datastorage/registry
DISTRIBUTED_STORAGE_DEFAULT_LOCATIONS: []
DISTRIBUTED_STORAGE_PREFERENCE: #must contain name of the storage config
    - nutanixStorage

3.7. Redis 配置字段

本节详细介绍了 Redis 部署可用的配置字段。

3.7.1. 构建日志

以下构建日志配置字段可用于 Redis 部署:

表 3.7. 构建日志配置

字段类型描述

BUILDLOGS_REDIS
(Required)

对象

构建日志缓存的 redis 连接详情。

.host
(Required)

字符串

可以访问 Redis 的主机名。
示例:
quay-server.example.com

.port
(Required)

Number

访问 Redis 的端口。
示例:
6379

.password

字符串

用于连接到 Redis 实例的密码。
示例:
strongpassword

.SSL
(可选)

布尔值

是否启用 Redis 和 Quay 之间的 TLS 通信。默认为false。

3.7.2. 用户事件

以下用户事件字段可用于 Redis 部署:

表 3.8. 用户事件配置

字段类型描述

USER_EVENTS_REDIS
(Required)

对象

用户事件处理的 redis 连接详情。

.host
(Required)

字符串

可以访问 Redis 的主机名。
示例:
quay-server.example.com

.port
(Required)

Number

访问 Redis 的端口。
示例:
6379

.password

字符串

用于连接到 Redis 实例的密码。
示例:
strongpassword

.ssl

布尔值

是否启用 Redis 和 Quay 之间的 TLS 通信。默认为false。

.ssl_keyfile
(Optional)

字符串

密钥数据库文件的名称,它存放要使用的客户端证书。
示例
ssl_keyfile: /path/to/server/privatekey.pem

.ssl_certfile
(可选)

字符串

用于指定 SSL 证书的文件路径。
示例
ssl_certfile: /path/to/server/certificate.pem

.ssl_cert_reqs
(可选)

字符串

用于指定在 SSL/TLS 握手期间要执行的证书验证级别。
示例
ssl_cert_reqs: CERT_REQUIRED

.ssl_ca_certs
(可选)

字符串

用于指定包含可信证书颁发机构(CA)证书列表的文件的路径。
示例
ssl_ca_certs: /path/to/ca_certs.pem

.ssl_ca_data
(Optional)

字符串

用于指定包含 PEM 格式的可信 CA 证书的字符串。
Example:
ssl_ca_data: <certificate>

.ssl_check_hostname
(可选)

布尔值

在设置到服务器的 SSL/TLS 连接时使用。它指定客户端是否应该检查服务器的 SSL/TLS 证书中的主机名是否与它连接的服务器的主机名匹配。
示例:
ssl_check_hostname: true

3.7.3. Redis 配置示例

以下 YAML 显示了一个使用带有可选 SSL/TLS 字段的 Redis 的示例配置:

BUILDLOGS_REDIS:
  host: quay-server.example.com
  password: strongpassword
  port: 6379
  ssl: true


USER_EVENTS_REDIS:
  host: quay-server.example.com
  password: strongpassword
  port: 6379
  ssl: true
  ssl_*: <path_location_or_certificate>
注意

如果您的部署使用 Azure Cache for Redis,并且 ssl 设置为 true,则端口默认为 6380

3.8. ModelCache 配置选项

Red Hat Quay 中提供了用于配置 ModelCache 的以下选项。

3.8.1. memcache 配置选项

memcache 是默认的 ModelCache 配置选项。使用 Memcache 时,不需要额外的配置。

3.8.2. 单个 Redis 配置选项

以下配置适用于具有可选只读副本的单一 Redis 实例:

    DATA_MODEL_CACHE_CONFIG:
      engine: redis
      redis_config:
        primary:
            host: <host>
            port: <port>
            password: <password if ssl is true>
           ssl: <true | false >
        replica:
            host: <host>
            port: <port>
            password: <password if ssl is true>
           ssl: <true | false >

3.8.3. 集群 Redis 配置选项

对集群的 Redis 实例使用以下配置:

    DATA_MODEL_CACHE_CONFIG:
      engine: rediscluster
      redis_config:
        startup_nodes:
          - host: <cluster-host>
            port: <port>
        password: <password if ssl: true>
        read_from_replicas: <true|false>
        skip_full_coverage_check: <true | false>
        ssl: <true | false >

3.9. 标签过期配置字段

Red Hat Quay 提供了以下标签过期配置字段:

表 3.9. 标签过期配置字段

字段类型描述

FEATURE_GARBAGE_COLLECTION

布尔值

是否启用存储库垃圾回收。

Default: True

TAG_EXPIRATION_OPTIONS
(Required)

字符串数组

如果启用,用户可以选择其命名空间中的标签过期。

Pattern:
^[0-9]+(w|m|d|h|s)$

DEFAULT_TAG_EXPIRATION
(Required)

字符串

默认可配置标签过期时间。

Pattern:
^[0-9]+(w|m|d|h|s)$
Default: 2w

FEATURE_CHANGE_TAG_EXPIRATION

布尔值

用户和机构是否允许更改其命名空间中标签的标签过期。

Default: True

3.9.1. 标签过期配置示例

以下 YAML 显示了标签过期配置示例:

DEFAULT_TAG_EXPIRATION: 2w
TAG_EXPIRATION_OPTIONS:
    - 0s
    - 1d
    - 1w
    - 2w
    - 4w

3.10. 配额管理配置字段

表 3.10. 配额管理配置

字段类型描述

FEATURE_QUOTA_MANAGEMENT

布尔值

为配额管理功能启用配置、缓存和验证。

**Default:** `False`

DEFAULT_SYSTEM_REJECT_QUOTA_BYTES

字符串

为所有机构启用系统默认配额拒绝字节允许。

默认情况下,不会设置限制。

QUOTA_BACKFILL

布尔值

启用配额回填工作程序来计算预先存在的 Blob 的大小。

默认:True

QUOTA_TOTAL_DELAY_SECONDS

字符串

启动配额回填的时间延迟。滚动部署可能会导致总部署不正确。此字段 必须设置为 超过滚动部署完成所需的时间。

默认 :1800

PERMANENTLY_DELETE_TAGS

布尔值

启用与从时间窗中删除标签相关的功能。

默认False

RESET_CHILD_MANIFEST_EXPIRATION

布尔值

重置以子清单为目标的临时标签的过期。将这个功能设置为 True 时,子清单会立即收集垃圾回收。

默认False

3.10.1. 配额管理配置示例

以下 YAML 是启用配额管理时推荐的配置。

配额管理 YAML 配置

FEATURE_QUOTA_MANAGEMENT: true
FEATURE_GARBAGE_COLLECTION: true
PERMANENTLY_DELETE_TAGS: true
QUOTA_TOTAL_DELAY_SECONDS: 1800
RESET_CHILD_MANIFEST_EXPIRATION: true

3.11. 代理缓存配置字段

表 3.11. 代理配置

字段类型描述

FEATURE_PROXY_CACHE

布尔值

使 Red Hat Quay 能够通过上游 registry 的缓存作为拉取(pull)。

默认false

3.12. 预配置 Red Hat Quay 以进行自动化

Red Hat Quay 支持几个启用自动化的配置选项。用户可以在部署前配置这些选项,以减少与用户界面交互的需求。

3.12.1. 允许 API 创建第一个用户

要创建第一个用户,用户需要将 FEATURE_USER_INITIALIZE 参数设置为 true,并调用 /api/v1/user/initialize API。与需要现有机构中 OAuth 应用的 OAuth 令牌生成的所有其他 registry API 调用不同,API 端点不需要身份验证。

部署 Red Hat Quay 后,用户可以使用 API 来创建用户,如 quayadmin,但没有创建其他用户。如需更多信息 ,请参阅使用 API 创建第一个用户

3.12.2. 启用常规 API 访问

用户应将 BROWSER_API_CALLS_XHR_ONLY 配置选项设置为 false,以允许常规访问 Red Hat Quay registry API。

3.12.3. 添加超级用户

部署 Red Hat Quay 后,用户可以创建用户,并授予第一个用户管理员特权具有完整权限。用户可以使用 SUPER_USER 配置对象提前配置完整的权限。例如:

...
SERVER_HOSTNAME: quay-server.example.com
SETUP_COMPLETE: true
SUPER_USERS:
  - quayadmin
...

3.12.4. 限制用户创建

配置超级用户后,您可以通过将 FEATURE_USER_CREATION 设置为 false 来限制创建新用户到超级用户组的能力。例如:

...
FEATURE_USER_INITIALIZE: true
BROWSER_API_CALLS_XHR_ONLY: false
SUPER_USERS:
- quayadmin
FEATURE_USER_CREATION: false
...

3.12.5. 在 Red Hat Quay 3.8 中启用新功能

要使用新的 Red Hat Quay 3.8 功能,请启用一些或全部的功能:

...
FEATURE_UI_V2: true
FEATURE_LISTEN_IP_VERSION:
FEATURE_SUPERUSERS_FULL_ACCESS: true
GLOBAL_READONLY_SUPER_USERS:
      -
FEATURE_RESTRICTED_USERS: true
RESTRICTED_USERS_WHITELIST:
      -
...

3.12.6. 在 Red Hat Quay 3.7 中启用新功能

要使用新的 Red Hat Quay 3.7 功能,请启用一些或全部的功能:

...
FEATURE_QUOTA_MANAGEMENT: true
FEATURE_BUILD_SUPPORT: true
FEATURE_PROXY_CACHE: true
FEATURE_STORAGE_REPLICATION: true
DEFAULT_SYSTEM_REJECT_QUOTA_BYTES: 102400000
...

3.12.7. 推荐的自动化配置

建议对自动化使用以下 config.yaml 参数:

...
FEATURE_USER_INITIALIZE: true
BROWSER_API_CALLS_XHR_ONLY: false
SUPER_USERS:
- quayadmin
FEATURE_USER_CREATION: false
...

3.12.8. 使用初始配置部署 Red Hat Quay Operator

使用以下步骤使用初始配置在 OpenShift Container Platform 上部署 Red Hat Quay。

先决条件

  • 已安装 oc CLI。

流程

  1. 使用配置文件创建 secret:

    $ oc create secret generic -n quay-enterprise --from-file config.yaml=./config.yaml init-config-bundle-secret
  2. 创建 quayregistry.yaml 文件。识别非受管组件并引用创建的 secret,例如:

    apiVersion: quay.redhat.com/v1
    kind: QuayRegistry
    metadata:
      name: example-registry
      namespace: quay-enterprise
    spec:
      configBundleSecret: init-config-bundle-secret
  3. 部署 Red Hat Quay registry:

    $ oc create -n quay-enterprise -f quayregistry.yaml

3.12.8.1. 使用 API 创建第一个用户

使用以下步骤在 Red Hat Quay 组织中创建第一个用户。

先决条件

  • 配置选项 FEATURE_USER_INITIALIZE 必须设为 true
  • 数据库中还没有存在用户。
流程

此流程通过指定 "access_token": true 来请求 OAuth 令牌。

  1. 以 root 用户身份,输入以下命令安装 python39

    $ sudo yum install python39
  2. 升级 Python 3.9 的 pip 软件包管理器:

    $ python3.9 -m pip install --upgrade pip
  3. 使用 pip 软件包管理器安装 bcrypt 软件包:

    $ pip install bcrypt
  4. 输入以下命令,使用 Python 3.9 中的 bcrypt 软件包生成安全散列密码:

    $ python3.9 -c 'import bcrypt; print(bcrypt.hashpw(b"subquay12345", bcrypt.gensalt(12)).decode("utf-8"))'
  5. 打开 Red Hat Quay 配置文件并更新以下配置字段:

    FEATURE_USER_INITIALIZE: true
    SUPER_USERS:
         -  quayadmin
  6. 输入以下命令停止 Red Hat Quay 服务:

    $ sudo podman stop quay
  7. 输入以下命令启动 Red Hat Quay 服务:

    $ sudo podman run -d -p 80:8080 -p 443:8443 --name=quay -v $QUAY/config:/conf/stack:Z  -v $QUAY/storage:/datastorage:Z {productrepo}/{quayimage}:{productminv}
  8. 运行以下 CURL 命令,以使用用户名、密码、电子邮件和访问令牌生成新用户:

    $ curl -X POST -k  http://quay-server.example.com/api/v1/user/initialize --header 'Content-Type: application/json' --data '{ "username": "quayadmin", "password":"quaypass12345", "email": "quayadmin@example.com", "access_token": true}'

    如果成功,命令会返回带有用户名、电子邮件和加密的密码的对象。例如:

    {"access_token":"6B4QTRSTSD1HMIG915VPX7BMEZBVB9GPNY2FC2ED", "email":"quayadmin@example.com","encrypted_password":"1nZMLH57RIE5UGdL/yYpDOHLqiNCgimb6W9kfF8MjZ1xrfDpRyRs9NUnUuNuAitW","username":"quayadmin"} # gitleaks:allow

    如果用户已在数据库中存在,则返回错误:

    {"message":"Cannot initialize user in a non-empty database"}

    如果您的密码不至少为 8 个字符或包含空格,则会返回错误:

    {"message":"Failed to initialize user: Invalid password, password must be at least 8 characters and contain no whitespace."}
  9. 输入以下命令登录到您的 Red Hat Quay 部署:

    $ sudo podman login -u quayadmin -p quaypass12345 http://quay-server.example.com --tls-verify=false

    输出示例

    Login Succeeded!

3.12.8.2. 使用 OAuth 令牌

调用 API 后,您可以通过指定返回的 OAuth 代码来调用 Red Hat Quay API 的其余部分。

先决条件

  • 您已调用 /api/v1/user/initialize API,并传递用户名、密码和电子邮件地址。

流程

  • 输入以下命令获取当前用户列表:

    $ curl -X GET -k -H "Authorization: Bearer 6B4QTRSTSD1HMIG915VPX7BMEZBVB9GPNY2FC2ED" https://example-registry-quay-quay-enterprise.apps.docs.quayteam.org/api/v1/superuser/users/

    输出示例:

    {
        "users": [
            {
                "kind": "user",
                "name": "quayadmin",
                "username": "quayadmin",
                "email": "quayadmin@example.com",
                "verified": true,
                "avatar": {
                    "name": "quayadmin",
                    "hash": "3e82e9cbf62d25dec0ed1b4c66ca7c5d47ab9f1f271958298dea856fb26adc4c",
                    "color": "#e7ba52",
                    "kind": "user"
                },
                "super_user": true,
                "enabled": true
            }
        ]
    }

    在本例中,quayadmin 用户的详细信息将返回,因为它是目前创建的唯一用户。

3.12.8.3. 使用 API 创建机构

以下流程描述了如何使用 API 创建 Red Hat Quay 组织。

先决条件

  • 您已调用 /api/v1/user/initialize API,并传递用户名、密码和电子邮件地址。
  • 您已通过指定返回的 OAuth 代码来调用 Red Hat Quay API 的其余部分。

流程

  1. 要创建机构,请使用对 api/v1/organization/ 端点的 POST 调用:

    $ curl -X POST -k --header 'Content-Type: application/json' -H "Authorization: Bearer 6B4QTRSTSD1HMIG915VPX7BMEZBVB9GPNY2FC2ED" https://example-registry-quay-quay-enterprise.apps.docs.quayteam.org/api/v1/organization/ --data '{"name": "testorg", "email": "testorg@example.com"}'

    输出示例:

    "Created"
  2. 您可以输入以下命令来检索您创建的机构详情:

    $ curl -X GET -k --header 'Content-Type: application/json' -H "Authorization: Bearer 6B4QTRSTSD1HMIG915VPX7BMEZBVB9GPNY2FC2ED" https://min-registry-quay-quay-enterprise.apps.docs.quayteam.org/api/v1/organization/testorg

    输出示例:

    {
        "name": "testorg",
        "email": "testorg@example.com",
        "avatar": {
            "name": "testorg",
            "hash": "5f113632ad532fc78215c9258a4fb60606d1fa386c91b141116a1317bf9c53c8",
            "color": "#a55194",
            "kind": "user"
        },
        "is_admin": true,
        "is_member": true,
        "teams": {
            "owners": {
                "name": "owners",
                "description": "",
                "role": "admin",
                "avatar": {
                    "name": "owners",
                    "hash": "6f0e3a8c0eb46e8834b43b03374ece43a030621d92a7437beb48f871e90f8d90",
                    "color": "#c7c7c7",
                    "kind": "team"
                },
                "can_view": true,
                "repo_count": 0,
                "member_count": 1,
                "is_synced": false
            }
        },
        "ordered_teams": [
            "owners"
        ],
        "invoice_email": false,
        "invoice_email_address": null,
        "tag_expiration_s": 1209600,
        "is_free_account": true
    }

3.13. 基本配置字段

表 3.12. 基本配置

字段类型描述

REGISTRY_TITLE

字符串

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

REGISTRY_TITLE_SHORT

字符串

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

CONTACT_INFO

字符串数组

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

[0]

字符串

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

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

[1]

字符串

添加访问 IRC chat room 的链接。

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

[2]

字符串

添加一个链接来调用电话号码。+
Pattern:
^tel: (.)+$
Example:
tel:+1-888-930-3475

[3]

字符串

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

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

3.14. SSL 配置字段

表 3.13. SSL 配置

字段类型描述

PREFERRED_URL_SCHEME

字符串

httphttps 之一。请注意,只有在从客户端到 Quay 的通信路径中没有 TLS 加密时,用户仅将 PREFERRED_URL_SCHEME 设置为 http

在使用 TLS 长期负载均衡器、反向代理(如 Nginx)或直接使用自定义 SSL 证书时,+ 用户必须将 PREFERRED_URL_SCHEME' 设置为 'https。在大多数情况下,PREFERRED_URL_SCHEME 应该为 https
默认: http

SERVER_HOSTNAME
(Required)

字符串

可以访问 Red Hat Quay 的 URL,不包括网络协议。

例如:
quay-server.example.com

SSL_CIPHERS

字符串数组

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

示例:
[CAMELLIA,!3DES]

SSL_PROTOCOLS

字符串数组

如果指定了,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

3.14.1. 配置 SSL

  1. 将证书文件和主密钥文件复制到您的配置目录中,确保分别命名为 ssl.certssl.key

    $ cp ~/ssl.cert $QUAY/config
    $ cp ~/ssl.key $QUAY/config
    $ cd $QUAY/config
  2. 编辑 config.yaml 文件,并指定您希望 Quay 处理 TLS:

    config.yaml

    ...
    SERVER_HOSTNAME: quay-server.example.com
    ...
    PREFERRED_URL_SCHEME: https
    ...

  3. 停止 Quay 容器并重启 registry

3.15. 在 Red Hat Quay 容器中添加 TLS 证书

要将自定义 TLS 证书添加到 Red Hat Quay,请在 Red Hat Quay config 目录下创建一个名为 extra_ca_certs/ 的新目录。将任何所需的特定于站点的 TLS 证书复制到这个新目录中。

3.15.1. 将 TLS 证书添加到 Red Hat Quay

  1. 查看添加到容器中的证书

    $ cat storage.crt
    -----BEGIN CERTIFICATE-----
    MIIDTTCCAjWgAwIBAgIJAMVr9ngjJhzbMA0GCSqGSIb3DQEBCwUAMD0xCzAJBgNV
    [...]
    -----END CERTIFICATE-----
  2. 创建证书目录并在其中复制证书

    $ mkdir -p quay/config/extra_ca_certs
    $ cp storage.crt quay/config/extra_ca_certs/
    $ tree quay/config/
    ├── config.yaml
    ├── extra_ca_certs
    │   ├── storage.crt
  3. 使用 podman ps 获取 Quay 容器的 CONTAINER ID

    $ sudo podman ps
    CONTAINER ID        IMAGE                                COMMAND                  CREATED             STATUS              PORTS
    5a3e82c4a75f        <registry>/<repo>/quay:v3.9.6 "/sbin/my_init"          24 hours ago        Up 18 hours         0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp, 443/tcp   grave_keller
  4. 使用该 ID 重启容器:

    $ sudo podman restart 5a3e82c4a75f
  5. 检查复制到容器命名空间中的证书:

    $ sudo podman exec -it 5a3e82c4a75f cat /etc/ssl/certs/storage.pem
    -----BEGIN CERTIFICATE-----
    MIIDTTCCAjWgAwIBAgIJAMVr9ngjJhzbMA0GCSqGSIb3DQEBCwUAMD0xCzAJBgNV

3.16. LDAP 配置字段

表 3.14. LDAP 配置

字段类型描述

AUTHENTICATION_TYPE
(Required)

字符串

必须设置为 LDAP

FEATURE_TEAM_SYNCING

布尔值

是否允许团队成员资格从身份验证引擎(LDAP 或 Keystone)中的后备组中同步。

默认: true

FEATURE_NONSUPERUSER_TEAM_SYNCING_SETUP

布尔值

如果启用,非超级用户可以使用 LDAP 在团队上设置同步。

默认: false

LDAP_ADMIN_DN

字符串

用于 LDAP 身份验证的管理 DN。

LDAP_ADMIN_PASSWD

字符串

LDAP 身份验证的管理员密码。

LDAP_ALLOW_INSECURE_FALLBACK

布尔值

是否允许对 LDAP 身份验证进行 SSL 不安全回退。

LDAP_BASE_DN

字符串数组

LDAP 身份验证的基本 DN。

LDAP_EMAIL_ATTR

字符串

用于 LDAP 身份验证的电子邮件属性。

LDAP_UID_ATTR

字符串

用于 LDAP 身份验证的 uid 属性。

LDAP_URI

字符串

LDAP URI。

LDAP_USER_FILTER

字符串

用于 LDAP 身份验证的用户过滤器。

LDAP_USER_RDN

字符串数组

用于 LDAP 身份验证的用户 RDN。

TEAM_RESYNC_STALE_TIME

字符串

如果为团队启用了团队同步,需要检查其成员资格和重新同步。

Pattern:
^[0-9]+(w|m|d|h|s)$
示例:
2h
Default:
30m

LDAP_SUPERUSER_FILTER

字符串

LDAP_USER_FILTER 配置字段的子集。配置后,Red Hat Quay 管理员能够在 Red Hat Quay 使用 LDAP 作为其身份验证提供程序时,将轻量级目录访问协议(LDAP)用户配置为超级用户。

使用此字段,管理员可以在无需更新 Red Hat Quay 配置文件并重新启动其部署的情况下添加或删除超级用户。

此字段需要您的 AUTHENTICATION_TYPE 设置为 LDAP

LDAP_RESTRICTED_USER_FILTER

字符串

LDAP_USER_FILTER 配置字段的子集。配置后,当 Red Hat Quay 使用 LDAP 作为其身份验证提供程序时,可以将轻量级目录访问协议(LDAP)用户配置为受限用户。

此字段需要您的 AUTHENTICATION_TYPE 设置为 LDAP

LDAP_TIMEOUT

整数

决定与轻量级目录访问协议(LDAP)服务器建立连接的最大时间段(以秒为单位)。

+ 默认 :10

LDAP_NETWORK_TIMEOUT

整数

定义 Red Hat Quay 在网络操作期间等待轻量级目录访问协议(LDAP)服务器的响应的最长时间(以秒为单位)。

+ 默认 :10

3.16.1. LDAP 配置参考

使用以下引用,使用所需的配置字段更新 config.yaml 文件。

3.16.1.1. 基本 LDAP 配置

---
AUTHENTICATION_TYPE: LDAP
---
LDAP_ADMIN_DN: uid=<name>,ou=Users,o=<organization_id>,dc=<example_domain_component>,dc=com
LDAP_ADMIN_PASSWD: ABC123
LDAP_ALLOW_INSECURE_FALLBACK: false
LDAP_BASE_DN:
    - o=<organization_id>
    - dc=<example_domain_component>
    - dc=com
LDAP_EMAIL_ATTR: mail
LDAP_UID_ATTR: uid
LDAP_URI: ldaps://<ldap_url_domain_name>
LDAP_USER_FILTER: (memberof=cn=developers,ou=Users,dc=<domain_name>,dc=com)
LDAP_USER_RDN:
    - ou=<example_organization_unit>
    - o=<organization_id>
    - dc=<example_domain_component>
    - dc=com

3.16.1.2. LDAP 受限用户配置

---
AUTHENTICATION_TYPE: LDAP
---
LDAP_ADMIN_DN: uid=<name>,ou=Users,o=<organization_id>,dc=<example_domain_component>,dc=com
LDAP_ADMIN_PASSWD: ABC123
LDAP_ALLOW_INSECURE_FALLBACK: false
LDAP_BASE_DN:
    - o=<organization_id>
    - dc=<example_domain_component>
    - dc=com
LDAP_EMAIL_ATTR: mail
LDAP_UID_ATTR: uid
LDAP_URI: ldap://<example_url>.com
LDAP_USER_FILTER: (memberof=cn=developers,ou=Users,o=<example_organization_unit>,dc=<example_domain_component>,dc=com)
LDAP_RESTRICTED_USER_FILTER: (<filterField>=<value>)
LDAP_USER_RDN:
    - ou=<example_organization_unit>
    - o=<organization_id>
    - dc=<example_domain_component>
    - dc=com
---

3.16.1.3. LDAP 超级用户配置参考

---
AUTHENTICATION_TYPE: LDAP
---
LDAP_ADMIN_DN: uid=<name>,ou=Users,o=<organization_id>,dc=<example_domain_component>,dc=com
LDAP_ADMIN_PASSWD: ABC123
LDAP_ALLOW_INSECURE_FALLBACK: false
LDAP_BASE_DN:
    - o=<organization_id>
    - dc=<example_domain_component>
    - dc=com
LDAP_EMAIL_ATTR: mail
LDAP_UID_ATTR: uid
LDAP_URI: ldap://<example_url>.com
LDAP_USER_FILTER: (memberof=cn=developers,ou=Users,o=<example_organization_unit>,dc=<example_domain_component>,dc=com)
LDAP_SUPERUSER_FILTER: (<filterField>=<value>)
LDAP_USER_RDN:
    - ou=<example_organization_unit>
    - o=<organization_id>
    - dc=<example_domain_component>
    - dc=com

3.17. 镜像配置字段

表 3.15. 镜像配置

字段类型描述

FEATURE_REPO_MIRROR

布尔值

启用或禁用存储库镜像

默认: false

REPO_MIRROR_INTERVAL

Number

检查存储库镜像候选者之间的秒数

默认:30

REPO_MIRROR_SERVER_HOSTNAME

字符串

替换 SERVER_HOSTNAME 作为镜像的目的地。

Default: None

Example:
openshift-quay-service

REPO_MIRROR_TLS_VERIFY

布尔值

需要 HTTPS 并在镜像过程中验证 Quay registry 的证书。

默认: false

REPO_MIRROR_ROLLBACK

布尔值

当设置为 true 时,存储库会在镜像尝试失败后回滚。

默认false

3.18. 安全扫描程序配置字段

表 3.16. 安全扫描程序配置

字段类型描述

FEATURE_SECURITY_SCANNER

布尔值

启用或禁用安全扫描程序

默认: false

FEATURE_SECURITY_NOTIFICATIONS

布尔值

如果启用了安全扫描程序,请打开或关闭安全通知

默认: false

SECURITY_SCANNER_V4_REINDEX_THRESHOLD

字符串

此参数用于决定在重新索引之前要等待的最短时间(以秒为单位),或者自上次索引后更改了状态。数据从 manifestsecuritystatus 表中的 last_indexed datetime 中计算。这个参数用于避免在每次索引运行时重新索引每个失败的清单。re-index 的默认时间为 300 秒。

SECURITY_SCANNER_V4_ENDPOINT

字符串

V4 安全扫描程序的端点

Pattern:
^http (s)?://(.)+$

Example:
http://192.168.99.101:6060

SECURITY_SCANNER_V4_PSK

字符串

Clair 生成的预共享密钥(PSK)

SECURITY_SCANNER_ENDPOINT

字符串

V2 安全扫描程序的端点

Pattern:
^http (s)?://(.)+$

示例:
http://192.168.99.100:6060

SECURITY_SCANNER_INDEXING_INTERVAL

整数

此参数用于决定安全扫描程序中索引间隔之间的秒数。触发索引时,Red Hat Quay 将查询其数据库以获取 Clair 必须索引的清单。这包括尚未索引的清单,以及之前索引失败的清单。

+ 默认值:30

FEATURE_SECURITY_SCANNER_NOTIFY_ON_NEW_INDEX

布尔值

是否允许发送有关新推送的漏洞的通知。

+ default*: True

3.18.1. 使用 Clair v4 重新索引

当 Clair v4 索引清单时,结果应确定性。例如,同一清单应生成相同的索引报告。这是 true,直到扫描程序更改,因为使用不同的扫描程序将生成与报告返回的特定清单相关的不同信息。因此,Clair v4 会公开索引引擎(/indexer/api/v1/index_state)的状态表示,以确定扫描程序配置是否已改变。

Red Hat Quay 通过在解析到 Quay 数据库时将其保存到索引报告中来利用此索引状态。如果因为清单之前扫描以来此状态已更改,Red Hat Quay 会在定期索引过程中尝试重新索引该清单。

默认情况下,此参数被设置为 30 秒。如果用户希望索引过程更频繁运行,例如,如果他们不希望等待 30 秒在推送新标签后查看安全扫描结果,用户可能会缩短时间。如果用户希望对请求模式进行更多控制,以及要在 Red Hat Quay 数据库上执行的数据库操作的模式,用户也可以更改参数。

3.18.2. 安全扫描程序配置示例

以下 YAML 是启用安全扫描程序功能时推荐的配置。

安全扫描程序 YAML 配置

FEATURE_SECURITY_NOTIFICATIONS: true
FEATURE_SECURITY_SCANNER: true
FEATURE_SECURITY_SCANNER_NOTIFY_ON_NEW_INDEX: true
...
SECURITY_SCANNER_INDEXING_INTERVAL: 30
SECURITY_SCANNER_V4_ENDPOINT: http://quay-server.example.com:8081
SECURITY_SCANNER_V4_PSK: MTU5YzA4Y2ZkNzJoMQ==
SERVER_HOSTNAME: quay-server.example.com
...

3.19. Helm 配置字段

表 3.17. Helm 配置字段

字段类型描述

FEATURE_GENERAL_OCI_SUPPORT

布尔值

启用对 OCI 工件的支持。

默认值: True

以下 Open Container Initiative (OCI)工件类型默认内置在 Red Hat Quay 中,并通过 FEATURE_GENERAL_OCI_SUPPORT 配置字段启用:

字段介质类型支持的内容类型

Helm

application/vnd.cncf.helm.config.v1+json

application/tar+gzip, application/vnd.cncf.helm.chart.content.v1.tar+gzip

Cosign

application/vnd.oci.image.config.v1+json

application/vnd.dev.cosign.simplesigning.v1+json, application/vnd.dsse.envelope.v1+json

SPDX

application/vnd.oci.image.config.v1+json

text/spdx, text/spdx+xml, text/spdx+json

Syft

application/vnd.oci.image.config.v1+json

application/vnd.syft+json

CycloneDX

application/vnd.oci.image.config.v1+json

application/vnd.cyclonedx,application/vnd.cyclonedx+xml,application/vnd.cyclonedx+json

in-toto

application/vnd.oci.image.config.v1+json

application/vnd.in-toto+json

Unknown

application/vnd.cncf.openpolicyagent.policy.layer.v1+rego

application/vnd.cncf.openpolicyagent.policy.layer.v1+rego,application/vnd.cncf.openpolicyagent.data.layer.v1+json

3.19.1. 配置 Helm

以下 YAML 是启用 Helm 时的示例配置。

Helm YAML 配置

FEATURE_GENERAL_OCI_SUPPORT: true

3.20. 开放容器项目配置字段

表 3.18. 其他 OCI 工件配置字段

字段类型描述

ALLOWED_OCI_ARTIFACT_TYPES

对象

允许的 OCI 工件 mimetypes 和关联的层类型集合。

3.20.1. 配置额外的工件类型

可以使用 ALLOWED_OCI_ARTIFACT_TYPES 配置字段将默认不支持的其他 OCI 工件类型添加到您的 Red Hat Quay 部署中。

使用以下引用添加额外的 OCI 工件类型:

OCI 工件类型配置

FEATURE_GENERAL_OCI_SUPPORT: true
ALLOWED_OCI_ARTIFACT_TYPES:
  <oci config type 1>:
  - <oci layer type 1>
  - <oci layer type 2>

  <oci config type 2>:
  - <oci layer type 3>
  - <oci layer type 4>

例如,您可以通过将以下内容添加到 config.yaml 文件中来添加单数(SIF)支持:

OCI 工件类型配置示例

ALLOWED_OCI_ARTIFACT_TYPES:
  application/vnd.oci.image.config.v1+json:
  - application/vnd.dev.cosign.simplesigning.v1+json
  application/vnd.cncf.helm.config.v1+json:
  - application/tar+gzip
  application/vnd.sylabs.sif.config.v1+json:
  - application/vnd.sylabs.sif.layer.v1+tar

注意

当添加不默认配置的 OCI 工件类型时,Red Hat Quay 管理员还需要手动添加对 cosign 和 Helm 的支持。

3.21. 未知介质类型

表 3.19. 未知介质类型配置字段

字段类型描述

IGNORE_UNKNOWN_MEDIATYPES

布尔值

启用后,允许容器 registry 平台对支持的工件类型忽略特定的限制,并接受任何未识别或未知的介质类型。

默认: false

3.21.1. 配置未知介质类型

当启用未知或未识别的介质类型时,以下 YAML 是示例配置。

未知介质类型 YAML 配置

IGNORE_UNKNOWN_MEDIATYPES: true

3.22. 操作日志配置字段

3.22.1. 操作日志存储配置

表 3.20. 操作日志存储配置

字段类型描述

FEATURE_LOG_EXPORT

布尔值

是否允许导出操作日志。

默认值: True

LOGS_MODEL

字符串

指定处理日志数据的首选方法。

值 : 一个数据库 ,transition_reads_both_writes_es,elasticsearch, mvapich
Default: database

LOGS_MODEL_CONFIG

对象

用于操作日志的日志模型配置。

  • LOGS_MODEL_CONFIG [object]:操作日志的日志模型配置。

    • elasticsearch_config [object]: Elasticsearch 集群配置。

      • access_key [string]: Elasticsearch 用户(或 AWS ES 的 IAM 密钥)。

        • 示例some_string
      • Host [string]: Elasticsearch 集群端点。

        • 示例host.elasticsearch.example
      • index_prefix [string]: Elasticsearch 的索引前缀。

        • 示例logentry_
      • index_settings [object]: Elasticsearch 的索引设置
      • use_ssl [boolean]:将 ssl 用于 Elasticsearch。默认值为 True

        • 示例True
      • SECRET_KEY [字符串]:Elasticsearch 密码(或 AWS ES 的 IAM secret)。

        • 示例some_secret_string
      • AWS_REGION [string]: Amazon Web 服务区域。

        • 示例us-east-1
      • 端口 [number]: Elasticsearch 集群端点端口。

        • 示例1234
    • kinesis_stream_config [object]: AWS Kinesis Stream 配置。

      • aws_secret_key [string]: AWS secret key。

        • 示例some_secret_key
      • stream_name [string]: Kinesis 流将操作日志发送到。

        • 示例logentry-kinesis-stream
      • aws_access_key [string]: AWS 访问密钥。

        • 示例some_access_key
      • retries [number]:在单个请求中尝试次数。

        • 示例5
      • read_timeout [number]:从连接读取时超时前的秒数。

        • 示例5
      • max_pool_connections [number] :连接池中要保留的最大连接数。

        • 示例 :10
      • AWS_REGION [string]: AWS region。

        • 示例us-east-1
      • connect_timeout [number]:尝试进行连接时超时前的秒数。

        • 示例5
    • producer [string]:如果日志记录到 Elasticsearch,则日志制作者。

      • Enum: kafka, elasticsearch, kinesis_stream
      • 示例kafka
    • kafka_config [object]: Kafka 集群配置。

      • topic [string]: Kafka topic 将日志条目发布到。

        • 示例logentry
      • bootstrap_servers [array]:从中引导客户端的 Kafka 代理列表。
      • max_block_seconds [number]: 在 send () 期间最大要阻止的秒数,因为缓冲区已满或元数据不可用。

        • 示例 :10
    • producer [string]: splunk
    • mvapich_config [object]: Splunk 操作日志的日志模型配置或 Splunk 集群配置。

      • Host [string]: Splunk 集群端点。
      • port [integer]: Splunk 管理集群端点端口。
      • bearer_token [string]: Splunk 的 bearer 令牌。
      • verify_ssl [boolean]: 启用(True)或为 HTTPS 连接禁用 TLS/SSL 验证。
      • index_prefix [string]: Splunk 的索引前缀。
      • ssl_ca_path [字符串]:指向包含用于 SSL 验证的证书颁发机构(CA)的单个 .pem 文件的相对容器路径。

3.22.2. 操作日志轮转和归档配置

表 3.21. 操作日志轮转和归档配置

字段类型描述

FEATURE_ACTION_LOG_ROTATION

布尔值

启用日志轮转和归档会将所有超过 30 天的日志移到存储。

默认: false

ACTION_LOG_ARCHIVE_LOCATION

字符串

如果启用了操作日志存档,则在其中放置存档数据的存储引擎。

示例: s3_us_east

ACTION_LOG_ARCHIVE_PATH

字符串

如果启用了操作日志存档,则存储中要放置存档数据的路径。

示例: archive /actionlogs

ACTION_LOG_ROTATION_THRESHOLD

字符串

轮转日志的时间间隔。

示例: 30d

3.22.3. 操作日志审计配置

表 3.22. 审计日志配置字段

字段类型描述

ACTION_LOG_AUDIT_LOGINS

布尔值

当设置为 True 时,请跟踪高级事件,如登录和注销、UI 和使用 Docker 进行常规用户、机器人帐户以及特定于应用的令牌帐户。

默认: True

3.23. 构建日志配置字段

表 3.23. 构建日志配置字段

字段类型描述

FEATURE_READER_BUILD_LOGS

布尔值

如果设置为 true,则构建日志可以被对存储库具有读取访问权限的用户 读取,而不仅仅是 写入 访问或 admin 访问权限。

Default: False

LOG_ARCHIVE_LOCATION

字符串

DISTRIBUTED_STORAGE_CONFIG 中定义的存储位置,用于放置归档的构建日志。

示例: s3_us_east

LOG_ARCHIVE_PATH

字符串

配置的存储引擎下的路径,在其中将归档的构建日志放在 .JSON 格式。

示例: archive /buildlogs

3.24. Dockerfile 构建触发器字段

表 3.24. Dockerfile 构建支持

字段类型描述

FEATURE_BUILD_SUPPORT

布尔值

是否支持 Dockerfile 构建。

Default: False

SUCCESSIVE_TRIGGER_FAILURE_DISABLE_THRESHOLD

Number

如果没有设置 None,则构建触发器前可能会出现的连续失败次数。

默认: 100

SUCCESSIVE_TRIGGER_INTERNAL_ERROR_DISABLE_THRESHOLD

Number

如果没有设置 None,则构建触发器前可能出现的连续内部错误数量

默认为 5

3.24.1. GitHub 构建触发器

表 3.25. GitHub 构建触发器

字段类型描述

FEATURE_GITHUB_BUILD

布尔值

是否支持 GitHub 构建触发器。

默认值: False

 

 

 

GITHUB_TRIGGER_CONFIG

对象

使用 GitHub Enterprise 进行构建触发器的配置。

   .GITHUB_ENDPOINT
(Required)

字符串

GitHub Enterprise 的端点。

示例: https://github.com/

   .API_ENDPOINT

字符串

要使用的 GitHub Enterprise API 的端点。必须覆盖 github.com

示例https://api.github.com/

   .CLIENT_ID
   (Required)

字符串

此 Red Hat Quay 实例注册的客户端 ID;这不能与 GITHUB_LOGIN_CONFIG 共享。

   .CLIENT_SECRET
(Required)

字符串

为此 Red Hat Quay 实例注册的客户端 secret。

3.24.2. Bitbucket 构建触发器

表 3.26. Bitbucket 构建触发器

字段类型描述

FEATURE_BITBUCKET_BUILD

布尔值

是否支持 Bitbucket 构建触发器。

默认值: False

 

 

 

BITBUCKET_TRIGGER_CONFIG

对象

使用 BitBucket 进行构建触发器的配置。

   .CONSUMER_KEY
(Required)

字符串

此 Red Hat Quay 实例注册的使用者密钥(客户端 ID)。

   .CONSUMER_SECRET
   (Required)

字符串

此 Red Hat Quay 实例注册的消费者 secret (客户端 secret)。

3.24.3. GitLab 构建触发器

表 3.27. GitLab 构建触发器

字段类型描述

FEATURE_GITLAB_BUILD

布尔值

是否支持 GitLab 构建触发器。

默认值: False

 

 

 

GITLAB_TRIGGER_CONFIG

对象

使用 Gitlab 进行构建触发器的配置。

   .GITLAB_ENDPOINT
(Required)

字符串

运行 Gitlab Enterprise 的端点。

   .CLIENT_ID
   (Required)

字符串

此 Red Hat Quay 实例的注册的客户端 ID。

   .CLIENT_SECRET
(Required)

字符串

为此 Red Hat Quay 实例注册的客户端 secret。

3.25. 构建管理器配置字段

表 3.28. 构建管理器配置字段

字段类型描述

ALLOWED_WORKER_COUNT

字符串

定义每个 Red Hat Quay pod 实例化多少个 Build Worker。通常设置为 1

ORCHESTRATOR_PREFIX

字符串

定义添加到所有 Redis 密钥的唯一前缀。这可用于将 Orchestrator 值与其他 Redis 键隔离。

REDIS_HOST

对象

Redis 服务的主机名。

REDIS_PASSWORD

字符串

在 Redis 服务中进行身份验证的密码。

REDIS_SSL

布尔值

定义您的 Redis 连接是否使用 SSL/TLS。

REDIS_SKIP_KEYSPACE_EVENT_SETUP

布尔值

默认情况下,Red Hat Quay 不会在运行时设置关键事件所需的关键空间事件。为此,请将 REDIS_SKIP_KEYSPACE_EVENT_SETUP 设置为 false

EXECUTOR

字符串

启动此类型的可执行文件定义。有效值为 kubernetesec2

BUILDER_NAMESPACE

字符串

将进行 Red Hat Quay 构建的 Kubernetes 命名空间。

K8S_API_SERVER

对象

发生 Builds 的 OpenShift Container Platform 集群的 API 服务器的主机名。

K8S_API_TLS_CA

对象

Quay 应用构建集群的 CA 证书的 Quay 容器中的文件路径,以便在发出 API 调用时信任。

KUBERNETES_DISTRIBUTION

字符串

指明正在使用的 Kubernetes 类型。有效值为 openshiftk8s

CONTAINER_*

对象

定义每个构建 Pod 的资源请求和限值。

NODE_SELECTOR_*

对象

定义应调度 构建 Pod 的节点选择器标签名称-值对。

CONTAINER_RUNTIME

对象

指定 Builder 是否应该运行 dockerpodman。使用红帽的 quay-builder 镜像的客户应将其设置为 podman

SERVICE_ACCOUNT_NAME/SERVICE_ACCOUNT_TOKEN

对象

定义 构建 Pod 将要使用的服务帐户名称或令牌。

QUAY_USERNAME/QUAY_PASSWORD

对象

定义拉取 WORKER_IMAGE 字段中指定的 Red Hat Quay 构建 worker 镜像所需的 registry 凭证。客户应提供一个 Red Hat Service Account 凭证,如 https://access.redhat.com/RegistryAuthentication 文章中的针对 registry.redhat.io 的"创建 Registry 服务账户"部分。

WORKER_IMAGE

对象

Red Hat Quay Builder 镜像的镜像引用。registry.redhat.io/quay/quay-builder

WORKER_TAG

对象

需要的 Builder 镜像的标签。最新版本为 3.9。

BUILDER_VM_CONTAINER_IMAGE

对象

对包含运行每个 Red Hat Quay Build. (registry.redhat.io/quay/quay-builder-qemu-rhcos:3.9)所需的内部虚拟机的完整引用。

SETUP_TIME

字符串

指定在 Build Manager 中尚未注册自身时构建超时的秒数。默认值为 500 秒。尝试重启三次的构建。如果构建在三次尝试后没有注册自己,则被视为失败。

MINIMUM_RETRY_THRESHOLD

字符串

此设置与多个可执行文件一起使用。它指示在选择不同的可执行文件前尝试启动构建的次数。设置为 0 表示对于构建作业需要的次数没有限制。这个值应该保持非常小(三个或更少),以确保在基础架构故障期间快速进行故障转移。必须为此设置指定一个值。例如,Kubernetes 被设置为第一个 executor,EC2 设置为第二个 executor。如果您希望最后一次尝试始终在 EC2 上执行作业,而不是在 EC2 上执行,您可以将 Kubernetes executor 的 MINIMUM_RETRY_THRESHOLD 设置为 1,EC2 的 MINIMUM_RETRY_THRESHOLD 设置为 0 (如果未设置则为 0 )。在这种情况下,Kubernetes 的 MINIMUM_RETRY_THRESHOLD retries_remaining (1) 将评估为 False,因此回退到配置的第二个 executor。

SSH_AUTHORIZED_KEYS

对象

ignition 配置中要引导的 SSH 密钥列表。这允许使用其他密钥通过 SSH 连接到 EC2 实例或 QEMU 虚拟机(VM)。

3.26. OAuth 配置字段

表 3.29. OAuth 字段

字段类型描述

DIRECT_OAUTH_CLIENTID_WHITELIST

字符串数组

Quay 管理 的应用程序的客户端 ID 列表,允许在不用户批准的情况下执行直接 OAuth 批准。

3.26.1. GitHub OAuth 配置字段

表 3.30. GitHub OAuth 字段

字段类型描述

FEATURE_GITHUB_LOGIN

布尔值

是否支持 GitHub 登录

**默认:False

GITHUB_LOGIN_CONFIG

对象

配置使用 GitHub (Enterprise)作为外部登录提供程序。

   .ALLOWED_ORGANIZATIONS

字符串数组

白名单为使用 ORG_RESTRICT 选项的 GitHub (Enterprise)组织的名称。

   .API_ENDPOINT

字符串

要使用的 GitHub (Enterprise) API 的端点。必须覆盖 github.com

示例: https://api.github.com/

   .CLIENT_ID
   (Required)

字符串

此 Red Hat Quay 实例注册的客户端 ID;不能与 GITHUB_TRIGGER_CONFIG 共享。

示例: 0e8dbe15c7630b6780

   .CLIENT_SECRET
(Required)

字符串

此 Red Hat Quay 实例注册的客户端 secret。

示例: e4a58ddd3d7408b7aec109e85564a0d153d3e846

   .GITHUB_ENDPOINT
(Required)

字符串

GitHub (Enterprise)的端点。

示例https://github.com/

   .ORG_RESTRICT

布尔值

如果为 true,则只有机构白名单中的用户可以使用此提供程序登录。

3.26.2. Google OAuth 配置字段

表 3.31. Google OAuth 字段

字段类型描述

FEATURE_GOOGLE_LOGIN

布尔值

是否支持 Google 登录。

**Default: False

GOOGLE_LOGIN_CONFIG

对象

使用 Google 进行外部身份验证的配置。

   .CLIENT_ID
   (Required)

字符串

此 Red Hat Quay 实例的注册的客户端 ID。

示例: 0e8dbe15c4c7630b6780

   .CLIENT_SECRET
(Required)

字符串

此 Red Hat Quay 实例注册的客户端 secret。

示例: e4a58ddd3d7408b7aec109e85564a0d153d3e846

3.27. OIDC 配置字段

表 3.32. OIDC 字段

字段

类型

描述

<string>_LOGIN_CONFIG
(Required)

字符串

包含 OIDC 配置设置的父键。通常,OIDC 供应商的名称,如 AZURE_LOGIN_CONFIG,但接受任何任意字符串。

.CLIENT_ID
(Required)

字符串

此 Red Hat Quay 实例的注册的客户端 ID。

示例: 0e8dbe15c4c7630b6780

.CLIENT_SECRET
(Required)

字符串

此 Red Hat Quay 实例注册的客户端 secret。

示例: e4a58ddd3d7408b7aec109e85564a0d153d3e846

.DEBUGLOG

布尔值

是否启用调试。

.LOGIN_BINDING_FIELD

字符串

当内部授权设置为 LDAP 时使用。Red Hat Quay 读取此参数,并尝试使用此用户名为用户搜索 LDAP 树。如果存在,它会自动创建到该 LDAP 帐户的链接。

.LOGIN_SCOPES

对象

添加 Red Hat Quay 用来与 OIDC 供应商通信的其他范围。

.OIDC_ENDPOINT_CUSTOM_PARAMS

字符串

支持 OIDC 端点上的自定义查询参数。支持以下端点: authorization_endpointtoken_endpointuser_endpoint

.OIDC_ISSUER

字符串

允许用户定义要验证的签发者。例如,JWT 令牌容器是一个称为 的参数,它定义谁发出了令牌。默认情况下,这从 .well-know/openid/configuration 端点读取,该端点由每个 OIDC 供应商公开。如果此验证失败,则没有登录。

.OIDC_SERVER
(Required)

字符串

用于身份验证的 OIDC 服务器地址。

https://sts.windows.net/6c878…​/

.PREFERRED_USERNAME_CLAIM_NAME

字符串

将首选用户名设置为令牌中的参数。

.SERVICE_ICON

字符串

更改登录屏幕上的图标。

.SERVICE_NAME
(Required)

字符串

正在验证的服务名称。

示例: Azure AD

.VERIFIED_EMAIL_CLAIM_NAME

字符串

用于验证用户电子邮件地址的声明名称。

3.27.1. OIDC 配置

以下示例显示了 OIDC 配置示例。

OIDC 配置示例

AZURE_LOGIN_CONFIG:
    CLIENT_ID: <client_id>
    CLIENT_SECRET: <client_secret>
    OIDC_SERVER: <oidc_server_address_>
    DEBUGGING: true
    SERVICE_NAME: Azure AD
    VERIFIED_EMAIL_CLAIM_NAME: <verified_email>
    OIDC_ENDPOINT_CUSTOM_PARAMS":
                "authorization_endpoint":
                    "some": "param",

3.28. 嵌套软件仓库配置字段

FEATURE_EXTENDED_REPOSITORY_NAMES 属性下添加了对嵌套存储库路径名称的支持。此可选配置默认添加到 config.yaml 中。启用允许在存储库名称中使用 /

表 3.33. OCI 和嵌套软件仓库配置字段

字段类型描述

FEATURE_EXTENDED_REPOSITORY_NAMES

布尔值

启用对嵌套存储库的支持

默认: True

OCI 和嵌套存储库配置示例

FEATURE_EXTENDED_REPOSITORY_NAMES: true

3.29. QuayIntegration 配置字段

以下配置字段可用于 QuayIntegration 自定义资源:

Name描述模式

allowlistNamespaces
(可选)

要包含的命名空间列表。

Array

clusterid
(Required)

与此集群关联的 ID。

字符串

credentialsSecret.key
(Required)

包含与 Quay registry 通信的凭据的机密。

对象

denylistNamespaces
(可选)

要排除的命名空间列表。

Array

insecureRegistry
(Optional)

是否跳过 Quay registry 的 TLS 验证

布尔值

quayHostname
(Required)

Quay registry 的主机名。

字符串

scheduledImageStreamImport
(Optional)

是否启用镜像流导入。

布尔值

3.30. 邮件配置字段

表 3.34. 邮件配置字段

字段类型描述

FEATURE_MAILING

布尔值

电子邮件是否已启用

默认: False

MAIL_DEFAULT_SENDER

字符串

如果指定了,当 Red Hat Quay 发送电子邮件时,电子邮件地址用作 from。如果没有,则默认为 support@quay.io

示例: support@example.com

MAIL_PASSWORD

字符串

发送电子邮件时要使用的 SMTP 密码

MAIL_PORT

Number

要使用的 SMTP 端口。如果没有指定,则默认为 587。

MAIL_SERVER

字符串

用于发送电子邮件的 SMTP 服务器。只有在将 FEATURE_MAILING 设置为 true 时才需要。

Example: smtp.example.com

MAIL_USERNAME

字符串

发送电子邮件时使用的 SMTP 用户名

MAIL_USE_TLS

布尔值

如果指定,是否使用 TLS 发送电子邮件

默认: True

3.31. 用户配置字段

表 3.35. 用户配置字段

字段类型描述

FEATURE_SUPER_USERS

布尔值

超级用户是否被支持

默认: true

FEATURE_USER_CREATION

布尔值

是否可以创建用户(通过非超级用户)

Default: true

FEATURE_USER_LAST_ACCESSED

布尔值

是否记录用户最后一次访问的时间

默认: true

FEATURE_USER_LOG_ACCESS

布尔值

如果设置为 true,则用户有权访问其命名空间的审计日志

默认: false

FEATURE_USER_METADATA

布尔值

是否收集和支持用户元数据

默认: false

FEATURE_USERNAME_CONFIRMATION

布尔值

如果设置为 true,用户可以在通过 OpenID Connect (OIDC)登录或非数据库内部身份验证提供程序(如 LDAP)登录时确认和修改其初始用户名。
默认: true

FEATURE_USER_RENAME

布尔值

如果设置为 true,用户可以重命名自己的命名空间

默认: false

FEATURE_INVITE_ONLY_USER_CREATION

布尔值

创建的用户都必须被其他用户邀请

默认: false

FRESH_LOGIN_TIMEOUT

字符串

新登录需要用户重新输入其密码的时间

示例5m

USERFILES_LOCATION

字符串

存储引擎的 ID,在其中放置用户上传的文件

示例s3_us_east

USERFILES_PATH

字符串

storage 下放置用户上传文件的路径

示例userfiles

USER_RECOVERY_TOKEN_LIFETIME

字符串

恢复用户帐户的令牌的时间长度为有效的

Pattern:^[0-9]+(w|m|d|h|s)$
Default:30m

FEATURE_SUPERUSERS_FULL_ACCESS

布尔值

授予超级用户从命名空间中没有拥有或具有显式权限的命名空间中从其他存储库中读取、写入和删除内容的权限。

Default: False

FEATURE_SUPERUSERS_ORG_CREATION_ONLY

布尔值

是否只允许超级用户创建机构。

Default: False

FEATURE_RESTRICTED_USERS

布尔值

当使用 RESTRICTED_USERS_WHITELIST 设置时,受限用户无法在自己的命名空间中创建机构或内容。普通权限适用于机构成员资格,例如,根据他们所属的团队,受限用户仍会在机构中具有正常权限。

Default: False

RESTRICTED_USERS_WHITELIST

字符串

当使用 FEATURE_RESTRICTED_USERS: true 设置时,特定用户不包括在 FEATURE_RESTRICTED_USERS 设置中。

GLOBAL_READONLY_SUPER_USERS

字符串

设置后,授予此列表的用户读取所有存储库的访问权限,无论它们是公共存储库。

3.31.1. 用户配置字段引用

使用以下引用,使用所需的配置字段更新 config.yaml 文件。

3.31.1.1. FEATURE_SUPERUSERS_FULL_ACCESS 配置参考

---
SUPER_USERS:
- quayadmin
FEATURE_SUPERUSERS_FULL_ACCESS: True
---

3.31.1.2. GLOBAL_READONLY_SUPER_USERS 配置参考

---
GLOBAL_READONLY_SUPER_USERS:
      - user1
---

3.31.1.3. FEATURE_RESTRICTED_USERS 配置参考

---
AUTHENTICATION_TYPE: Database
---
---
FEATURE_RESTRICTED_USERS: true
---

3.31.1.4. RESTRICTED_USERS_WHITELIST 配置参考

先决条件

  • config.yaml 文件中,FEATURE_RESTRICTED_USERS 设置为 true
---
AUTHENTICATION_TYPE: Database
---
---
FEATURE_RESTRICTED_USERS: true
RESTRICTED_USERS_WHITELIST:
      - user1
---
注意

当设置此字段时,即使将 FEATURE_RESTRICTED_USERS 设置为 true,也可以将白名单创建机构或从存储库中读取或写入内容。其他用户(如 user2、 user3user4) 受创建机构、读取或写入内容的限制

3.32. reCAPTCHA 配置字段

表 3.36. reCAPTCHA 配置字段

字段类型描述

FEATURE_RECAPTCHA

布尔值

用户登录和恢复是否需要 Recaptcha

Default: False

RECAPTCHA_SECRET_KEY

字符串

如果启用了 recaptcha,则 Recaptcha 服务的 secret 键

RECAPTCHA_SITE_KEY

字符串

如果启用了 recaptcha,则 Recaptcha 服务的站点键

3.33. ACI 配置字段

表 3.37. ACI 配置字段

字段类型描述

FEATURE_ACI_CONVERSION

布尔值

是否启用转换为 ACI

默认: False

GPG2_PRIVATE_KEY_FILENAME

字符串

用于解密 ACI 的私钥的文件名

GPG2_PRIVATE_KEY_NAME

字符串

用于为 ACI 签名的私钥的名称

GPG2_PUBLIC_KEY_FILENAME

字符串

用于加密 ACI 的公钥的文件名

3.34. JWT 配置字段

表 3.38. JWT 配置字段

字段类型描述

JWT_AUTH_ISSUER

字符串

JWT 用户的端点

Pattern:^http (s)?://(.)+$
Example:http://192.168.99.101:6060

JWT_GETUSER_ENDPOINT

字符串

JWT 用户的端点
Pattern:^http (s)?://(.)+$
Example:http://192.168.99.101:6060

JWT_QUERY_ENDPOINT

字符串

JWT 查询的端点

Pattern:^http (s)?://(.)+$
Example:http://192.168.99.101:6060

JWT_VERIFY_ENDPOINT

字符串

JWT 验证的端点

Pattern:^http (s)?://(.)+$
Example:http://192.168.99.101:6060

3.35. 应用程序令牌配置字段

表 3.39. 应用程序令牌配置字段

字段类型描述

FEATURE_APP_SPECIFIC_TOKENS

布尔值

如果启用,用户可以创建供 Docker CLI 使用的令牌

Default: True

APP_SPECIFIC_TOKEN_EXPIRATION

字符串

外部应用程序令牌的过期。

Default None
Pattern: ^[0-9]+(w|m|d|h|s)$

EXPIRED_APP_SPECIFIC_TOKEN_GC

字符串

外部应用程序令牌在垃圾回收前保留的时长

默认: 1d

3.36. 其它配置字段

表 3.40. 其它配置字段

字段类型描述

ALLOW_PULLS_WITHOUT_STRICT_LOGGING

字符串

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

默认 : False

AVATAR_KIND

字符串

要显示的 avatars 的类型,可生成内联(本地)或 Gravatar (gravatar)

Values: local, gravatar

BROWSER_API_CALLS_XHR_ONLY

布尔值

如果启用,则只允许被标记为来自浏览器的、由 XHR 发出的 API 调用

默认: True

DEFAULT_NAMESPACE_MAXIMUM_BUILD_COUNT

Number

可以在命名空间中排队的默认最大构建数。

Default: None

ENABLE_HEALTH_DEBUG_SECRET

字符串

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

EXTERNAL_TLS_TERMINATION

布尔值

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

FRESH_LOGIN_TIMEOUT

字符串

新登录需要用户重新输入密码的时间

示例: 5m

HEALTH_CHECKER

字符串

配置的健康检查

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

PROMETHEUS_NAMESPACE

字符串

应用到所有公开的 Prometheus 指标的前缀

默认: quay

PUBLIC_NAMESPACES

字符串数组

如果命名空间定义在公共命名空间列表中,则它将在 所有 用户的存储库列表页上显示,无论用户是否是命名空间的成员。通常,这供企业客户用于配置一组"well-known"命名空间。

REGISTRY_STATE

字符串

registry 的状态

值: normalread-only

SEARCH_MAX_RESULT_PAGE_COUNT

Number

用户在限制前可以分页搜索的最大页面数

默认:10

SEARCH_RESULTS_PER_PAGE

Number

搜索页面返回的结果数

默认:10

V2_PAGINATION_SIZE

Number

V2 registry API 中每个页面返回的结果数量

默认: 50

WEBHOOK_HOSTNAME_BLACKLIST

字符串数组

验证时不允许 webhook 的主机名集合,而不是 localhost 之外

CREATE_PRIVATE_REPO_ON_PUSH

布尔值

通过 push 创建新软件仓库是否被设置为私有可见

默认: True

CREATE_NAMESPACE_ON_PUSH

布尔值

新推送到不存在的机构时是否创建它

默认: False

NON_RATE_LIMITED_NAMESPACES

字符串数组

如果使用 FEATURE_RATE_LIMITS 启用了速率限制,您可以为需要无限访问的特定命名空间覆盖它。

FEATURE_UI_V2

布尔值

设置后,允许用户尝试 beta UI 环境。

Default: True

FEATURE_REQUIRE_TEAM_INVITE

布尔值

在将用户添加到团队时是否需要邀请

默认值: True

FEATURE_REQUIRE_ENCRYPTED_BASIC_AUTH

布尔值

未加密的密码(而不是加密令牌)都可用于基本 auth

默认值: False

FEATURE_RATE_LIMITS

布尔值

是否启用对 API 和 registry 端点的速率限制。将 FEATURE_RATE_LIMITS 设置为 true 会导致 nginx 将某些 API 调用限制为每秒 30 个。如果没有设置该功能,API 调用会每秒限制为 300 个(有效无限)。

Default: False

FEATURE_FIPS

布尔值

如果设置为 true,Red Hat Quay 将使用 FIPS 兼容哈希功能运行

Default: False

FEATURE_AGGREGATED_LOG_COUNT_RETRIEVAL

布尔值

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

Default: True

FEATURE_ANONYMOUS_ACCESS

布尔值

是否允许匿名用户浏览和拉取公共存储库

默认值: True

FEATURE_DIRECT_LOGIN

布尔值

用户是否可以直接登录到 UI

默认值: True

FEATURE_LIBRARY_SUPPORT

布尔值

从 Docker

默认值拉取和推送时是否允许"无命名空间"存储库默认值

FEATURE_PARTIAL_USER_AUTOCOMPLETE

布尔值

如果设置为 true,则自动完成将应用到部分 usernames+
Default: True

FEATURE_PERMANENT_SESSIONS

布尔值

会话是永久的

默认值: True

FEATURE_PUBLIC_CATALOG

布尔值

如果设置为 true,_catalog 端点会返回公共存储库。否则,只能返回私有存储库。

Default: False

3.37. 旧配置字段

以下字段已弃用或过时。

表 3.41. 旧配置字段

字段类型描述

FEATURE_BLACKLISTED_EMAILS

布尔值

如果设置为 true,则如果电子邮件域列入黑名单,则无法创建新的用户帐户

BLACKLISTED_EMAIL_DOMAINS

字符串数组

FEATURE_BLACKLISTED_EMAILS 设置为 true 时使用的电子邮件地址域列表

示例:" example.com", "example.org"

BLACKLIST_V2_SPEC

字符串

Red Hat Quay 将响应 V2 的 Docker CLI 版本 不被支持

示例 : <1.8.0
Default: &lt ;1.6.0

DOCUMENTATION_ROOT

字符串

文档链接的根 URL

SECURITY_SCANNER_V4_NAMESPACE_WHITELIST

字符串

应该启用安全扫描程序的命名空间

FEATURE_RESTRICTED_V1_PUSH

布尔值

如果设置为 true,则只有 V1_PUSH_WHITELIST 中列出的命名空间支持 V1 push

Default: True

V1_PUSH_WHITELIST

字符串数组

如果 FEATURE_RESTRICTED_V1_PUSH 设置为 true,支持 V1 push 的命名空间名称的数组

FEATURE_HELM_OCI_SUPPORT

布尔值

启用对 Helm 工件的支持。

默认值: False

3.38. 用户界面 v2 配置字段

表 3.42. 用户界面 v2 配置字段

字段类型描述

FEATURE_UI_V2

布尔值

设置后,允许用户尝试 beta UI 环境。

Default: False

3.38.1. v2 用户界面配置

启用 FEATURE_UI_V2 后,您可以在用户界面和用户界面的新版本间切换。

重要
  • 这个 UI 目前处于 beta 阶段,可能会有变化。在当前状态下,用户只能创建、查看和删除组织、存储库和镜像标签。
  • 在旧 UI 中运行 Red Hat Quay 时,超时会话要求用户在弹出窗口中再次输入密码。使用新的 UI 时,用户返回到主页面,需要输入其用户名和密码凭证。这是一个已知问题,并将在以后的 UI 版本中解决。
  • 在旧 UI 和新 UI 之间如何报告镜像清单大小有一个差异。在传统的 UI 中,以兆字节为单位报告镜像清单。在新的 UI 中,Red Hat Quay 使用 MB (MB)的标准定义来报告镜像清单大小。

流程

  1. 在部署的 config.yaml 文件中,添加 FEATURE_UI_V2 参数并将其设置为 true,例如:

    ---
    FEATURE_TEAM_SYNCING: false
    FEATURE_UI_V2: true
    FEATURE_USER_CREATION: true
    ---
  2. 登录到您的 Red Hat Quay 部署。
  3. 在 Red Hat Quay 部署的导航窗格中,会给一个可以在 Current UINew UI 之间切换的选项。点切换按钮将其设置为新的 UI,然后点 Use Beta Environment,例如:

    Red Hat Quay v2 UI toggle

3.39. IPv6 配置字段

表 3.43. IPv6 配置字段

字段类型描述

FEATURE_LISTEN_IP_VERSION

字符串

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

默认: IPv4

其他配置: IPv6双栈

3.40. 品牌配置字段

表 3.44. 品牌配置字段

字段类型Description

品牌

对象

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

.logo
(Required)

字符串

主徽标镜像 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

3.40.1. Red Hat Quay 品牌配置示例

品牌 config.yaml 示例

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/

3.41. 会话超时配置字段

以下配置字段依赖于相同名称的 Flask API 配置字段。

表 3.45. 会话注销配置字段

字段类型描述

PERMANENT_SESSION_LIFETIME

整数

用于设置永久会话的过期日期 的时间增量。默认值为 31 天,这会在大约一个月后保持永久会话。

默认: 2678400

3.41.1. 会话超时配置示例

以下 YAML 是启用会话生命周期时的建议配置。

重要

不建议更改会话生命周期。在设置会话超时时,管理员应了解分配的时间。如果您设置的时间过早,它可能会中断您的工作流。

会话超时 YAML 配置

PERMANENT_SESSION_LIFETIME: 3000

第 4 章 环境变量

Red Hat Quay 支持许多用于动态配置的环境变量。

4.1. geo-replication

所有区域应当使用相同的配置,但存储后端除外,这些后端可以使用 QUAY_DISTRIBUTED_STORAGE_PREFERENCE 环境变量明确进行配置。

表 4.1. geo-replication 配置

变量类型描述

QUAY_DISTRIBUTED_STORAGE_PREFERENCE

字符串

要使用的首选存储引擎(由 DISTRIBUTED_STORAGE_CONFIG 中的 ID)。

4.2. 数据库连接池

Red Hat Quay 由很多不同的进程组成,它们都在同一个容器中运行。很多进程与数据库交互。

如果启用,与数据库交互的每个进程都将包含一个连接池。这些每个进程连接池配置为最多维护 20 个连接。在负载过重时,可以为 Red Hat Quay 容器中的每个进程填充连接池。在某些部署和负载下,这可能需要分析以确保 Red Hat Quay 不会超过配置的数据库的最大连接数。

连接池将释放闲置连接。要立即发布所有连接,Red Hat Quay 需要重启。

通过将环境变量 DB_CONNECTION_POOLING 设置为 truefalse,可以切换数据库连接池。

表 4.2. 数据库连接池配置

变量类型描述

DB_CONNECTION_POOLING

布尔值

启用或禁用数据库连接池

如果启用了数据库连接池,则可以更改连接池的最大大小。这可以通过以下 config.yaml 选项完成:

config.yaml

...
DB_CONNECTION_ARGS:
  max_connections: 10
...

4.3. HTTP 连接数

可以使用环境变量指定同时 HTTP 连接的数量。它们可以指定为整个组件,也可以指定特定组件。每个进程的默认值为 50 个并行连接。

表 4.3. HTTP 连接计数配置

变量类型描述

WORKER_CONNECTION_COUNT

Number

同时 HTTP 连接

默认: 50

WORKER_CONNECTION_COUNT_REGISTRY

Number

同步 registry 的 HTTP 连接

默认: WORKER_CONNECTION_COUNT

WORKER_CONNECTION_COUNT_WEB

Number

Web UI 同时 HTTP 连接

默认: WORKER_CONNECTION_COUNT

WORKER_CONNECTION_COUNT_SECSCAN

Number

Clair 的 HTTP 连接

Default: WORKER_CONNECTION_COUNT

4.4. worker 计数变量

表 4.4. worker 计数变量

变量类型描述

WORKER_COUNT

Number

进程数量的通用覆盖

WORKER_COUNT_REGISTRY

Number

指定处理 Quay 容器中 Registry 请求的进程数量

值: 864之间的整数

WORKER_COUNT_WEB

Number

指定处理容器中的 UI/Web 请求的进程数量

值: 232之间的整数

WORKER_COUNT_SECSCAN

Number

指定处理容器中的安全扫描(如 Clair)集成的进程数量

值: 整数。因为 Operator 为资源请求和限值指定 2 个 vCPU,所以在 24 之间设置这个值是安全的。但是,如果保证,用户可以运行更多,例如 16 个。

4.5. 调试变量

Red Hat Quay 上提供以下调试变量。

表 4.5. 调试配置变量

变量类型描述

DEBUGLOG

布尔值

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

用户_DEBUG

整数.01

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

重要

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

第 5 章 Clair for Red Hat Quay

Clair v4 (Clair)是一个开源应用程序,它利用静态代码分析来解析镜像内容和报告影响内容的漏洞。Clair 与 Red Hat Quay 打包,并可用于独立和 Operator 部署。它可以在高度可扩展的配置中运行,其中组件可根据企业环境单独扩展。

5.1. Clair 配置概述

Clair 由一个结构化的 YAML 文件配置。每个 Clair 节点都需要指定其将在其中运行的模式,以及通过 CLI 标志或环境变量的配置文件的路径。例如:

$ clair -conf ./path/to/config.yaml -mode indexer

或者

$ clair -conf ./path/to/config.yaml -mode matcher

以上命令各自使用相同的配置文件启动两个 Clair 节点。一个运行索引功能,另一个则运行匹配的功能。

如果您以 组合 模式运行 Clair,则必须在配置中提供索引器、匹配器和通知程序配置块。

5.1.1. 在代理环境中使用 Clair 的信息

如果需要,可以指定 Go 标准库所遵守的环境变量,例如:

  • HTTP_PROXY

    $ export http://<user_name>:<password>@<proxy_host>:<proxy_port>
  • HTTPS_PROXY.

    $ export https://<user_name>:<password>@<proxy_host>:<proxy_port>
  • SSL_CERT_DIR.

    $ export SSL_CERT_DIR=/<path>/<to>/<ssl>/<certificates>

如果您使用带有 Clair 更新器 URL 的环境中的代理服务器,您必须识别哪些 URL 需要添加到代理允许列表中,以确保 Clair 可以访问它们。例如: osv updater 需要访问 https://osv-vulnerabilities.storage.googleapis.com 来获取生态系统数据转储。在这种情况下,URL 必须添加到代理允许列表中。有关 updater URL 的完整列表,请参阅"Clair updater URL"。

您还必须确保将标准 Clair URL 添加到代理允许列表中:

  • https://search.maven.org/solrsearch/select
  • https://catalog.redhat.com/api/containers/
  • https://access.redhat.com/security/data/metrics/repository-to-cpe.json
  • https://access.redhat.com/security/data/metrics/container-name-repos-map.json

在配置代理服务器时,请考虑启用 Clair 和这些 URL 之间的无缝通信所需的任何身份验证要求或特定的代理设置。通过全面记录并解决这些注意事项,您可以确保在通过代理路由更新器流量的同时,有效处理 Clair 功能。

5.1.2. Clair 配置参考

以下 YAML 显示了一个 Clair 配置示例:

http_listen_addr: ""
introspection_addr: ""
log_level: ""
tls: {}
indexer:
    connstring: ""
    scanlock_retry: 0
    layer_scan_concurrency: 5
    migrations: false
    scanner: {}
    airgap: false
matcher:
    connstring: ""
    indexer_addr: ""
    migrations: false
    period: ""
    disable_updaters: false
    update_retention: 2
matchers:
    names: nil
    config: nil
updaters:
    sets: nil
    config: nil
notifier:
    connstring: ""
    migrations: false
    indexer_addr: ""
    matcher_addr: ""
    poll_interval: ""
    delivery_interval: ""
    disable_summary: false
    webhook: null
    amqp: null
    stomp: null
auth:
  psk: nil
trace:
    name: ""
    probability: null
    jaeger:
        agent:
            endpoint: ""
        collector:
            endpoint: ""
            username: null
            password: null
        service_name: ""
        tags: nil
        buffer_max: 0
metrics:
    name: ""
    prometheus:
        endpoint: null
    dogstatsd:
        url: ""
注意

为了完整,以上 YAML 文件列出了每个键。使用此配置文件原样将导致一些选项不会正常设置默认值。

5.1.3. Clair 常规字段

下表描述了 Clair 部署可用的常规配置字段。

字段Typhttp_listen_ae描述

http_listen_addr

字符串

配置公开 HTTP API 的位置。

默认: :6060

introspection_addr

字符串

配置 Clair 的指标和健康端点公开的位置。

log_level

字符串

设置日志级别。需要以下字符串之一: debug-colordebuginfowarnerrorfatalpanic

tls

字符串

包含提供 TLS/SSL 和 HTTP/2 的 HTTP API 配置的映射。

.cert

字符串

要使用的 TLS 证书。必须是全链证书。

常规 Clair 字段的配置示例

以下示例显示了 Clair 配置。

常规 Clair 字段的配置示例

# ...
http_listen_addr: 0.0.0.0:6060
introspection_addr: 0.0.0.0:8089
log_level: info
# ...

5.1.4. Clair 索引器配置字段

下表描述了 Clair 的 indexer 组件的配置字段。

字段类型描述

indexer

对象

提供 Clair 索引器节点配置。

.airgap

布尔值

为索引器和获取者禁用对互联网的 HTTP 访问。允许私有 IPv4 和 IPv6 地址。数据库连接不受影响。

.connstring

字符串

Postgres 连接字符串。接受格式为 URL 或 libpq 连接字符串。

.index_report_request_concurrency

整数

速率限制索引报告创建请求的数量。把它设置为 0, 以自动调整此值的大小。设置负值意味着无限。自动大小是可用内核数的倍数。

如果超过并发状态,API 会返回 429 状态代码。

.scanlock_retry

整数

代表秒的正整数。在清单扫描时并发索引器锁定,以避免冲突。这个值调整等待索引器轮询锁定的频率。

.layer_scan_concurrency

整数

正整数限制并发层扫描的数量。Indexers 将同时匹配清单的层。这个值调整索引程序并行扫描的层数。

.migrations

布尔值

索引器节点是否处理迁移到其数据库的迁移。

.scanner

字符串

索引器配置。

扫描程序允许将配置选项传递给层扫描程序。如果设计这样做,扫描程序会将此配置传递给它。

.scanner.dist

字符串

特定扫描程序名称和任意 YAML 作为值的映射。

.scanner.package

字符串

特定扫描程序名称和任意 YAML 作为值的映射。

.scanner.repo

字符串

特定扫描程序名称和任意 YAML 作为值的映射。

indexer 配置示例

以下示例显示了 Clair 的 hypothetical indexer 配置。

indexer 配置示例

# ...
indexer:
  connstring: host=quay-server.example.com port=5433 dbname=clair user=clairuser password=clairpass sslmode=disable
  scanlock_retry: 10
  layer_scan_concurrency: 5
  migrations: true
# ...

5.1.5. Clair 匹配程序配置字段

下表描述了 Clair 的 matcher 组件的配置字段。

注意

matchers 配置字段不同。

字段类型描述

matcher

对象

提供 Clair 匹配器节点配置。

.cache_age

字符串

控制用户应提示缓存响应的时间。

.connstring

字符串

Postgres 连接字符串。接受格式为 URL 或 libpq 连接字符串。

.max_conn_pool

整数

限制数据库连接池大小。

Clair 允许自定义连接池大小。这个数字直接设定同时允许的活跃数据库连接的数量。

这个参数将在以后的发行版本中被忽略。用户应该通过连接字符串进行配置。

.indexer_addr

字符串

匹配者联系索引程序来创建漏洞报告。需要此索引器的位置。

默认值为 30m

.migrations

布尔值

匹配器节点是否处理迁移到其数据库的迁移。

.period

字符串

决定新安全公告的更新频率。

默认值为 30m

.disable_updaters

布尔值

是否运行后台更新。

Default: False

.update_retention

整数

设置在垃圾回收周期之间保留的更新操作数量。这应该根据数据库大小限制设置为安全 MAX 值。

默认值为 10m

如果提供小于 0 的值,则禁用垃圾回收。2 是确保可将更新与通知进行比较的最小值。

matcher 配置示例

matcher 配置示例

# ...
matcher:
  connstring: >-
    host=<DB_HOST> port=5432 dbname=<matcher> user=<DB_USER> password=D<B_PASS>
    sslmode=verify-ca sslcert=/etc/clair/ssl/cert.pem sslkey=/etc/clair/ssl/key.pem
    sslrootcert=/etc/clair/ssl/ca.pem
  indexer_addr: http://clair-v4/
  disable_updaters: false
  migrations: true
  period: 6h
  update_retention: 2
# ...

5.1.6. Clair 匹配器配置字段

下表描述了 Clair 的 matchers 组件的配置字段。

注意

matcher 配置字段不同。

表 5.1. matchers 配置字段

字段类型描述

matchers

字符串数组

为树内 匹配器提供配置

.names

字符串

一个字符串值列表,用于告知匹配者工厂关于启用的匹配者信息。如果值设为 null,则默认匹配者列表将运行。以下字符串被接受: alpine-matcher,aws-matcher,debian-matcher,gobin,java-maven,oracle,photon,python, rhel ,rhel -container-matcher,ruby, suse ,suse,ubuntu-matcher

.config

字符串

为特定匹配程序提供配置。

由匹配者名称的键的映射,其中包含将提供给 matchers 工厂构造器的子对象。例如:

matchers 配置示例

以下示例显示了一个假设的 Clair 部署,它只需要 alpine,aws,debian,oracle matchers。

matchers 配置示例

# ...
matchers:
  names:
  - "alpine-matcher"
  - "aws"
  - "debian"
  - "oracle"
# ...

5.1.7. Clair updaters 配置字段

下表描述了 Clair 的 updaters 组件 的配置字段

表 5.2. 更新器配置字段

字段类型描述

updaters

对象

为匹配器的更新管理器提供配置。

.sets

字符串

一个值列表,告知更新管理器要运行的更新程序。

如果值设为 null,则默认更新程序将运行以下内容: alpine,aws,clair.cvss,debian,oracle,photon,osv,rhel,rhcc suse,0.11.0-

如果留空,则运行零 updaters。

.config

字符串

为特定更新器集提供配置。

由 updater 集名称的键的映射,其中包含将提供给 updater 设置构造器的子对象。有关每个 updater 的子对象列表,请参阅"高级更新器配置"。

updaters 配置示例

在以下配置中,仅配置 rhel 集。也定义了特定于 rhel 更新器的 ignore_unpatched 变量。

updaters 配置示例

# ...
updaters:
  sets:
    - rhel
  config:
    rhel:
      ignore_unpatched: false
# ...

5.1.8. Clair 通知程序配置字段

Clair 的一般通知程序配置字段如下。

字段类型描述

通知程序

对象

提供 Clair notifier 节点配置。

.connstring

字符串

postgres 连接字符串。接受格式为 URL 或 libpq 连接字符串。

.migrations

布尔值

通知节点是否处理迁移到其数据库的迁移。

.indexer_addr

字符串

通知程序联系索引器来创建或获取受漏洞影响的清单。需要此索引器的位置。

.matcher_addr

字符串

通知程序联系一个匹配者来列出更新操作并获取 diffs。这个匹配器的位置是必需的。

.poll_interval

字符串

通知程序查询匹配程序更新操作的频率。

.delivery_interval

字符串

通知程序尝试发送创建的频率,或者以前失败的通知。

.disable_summary

布尔值

控制是否应为每个清单将通知总结到一个。

通知程序配置示例

以下 通知程序 片断用于最小配置。

通知程序配置示例

# ...
notifier:
  connstring: >-
    host=DB_HOST port=5432 dbname=notifier user=DB_USER password=DB_PASS
    sslmode=verify-ca sslcert=/etc/clair/ssl/cert.pem sslkey=/etc/clair/ssl/key.pem
    sslrootcert=/etc/clair/ssl/ca.pem
  indexer_addr: http://clair-v4/
  matcher_addr: http://clair-v4/
  delivery_interval: 5s
  migrations: true
  poll_interval: 15s
  webhook:
    target: "http://webhook/"
    callback: "http://clair-notifier/notifier/api/v1/notifications"
    headers: ""
  amqp: null
  stomp: null
# ...

5.1.8.1. Clair Webhook 配置字段

以下 Webhook 字段可用于 Clair 通知程序环境。

表 5.3. Clair Webhook 字段

.webhook

对象

配置 webhook 交付通知程序。

.webhook.target

字符串

发送 webhook 的 URL。

.webhook.callback

字符串

检索通知的回调 URL。通知 ID 将附加到此 URL。

这通常是托管 Clair notifier 的位置。

.webhook.headers

字符串

将标头名称与值列表关联的映射。

Webhook 配置示例

Webhook 配置示例

# ...
notifier:
# ...
  webhook:
    target: "http://webhook/"
    callback: "http://clair-notifier/notifier/api/v1/notifications"
# ...

5.1.8.2. Clair amqp 配置字段

以下高级消息队列协议(AMQP)字段可用于 Clair 通知程序环境。

.amqp

对象

配置用于 AMQP 交付的通知。

[NOTE] ==== Clair 不自行声明任何 AMQP 组件。所有尝试使用交换或队列的尝试都是被动的,将失败。代理管理员应提前设置交换和队列。===

.amqp.direct

布尔值

如果为 true,则通知程序会将各个通知(而非回调)提供给配置的 AMQP 代理。

.amqp.rollup

整数

amqp.direct 设为 true 时,这个值会告知通知通知在直接发送中发送多少通知。例如,如果 直接 设置为 true,并且 amqp.rollup 设置为 5,则通知程序在单个 JSON 有效负载中为代理提供超过 5 个通知。将值设为 0 实际的效果是将其设置为 1

.amqp.exchange

对象

要连接的 AMQP 交换。

.amqp.exchange.name

字符串

要连接的交换名称。

.amqp.exchange.type

字符串

交换的类型。通常,以下之一: directfanouttopicHeader

.amqp.exchange.durability

布尔值

配置的队列是 durable。

.amqp.exchange.auto_delete

布尔值

配置的队列是否使用 auto_delete_policy

.amqp.routing_key

字符串

每个通知的路由键的名称。

.amqp.callback

字符串

如果 amqp.direct 设为 false,则此 URL 在发送到代理的通知回调中提供。此 URL 应该指向 Clair 的通知 API 端点。

.amqp.uris

字符串

要连接的一个或多个 AMQP 代理的列表,按优先级顺序进行。

.amqp.tls

对象

配置到 AMQP 代理的 TLS/SSL 连接。

.amqp.tls.root_ca

字符串

可以读取 root CA 的文件系统路径。

.amqp.tls.cert

字符串

可以读取 TLS/SSL 证书的文件系统路径。

[NOTE] ==== Clair 还允许 SSL_CERT_DIR,如 Go crypto/x509 软件包所记录。====

.amqp.tls.key

字符串

读取 TLS/SSL 私钥的文件系统路径。

AMQP 配置示例

以下示例显示了 Clair 的 hypothetical AMQP 配置。

AMQP 配置示例

# ...
notifier:
# ...
  amqp:
    exchange:
        name: ""
        type: "direct"
        durable: true
        auto_delete: false
    uris: ["amqp://user:pass@host:10000/vhost"]
    direct: false
    routing_key: "notifications"
    callback: "http://clair-notifier/notifier/api/v1/notifications"
    tls:
     root_ca: "optional/path/to/rootca"
     cert: "madatory/path/to/cert"
     key: "madatory/path/to/key"
# ...

5.1.8.3. Clair STOMP 配置字段

Clair 通知程序环境提供了以下简单文本导向型消息协议(STOMP)字段。

.stomp对象为 STOMP 发送配置通知程序。

.stomp.direct

布尔值

如果为 true,则通知程序会向配置的 STOMP 代理提供单独的通知(而非回调)。

.stomp.rollup

整数

如果 stomp.direct 设为 true,则该值限制在单个直接交付中发送的通知数量。例如,如果 直接 设置为 true,并且 rollup 设置为 5,则通知程序在单个 JSON 有效负载中为代理提供超过 5 个通知。将值设为 0 实际的效果是将其设置为 1

.stomp.callback

字符串

如果 stomp.callback 设为 false,则通知回调中提供的 URL 将发送到代理。此 URL 应该指向 Clair 的通知 API 端点。

.stomp.destination

字符串

要发送通知的 STOMP 目的地。

.stomp.uris

字符串

按顺序连接的一个或多个 STOMP 代理的列表。

.stomp.tls

对象

配置到 STOMP 代理的 TLS/SSL 连接。

.stomp.tls.root_ca

字符串

可以读取 root CA 的文件系统路径。

[NOTE] ==== Clair 还尊重 SSL_CERT_DIR,如 Go crypto/x509 软件包所记录。====

.stomp.tls.cert

字符串

可以读取 TLS/SSL 证书的文件系统路径。

.stomp.tls.key

字符串

读取 TLS/SSL 私钥的文件系统路径。

.stomp.user

字符串

为 STOMP 代理配置登录详情。

.stomp.user.login

字符串

要连接的 STOMP 登录。

.stomp.user.passcode

字符串

要连接的 STOMP passcode。

STOMP 配置示例

以下示例显示了 Clair 的 hypothetical STOMP 配置。

STOMP 配置示例

# ...
notifier:
# ...
  stomp:
    desitnation: "notifications"
    direct: false
    callback: "http://clair-notifier/notifier/api/v1/notifications"
    login:
      login: "username"
      passcode: "passcode"
    tls:
     root_ca: "optional/path/to/rootca"
     cert: "madatory/path/to/cert"
     key: "madatory/path/to/key"
# ...

5.1.9. Clair 授权配置字段

以下授权配置字段可用于 Clair。

字段类型描述

auth

对象

定义 Clair 的外部和服务内 JWT 身份验证。如果定义了多个 auth 机制,Clair 会选择一个。目前,不支持多种机制。

.psk

字符串

定义预共享密钥身份验证。

.psk.key

字符串

所有方签名和验证 JWT 之间分发的共享 base64 编码密钥。

.psk.iss

字符串

用于验证的 JWT 签发者列表。空列表接受 JWT 声明中的任何签发者。

授权配置示例

以下 授权 片断用于最小配置。

授权配置示例

# ...
auth:
  psk:
    key: MTU5YzA4Y2ZkNzJoMQ== 1
    iss: ["quay"]
# ...

5.1.10. Clair trace 配置字段

以下 trace 配置字段可用于 Clair。

字段类型描述

trace

对象

定义基于 OpenTelemetry 的分布式追踪配置。

.name

字符串

应用程序跟踪的名称将属于。

.probability

整数

会发生 trace 的概率。

.jaeger

对象

定义 Jaeger 追踪的值。

.jaeger.agent

对象

定义配置发送到 Jaeger 代理的值。

.jaeger.agent.endpoint

字符串

< host>:<post&gt; 语法中的地址,可以提交 trace。

.jaeger.collector

对象

为配置发送到 Jaeger 收集器定义值。

.jaeger.collector.endpoint

字符串

< host>:<post&gt; 语法中的地址,可以提交 trace。

.jaeger.collector.username

字符串

Jaeger 用户名。

.jaeger.collector.password

字符串

Jaeger 密码。

.jaeger.service_name

字符串

在 Jaeger 中注册的服务名称。

.jaeger.tags

字符串

用于提供额外的元数据的键值对。

.jaeger.buffer_max

整数

在将内存缓冲到 Jaeger 后端前可缓冲的最大 span 数量,以存储和分析。

trace 配置示例

以下示例显示了 Clair 的 hypothetical trace 配置。

trace 配置示例

# ...
trace:
  name: "jaeger"
  probability: 1
  jaeger:
    agent:
      endpoint: "localhost:6831"
    service_name: "clair"
# ...

5.1.11. Clair 指标配置字段

以下指标配置字段可用于 Clair。

字段类型描述

metrics

对象

定义基于 OpenTelemetry 的分布式追踪配置。

.name

字符串

使用的指标的名称。

.prometheus

字符串

配置 Prometheus 指标导出器。

.prometheus.endpoint

字符串

定义提供指标的路径。

指标配置示例

以下示例显示了 Clair 的 hypothetical 指标配置。

指标配置示例

# ...
metrics:
  name: "prometheus"
  prometheus:
    endpoint: "/metricsz"
# ...

法律通告

Copyright © 2024 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.