3.4. oc-mirror プラグインを使用した非接続インストールのイメージのミラーリング

手順

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

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

   1

   Copy to Clipboard Toggle word wrap

   1

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

2. ファイルを編集し、必要に応じて設定を調整します。

   kind: ImageSetConfiguration
   apiVersion: mirror.openshift.io/v1alpha2
   archiveSize: 4                                                      

   1

   
   storageConfig:                                                      

   2

   
     registry:
       imageURL: example.com/mirror/oc-mirror-metadata                 

   3

   
       skipTLS: false
   mirror:
     platform:
       channels:
       - name: stable-4.17                                             

   4

   
         type: ocp
       graph: true                                                     

   5

   
     operators:
     - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.17  

   6

   
       packages:
       - name: serverless-operator                                     

   7

   
         channels:
         - name: stable                                                

   8

   
     additionalImages:
     - name: registry.redhat.io/ubi9/ubi:latest                        

   9

   
     helm: {}

   Copy to Clipboard Toggle word wrap

   1

   archiveSize を追加して、イメージセット内の各ファイルの最大サイズを GiB 単位で設定します。

   2

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

   3

   ストレージバックエンドのレジストリー URL を設定します。

   4

   OpenShift Container Platform イメージを取得するためのチャネルを設定します。

   5

   graph: true を追加して、グラフデータイメージをビルドし、ミラーレジストリーにプッシュします。OpenShift Update Service (OSUS) を作成するには、graph-data イメージが必要です。graph: true フィールドは UpdateService カスタムリソースマニフェストも生成します。oc コマンドラインインターフェイス (CLI) は、UpdateService カスタムリソースマニフェストを使用して OSUS を作成できます。詳細は、OpenShift Update Service について を参照してください。

   6

   OpenShift Container Platform イメージを取得するための Operator カタログを設定します。

   7

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

   8

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

   9

   イメージセットに含める追加のイメージを指定します。

   注記

   graph: true フィールドは、他のミラーリングされたイメージとともに ubi-micro イメージもミラーリングします。

   OpenShift Container Platform Extended Update Support (EUS) バージョンをアップグレードする場合、現行バージョンとターゲットバージョンの間に中間バージョンが必要になる場合があります。たとえば、最新バージョンが 4.14 で、ターゲットバージョンが 4.16 の場合、oc-mirror プラグイン v1 の使用時に ImageSetConfiguration に 4.15.8 などのバージョンを含める必要がある場合があります。

   oc-mirror プラグイン v1 は必ずしもこれを自動的に検出するとは限りません。Cincinnati graph の Web ページで 必要な中間バージョンを確認し、手動で設定に追加してください。

   パラメーターの完全なリストは、「イメージセットの設定パラメーター」を参照してください。また、さまざまなミラーリングのユースケースは、「イメージセットの設定例」を参照してください。

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

   このイメージセット設定ファイルは、コンテンツをミラーリングするときに oc mirror コマンドで必要になります。

手順

1. cluster-admin ロールを持つユーザーとして OpenShift CLI にログインします。

2. 以下のコマンドを実行して、results ディレクトリーからクラスターに YAML ファイルを適用します。

   $ oc apply -f ./oc-mirror-workspace/results-1639608409/

   Copy to Clipboard Toggle word wrap

3. リリースイメージをミラーリングした場合は、次のコマンドを実行して、リリースイメージの署名をクラスターに適用します。

   $ oc apply -f ./oc-mirror-workspace/results-1639608409/release-signatures/

   Copy to Clipboard Toggle word wrap
   注記

   クラスターではなく Operator をミラーリングしている場合、$ oc apply -f ./oc-mirror-workspace/results-1639608409/release-signatures/ を実行する必要はありません。適用するリリースイメージ署名がないため、このコマンドを実行するとエラーが返されます。

検証

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

   $ oc get imagecontentsourcepolicy

   Copy to Clipboard Toggle word wrap

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

   $ oc get catalogsource -n openshift-marketplace

   Copy to Clipboard Toggle word wrap

手順

1. --dry-run フラグを指定して oc mirror コマンドを実行し、ドライランを実行します。

   $ oc mirror --config=./imageset-config.yaml \

   1

   
     docker://registry.example:5000            \

   2

   
     --dry-run                                  

   3

   Copy to Clipboard Toggle word wrap

   1

   作成されたイメージセット設定ファイルを渡します。この手順では、imageset-config.yaml という名前であることを前提としています。

   2

   ミラーレジストリーを指定します。--dry-run フラグを使用している限り、このレジストリーには何もミラーリングされません。

   3

   --dry-run フラグを使用して、実際のイメージセットファイルではなく、ドライランアーティファクトを生成します。

   出力例

   Checking push permissions for registry.example:5000
   Creating directory: oc-mirror-workspace/src/publish
   Creating directory: oc-mirror-workspace/src/v2
   Creating directory: oc-mirror-workspace/src/charts
   Creating directory: oc-mirror-workspace/src/release-signatures
   No metadata detected, creating new workspace
   wrote mirroring manifests to oc-mirror-workspace/operators.1658342351/manifests-redhat-operator-index
   
   ...
   
   info: Planning completed in 31.48s
   info: Dry run complete
   Writing image mapping to oc-mirror-workspace/mapping.txt

   Copy to Clipboard Toggle word wrap

2. 生成されたワークスペースディレクトリーに移動します。

   $ cd oc-mirror-workspace/

   Copy to Clipboard Toggle word wrap

3. 生成された mapping.txt ファイルを確認します。

   このファイルには、ミラーリングされるすべてのイメージのリストが含まれています。

4. 生成された pruning-plan.json ファイルを確認します。

   このファイルには、イメージセットの公開時にミラーレジストリーからプルーニングされるすべてのイメージのリストが含まれています。

   注記

   pruning-plan.json ファイルは、oc-mirror コマンドがミラーレジストリーを指し、プルーニングするイメージがある場合にのみ生成されます。

手順

1. イメージセット設定ファイルを作成し、必要に応じて設定を調整します。

   次のイメージセット設定例では、OpenShift Container Platform リリースおよび registry.redhat.io の UBI イメージとともに、ディスク上の OCI カタログをミラーリングします。

   kind: ImageSetConfiguration
   apiVersion: mirror.openshift.io/v1alpha2
   storageConfig:
     local:
       path: /home/user/metadata                                                

   1

   
   mirror:
     platform:
       channels:
       - name: stable-4.17                                                      

   2

   
         type: ocp
       graph: false
     operators:
     - catalog: oci:///home/user/oc-mirror/my-oci-catalog                       

   3

   
       targetCatalog: my-namespace/redhat-operator-index                        

   4

   
       packages:
       - name: aws-load-balancer-operator
     - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.17           

   5

   
       packages:
       - name: rhacs-operator
     additionalImages:
     - name: registry.redhat.io/ubi9/ubi:latest                                 

   6

   Copy to Clipboard Toggle word wrap

   1

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

   2

   オプションで、registry.redhat.io からミラーリングする OpenShift Container Platform リリースを含めます。

   3

   ディスク上の OCI カタログの場所への絶対パスを指定します。OCI 機能を使用する場合、パスは oci:// で始まる必要があります。

   4

   必要に応じて、カタログをミラーリングする代替の namespace と名前を指定します。

   5

   必要に応じて、レジストリーから取得する追加の Operator カタログを指定します。

   6

   必要に応じて、レジストリーからプルする追加のイメージを指定します。

   注記

   oc-mirror プラグイン v2 では、additionalImages にリストされているすべてのイメージに明示的なレジストリーホスト名を使用する必要があります。それ以外の場合、イメージは誤ったターゲットパスにミラーリングされます。

2. oc mirror コマンドを実行して、OCI カタログをターゲットミラーレジストリーにミラーリングします。

   $ oc mirror --config=./imageset-config.yaml \ 

   1

   
     docker://registry.example:5000              

   2

   Copy to Clipboard Toggle word wrap

   1

   イメージセット設定ファイルを渡します。この手順では、imageset-config.yaml という名前であることを前提としています。

   2

   コンテンツをミラーリングするレジストリーを指定します。レジストリーは docker:// で始まる必要があります。ミラーレジストリーに最上位の namespace を指定する場合は、これ以降の実行でもこれと同じ namespace を使用する必要があります。

   オプションで、他のフラグを指定して OCI 機能の動作を調整できます。

   --oci-insecure-signature-policy

   署名をターゲットミラーレジストリーにプッシュしないでください。

   --oci-registries-config

   TOML 形式の registries.conf ファイルへのパスを指定します。これを使用して、イメージセット設定ファイルを変更することなく、テスト用の運用前の場所など、別のレジストリーからミラーリングできます。このフラグはローカル OCI カタログにのみ影響し、他のミラーリングされたコンテンツには影響しません。

   registries.conf ファイルの例

   [[registry]]
    location = "registry.redhat.io:5000"
    insecure = false
    blocked = false
    mirror-by-digest-only = true
    prefix = ""
    [[registry.mirror]]
       location = "preprod-registry.example.com"
       insecure = false

   Copy to Clipboard Toggle word wrap