8.3. oc-mirror プラグインを使用したカスタムカタログの作成

手順

1. 次のコマンドを実行して、フィルタリング可能な Red Hat 提供の Operator カタログのリストを取得します。

   $ oc mirror list operators --version 4.15 --catalogs

2. 次のコマンドを実行して、Red Hat Operators カタログ内の Operators のリストを取得します。

   $ oc mirror list operators <--catalog=<catalog_source>> 1

   1

   registry.redhat.io/redhat/redhat-operator-index:v4.15 や quay.io/operatorhubio/catalog:latest などのカタログソースを指定します。

3. Operator を選択します。この例では、amq-broker-rhel8 が選択されています。

4. オプション: フィルタリングする Operator のチャネルとバージョンを検査するには、次のコマンドを入力します。

   1. 次のコマンドを実行して、チャネルのリストを取得します。

      $ oc mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v4.15 --package=amq-broker-rhel8

   2. 次のコマンドを実行して、チャネル内のバージョンのリストを取得します。

      $ oc mirror list operators --catalog=registry.redhat.io/redhat/redhat-operator-index:v4.15 --package=amq-broker-rhel8 --channel=7.11.x

手順

1. oc mirror init コマンドを使用して、イメージセット設定のテンプレートを作成し、それを imageset-config.yaml というファイルに保存します。

   $ oc mirror init <--registry <storage_backend> > imageset-config.yaml 1

   1

   ストレージバックエンドのロケーションを指定します (例: example.com/mirror/oc-mirror-metadata)。

   デフォルトのイメージセット設定ファイルの例

   kind: ImageSetConfiguration
   apiVersion: mirror.openshift.io/v1alpha2
   storageConfig:
     registry:
       imageURL: registry.example.com/oc-mirror
       skipTLS: false
   mirror:
     platform: 1
       channels:
       - name: stable-4.15
         type: ocp
     operators:
     - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.15
       packages:
       - name: serverless-operator
         channels:
         - name: stable
     additionalImages: 2
     - name: registry.redhat.io/ubi8/ubi:latest
     helm: {} 3

   1

   platform フィールドと関連フィールドは MicroShift ではサポートされていないため、削除する必要があります。

   2

   イメージセットに含める追加のイメージを指定します。追加のイメージを指定する必要がない場合は、このフィールドを削除してください。

   3

   Helm は MicroShift ではサポートされていないため、削除する必要があります。

2. 次の例のように、MicroShift とミラーリングする Operator の両方の要件を満たすようにイメージセット設定ファイルの値を編集します。

   編集された MicroShift イメージセット設定ファイルの例

   kind: ImageSetConfiguration
   apiVersion: mirror.openshift.io/v1alpha2
   storageConfig: 1
     registry:
       imageURL: <storage_backend> 2
       skipTLS: false
   mirror:
     operators:
     - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.15 3
       packages:
       - name: amq-broker-rhel8 4
         channels:
         - name: 7.11.x 5

   1

   イメージセットのメタデータが保存されるバックエンドのロケーションを設定します。この場所は、レジストリーまたはローカルディレクトリーにすることができます。storageConfig値を指定する必要があります。

   2

   ストレージバックエンドのレジストリー URL (例: <example.com/mirror/oc-mirror-metadata) を設定します。

   3

   イメージを取得する Operator カタログを設定します。

   4

   イメージセットに含める Operator パッケージを指定します。カタログ内のすべてのパッケージを取得するには、このフィールドを削除してください。

   5

   イメージセットに含める Operator パッケージの特定のチャネルのみを指定します。そのチャネルでバンドルを使用しない場合も、常に Operator パッケージのデフォルトチャネルを含める必要があります。oc mirror list operators --catalog=<catalog_name> --package=<package_name> コマンドを実行すると、デフォルトチャネルを見つけることができます。

3. 更新したファイルを保存します。

検証

1. 生成された oc-mirror-workspace/ ディレクトリーに移動します。
2. results ディレクトリーに移動します (例: results-1639608409/。
3. ImageContentSourcePolicy および CatalogSource リソースに YAML ファイルが存在することを確認します。

手順

1. 次のコマンドを実行して、imageContentSourcePolicy.yaml ファイルの内容を確認します。

   $ cat oc-mirror-workspace/<results-directory>/imageContentSourcePolicy.yaml 1

   1

   <results-1707148826> などの results ディレクトリー名を指定します。

   出力例

   apiVersion: operator.openshift.io/v1alpha1
   kind: ImageContentSourcePolicy
   metadata:
     labels:
       operators.openshift.org/catalog: "true"
     name: operator-0
   spec:
     repositoryDigestMirrors:
     - mirrors:
       - registry.<example.com>/amq7
       source: registry.redhat.io/amq7

2. 次のコマンドを実行して、imageContentSourcePolicy.yaml を CRI-O 設定に適した形式に変換します。

   yq '.spec.repositoryDigestMirrors[] as $item ireduce([]; . + [{"mirror": $item.mirrors[], "source": ($item | .source)}]) | .[] |
     "[[registry]]
         prefix = \"" + .source + "\"
         location = \"" + .mirror + "\"
         mirror-by-digest-only = true
         insecure = true
         "' ./icsp.yaml

   出力例

   [[registry]]
         prefix = "registry.redhat.io/amq7"
         location = "registry.example.com/amq7"
         mirror-by-digest-only = true
         insecure = true

3. /etc/containers/registries.conf.d/ ディレクトリーの CRI-O 設定ファイルに出力を追加します。

   crio-config.yaml ミラー設定ファイルの例

   [[registry]]
         prefix = "registry.redhat.io/amq7"
         location = "registry.example.com/amq7"
         mirror-by-digest-only = true
         insecure = true
   
   [[registry]]
       prefix = ""
       location = "quay.io"
       mirror-by-digest-only = true
   [[registry.mirror]]
       location = "<registry_host>:<port>" 1
       insecure = false

   1

   ミラーレジストリーサーバーのホスト名とポートを指定します (例: microshift-quay:8443)。

4. 次のコマンドで MicroShift を再起動して、CRI-O 設定の変更を適用します。

   $ sudo systemctl restart crio

手順

1. 次のコマンドを実行して、results ディレクトリーからカタログソース設定ファイルを適用し、カタログソースオブジェクトを作成します。

   $ oc apply -f ./oc-mirror-workspace/results-1708508014/catalogSource-cs-redhat-operator-index.yaml

   カタログソース設定ファイルの例

   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: redhat-catalog
     namespace: openshift-marketplace 1
   spec:
     sourceType: grpc
     image: registry.example.com/redhat/redhat-operator-index:v4.15
     updateStrategy:
       registryPoll:
         interval: 60m

   1

   グローバル namespace を指定します。metadata.namespace を openshift-marketplace に設定すると、カタログはすべての namespace 内のカタログを参照できるようになります。どの namespace のサブスクリプションでも、openshift-marketplace namespace で作成されたカタログを参照できます。

   出力例

   catalogsource.operators.coreos.com/cs-redhat-operator-index created

2. 以下のコマンドを実行して、CatalogSource リソースが正常にインストールされたことを確認します。

   $ oc get catalogsource --all-namespaces

3. 次のコマンドを使用して、カタログソースが実行されていることを確認します。

   $ oc get pods -n openshift-marketplace

   出力例

   NAME                             READY   STATUS    RESTARTS   AGE
   cs-redhat-operator-index-4227b   2/2     Running   0          2m5s

4. 次の例のような Subscription CR を作成します。

   Subscription CR の例

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: amq-broker
     namespace: openshift-operators
   spec:
     channel: 7.11.x
     name: amq-broker-rhel8
     source: cs-redhat-operator-index
     sourceNamespace: openshift-marketplace

5. 次のコマンドを実行して、Subscription CR 設定を適用します。

   $ oc apply -f ./<my-subscription-cr.yaml> 1

   1

   サブスクリプションの名前 (my-subscription-cr.yaml など) を指定します。

   出力例

   subscription.operators.coreos.com/amq-broker created