Red Hat Quay Operator の OpenShift Container Platform へのデプロイ

手順

1. OpenShift Container Platform 開発者コンソールで、Operator → Installed Operators → Red Hat Quay をクリックします。
2. QuayRegistry をクリックします。
3. レジストリーの名前 (例: example-registry) をクリックします。
4. YAML をクリックします。

5. spec.components フィールドでは、.overrides.resources.limits および overrides.resources.requests フィールドに値を設定することで、quay、clair、mirroring clairpostgres、および postgres リソースのリソースをオーバーライドできます。以下に例を示します。

   spec:
     components:
       - kind: clair
         managed: true
         overrides:
           resources:
             limits:
               cpu: "5"     # Limiting to 5 CPU (equivalent to 5000m or 5000 millicpu)
               memory: "18Gi"  # Limiting to 18 Gibibytes of memory
             requests:
               cpu: "4"     # Requesting 4 CPU
               memory: "4Gi"   # Requesting 4 Gibibytes of memory
       - kind: postgres
         managed: true
         overrides:
           resources:
             limits: {} 

   1

   
             requests:
               cpu: "700m"   # Requesting 700 millicpu or 0.7 CPU
               memory: "4Gi"   # Requesting 4 Gibibytes of memory
       - kind: mirror
         managed: true
         overrides:
           resources:
             limits: 

   2

   
             requests:
               cpu: "800m"   # Requesting 800 millicpu or 0.8 CPU
               memory: "1Gi"   # Requesting 1 Gibibyte of memory
       - kind: quay
         managed: true
         overrides:
           resources:
             limits:
               cpu: "4"    # Limiting to 4 CPU
               memory: "10Gi"   # Limiting to 10 Gibibytes of memory
             requests:
               cpu: "4"   # Requesting 4 CPU
               memory: "10Gi"   # Requesting 10 Gibi of memory
       - kind: clairpostgres
         managed: true
         overrides:
           resources:
             limits:
               cpu: "800m"   # Limiting to 800 millicpu or 0.8 CPU
               memory: "3Gi"   # Limiting to 3 Gibibytes of memory
             requests: {}

   Copy to Clipboard Toggle word wrap

   1

   limits または requests フィールドを {} に設定すると、これらのリソースのデフォルト値が使用されます。

   2

   limits または requests フィールドを空のままにしておくと、これらのリソースに制限は設定されません。

手順

1. オプション: QuayRegistry YAML ファイルのローカルコピーがない場合は、次のコマンドを入力して取得します。

   $ oc get quayregistry <registry_name> -n <namespace> -o yaml > quayregistry.yaml

   Copy to Clipboard Toggle word wrap

2. この手順のステップ 1 で作成した quayregistry.yaml を開き、必要な変更を加えます。以下に例を示します。

       - kind: quay
         managed: true
         overrides:
           resources:
             limits: {}
             requests:
               cpu: "0.7"   # Requesting 0.7 CPU (equivalent to 500m or 500 millicpu)
               memory: "512Mi"   # Requesting 512 Mebibytes of memory

   Copy to Clipboard Toggle word wrap
3. 変更を保存します。

4. 次のコマンドを実行して、更新された設定を使用して Red Hat Quay レジストリーを適用します。

   $ oc replace -f quayregistry.yaml

   Copy to Clipboard Toggle word wrap

   出力例

   quayregistry.quay.redhat.com/example-registry replaced

   Copy to Clipboard Toggle word wrap

手順

1. 必要なデータベースフィールドを含む config.yaml ファイルを作成します。以下に例を示します。

   config.yaml ファイルの例:

   DB_URI: postgresql://test-quay-database:postgres@test-quay-database:5432/test-quay-database

   Copy to Clipboard Toggle word wrap

2. 設定ファイルを使用して Secret を作成します。

   $ kubectl create secret generic --from-file config.yaml=./config.yaml config-bundle-secret

   Copy to Clipboard Toggle word wrap

3. postgres コンポーネントを unmanaged とマークし、作成した Secret を参照する QuayRegistry.yaml ファイルを作成します。以下に例を示します。

   quayregistry.yaml ファイルの例

   apiVersion: quay.redhat.com/v1
   kind: QuayRegistry
   metadata:
     name: example-registry
     namespace: quay-enterprise
   spec:
     configBundleSecret: config-bundle-secret
     components:
       - kind: postgres
         managed: false

   Copy to Clipboard Toggle word wrap

手順

1. 次のコマンドを入力して、namespace (例: quay-enterprise) を作成します。

   $ oc new-project quay-enterprise

   Copy to Clipboard Toggle word wrap

2. オプション: Red Hat Quay デプロイメントで何かを事前に設定する場合は、設定バンドルの Secret を作成します。

   $ oc create secret generic quay-enterprise-config-bundle --from-file=config-bundle.tar.gz=/path/to/config-bundle.tar.gz

   Copy to Clipboard Toggle word wrap

3. quayregistry.yaml という名前のファイルに QuayRegistry カスタムリソースを作成します。

   1. 最小限のデプロイメントでは、すべてのデフォルトを使用します。

      quayregistry.yaml:

      apiVersion: quay.redhat.com/v1
      kind: QuayRegistry
      metadata:
        name: example-registry
        namespace: quay-enterprise

      Copy to Clipboard Toggle word wrap

   2. オプション: 一部のコンポーネントを管理対象外にする必要がある場合、この情報を spec フィールドに追加します。最小デプロイメントは次の例のようになります。

      管理対象外コンポーネントを含む quayregistry.yaml の例

      apiVersion: quay.redhat.com/v1
      kind: QuayRegistry
      metadata:
        name: example-registry
        namespace: quay-enterprise
      spec:
        components:
          - kind: clair
            managed: false
          - kind: horizontalpodautoscaler
            managed: false
          - kind: mirror
            managed: false
          - kind: monitoring
            managed: false

      Copy to Clipboard Toggle word wrap

   3. オプション: 設定バンドル (例: init-config-bundle-secret) を作成している場合は、これを quayregistry.yaml ファイルで参照します。

      設定バンドルを含む quayregistry.yaml の例

      apiVersion: quay.redhat.com/v1
      kind: QuayRegistry
      metadata:
        name: example-registry
        namespace: quay-enterprise
      spec:
        configBundleSecret: init-config-bundle-secret

      Copy to Clipboard Toggle word wrap

   4. オプション: プロキシーを設定している場合は、Red Hat Quay、Clair、およびミラーリングのオーバーライドを使用して情報を追加できます。

      プロキシーが設定された quayregistry.yaml の例

        kind: QuayRegistry
        metadata:
          name: quay37
        spec:
          configBundleSecret: config-bundle-secret
          components:
            - kind: objectstorage
              managed: false
            - kind: route
              managed: true
            - kind: mirror
              managed: true
              overrides:
                env:
                  - name: DEBUGLOG
                    value: "true"
                  - name: HTTP_PROXY
                    value: quayproxy.qe.devcluster.openshift.com:3128
                  - name: HTTPS_PROXY
                    value: quayproxy.qe.devcluster.openshift.com:3128
                  - name: NO_PROXY
                    value: svc.cluster.local,localhost,quay370.apps.quayperf370.perfscale.devcluster.openshift.com
            - kind: tls
              managed: false
            - kind: clair
              managed: true
              overrides:
                env:
                  - name: HTTP_PROXY
                    value: quayproxy.qe.devcluster.openshift.com:3128
                  - name: HTTPS_PROXY
                    value: quayproxy.qe.devcluster.openshift.com:3128
                  - name: NO_PROXY
                    value: svc.cluster.local,localhost,quay370.apps.quayperf370.perfscale.devcluster.openshift.com
            - kind: quay
              managed: true
              overrides:
                env:
                  - name: DEBUGLOG
                    value: "true"
                  - name: NO_PROXY
                    value: svc.cluster.local,localhost,quay370.apps.quayperf370.perfscale.devcluster.openshift.com
                  - name: HTTP_PROXY
                    value: quayproxy.qe.devcluster.openshift.com:3128
                  - name: HTTPS_PROXY
                    value: quayproxy.qe.devcluster.openshift.com:3128

      Copy to Clipboard Toggle word wrap

4. 次のコマンドを入力して、指定の namespace に QuayRegistry を作成します。

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

   Copy to Clipboard Toggle word wrap

5. 次のコマンドを入力して、status.registryEndpoint がいつ設定されるかを確認します。

   $ oc get quayregistry -n quay-enterprise example-registry -o jsonpath="{.status.registryEndpoint}" -w

   Copy to Clipboard Toggle word wrap

1. 次のコマンドを入力して、デプロイメント内の ワーカー ノードのリストを取得します。

   $ oc get nodes | grep worker

   Copy to Clipboard Toggle word wrap

   出力例

   NAME                                                              STATUS   ROLES                  AGE    VERSION
   ---
   example-cluster-new-c5qqp-worker-b-4zxx5.c.quay-devel.internal   Ready    worker                 401d   v1.31.11
   example-cluster-new-c5qqp-worker-b-kz6jn.c.quay-devel.internal   Ready    worker                 402d   v1.31.11
   example-cluster-new-c5qqp-worker-b-wrhw4.c.quay-devel.internal   Ready    worker                 401d   v1.31.11
   ---

   Copy to Clipboard Toggle word wrap

2. 次のコマンドを入力して、node-role.kubernetes.io/infra= ラベルをワーカーノードに追加します。必要なインフラストラクチャーノードの数は、環境によって異なります。実稼働環境では、すべての quay関連のコンポーネントに対して高可用性と十分なリソースを確保するために、十分な infra ノードをプロビジョニングする必要があります。CPU、メモリー、およびストレージ使用率を監視して、追加のインフラノードが必要であるかどうかを判別します。

   $ oc label node --overwrite <infra_node_one> <infra_node_two> <infra_node_three> node-role.kubernetes.io/infra=

   Copy to Clipboard Toggle word wrap

3. 次のコマンドを入力して、node-role.kubernetes.io/infra= ラベルが適切なノードに追加されていることを確認します。

   $ oc get node | grep infra

   Copy to Clipboard Toggle word wrap

   ---
   example-cluster-new-c5qqp-worker-b-4zxx5.c.quay-devel.internal   Ready    infra,worker           405d   v1.32.8
   example-cluster-new-c5qqp-worker-b-kz6jn.c.quay-devel.internal   Ready    infra,worker           406d   v1.32.8
   example-cluster-new-c5qqp-worker-b-wrhw4.c.quay-devel.internal   Ready    infra,worker           405d   v1.32.8
   ---

   Copy to Clipboard Toggle word wrap

4. ワーカーノードに infra ロールが割り当てられている場合、ユーザーのワークロードが誤ってインフラノードに割り当てられる可能性があります。これを回避するには、infra ノードにテイントを適用し、制御する Pod に容認を追加します。次のコマンドを入力して、ワーカーノードに infra ラベルを付けます。

   $ oc adm taint nodes -l node-role.kubernetes.io/infra \
     node-role.kubernetes.io/infra=reserved:NoSchedule --overwrite

   Copy to Clipboard Toggle word wrap

   出力例

   node/example-cluster-new-c5qqp-worker-b-4zxx5.c.quay-devel.internal modified
   node/example-cluster-new-c5qqp-worker-b-kz6jn.c.quay-devel.internal modified
   node/example-cluster-new-c5qqp-worker-b-wrhw4.c.quay-devel.internal modified

   Copy to Clipboard Toggle word wrap

手順

1. 次のコマンドを入力して、node-selector アノテーションを namespace に追加します。

   $ oc annotate namespace <namespace> openshift.io/node-selector='node-role.kubernetes.io/infra='

   Copy to Clipboard Toggle word wrap

   出力例

   namespace/<namespace> annotated

   Copy to Clipboard Toggle word wrap

2. 以下のコマンドを入力して tolerations アノテーションを namespace に追加します。

   $ oc annotate namespace <namespace> scheduler.alpha.kubernetes.io/defaultTolerations='[{"operator":"Equal","value":"reserved","effect":"NoSchedule","key":"node-role.kubernetes.io/infra"},{"operator":"Equal","value":"reserved","effect":"NoExecute","key":"node-role.kubernetes.io/infra"}]' --overwrite

   Copy to Clipboard Toggle word wrap

   出力例

   namespace/<namespace> annotated

   Copy to Clipboard Toggle word wrap

   重要

   この例の容認は、一般的にインフラノードに適用される 2 つのテイントに固有のものです。お使いの環境で設定したテイントは異なる場合があります。それに応じて容認を設定して、インフラノードに適用されたテイントと一致させる必要があります。

手順

1. OpenShift Container Platform Web コンソールで、Operators → OperatorHub をクリックします。
2. 検索ボックスに、Red Hat Quay と入力します。
3. Red Hat Quay → Install をクリックします。
4. 更新チャネルを選択します（例： stable-3.14 および version）。
5. インストールモード のクラスターで特定の namespace をクリックし、node-selector および tolerations アノテーションを適用した namespace を選択します。
6. Install をクリックします。

1. 次のコマンドを入力して、Operator がインストールされていることを確認します。

   $ oc get pods -n <annotated_namespace> -o wide | grep quay-operator

   Copy to Clipboard Toggle word wrap

   出力例

   quay-operator.v3.15.1-858b5c5fdc-lf5kj   1/1     Running   0          29m   10.130.6.18   example-cluster-new-c5qqp-worker-f-mhngl.c.quay-devel.internal   <none>           <none>

   Copy to Clipboard Toggle word wrap

手順

1. OpenShift Container Platform Web コンソールで、Operators → Installed Operators → Red Hat Quay をクリックします。
2. Red Hat Quay Operator の詳細 ページで、Quay Registry → Create QuayRegistry をクリックします。

3. Create QuayRegistry ページで、monitoring および objectstorage フィールドを false に設定します。Red Hat Quay が単一の namespace にインストールされている場合、モニタリングコンポーネントを有効にすることはできません。以下に例を示します。

   # ...
       - kind: monitoring
         managed: false
       - kind: objectstorage
         managed: false
   # ...

   Copy to Clipboard Toggle word wrap
4. Create をクリックします。

1. オプション：Pod がインフラノードで実行されていることを確認します。

   1. 次のコマンドを入力して、すべての Quay関連の Pod とスケジュールされているノードを一覧表示します。

      $ oc get pods -n <annotated_namespace> -o wide | grep example-registry

      Copy to Clipboard Toggle word wrap

      出力例

      ...
      NAME                                               READY   STATUS      RESTARTS   AGE   IP             NODE                                                              NOMINATED NODE   READINESS GATES
      example-registry-clair-app-5f95d685bd-dgjf6        1/1     Running     0          52m   10.128.4.12    example-cluster-new-c5qqp-worker-b-wrhw4.c.quay-devel.internal   <none>           <none>
      ...

      Copy to Clipboard Toggle word wrap

   2. 次のコマンドを実行して、一覧表示されたノードに infra というラベルが付けられたノードのみが含まれていることを確認します。

      $ oc get nodes -l node-role.kubernetes.io/infra -o name

      Copy to Clipboard Toggle word wrap

      出力例

      node/example-cluster-new-c5qqp-worker-b-4zxx5.c.quay-devel.internal modified
      node/example-cluster-new-c5qqp-worker-b-kz6jn.c.quay-devel.internal modified
      node/example-cluster-new-c5qqp-worker-b-wrhw4.c.quay-devel.internal modified

      Copy to Clipboard Toggle word wrap

      注記

      いずれかの Pod がインフラ以外のノードに表示される場合は、namespace のアノテーションとデプロイメントのパッチを適用します。

2. 次のコマンドを入力して、Red Hat Quay レジストリーのすべての Pod を再起動します。

   $ oc delete pod -n <annotated_namespace> --all

   Copy to Clipboard Toggle word wrap

3. 以下のコマンドを実行して Pod のステータスを確認します。

   $ oc get pods -n <annotated_namespace>

   Copy to Clipboard Toggle word wrap

   出力例

   ...
   NAME                                               READY   STATUS      RESTARTS   AGE
   example-registry-clair-app-5f95d685bd-dgjf6        1/1     Running     0          5m4s
   ...

   Copy to Clipboard Toggle word wrap

1. namespace (例: quay-enterprise) を作成します。
2. Operators → Installed Operators を選択してから Quay Operator を選択し、Operator の詳細ビューに移動します。
3. 'Provided API' の下にある 'Quay Registry' タイルの 'Create Instance' をクリックします。
4. オプションで、QuayRegistry の 'Name' を変更します。これはレジストリーのホスト名に影響します。その他のフィールドはすべてデフォルトで入力されています。
5. 'Create' をクリックし、Quay Operator によってデプロイされる QuayRegistry を送信します。
6. QuayRegistry リストビューにリダイレクトされるはずです。作成した QuayRegistry をクリックし、詳細ビューを表示します。
7. 'Registry Endpoint' の値が設定されたら、その値をクリックして UI で新規 Quay レジストリーにアクセスします。'Create Account' を選択して、ユーザーを作成し、サインインできるようになりました。

手順

1. Red Hat Quay Registry の概要画面で、Config Bundle Secret のリンクをクリックします。

   

2. シークレットを編集するには、Actions → Edit Secret をクリックします。

   

3. 設定を変更して保存します

   

4. デプロイメントを監視して、正常に完了したこと、および設定の変更が反映されていることを確認します。

手順

1. 現在のエンドポイントとシークレットを見つけるには、次のコマンドを入力し、oc describe quayregistry または oc get quayregistry -o yaml を使用して QuayRegistry リソースを調べます。

   $ oc get quayregistry example-registry -n quay-enterprise -o yaml

   Copy to Clipboard Toggle word wrap

   出力例

   apiVersion: quay.redhat.com/v1
   kind: QuayRegistry
   metadata:
     ...
     name: example-registry
     namespace: quay-enterprise
     ...
   spec:
     components:
     - kind: quay
       managed: true
     ...
     - kind: clairpostgres
       managed: true
     configBundleSecret: init-config-bundle-secret 

   1

   
   status:
     currentVersion: 3.7.0
     lastUpdated: 2022-05-11 13:28:38.199476938 +0000 UTC
     registryEndpoint: https://example-registry-quay-quay-enterprise.apps.docs.gcp.quaydev.org 

   2

   Copy to Clipboard Toggle word wrap

   1

   config.yaml ファイルと SSL/TLS 証明書を含む設定バンドルのシークレット。

   2

   レジストリーの URL、レジストリー UI へのブラウザーアクセス、およびレジストリー API エンドポイント。

手順

1. 次のコマンドを入力して、QuayRegistry リソースを記述します。

   $ oc describe quayregistry -n <quay_namespace>

   Copy to Clipboard Toggle word wrap

   # ...
     Config Bundle Secret:  example-registry-config-bundle-v123x
   # ...

   Copy to Clipboard Toggle word wrap

2. 次のコマンドを入力してシークレットデータを取得します。

   $ oc get secret -n <quay_namespace> <example-registry-config-bundle-v123x> -o jsonpath='{.data}'

   Copy to Clipboard Toggle word wrap

   出力例

   {
       "config.yaml": "RkVBVFVSRV9VU0 ... MDAwMAo="
   }

   Copy to Clipboard Toggle word wrap

3. >> config.yaml フラグを渡して、データをカレントディレクトリーの YAML ファイルにデコードします。以下に例を示します。

   $ echo 'RkVBVFVSRV9VU0 ... MDAwMAo=' | base64 --decode >> config.yaml

   Copy to Clipboard Toggle word wrap
4. config.yaml ファイルに必要な変更を加え、ファイルを config.yaml として保存します。

5. 次のコマンドを入力して、新しい configBundleSecret YAML を作成します。

   $ touch <new_configBundleSecret_name>.yaml

   Copy to Clipboard Toggle word wrap

6. 次のコマンドを入力し、config.yaml ファイルを渡して新しい configBundleSecret リソースを作成します。

   $ oc -n <namespace> create secret generic <secret_name> \
     --from-file=config.yaml=</path/to/config.yaml> \ 

   1

   
     --dry-run=client -o yaml > <new_configBundleSecret_name>.yaml

   Copy to Clipboard Toggle word wrap

   1

   <config.yaml> は base64 でデコード された config.yaml ファイルです。

7. 次のコマンドを入力して、configBundleSecret リソースを作成します。

   $ oc create -n <namespace> -f <new_configBundleSecret_name>.yaml

   Copy to Clipboard Toggle word wrap

   出力例

   secret/config-bundle created

   Copy to Clipboard Toggle word wrap

8. 次のコマンドを入力して、新しい configBundleSecret オブジェクトを参照するように QuayRegistry YAML ファイルを更新します。

   $ oc patch quayregistry <registry_name> -n <namespace> --type=merge -p '{"spec":{"configBundleSecret":"<new_configBundleSecret_name>"}}'

   Copy to Clipboard Toggle word wrap

   出力例

   quayregistry.quay.redhat.com/example-registry patched

   Copy to Clipboard Toggle word wrap

検証

1. QuayRegistry CR が新しい configBundleSecret で更新されていることを確認します。

   $ oc describe quayregistry -n <quay_namespace>

   Copy to Clipboard Toggle word wrap

   出力例

   # ...
     Config Bundle Secret: <new_configBundleSecret_name>
   # ...

   Copy to Clipboard Toggle word wrap

   レジストリーにパッチを適用すると、Red Hat Quay Operator が自動的に変更を調整します。