Red Hat Quay Operator 的功能

流程

1. 登录 OpenShift Container Platform 控制台并选择 Storage → Persistent Volume Claims。
2. 为 PostgreSQL 13 或 Clair PostgreSQL 13 选择所需的 PersistentVolumeClaim，如 example-registry-quay-postgres-13。
3. 在 Action 菜单中，选择 Expand PVC。

4. 输入持久性卷声明的新大小，然后选择 Expand。

   几分钟后，扩展的大小应在 PVC 的 Capacity 字段中反映。

流程

1. ClusterServiceVersion 对象是集群中正在运行的 Operator 的 Operator Lifecycle Manager 表示。使用 Kubernetes UI 或 kubectl/oc CLI 工具查找 Red Hat Quay Operator 的 ClusterServiceVersion。例如：

   $ oc get clusterserviceversions -n <your-namespace>

   Copy to Clipboard Toggle word wrap

2. 使用 UI、oc edit 或其它方法修改 Red Hat Quay ClusterServiceVersion，使其包含上面概述的环境变量以指向覆盖镜像：

   jsonpath:spec.install.spec.deployments[0].spec.template.spec.containers[0].env

   - name: RELATED_IMAGE_COMPONENT_QUAY
     value: quay.io/projectquay/quay@sha256:c35f5af964431673f4ff5c9e90bdf45f19e38b8742b5903d41c10cc7f6339a6d
   - name: RELATED_IMAGE_COMPONENT_CLAIR
     value: quay.io/projectquay/clair@sha256:70c99feceb4c0973540d22e740659cd8d616775d3ad1c1698ddf71d0221f3ce6
   - name: RELATED_IMAGE_COMPONENT_POSTGRES
     value: centos/postgresql-10-centos7@sha256:de1560cb35e5ec643e7b3a772ebaac8e3a7a2a8e8271d9e91ff023539b4dfb33
   - name: RELATED_IMAGE_COMPONENT_REDIS
     value: centos/redis-32-centos7@sha256:06dbb609484330ec6be6090109f1fa16e936afcf975d1cbc5fff3e6c7cae7542

   Copy to Clipboard Toggle word wrap

流程

1. 为 Red Hat Quay 部署 postgres 实例。

2. 输入以下命令登录到数据库：

   psql -U <username> -h <hostname> -p <port> -d <database_name>

   Copy to Clipboard Toggle word wrap

3. 为 Red Hat Quay 创建名为 quay 的数据库。例如：

   CREATE DATABASE quay;

   Copy to Clipboard Toggle word wrap

4. 在数据库中启用 pg_trm 扩展

   \c quay;
   CREATE EXTENSION IF NOT EXISTS pg_trgm;

   Copy to Clipboard Toggle word wrap

5. 部署 Redis 实例：

   注意
   • 如果您的云供应商有自己的服务，则部署 Redis 实例可能是必需的。
   • 如果您使用 Builders，则需要部署 Redis 实例。
   1. 为 Redis 部署虚拟机
   2. 验证是否可以从运行 Red Hat Quay 的集群访问
   3. 必须打开端口 6379/TCP

   4. 在实例内运行 Redis

      sudo dnf install -y podman
      podman run -d --name redis -p 6379:6379 redis

      Copy to Clipboard Toggle word wrap
6. 创建两个对象存储后端，每个集群一个。理想情况下，一个对象存储桶将接近第一个或主集群，另一个则运行更接近第二个或次要集群。
7. 使用同一配置捆绑包部署集群，使用环境变量覆盖来为单个集群选择适当的存储后端。
8. 配置负载均衡器，以提供集群的单个入口点。

流程

1. 运行以下命令，同步所有定义的站点之间的 Blob：

   $ python -m util.backfillreplication

   Copy to Clipboard Toggle word wrap
   警告

   在从 Red Hat Quay config.yaml 文件中删除存储引擎 前，您必须确保在 所有定义的站点间同步所有 Blob。

   在运行此命令时，会创建复制作业，由复制工作程序提取。如果有需要复制的 Blob，该脚本会返回将复制的 Blob 的 UUID。如果您多次运行此命令，并且返回脚本的输出为空，并不意味着完成复制过程；这意味着没有更多 Blob 进行复制。客户应在继续前使用适当的 judgement，因为分配的时间复制取决于检测到的 Blob 数量。

   或者，您可以使用第三方云工具（如 Microsoft Azure）来检查同步状态。

   在继续之前，必须完成此步骤。

2. 在 Red Hat Quay config.yaml 文件中，删除 eu storage 站点的 DISTRIBUTED_STORAGE_CONFIG 条目。

3. 输入以下命令来标识 Quay 应用程序 pod：

   $ oc get pod -n <quay_namespace>

   Copy to Clipboard Toggle word wrap

   输出示例

   quay390usstorage-quay-app-5779ddc886-2drh2
   quay390eustorage-quay-app-66969cd859-n2ssm

   Copy to Clipboard Toggle word wrap

4. 输入以下命令在 usstorage pod 中打开交互式 shell 会话：

   $ oc rsh quay390usstorage-quay-app-5779ddc886-2drh2

   Copy to Clipboard Toggle word wrap

5. 输入以下命令永久删除 eustorage 站点：

   重要

   以下操作无法撤消。请谨慎使用。

   sh-4.4$ python -m util.removelocation eustorage

   Copy to Clipboard Toggle word wrap

   输出示例

   WARNING: This is a destructive operation. Are you sure you want to remove eustorage from your storage locations? [y/n] y
   Deleted placement 30
   Deleted placement 31
   Deleted placement 32
   Deleted placement 33
   Deleted location eustorage

   Copy to Clipboard Toggle word wrap

流程

1. 输入以下命令获取 Red Hat Quay pod 列表：

   $ oc get pods -n <namespace>

   Copy to Clipboard Toggle word wrap

   输出示例

   example-registry-clair-app-7dc7ff5844-4skw5           0/1     Error                    0             70d
   example-registry-clair-app-7dc7ff5844-nvn4f           1/1     Running                  0             31d
   example-registry-clair-app-7dc7ff5844-x4smw           0/1     ContainerStatusUnknown   6 (70d ago)   70d
   example-registry-clair-app-7dc7ff5844-xjnvt           1/1     Running                  0             60d
   example-registry-clair-postgres-547d75759-75c49       1/1     Running                  0             70d
   example-registry-quay-app-76c8f55467-52wjz            1/1     Running                  0             70d
   example-registry-quay-app-76c8f55467-hwz4c            1/1     Running                  0             70d
   example-registry-quay-app-upgrade-57ghs               0/1     Completed                1             70d
   example-registry-quay-database-7c55899f89-hmnm6       1/1     Running                  0             70d
   example-registry-quay-mirror-6cccbd76d-btsnb          1/1     Running                  0             70d
   example-registry-quay-mirror-6cccbd76d-x8g42          1/1     Running                  0             70d
   example-registry-quay-redis-85cbdf96bf-4vk5m          1/1     Running                  0             70d

   Copy to Clipboard Toggle word wrap

2. 输入以下命令打开到 Quay 容器的远程 shell 会话：

   $ oc rsh example-registry-quay-app-76c8f55467-52wjz

   Copy to Clipboard Toggle word wrap

3. 输入以下命令来创建所需的服务密钥：

   sh-4.4$ python3 tools/generatekeypair.py quay-readonly

   Copy to Clipboard Toggle word wrap

   输出示例

   Writing public key to quay-readonly.jwk
   Writing key ID to quay-readonly.kid
   Writing private key to quay-readonly.pem

   Copy to Clipboard Toggle word wrap

流程

1. 输入以下命令输入 Red Hat Quay 数据库环境：

   $ oc rsh example-registry-quay-app-76c8f55467-52wjz psql -U <database_username> -d <database_name>

   Copy to Clipboard Toggle word wrap

2. 输入以下命令显示 servicekeyapproval 的批准类型和相关备注：

   quay=# select * from servicekeyapproval;

   Copy to Clipboard Toggle word wrap

   输出示例

    id | approver_id |          approval_type           |       approved_date        | notes
   ----+-------------+----------------------------------+----------------------------+-------
     1 |             | ServiceKeyApprovalType.AUTOMATIC | 2024-05-07 03:47:48.181347 |
     2 |             | ServiceKeyApprovalType.AUTOMATIC | 2024-05-07 03:47:55.808087 |
     3 |             | ServiceKeyApprovalType.AUTOMATIC | 2024-05-07 03:49:04.27095  |
     4 |             | ServiceKeyApprovalType.AUTOMATIC | 2024-05-07 03:49:05.46235  |
     5 |           1 | ServiceKeyApprovalType.SUPERUSER | 2024-05-07 04:05:10.296796 |
   ...

   Copy to Clipboard Toggle word wrap

3. 输入以下查询在 Red Hat Quay 数据库中添加服务密钥：

   quay=# INSERT INTO servicekey
     (name, service, metadata, kid, jwk, created_date, expiration_date)
     VALUES ('quay-readonly',
              'quay',
              '{}',
              '{<contents_of_.kid_file>}',
              '{<contents_of_.jwk_file>}',
              '{<created_date_of_read-only>}',
              '{<expiration_date_of_read-only>}');

   Copy to Clipboard Toggle word wrap

   输出示例

   INSERT 0 1

   Copy to Clipboard Toggle word wrap

4. 接下来，使用以下查询添加密钥批准：

   quay=# INSERT INTO servicekeyapproval ('approval_type', 'approved_date', 'notes')
     VALUES ("ServiceKeyApprovalType.SUPERUSER", "CURRENT_DATE",
              {include_notes_here_on_why_this_is_being_added});

   Copy to Clipboard Toggle word wrap

   输出示例

   INSERT 0 1

   Copy to Clipboard Toggle word wrap

5. 将所创建的服务键行中的 approval_ id 字段设置为所创建的服务密钥批准中的 id 字段。您可以使用以下 SELECT 语句来获取必要的 ID：

   UPDATE servicekey
   SET approval_id = (SELECT id FROM servicekeyapproval WHERE approval_type = 'ServiceKeyApprovalType.SUPERUSER')
   WHERE name = 'quay-readonly';

   Copy to Clipboard Toggle word wrap

   UPDATE 1

   Copy to Clipboard Toggle word wrap

流程

1. 输入以下命令在 OpenShift Container Platform 部署中读取 Red Hat Quay 的 secret 名称：

   $ oc get deployment -o yaml <quay_main_app_deployment_name>

   Copy to Clipboard Toggle word wrap

2. 使用 base64 命令对 quay-readonly.kid 和 quay-readonly.pem 文件进行编码：

   $ base64 -w0 quay-readonly.kid

   Copy to Clipboard Toggle word wrap

   输出示例

   ZjUyNDFm...

   Copy to Clipboard Toggle word wrap

   $ base64 -w0 quay-readonly.pem

   Copy to Clipboard Toggle word wrap

   输出示例

   LS0tLS1CRUdJTiBSU0E...

   Copy to Clipboard Toggle word wrap

3. 输入以下命令来获取当前的配置捆绑包和 secret：

   $ oc get secret quay-config-secret-name -o json | jq '.data."config.yaml"' | cut -d '"' -f2 | base64 -d -w0 > config.yaml

   Copy to Clipboard Toggle word wrap

4. 编辑 config.yaml 文件并添加以下信息：

   # ...
   REGISTRY_STATE: readonly
   INSTANCE_SERVICE_KEY_KID_LOCATION: 'conf/stack/quay-readonly.kid'
   INSTANCE_SERVICE_KEY_LOCATION: 'conf/stack/quay-readonly.pem'
   # ...

   Copy to Clipboard Toggle word wrap

5. 运行以下命令保存文件和 base64 编码：

   $ base64 -w0 quay-config.yaml

   Copy to Clipboard Toggle word wrap

6. 将 Red Hat Quay Operator pod 缩减为 0。这样可确保 Operator 在编辑后不会协调 secret。

   $ oc scale --replicas=0 deployment quay-operator -n openshift-operators

   Copy to Clipboard Toggle word wrap

7. 编辑 secret 使其包含新内容：

   $ oc edit secret quay-config-secret-name -n quay-namespace

   Copy to Clipboard Toggle word wrap

   # ...
   data:
     "quay-readonly.kid": "ZjUyNDFm..."
     "quay-readonly.pem": "LS0tLS1CRUdJTiBSU0E..."
     "config.yaml": "QUNUSU9OX0xPR19..."
   # ...

   Copy to Clipboard Toggle word wrap

   在 OpenShift Container Platform 以只读模式部署 Red Hat Quay 时，您可以安全地管理 registry 的操作并执行如备份和恢复等操作。

流程

1. 要通过导出 QuayRegistry 自定义资源来支持 QuayRegistry 自定义资源，请输入以下命令：

   $ oc get quayregistry <quay_registry_name> -n <quay_namespace> -o yaml > quay-registry.yaml

   Copy to Clipboard Toggle word wrap

2. 编辑生成的 quayregistry.yaml 并删除 status 部分和以下 metadata 字段：

     metadata.creationTimestamp
     metadata.finalizers
     metadata.generation
     metadata.resourceVersion
     metadata.uid

   Copy to Clipboard Toggle word wrap

3. 输入以下命令备份受管密钥 secret：

   注意

   如果您正在运行早于 Red Hat Quay 3.7.0 的版本，可以跳过这一步。第一次部署 Red Hat Quay 时会自动生成一些 secret。它们存储在 QuayRegistry 资源的命名空间中名为 &lt ;quay_registry_name>-quay-registry-managed-secret-keys 的 secret 中。

   $ oc get secret -n <quay_namespace> <quay_registry_name>-quay-registry-managed-secret-keys -o yaml > managed_secret_keys.yaml

   Copy to Clipboard Toggle word wrap

4. 编辑生成的 managed_secret_keys.yaml 文件，并删除条目 metadata.ownerReferences。您的 managed_secret_keys.yaml 文件应类似于如下：

   apiVersion: v1
   kind: Secret
   type: Opaque
   metadata:
     name: <quay_registry_name>-quay-registry-managed-secret-keys
     namespace: <quay_namespace>
   data:
     CONFIG_EDITOR_PW: <redacted>
     DATABASE_SECRET_KEY: <redacted>
     DB_ROOT_PW: <redacted>
     DB_URI: <redacted>
     SECRET_KEY: <redacted>
     SECURITY_SCANNER_V4_PSK: <redacted>

   Copy to Clipboard Toggle word wrap

   data 属性下的所有信息都应保持不变。

5. 输入以下命令重定向当前的 Quay 配置文件：

   $ oc get secret -n <quay-namespace>  $(oc get quayregistry <quay_registry_name> -n <quay_namespace>  -o jsonpath='{.spec.configBundleSecret}') -o yaml > config-bundle.yaml

   Copy to Clipboard Toggle word wrap

6. 备份挂载到 Quay pod 中的 /conf/stack/config.yaml 文件：

   $ oc exec -it quay_pod_name -- cat /conf/stack/config.yaml > quay_config.yaml

   Copy to Clipboard Toggle word wrap

7. 获取 Quay 数据库名称：

   $ oc -n <quay_namespace> rsh $(oc get pod -l app=quay -o NAME -n <quay_namespace> |head -n 1) cat /conf/stack/config.yaml|awk -F"/" '/^DB_URI/ {print $4}'

   Copy to Clipboard Toggle word wrap

   输出示例

   quayregistry-quay-database

   Copy to Clipboard Toggle word wrap

流程

1. 根据 Red Hat Quay 部署的版本，使用以下选项之一缩减部署。

   1. 对于 Operator 版本 3.7 及更新版本： 通过禁用自动扩展并覆盖 Red Hat Quay、mirror worker 和 Clair （如果受管）的副本数来缩减 Red Hat Quay 部署。您的 QuayRegistry 资源应类似于如下：

      apiVersion: quay.redhat.com/v1
      kind: QuayRegistry
      metadata:
        name: registry
        namespace: ns
      spec:
        components:
          …
          - kind: horizontalpodautoscaler
            managed: false 

      1

      
          - kind: quay
            managed: true
            overrides: 

      2

      
              replicas: 0
          - kind: clair
            managed: true
            overrides:
              replicas: 0
          - kind: mirror
            managed: true
            overrides:
              replicas: 0
          …

      Copy to Clipboard Toggle word wrap

      1

      禁用 Quay、Clair 和 Mirroring worker 的自动扩展

      2

      对于访问数据库和 objectstorage 的组件，将副本数设置为 0。

   2. 对于 Operator 版本 3.6 及更早版本 ：首先缩减 Red Hat Quay registry，然后是管理的 Red Hat Quay 资源，以缩减 Red Hat Quay 部署：

      $ oc scale --replicas=0 deployment $(oc get deployment -n <quay-operator-namespace>|awk '/^quay-operator/ {print $1}') -n <quay-operator-namespace>

      Copy to Clipboard Toggle word wrap

      $ oc scale --replicas=0 deployment $(oc get deployment -n <quay-namespace>|awk '/quay-app/ {print $1}') -n <quay-namespace>

      Copy to Clipboard Toggle word wrap

      $ oc scale --replicas=0 deployment $(oc get deployment -n <quay-namespace>|awk '/quay-mirror/ {print $1}') -n <quay-namespace>

      Copy to Clipboard Toggle word wrap

      $ oc scale --replicas=0 deployment $(oc get deployment -n <quay-namespace>|awk '/clair-app/ {print $1}') -n <quay-namespace>

      Copy to Clipboard Toggle word wrap

2. 等待 registry-quay-app、registry-quay-mirror 和 registry-clair-app pod （取决于您设置为由 Red Hat Quay Operator 管理的组件）消失。您可以运行以下命令来检查其状态：

   $ oc get pods -n <quay_namespace>

   Copy to Clipboard Toggle word wrap

   输出示例：

   $ oc get pod

   Copy to Clipboard Toggle word wrap

   输出示例

   quay-operator.v3.7.1-6f9d859bd-p5ftc               1/1     Running     0             12m
   quayregistry-clair-postgres-7487f5bd86-xnxpr       1/1     Running     1 (12m ago)   12m
   quayregistry-quay-app-upgrade-xq2v6                0/1     Completed   0             12m
   quayregistry-quay-database-859d5445ff-cqthr        1/1     Running     0             12m
   quayregistry-quay-redis-84f888776f-hhgms           1/1     Running     0             12m

   Copy to Clipboard Toggle word wrap

流程

1. 识别 Quay PostgreSQL pod 名称：

   $ oc get pod -l quay-component=postgres -n <quay_namespace> -o jsonpath='{.items[0].metadata.name}'

   Copy to Clipboard Toggle word wrap

   输出示例：

   quayregistry-quay-database-59f54bb7-58xs7

   Copy to Clipboard Toggle word wrap

2. 下载备份数据库：

   $ oc -n <quay_namespace> exec quayregistry-quay-database-59f54bb7-58xs7 -- /usr/bin/pg_dump -C quayregistry-quay-database  > backup.sql

   Copy to Clipboard Toggle word wrap

1. 根据 Red Hat Quay 部署的版本，使用以下选项之一扩展部署：

   1. 对于 Operator 版本 3.7 及更新版本： 如果需要，通过重新启用自动扩展（如果需要），并删除 Quay、镜像 worker 和 Clair 的副本覆盖来扩展 Red Hat Quay 部署。您的 QuayRegistry 资源应类似于如下：

      apiVersion: quay.redhat.com/v1
      kind: QuayRegistry
      metadata:
        name: registry
        namespace: ns
      spec:
        components:
          …
          - kind: horizontalpodautoscaler
            managed: true 

      1

      
          - kind: quay 

      2

      
            managed: true
          - kind: clair
            managed: true
          - kind: mirror
            managed: true
          …

      Copy to Clipboard Toggle word wrap

      1

      重新启用 Quay、Clair 和 mirroring worker 的自动扩展（如果需要）

      2

      副本覆盖会再次删除，以扩展 Quay 组件备份

   2. 对于 Operator 版本 3.6 及更早版本： 通过扩展 Red Hat Quay registry 来扩展 Red Hat Quay 部署：

      $ oc scale --replicas=1 deployment $(oc get deployment -n <quay_operator_namespace> | awk '/^quay-operator/ {print $1}') -n <quay_operator_namespace>

      Copy to Clipboard Toggle word wrap

2. 输入以下命令检查 Red Hat Quay 部署的状态：

   $ oc wait quayregistry registry --for=condition=Available=true -n <quay_namespace>

   Copy to Clipboard Toggle word wrap

   输出示例：

   apiVersion: quay.redhat.com/v1
   kind: QuayRegistry
   metadata:
     ...
     name: registry
     namespace: <quay-namespace>
     ...
   spec:
     ...
   status:
     - lastTransitionTime: '2022-06-20T05:31:17Z'
       lastUpdateTime: '2022-06-20T17:31:13Z'
       message: All components reporting as healthy
       reason: HealthChecksPassing
       status: 'True'
       type: Available

   Copy to Clipboard Toggle word wrap

流程

1. 输入以下命令恢复备份的 Red Hat Quay 配置：

   $ oc create -f ./config-bundle.yaml

   Copy to Clipboard Toggle word wrap
   重要

   如果您接收到错误 Error from server (AlreadyExists): error when creating "./config-bundle.yaml": secrets "config-bundle-secret" already exists，您需要使用 $ oc delete Secret config-bundle-secret -n <quay-namespace> 删除现有的资源，并使用 $ oc create -f ./config-bundle.yaml 重新创建它。

2. 输入以下命令从备份中恢复生成的密钥：

   $ oc create -f ./managed-secret-keys.yaml

   Copy to Clipboard Toggle word wrap

3. 恢复 QuayRegistry 自定义资源：

   $ oc create -f ./quay-registry.yaml

   Copy to Clipboard Toggle word wrap

4. 检查 Red Hat Quay 部署的状态并等待它可用：

   $ oc wait quayregistry registry --for=condition=Available=true -n <quay-namespace>

   Copy to Clipboard Toggle word wrap

流程

1. 根据 Red Hat Quay 部署的版本，使用以下选项之一缩减部署。

   1. 对于 Operator 版本 3.7 及更新版本： 通过禁用自动扩展并覆盖 Quay、mirror worker 和 Clair （如果托管）的副本数来缩减 Red Hat Quay 部署。您的 QuayRegistry 资源应类似于如下：

      apiVersion: quay.redhat.com/v1
      kind: QuayRegistry
      metadata:
        name: registry
        namespace: ns
      spec:
        components:
          …
          - kind: horizontalpodautoscaler
            managed: false 

      1

      
          - kind: quay
            managed: true
            overrides: 

      2

      
              replicas: 0
          - kind: clair
            managed: true
            overrides:
              replicas: 0
          - kind: mirror
            managed: true
            overrides:
              replicas: 0
          …

      Copy to Clipboard Toggle word wrap

      1

      禁用 Quay、Clair 和 Mirroring worker 的自动扩展

      2

      对于访问数据库和 objectstorage 的组件，将副本数设置为 0。

   2. 对于 Operator 版本 3.6 及更早版本： 首先缩减 Red Hat Quay registry，然后是管理的 Red Hat Quay 资源，以缩减 Red Hat Quay 部署：

      $ oc scale --replicas=0 deployment $(oc get deployment -n <quay-operator-namespace>|awk '/^quay-operator/ {print $1}') -n <quay-operator-namespace>

      Copy to Clipboard Toggle word wrap

      $ oc scale --replicas=0 deployment $(oc get deployment -n <quay-namespace>|awk '/quay-app/ {print $1}') -n <quay-namespace>

      Copy to Clipboard Toggle word wrap

      $ oc scale --replicas=0 deployment $(oc get deployment -n <quay-namespace>|awk '/quay-mirror/ {print $1}') -n <quay-namespace>

      Copy to Clipboard Toggle word wrap

      $ oc scale --replicas=0 deployment $(oc get deployment -n <quay-namespace>|awk '/clair-app/ {print $1}') -n <quay-namespace>

      Copy to Clipboard Toggle word wrap

2. 等待 registry-quay-app、registry-quay-mirror 和 registry-clair-app pod （取决于您设置为由 Red Hat Quay Operator 管理的组件）消失。您可以运行以下命令来检查其状态：

   $ oc get pods -n <quay-namespace>

   Copy to Clipboard Toggle word wrap

   输出示例：

   registry-quay-config-editor-77847fc4f5-nsbbv   1/1     Running            0          9m1s
   registry-quay-database-66969cd859-n2ssm        1/1     Running            0          6d1h
   registry-quay-redis-7cc5f6c977-956g8           1/1     Running            0          5d21h

   Copy to Clipboard Toggle word wrap