4.8. カスタムカタログの管理

手順

1. ファイルベースのカタログを初期化します。

   1. カタログのディレクトリーを作成します。

      $ mkdir <operator_name>-index

      Copy to Clipboard Toggle word wrap

   2. カタログイメージをビルドできる Dockerfile を作成します。

      例 <operator_name>-index.Dockerfile

      # The base image is expected to contain
      # /bin/opm (with a serve subcommand) and /bin/grpc_health_probe
      FROM registry.redhat.io/openshift4/ose-operator-registry:v4.9
      
      # Configure the entrypoint and command
      ENTRYPOINT ["/bin/opm"]
      CMD ["serve", "/configs"]
      
      # Copy declarative config root into image at /configs
      ADD <operator_name>-index /configs
      
      # Set DC-specific label for the location of the DC root directory
      # in the image
      LABEL operators.operatorframework.io.index.configs.v1=/configs

      Copy to Clipboard Toggle word wrap

      Dockerfile は、直前の手順で作成したカタログディレクトリーと同じ親ディレクトリーに存在する必要があります。

      ディレクトリー構造の例

      .
      ├── <operator_name>-index
      └── <operator_name>-index.Dockerfile

      Copy to Clipboard Toggle word wrap

   3. カタログにパッケージ定義を設定します。

      $ opm init <operator_name> \ 

      1

      
          --default-channel=preview \ 

      2

      
          --description=./README.md \ 

      3

      
          --icon=./operator-icon.svg \ 

      4

      
          --output yaml \ 

      5

      
          > <operator_name>-index/index.yaml 

      6

      Copy to Clipboard Toggle word wrap

      1

      Operator、またはパッケージ、名前。

      2

      指定されていない場合に、サブスクリプションがデフォルトで設定されるチャネル。

      3

      Operator の README.md またはその他のドキュメントへのパス。

      4

      Operator のアイコンへのパス。

      5

      出力形式: JSON または YAML。

      6

      カタログ設定ファイルを作成するパス。

      このコマンドは、指定されたカタログ設定ファイルに aolm.package 宣言型設定 blob を生成します。

2. バンドルをカタログに追加します。

   $ opm render <registry>/<namespace>/<bundle_image_name>:<tag> \ 

   1

   
       --output=yaml \
       >> <operator_name>-index/index.yaml 

   2

   Copy to Clipboard Toggle word wrap

   1

   バンドルイメージのプル仕様。

   2

   カタログ設定ファイルへのパス。

   opm render コマンドは、提供されるカタログイメージおよびバンドルイメージから宣言型の設定 Blob を生成します。

   注記

   チャネルには、1 つ以上のバンドルが含まれる必要があります。

3. バンドルのチャネルエントリーを追加します。たとえば、以下のサンプルを仕様に変更し、<operator_name>-index/index.yaml ファイルに追加します。

   チャネルエントリーの例

   ---
   schema: olm.channel
   package: <operator_name>
   name: preview
   entries:
     - name: <operator_name>.v0.1.0 

   1

   Copy to Clipboard Toggle word wrap

   1

   <operator_name> の後、かつ、バージョンの v の前に、ピリオド (.) を追加するようにしてください。そうでない場合は、エントリーは opm validate コマンドを渡すことができません。

4. ファイルベースのカタログを検証します。

   1. カタログディレクトリーに対して opm validate コマンドを実行します。

      $ opm validate <operator_name>-index

      Copy to Clipboard Toggle word wrap

   2. エラーコードが 0 であることを確認します。

      $ echo $?

      Copy to Clipboard Toggle word wrap

      出力例

      0

      Copy to Clipboard Toggle word wrap

5. カタログイメージをビルドします。

   $ podman build . \
       -f <operator_name>-index.Dockerfile \
       -t <registry>/<namespace>/<catalog_image_name>:<tag>

   Copy to Clipboard Toggle word wrap

6. カタログイメージをレジストリーにプッシュします。

   1. 必要な場合は、ターゲットレジストリーで認証します。

      $ podman login <registry>

      Copy to Clipboard Toggle word wrap

   2. カタログイメージをプッシュします。

      $ podman push <registry>/<namespace>/<catalog_image_name>:<tag>

      Copy to Clipboard Toggle word wrap

手順

1. 新しいインデックスを開始します。

   $ opm index add \
       --bundles <registry>/<namespace>/<bundle_image_name>:<tag> \

   1

   
       --tag <registry>/<namespace>/<index_image_name>:<tag> \

   2

   
       [--binary-image <registry_base_image>] 

   3

   Copy to Clipboard Toggle word wrap

   1

   インデックスに追加するバンドルイメージのコンマ区切りの一覧。

   2

   インデックスイメージで使用するイメージタグ。

   3

   オプション: カタログを提供するために使用する代替レジストリーベースイメージ。

2. インデックスイメージをレジストリーにプッシュします。

   1. 必要な場合は、ターゲットレジストリーで認証します。

      $ podman login <registry>

      Copy to Clipboard Toggle word wrap

   2. インデックスイメージをプッシュします。

      $ podman push <registry>/<namespace>/<index_image_name>:<tag>

      Copy to Clipboard Toggle word wrap

手順

1. バンドルイメージを追加して、既存のインデックスを更新します。

   $ opm index add \
       --bundles <registry>/<namespace>/<new_bundle_image>@sha256:<digest> \

   1

   
       --from-index <registry>/<namespace>/<existing_index_image>:<existing_tag> \

   2

   
       --tag <registry>/<namespace>/<existing_index_image>:<updated_tag> \

   3

   
       --pull-tool podman 

   4

   Copy to Clipboard Toggle word wrap

   1

   --bundlesフラグは、インデックスに追加する他のバンドルイメージのコンマ区切りリストを指定します。

   2

   --from-indexフラグは、以前にプッシュされたインデックスを指定します。

   3

   --tagフラグは、更新されたインデックスイメージに適用するイメージタグを指定します。

   4

   --pull-toolフラグは、コンテナーイメージのプルに使用されるツールを指定します。

   ここでは、以下のようになります。

   <registry>

   quay.ioやmirror.example.comなどのレジストリーのホスト名を指定します。

   <namespace>

   ocs-devやabcなど、レジストリーの namespace を指定します。

   <new_bundle_image>

   ocs-operatorなど、レジストリーに追加する新しいバンドルイメージを指定します。

   <digest>

   c7f11097a628f092d8bad148406aa0e0951094a03445fd4bc0775431ef683a41などのバンドルイメージの SHA イメージ ID またはダイジェストを指定します。

   <existing_index_image>

   abc-redhat-operator-indexなど、以前にプッシュされたイメージを指定します。

   <existing_tag>

   4.9 など、以前にプッシュされたイメージタグを指定します。

   <updated_tag>

   4.9.1 など、更新されたインデックスイメージに適用するイメージタグを指定します。

   コマンドの例

   $ opm index add \
       --bundles quay.io/ocs-dev/ocs-operator@sha256:c7f11097a628f092d8bad148406aa0e0951094a03445fd4bc0775431ef683a41 \
       --from-index mirror.example.com/abc/abc-redhat-operator-index:4.9 \
       --tag mirror.example.com/abc/abc-redhat-operator-index:4.9.1 \
       --pull-tool podman

   Copy to Clipboard Toggle word wrap

2. 更新されたインデックスイメージをプッシュします。

   $ podman push <registry>/<namespace>/<existing_index_image>:<updated_tag>

   Copy to Clipboard Toggle word wrap

3. Operator Lifecycle Manager (OLM) がカタログソースで参照されるインデックスイメージを一定間隔で自動的にポーリングした後に、新規パッケージが正常に追加されたことを確認します。

   $ oc get packagemanifests -n openshift-marketplace

   Copy to Clipboard Toggle word wrap

手順

1. ターゲットレジストリーで認証します。

   $ podman login <target_registry>

   Copy to Clipboard Toggle word wrap

2. プルーニングされたインデックスに追加するパッケージの一覧を判別します。

   1. コンテナーでプルーニングするソースインデックスイメージを実行します。以下に例を示します。

      $ podman run -p50051:50051 \
          -it registry.redhat.io/redhat/redhat-operator-index:v4.9

      Copy to Clipboard Toggle word wrap

      出力例

      Trying to pull registry.redhat.io/redhat/redhat-operator-index:v4.9...
      Getting image source signatures
      Copying blob ae8a0c23f5b1 done
      ...
      INFO[0000] serving registry                              database=/database/index.db port=50051

      Copy to Clipboard Toggle word wrap

   2. 別のターミナルセッションで、grpcurl コマンドを使用して、インデックスが提供するパッケージの一覧を取得します。

      $ grpcurl -plaintext localhost:50051 api.Registry/ListPackages > packages.out

      Copy to Clipboard Toggle word wrap

   3. packages.out ファイルを検査し、プルーニングされたインデックスに保持したいパッケージ名をこの一覧から特定します。以下に例を示します。

      パッケージ一覧のスニペットの例

      ...
      {
        "name": "advanced-cluster-management"
      }
      ...
      {
        "name": "jaeger-product"
      }
      ...
      {
      {
        "name": "quay-operator"
      }
      ...

      Copy to Clipboard Toggle word wrap

   4. podman run コマンドを実行したターミナルセッションで、Ctrl と C を押してコンテナープロセスを停止します。

3. 以下のコマンドを実行して、指定したパッケージ以外のすべてのパッケージのソースインデックスをプルーニングします。

   $ opm index prune \
       -f registry.redhat.io/redhat/redhat-operator-index:v4.9 \

   1

   
       -p advanced-cluster-management,jaeger-product,quay-operator \

   2

   
       [-i registry.redhat.io/openshift4/ose-operator-registry:v4.9] \

   3

   
       -t <target_registry>:<port>/<namespace>/redhat-operator-index:v4.9 

   4

   Copy to Clipboard Toggle word wrap

   1

   プルーニングするインデックス。

   2

   保持するパッケージのコンマ区切りリスト。

   3

   IBM Power および IBM Z イメージのみに必要です: ターゲット OpenShift Container Platform クラスターのメジャーバージョンおよびマイナーバージョンに一致するタグを使用する Operator レジストリーのベースイメージです。

   4

   ビルドされる新規インデックスイメージのカスタムタグ。

4. 以下のコマンドを実行して、新規インデックスイメージをターゲットレジストリーにプッシュします。

   $ podman push <target_registry>:<port>/<namespace>/redhat-operator-index:v4.9

   Copy to Clipboard Toggle word wrap

   ここで、<namespace> はレジストリー上の既存の namespace になります。