13.2. OpenShift Container Platform イメージリポジトリーのミラーリング

手順

1. Red Hat カスタマーポータルの OpenShift Container Platform ダウンロードページ に移動します。
2. Product Variant ドロップダウンリストからアーキテクチャーを選択します。
3. バージョン ドロップダウンリストから適切なバージョンを選択します。
4. OpenShift v4.12 Linux Client エントリーの横にある Download Now をクリックして、ファイルを保存します。

5. アーカイブを展開します。

   $ tar xvf <file>

6. oc バイナリーを、PATH にあるディレクトリーに配置します。

   PATH を確認するには、以下のコマンドを実行します。

   $ echo $PATH

手順

1. Red Hat カスタマーポータルの OpenShift Container Platform ダウンロードページ に移動します。
2. バージョン ドロップダウンリストから適切なバージョンを選択します。
3. OpenShift v4.12 Windows Client エントリーの横にある Download Now をクリックして、ファイルを保存します。
4. ZIP プログラムでアーカイブを解凍します。

5. oc バイナリーを、PATH にあるディレクトリーに移動します。

   PATH を確認するには、コマンドプロンプトを開いて以下のコマンドを実行します。

   C:\> path

手順

1. Red Hat カスタマーポータルの OpenShift Container Platform ダウンロードページ に移動します。
2. バージョン ドロップダウンリストから適切なバージョンを選択します。

3. OpenShift v4.12 macOS Client エントリーの横にある Download Now をクリックして、ファイルを保存します。

   注記

   macOS arm64 の場合は、OpenShift v4.12 macOS arm64 Client エントリーを選択します。

4. アーカイブを展開し、解凍します。

5. oc バイナリーをパスにあるディレクトリーに移動します。

   PATH を確認するには、ターミナルを開き、以下のコマンドを実行します。

   $ echo $PATH

1. Red Hat OpenShift Cluster Manager サイトの Pull Secret ページから registry.redhat.io プルシークレットをダウンロードします。

2. JSON 形式でプルシークレットのコピーを作成します。

   $ cat ./pull-secret | jq . > <path>/<pull_secret_file_in_json> 1

   1

   プルシークレットを保存するフォルダーへのパスおよび作成する JSON ファイルの名前を指定します。

   ファイルの内容は以下の例のようになります。

   {
     "auths": {
       "cloud.openshift.com": {
         "auth": "b3BlbnNo...",
         "email": "you@example.com"
       },
       "quay.io": {
         "auth": "b3BlbnNo...",
         "email": "you@example.com"
       },
       "registry.connect.redhat.com": {
         "auth": "NTE3Njg5Nj...",
         "email": "you@example.com"
       },
       "registry.redhat.io": {
         "auth": "NTE3Njg5Nj...",
         "email": "you@example.com"
       }
     }
   }

3. オプション: oc-mirror プラグインを使用している場合は、ファイルを ~/.docker/config.json または $XDG_RUNTIME_DIR/containers/auth.json として保存します。

   1. .docker または $XDG_RUNTIME_DIR/containers ディレクトリーが存在しない場合は、次のコマンドを入力して作成します。

      $ mkdir -p <directory_name>

      この場合の <directory_name> は、~/.docker または $XDG_RUNTIME_DIR/containers のいずれかです。

   2. 次のコマンドを入力して、プルシークレットを適切なディレクトリーにコピーします。

      $ cp <path>/<pull_secret_file_in_json> <directory_name>/<auth_file>

      この場合の <directory_name> は ~/.docker または $XDG_RUNTIME_DIR/containers、<auth_file> は config.json または auth.json のいずれかです。

4. ミラーレジストリーの base64 でエンコードされたユーザー名およびパスワードまたはトークンを生成します。

   $ echo -n '<user_name>:<password>' | base64 -w0 1
   BGVtbYk3ZHAtqXs=

   1

   <user_name> および <password> については、レジストリーに設定したユーザー名およびパスワードを指定します。

5. JSON ファイルを編集し、レジストリーについて記述するセクションをこれに追加します。

     "auths": {
       "<mirror_registry>": { 1
         "auth": "<credentials>", 2
         "email": "you@example.com"
       }
     },

   1

   <mirror_registry> については、レジストリードメイン名と、ミラーレジストリーがコンテンツを提供するために使用するポートをオプションで指定します。例: registry.example.com または registry.example.com:8443

   2

   <credentials> については、ミラーレジストリーの base64 でエンコードされたユーザー名およびパスワードを指定します。

   ファイルは以下の例のようになります。

   {
     "auths": {
       "registry.example.com": {
         "auth": "BGVtbYk3ZHAtqXs=",
         "email": "you@example.com"
       },
       "cloud.openshift.com": {
         "auth": "b3BlbnNo...",
         "email": "you@example.com"
       },
       "quay.io": {
         "auth": "b3BlbnNo...",
         "email": "you@example.com"
       },
       "registry.connect.redhat.com": {
         "auth": "NTE3Njg5Nj...",
         "email": "you@example.com"
       },
       "registry.redhat.io": {
         "auth": "NTE3Njg5Nj...",
         "email": "you@example.com"
       }
     }
   }

手順

1. oc-mirror CLI プラグインをダウンロードします。

   1. OpenShift Cluster Manager Hybrid Cloud Console の ダウンロード ページに移動します。
   2. OpenShift 切断インストールツール セクションで、OpenShift Client (oc) ミラープラグイン の ダウンロード をクリックしてファイルを保存します。

2. アーカイブを抽出します。

   $ tar xvzf oc-mirror.tar.gz

3. 必要に応じて、プラグインファイルを更新して実行可能にします。

   $ chmod +x oc-mirror

   注記

   oc-mirror ファイルの名前を変更しないでください。

4. ファイルを PATH に配置して、oc-mirror CLI プラグインをインストールします (例: /usr/local/bin):。

   $ sudo mv oc-mirror /usr/local/bin/.

手順

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

   $ oc mirror init --registry example.com/mirror/oc-mirror-metadata > imageset-config.yaml 1

   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.12                                             4
         type: ocp
       graph: true                                                     5
     operators:
     - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.12  6
       packages:
       - name: serverless-operator                                     7
         channels:
         - name: stable                                                8
     additionalImages:
     - name: registry.redhat.io/ubi8/ubi:latest                        9
     helm: {}

   1

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

   2

   イメージセットのメタデータを保存するバックエンドの場所を設定します。この場所は、レジストリーまたはローカルディレクトリーにすることができます。Technology Preview OCI 機能を使用していない場合は、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 イメージもミラーリングします。

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

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

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

手順

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

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

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

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

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

   注記

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

検証

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

   $ oc get imagecontentsourcepolicy

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

   $ oc get catalogsource -n openshift-marketplace

手順

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

   $ oc mirror --config=./imageset-config.yaml \1
     docker://registry.example:5000            \2
     --dry-run                                  3

   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

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

   $ cd oc-mirror-workspace/

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

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

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

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

   注記

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

手順

1. オプション: 必要なカタログとイメージを取得し、ディスクに保存します。ディスク上に OCI 形式のカタログイメージがすでにある場合は、この手順を省略できます。

   1. イメージセット設定ファイルを作成します。

      ディスクにコピーするためのイメージセット設定ファイルの例

      kind: ImageSetConfiguration
      apiVersion: mirror.openshift.io/v1alpha2
      mirror:
       operators:
       - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.12
         packages:
         - name: aws-load-balancer-operator

      注記

      OCI 機能を使用する場合、mirror.operators.catalog 設定のみを使用できます。

      storageConfig 設定は無視され、oc mirror コマンドに渡された場所が優先されます。

   2. oc mirror コマンドを実行して、指定されたイメージセット設定からディスクにイメージをミラーリングします。

      $ oc mirror --config=./imageset-config.yaml \ 1
        --use-oci-feature \                         2
        --oci-feature-action=copy \                 3
        oci://my-oci-catalog                        4

      1

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

      2

      --use-oci-feature フラグを使用して OCI 機能を有効にします。

      3

      カタログをディスクにコピーするには、--oci-feature-action フラグを copy に設定します。

      4

      カタログを出力するディスク上のディレクトリーを指定します。この手順では、名前が my-oci-catalog であることを前提としています。パスは oci:// で始まる必要があります。指定されたディレクトリーがフルパスでない場合、ディレクトリーは oc mirror コマンドが実行される現在の作業ディレクトリーに作成されます。

      注記

      オプションで --oci-registries-config フラグを使用して、TOML 形式の registries.conf ファイルへのパスを指定できます。これを使用して、イメージセット設定ファイルを変更することなく、テスト用の運用前の場所など、別のレジストリーからミラーリングできます。

      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

      registry.mirror セクションの location フィールドを、イメージを取得する別のレジストリーの場所に設定します。registry セクションの location フィールドは、イメージセット設定ファイルで指定したものと同じレジストリーの場所である必要があります。

   3. ディレクトリーの内容を一覧表示し、次のディレクトリーが作成されたことを確認します。

      $ ls -l

      出力例

      my-oci-catalog      1
      oc-mirror-workspace 2
      olm_artifacts       3

      1

      OCI カタログを含むディレクトリー。この手順では、名前が my-oci-catalog であることを前提としています。

      2

      カタログ内の各イメージを元の形式で含むディレクトリー。

      3

      このカタログが参照する Operator バンドルを記述するファイルを含むディレクトリー。

2. イメージセット設定ファイルを更新して、ターゲットミラーレジストリーにミラーリングするディスク上のカタログの場所を指定します。

   レジストリーをミラーリングするためのイメージセット設定ファイルの例

   kind: ImageSetConfiguration
   apiVersion: mirror.openshift.io/v1alpha2
   mirror:
    operators:
    - catalog: oci:///home/user/oc-mirror/my-oci-catalog/redhat-operator-index 1
      packages:
      - name: aws-load-balancer-operator

   1

   ディスク上の OCI カタログの場所への絶対パスを指定します。この手順は、ディレクトリーとして my-oci-catalog を使用し、redhat-operator-index カタログをミラーリングしたことを前提としています。パスは oci:// で始まる必要があります。

3. oc mirror コマンドを実行して、ディスク上のイメージセットファイルを処理し、その内容をターゲットミラーレジストリーにミラーリングします。

   $ oc mirror --config=./imageset-config.yaml \ 1
     --use-oci-feature \                         2
     --oci-feature-action=mirror \               3
     docker://registry.example:5000              4

   1

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

   2

   --use-oci-feature フラグを使用して OCI 機能を有効にします。

   3

   カタログをターゲットミラーレジストリーにミラーリングするには、--oci-feature-action フラグを mirror に設定します。

   4

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

   注記

   オプションで --oci-insecure-signature-policy フラグを使用して、署名をターゲットミラーレジストリーにプッシュしないようにすることができます。