拡張機能

1. カタログの設定ファイルを 1 つ維持し、カタログ内に Operator ごとにイメージの参照を含めます。

   カタログ設定ファイルのサンプル

   name: community-operators
   repo: quay.io/community-operators/catalog
   tag: latest
   references:
   - name: etcd-operator
     image: quay.io/etcd-operator/index@sha256:5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
   - name: prometheus-operator
     image: quay.io/prometheus-operator/index@sha256:e258d248fda94c63753607f7c4494ee0fcbe92f1a76bfdac795c9d84101eb317

   Copy to Clipboard Toggle word wrap

2. 設定ファイルを解析し、その参照から新規カタログを作成するスクリプトを実行します。

   スクリプトの例

   name=$(yq eval '.name' catalog.yaml)
   mkdir "$name"
   yq eval '.name + "/" + .references[].name' catalog.yaml | xargs mkdir
   for l in $(yq e '.name as $catalog | .references[] | .image + "|" + $catalog + "/" + .name + "/index.yaml"' catalog.yaml); do
     image=$(echo $l | cut -d'|' -f1)
     file=$(echo $l | cut -d'|' -f2)
     opm render "$image" > "$file"
   done
   opm generate dockerfile "$name"
   indexImage=$(yq eval '.repo + ":" + .tag' catalog.yaml)
   docker build -t "$indexImage" -f "$name.Dockerfile" .
   docker push "$indexImage"

   Copy to Clipboard Toggle word wrap

手順

1. 次の例のようなカタログカスタムリソース (CR) を作成します。

   redhat-operators.yaml の例

   apiVersion: catalogd.operatorframework.io/v1alpha1
   kind: ClusterCatalog
   metadata:
     name: redhat-operators
   spec:
     source:
       type: image
       image:
         ref: registry.redhat.io/redhat/redhat-operator-index:v4.17 

   1

   
         pullSecret: <pull_secret_name> 

   2

   
         pollInterval: <poll_interval_duration> 

   3

   Copy to Clipboard Toggle word wrap

   1

   spec.source.image フィールドにカタログのイメージを指定します。

   2

   カタログが registry.redhat.io などのセキュアなレジストリーでホストされている場合は、スコープを openshift-catalog namespace に設定したプルシークレットを作成する必要があります。

   3

   新しいイメージダイジェストを確認するためにリモートレジストリーをポーリングする間隔を指定します。デフォルト値は、24h です。有効な単位は、秒 (s)、分 (m)、および時間 (h) です。ポーリングを無効にするには、0s などのゼロ値を設定します。

2. 次のコマンドを実行して、カタログをクラスターに追加します。

   $ oc apply -f redhat-operators.yaml

   Copy to Clipboard Toggle word wrap

   出力例

   catalog.catalogd.operatorframework.io/redhat-operators created

   Copy to Clipboard Toggle word wrap

手順

1. カタログを初期化します。

   1. 次のコマンドを実行して、カタログ用のディレクトリーを作成します。

      $ mkdir <catalog_dir>

      Copy to Clipboard Toggle word wrap

   2. opm generate dockerfile コマンドを実行して、カタログイメージを構築できる Dockerfile を生成します。

      $ opm generate dockerfile <catalog_dir> \
          -i registry.redhat.io/openshift4/ose-operator-registry-rhel9:v4.17 

      1

      Copy to Clipboard Toggle word wrap

      1

      -i フラグを使用して公式の Red Hat ベースイメージを指定します。それ以外の場合、Dockerfile はデフォルトのアップストリームイメージを使用します。

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

      ディレクトリー構造の例

      . 

      1

      
      ├── <catalog_dir> 

      2

      
      └── <catalog_dir>.Dockerfile 

      3

      Copy to Clipboard Toggle word wrap

      1

      親ディレクトリー

      2

      カタログディレクトリー

      3

      opm generate dockerfile コマンドによって生成された Dockerfile

   3. opm init コマンドを実行して、カタログに Operator のパッケージ定義を追加します。

      $ opm init <operator_name> \ 

      1

      
          --default-channel=preview \ 

      2

      
          --description=./README.md \ 

      3

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

      4

      
          --output yaml \ 

      5

      
          > <catalog_dir>/index.yaml 

      6

      Copy to Clipboard Toggle word wrap

      1

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

      2

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

      3

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

      4

      Operator のアイコンへのパス。

      5

      出力形式: JSON または YAML。

      6

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

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

2. opm render コマンドを実行して、バンドルをカタログに追加します。

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

   1

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

   2

   Copy to Clipboard Toggle word wrap

   1

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

   2

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

   注記

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

3. バンドルのチャネルエントリーを追加します。たとえば、次の例を仕様に合わせて変更し、<catalog_dir>/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 <catalog_dir>

      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 コマンドを実行して、カタログイメージをビルドします。

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

   Copy to Clipboard Toggle word wrap

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

   1. 必要に応じて、podman login コマンドを実行してターゲットレジストリーで認証します。

      $ podman login <registry>

      Copy to Clipboard Toggle word wrap

   2. podman push コマンドを実行して、カタログイメージをプッシュします。

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

      Copy to Clipboard Toggle word wrap

手順

1. カタログイメージのコンテンツを YAML 形式でカタログディレクトリーの index.yaml ファイルに展開します。

   $ opm render <registry>/<namespace>/<catalog_image_name>:<tag> \
       -o yaml > <catalog_dir>/index.yaml

   Copy to Clipboard Toggle word wrap
   注記

   または、-o json フラグを使用して JSON 形式で出力することもできます。

2. 作成された index.yaml ファイルの内容を仕様に合わせて変更します。

   重要

   バンドルがカタログに公開されたら、いずれかのユーザーがバンドルをインストールしていると想定します。カタログ内で以前に公開されたすべてのバンドルに、現在または新しいチャネルヘッドへの更新パスが設定されていることを確認し、そのバージョンがインストールされているユーザーが立ち往生するのを防ぎます。

   • Operator を追加するには、「ファイルベースのカタログイメージの作成」手順のパッケージ、バンドル、およびチャネルエントリーを作成する手順に従います。

   • Operator を削除するには、パッケージに関連する olm.package、olm.channel、および olm.bundle Blob のセットを削除します。次の例は、カタログから example-operator パッケージを削除するために削除する必要があるセットを示しています。

     例4.12 削除されたエントリーの例

     ---
     defaultChannel: release-2.7
     icon:
       base64data: <base64_string>
       mediatype: image/svg+xml
     name: example-operator
     schema: olm.package
     ---
     entries:
     - name: example-operator.v2.7.0
       skipRange: '>=2.6.0 <2.7.0'
     - name: example-operator.v2.7.1
       replaces: example-operator.v2.7.0
       skipRange: '>=2.6.0 <2.7.1'
     - name: example-operator.v2.7.2
       replaces: example-operator.v2.7.1
       skipRange: '>=2.6.0 <2.7.2'
     - name: example-operator.v2.7.3
       replaces: example-operator.v2.7.2
       skipRange: '>=2.6.0 <2.7.3'
     - name: example-operator.v2.7.4
       replaces: example-operator.v2.7.3
       skipRange: '>=2.6.0 <2.7.4'
     name: release-2.7
     package: example-operator
     schema: olm.channel
     ---
     image: example.com/example-inc/example-operator-bundle@sha256:<digest>
     name: example-operator.v2.7.0
     package: example-operator
     properties:
     - type: olm.gvk
       value:
         group: example-group.example.io
         kind: MyObject
         version: v1alpha1
     - type: olm.gvk
       value:
         group: example-group.example.io
         kind: MyOtherObject
         version: v1beta1
     - type: olm.package
       value:
         packageName: example-operator
         version: 2.7.0
     - type: olm.bundle.object
       value:
         data: <base64_string>
     - type: olm.bundle.object
       value:
         data: <base64_string>
     relatedImages:
     - image: example.com/example-inc/example-related-image@sha256:<digest>
       name: example-related-image
     schema: olm.bundle
     ---

     Copy to Clipboard Toggle word wrap
   • Operator の非推奨メッセージを追加または更新するには、パッケージの index.yaml ファイルと同じディレクトリーに deprecations.yaml ファイルがあることを確認してください。deprecations.yaml ファイル形式の詳細は、「olm.deprecations スキーマ」を参照してください。
3. 変更を保存します。

4. カタログを検証します。

   $ opm validate <catalog_dir>

   Copy to Clipboard Toggle word wrap

5. カタログを再構築します。

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

   Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap

検証

1. Web コンソールで、Administration → Cluster Settings → Configuration ページで OperatorHub 設定リソースに移動します。

2. カタログソースを追加するか、既存のカタログソースを更新して、更新されたカタログイメージのプル仕様を使用します。

   詳細は、このセクションの「関連情報」にある「クラスターへのカタログソースの追加」を参照してください。

3. カタログソースが READY 状態になったら、Operators → OperatorHub ページに移動し、加えた変更が Operator のリストに反映されていることを確認します。

手順

1. 次のコマンドを実行して、openshift-catalogd namespace のカタログサーバーサービスのポート転送を行います。

   $ oc -n openshift-catalogd port-forward svc/catalogd-catalogserver 8080:443

   Copy to Clipboard Toggle word wrap

2. 新しいターミナルウィンドウまたはタブで、次のコマンドを実行してカタログの JSON ファイルをローカルにダウンロードします。

   $ curl -L -k https://localhost:8080/catalogs/<catalog_name>/all.json \
     -C - -o /<path>/<catalog_name>.json

   Copy to Clipboard Toggle word wrap

   例5.1 コマンドの例

   $ curl -L -k https://localhost:8080/catalogs/redhat-operators/all.json \
     -C - -o /home/username/catalogs/rhoc.json

   Copy to Clipboard Toggle word wrap

3. 次のコマンドのいずれかを実行して、カタログ内のオペレータと拡張機能のリストを返します。

   重要

   現在、Operator Lifecycle Manager (OLM) v1 は、次のすべての条件を満たすクラスター拡張機能のインストールをサポートしています。

   • 拡張機能は、既存の OLM で導入された registry+v1 バンドル形式を使用する必要があります。
   • 拡張機能は、AllNamespaces インストールモードによるインストールをサポートする必要があります。
   • 拡張機能は Webhook を使用してはなりません。

   • 拡張機能は、次に示すいずれかのファイルベースのカタログプロパティーを使用して依存関係を宣言してはなりません。

     • olm.gvk.required
     • olm.package.required
     • olm.constraint

   OLM v1 は、インストールする拡張機能がこれらの制約を満たしているかどうかを確認します。インストールする拡張機能がこれらの制約を満たしていない場合、クラスター拡張機能の条件にエラーメッセージが出力されます。

   • 次のコマンドを実行して、ローカルカタログファイルからすべての Operator と拡張機能のリストを取得します。

     $ jq -s '.[] | select(.schema == "olm.package") | .name' \
       /<path>/<filename>.json

     Copy to Clipboard Toggle word wrap

     例5.2 コマンドの例

     $ jq -s '.[] | select(.schema == "olm.package") | .name' \
       /home/username/catalogs/rhoc.json

     Copy to Clipboard Toggle word wrap

     例5.3 出力例

     NAME                                                        AGE
     "3scale-operator"
     "advanced-cluster-management"
     "amq-broker-rhel8"
     "amq-online"
     "amq-streams"
     "amq7-interconnect-operator"
     "ansible-automation-platform-operator"
     "ansible-cloud-addons-operator"
     "apicast-operator"
     "aws-efs-csi-driver-operator"
     "aws-load-balancer-operator"
     "bamoe-businessautomation-operator"
     "bamoe-kogito-operator"
     "bare-metal-event-relay"
     "businessautomation-operator"
     ...

     Copy to Clipboard Toggle word wrap

   • 次のコマンドを実行して、AllNamespaces インストールモードをサポートし、Webhook を使用しないパッケージのリストを、ローカルカタログファイルから取得します。

     $ jq -c 'select(.schema == "olm.bundle") | \
       {"package":.package, "version":.properties[] | \
       select(.type == "olm.bundle.object").value.data | @base64d | fromjson | \
       select(.kind == "ClusterServiceVersion" and (.spec.installModes[] | \
       select(.type == "AllNamespaces" and .supported == true) != null) \
       and .spec.webhookdefinitions == null).spec.version}' \
       /<path>/<catalog_name>.json

     Copy to Clipboard Toggle word wrap

     例5.4 出力例

     {"package":"3scale-operator","version":"0.10.0-mas"}
     {"package":"3scale-operator","version":"0.10.5"}
     {"package":"3scale-operator","version":"0.11.0-mas"}
     {"package":"3scale-operator","version":"0.11.1-mas"}
     {"package":"3scale-operator","version":"0.11.2-mas"}
     {"package":"3scale-operator","version":"0.11.3-mas"}
     {"package":"3scale-operator","version":"0.11.5-mas"}
     {"package":"3scale-operator","version":"0.11.6-mas"}
     {"package":"3scale-operator","version":"0.11.7-mas"}
     {"package":"3scale-operator","version":"0.11.8-mas"}
     {"package":"amq-broker-rhel8","version":"7.10.0-opr-1"}
     {"package":"amq-broker-rhel8","version":"7.10.0-opr-2"}
     {"package":"amq-broker-rhel8","version":"7.10.0-opr-3"}
     {"package":"amq-broker-rhel8","version":"7.10.0-opr-4"}
     {"package":"amq-broker-rhel8","version":"7.10.1-opr-1"}
     {"package":"amq-broker-rhel8","version":"7.10.1-opr-2"}
     {"package":"amq-broker-rhel8","version":"7.10.2-opr-1"}
     {"package":"amq-broker-rhel8","version":"7.10.2-opr-2"}
     ...

     Copy to Clipboard Toggle word wrap

4. 次のコマンドを実行して、Operator または拡張機能のメタデータの内容を検査します。

   $ jq -s '.[] | select( .schema == "olm.package") | \
     select( .name == "<package_name>")' /<path>/<catalog_name>.json

   Copy to Clipboard Toggle word wrap

   例5.5 コマンドの例

   $ jq -s '.[] | select( .schema == "olm.package") | \
     select( .name == "openshift-pipelines-operator-rh")' \
     /home/username/rhoc.json

   Copy to Clipboard Toggle word wrap

   例5.6 出力例

   {
     "defaultChannel": "stable",
     "icon": {
       "base64data": "PHN2ZyB4bWxu..."
       "mediatype": "image/png"
     },
     "name": "openshift-pipelines-operator-rh",
     "schema": "olm.package"
   }

   Copy to Clipboard Toggle word wrap

手順

1. 次の例のように、サービスアカウントを作成します。

   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: <extension>-installer
     namespace: <namespace>

   Copy to Clipboard Toggle word wrap

   例5.7 extension-service-account.yaml ファイルの例

   apiVersion: v1
   kind: ServiceAccount
   metadata:
     name: pipelines-installer
     namespace: pipelines

   Copy to Clipboard Toggle word wrap

2. 次のコマンドを実行してサービスアカウントを適用します。

   $ oc apply -f extension-service-account.yaml

   Copy to Clipboard Toggle word wrap

3. 次の例のように、クラスターロールを作成し、RBAC を割り当てます。

   警告

   次のクラスターロールは、最小権限の原則に従っていません。このクラスターロールはテスト目的に限定して使用できます。実稼働クラスターでは使用しないでください。

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: <extension>-installer-clusterrole
   rules:
   - apiGroups: ["*"]
     resources: ["*"]
     verbs: ["*"]

   Copy to Clipboard Toggle word wrap

   例5.8 pipelines-cluster-role.yaml ファイルの例

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: pipelines-installer-clusterrole
   rules:
   - apiGroups: ["*"]
     resources: ["*"]
     verbs: ["*"]

   Copy to Clipboard Toggle word wrap

4. 次のコマンドを実行して、クラスターにクラスターロールを追加します。

   $ oc apply -f pipelines-role.yaml

   Copy to Clipboard Toggle word wrap

5. 次の例のように、クラスターロールバインディングを作成して、クラスターロールによって付与された権限をサービスアカウントにバインドします。

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: <extension>-installer-binding
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: ClusterRole
     name: <extension>-installer-clusterrole
   subjects:
   - kind: ServiceAccount
     name: <extension>-installer
     namespace: <namespace>

   Copy to Clipboard Toggle word wrap

   例5.9 pipelines-cluster-role-binding.yaml ファイルの例

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: pipelines-installer-binding
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: ClusterRole
     name: pipelines-installer-clusterrole
   subjects:
   - kind: ServiceAccount
     name: pipelines-installer
     namespace: pipelines

   Copy to Clipboard Toggle word wrap

6. 次のコマンドを実行して、クラスターロールバインディングを適用します。

   $ oc apply -f pipelines-cluster-role-binding.yaml

   Copy to Clipboard Toggle word wrap

手順

1. 次の手順を実行して、カタログファイルのローカルコピーからパッケージのチャネルとバージョン情報を検査します。

   1. 次のコマンドを実行して、選択したパッケージからチャネルのリストを取得します。

      $ jq -s '.[] | select( .schema == "olm.channel" ) | \
        select( .package == "<package_name>") | \
        .name' /<path>/<catalog_name>.json

      Copy to Clipboard Toggle word wrap

      例5.10 コマンドの例

      $ jq -s '.[] | select( .schema == "olm.channel" ) | \
        select( .package == "openshift-pipelines-operator-rh") | \
        .name' /home/username/rhoc.json

      Copy to Clipboard Toggle word wrap

      例5.11 出力例

      "latest"
      "pipelines-1.11"
      "pipelines-1.12"
      "pipelines-1.13"
      "pipelines-1.14"

      Copy to Clipboard Toggle word wrap

   2. 次のコマンドを実行して、チャネルで公開されているバージョンのリストを取得します。

      $ jq -s '.[] | select( .package == "<package_name>" ) | \
        select( .schema == "olm.channel" ) | \
        select( .name == "<channel_name>" ) | .entries | \
        .[] | .name' /<path>/<catalog_name>.json

      Copy to Clipboard Toggle word wrap

      例5.12 コマンドの例

      $ jq -s '.[] | select( .package == "openshift-pipelines-operator-rh" ) | \
      select( .schema == "olm.channel" ) | select( .name == "latest" ) | \
      .entries | .[] | .name' /home/username/rhoc.json

      Copy to Clipboard Toggle word wrap

      例5.13 出力例

      "openshift-pipelines-operator-rh.v1.12.0"
      "openshift-pipelines-operator-rh.v1.12.1"
      "openshift-pipelines-operator-rh.v1.12.2"
      "openshift-pipelines-operator-rh.v1.13.0"
      "openshift-pipelines-operator-rh.v1.13.1"
      "openshift-pipelines-operator-rh.v1.11.1"
      "openshift-pipelines-operator-rh.v1.12.0"
      "openshift-pipelines-operator-rh.v1.12.1"
      "openshift-pipelines-operator-rh.v1.12.2"
      "openshift-pipelines-operator-rh.v1.13.0"
      "openshift-pipelines-operator-rh.v1.14.1"
      "openshift-pipelines-operator-rh.v1.14.2"
      "openshift-pipelines-operator-rh.v1.14.3"
      "openshift-pipelines-operator-rh.v1.14.4"

      Copy to Clipboard Toggle word wrap

2. 拡張機能を新しい namespace にインストールする場合は、次のコマンドを実行します。

   $ oc adm new-project <new_namespace>

   Copy to Clipboard Toggle word wrap

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

   pipelines-operator.yaml CR の例

   apiVersion: olm.operatorframework.io/v1alpha1
   kind: ClusterExtension
   metadata:
     name: pipelines-operator
   spec:
     packageName: openshift-pipelines-operator-rh
     installNamespace: <namespace>
     serviceAccount:
       name: <service_account>
     channel: <channel>
     version: "<version>"

   Copy to Clipboard Toggle word wrap

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

   <namespace>

   pipelines や my-extension など、バンドルをインストールする namespace を指定します。拡張機能は継続してクラスタースコープであり、異なる namespace にインストールされているリソースが含まれる可能性があります。

   <service_account>

   拡張機能をインストール、更新、管理するために作成したサービスアカウントの名前を指定します。

   <channel>

   オプション: インストールまたは更新するパッケージのチャネル (pipelines-1.11、latest など) を指定します。

   <version>

   オプション: インストールまたは更新するパッケージのバージョンまたはバージョン範囲 (1.11.1、1.12.x、>=1.12.1 など) を指定します。詳細は、「ターゲットバージョンを指定するカスタムリソース (CR) の例」および「バージョン範囲のサポート」を参照してください。

   重要

   一意の名前を持たない Operator または拡張機能をインストールしようとすると、インストールが失敗するか、予期しない結果になる可能性があります。その原因は以下のとおりです。

   • クラスターに複数のカタログがインストールされている場合、Operator Lifecycle Manager (OLM) v1 には、Operator または拡張機能のインストール時にカタログを指定するメカニズムがありません。
   • OLM v1 では、クラスターにインストールできるすべての Operator および拡張機能のバンドルとパッケージに、一意の名前が使用されている必要があります。

4. 次のコマンドを実行して、CR をクラスターに適用します。

   $ oc apply -f pipeline-operator.yaml

   Copy to Clipboard Toggle word wrap

   出力例

   clusterextension.olm.operatorframework.io/pipelines-operator created

   Copy to Clipboard Toggle word wrap

検証

1. 次のコマンドを実行して、Operator または拡張機能の CR を YAML 形式で表示します。

   $ oc get clusterextension pipelines-operator -o yaml

   Copy to Clipboard Toggle word wrap

   例5.14 出力例

   apiVersion: v1
   items:
   - apiVersion: olm.operatorframework.io/v1alpha1
     kind: ClusterExtension
     metadata:
       annotations:
         kubectl.kubernetes.io/last-applied-configuration: |
           {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipelines-operator"},"spec":{"channel":"latest","installNamespace":"pipelines","packageName":"openshift-pipelines-operator-rh","serviceAccount":{"name":"pipelines-installer"},"pollInterval":"30m"}}
       creationTimestamp: "2024-06-10T17:50:51Z"
       finalizers:
       - olm.operatorframework.io/cleanup-unpack-cache
       generation: 1
       name: pipelines-operator
       resourceVersion: "53324"
       uid: c54237be-cde4-46d4-9b31-d0ec6acc19bf
     spec:
       channel: latest
       installNamespace: pipelines
       packageName: openshift-pipelines-operator-rh
       serviceAccount:
         name: pipelines-installer
       upgradeConstraintPolicy: Enforce
     status:
       conditions:
       - lastTransitionTime: "2024-06-10T17:50:58Z"
         message: resolved to "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:dd3d18367da2be42539e5dde8e484dac3df33ba3ce1d5bcf896838954f3864ec"
         observedGeneration: 1
         reason: Success
         status: "True"
         type: Resolved
       - lastTransitionTime: "2024-06-10T17:51:11Z"
         message: installed from "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:dd3d18367da2be42539e5dde8e484dac3df33ba3ce1d5bcf896838954f3864ec"
         observedGeneration: 1
         reason: Success
         status: "True"
         type: Installed
       - lastTransitionTime: "2024-06-10T17:50:58Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: Deprecated
       - lastTransitionTime: "2024-06-10T17:50:58Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: PackageDeprecated
       - lastTransitionTime: "2024-06-10T17:50:58Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: ChannelDeprecated
       - lastTransitionTime: "2024-06-10T17:50:58Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: BundleDeprecated
       - lastTransitionTime: "2024-06-10T17:50:58Z"
         message: 'unpack successful:
         observedGeneration: 1
         reason: UnpackSuccess
         status: "True"
         type: Unpacked
       installedBundle:
         name: openshift-pipelines-operator-rh.v1.14.4
         version: 1.14.4
       resolvedBundle:
         name: openshift-pipelines-operator-rh.v1.14.4
         version: 1.14.4

   Copy to Clipboard Toggle word wrap

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

   spec.channel

   拡張の CR で定義されたチャネルを表示します。

   spec.version

   拡張の CR で定義されたバージョンまたはバージョン範囲を表示します。

   status.conditions

   拡張機能のステータスと健全性に関する情報を表示します。

   type: Deprecated

   次の 1 つ以上が非推奨かどうかを表示します。

   type: PackageDeprecated

   解決されたパッケージが非推奨かどうかを表示します。

   type: ChannelDeprecated

   解決されたチャネルが非推奨かどうかを表示します。

   type: BundleDeprecated

   解決されたバンドルが非推奨かどうかを表示します。

   status フィールドの False の値は reason: Deprecated 条件が非推奨ではないことを示します。ステータス フィールドの True の値は reason: Deprecated 条件が非推奨であることを示します。

   installedBundle.name

   インストールされているバンドルの名前を表示します。

   installedBundle.version

   インストールされているバンドルのバージョンを表示します。

   resolvedBundle.name

   解決されたバンドルの名前を表示します。

   resolvedBundle.version

   解決されたバンドルのバージョンを表示します。

手順

1. 次の手順を実行して、カタログファイルのローカルコピーからパッケージのチャネルとバージョン情報を検査します。

   1. 次のコマンドを実行して、選択したパッケージからチャネルのリストを取得します。

      $ jq -s '.[] | select( .schema == "olm.channel" ) | \
        select( .package == "<package_name>") | \
        .name' /<path>/<catalog_name>.json

      Copy to Clipboard Toggle word wrap

      例5.15 コマンドの例

      $ jq -s '.[] | select( .schema == "olm.channel" ) | \
        select( .package == "openshift-pipelines-operator-rh") | \
        .name' /home/username/rhoc.json

      Copy to Clipboard Toggle word wrap

      例5.16 出力例

      "latest"
      "pipelines-1.11"
      "pipelines-1.12"
      "pipelines-1.13"
      "pipelines-1.14"

      Copy to Clipboard Toggle word wrap

   2. 次のコマンドを実行して、チャネルで公開されているバージョンのリストを取得します。

      $ jq -s '.[] | select( .package == "<package_name>" ) | \
        select( .schema == "olm.channel" ) | \
        select( .name == "<channel_name>" ) | .entries | \
        .[] | .name' /<path>/<catalog_name>.json

      Copy to Clipboard Toggle word wrap

      例5.17 コマンドの例

      $ jq -s '.[] | select( .package == "openshift-pipelines-operator-rh" ) | \
      select( .schema == "olm.channel" ) | select( .name == "latest" ) | \
      .entries | .[] | .name' /home/username/rhoc.json

      Copy to Clipboard Toggle word wrap

      例5.18 出力例

      "openshift-pipelines-operator-rh.v1.11.1"
      "openshift-pipelines-operator-rh.v1.12.0"
      "openshift-pipelines-operator-rh.v1.12.1"
      "openshift-pipelines-operator-rh.v1.12.2"
      "openshift-pipelines-operator-rh.v1.13.0"
      "openshift-pipelines-operator-rh.v1.14.1"
      "openshift-pipelines-operator-rh.v1.14.2"
      "openshift-pipelines-operator-rh.v1.14.3"
      "openshift-pipelines-operator-rh.v1.14.4"

      Copy to Clipboard Toggle word wrap

2. 次のコマンドを実行して、Operator または拡張機能の CR で指定されているバージョンまたはチャネルを確認します。

   $ oc get clusterextension <operator_name> -o yaml

   Copy to Clipboard Toggle word wrap

   コマンドの例

   $ oc get clusterextension pipelines-operator -o yaml

   Copy to Clipboard Toggle word wrap

   例5.19 出力例

   apiVersion: olm.operatorframework.io/v1alpha1
   kind: ClusterExtension
   metadata:
     annotations:
       kubectl.kubernetes.io/last-applied-configuration: |
         {"apiVersion":"olm.operatorframework.io/v1alpha1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipelines-operator"},"spec":{"channel":"latest","installNamespace":"openshift-operators","packageName":"openshift-pipelines-operator-rh","pollInterval":"30m","version":"\u003c1.12"}}
     creationTimestamp: "2024-06-11T15:55:37Z"
     generation: 1
     name: pipelines-operator
     resourceVersion: "69776"
     uid: 6a11dff3-bfa3-42b8-9e5f-d8babbd6486f
   spec:
     channel: latest
     installNamespace: openshift-operators
     packageName: openshift-pipelines-operator-rh
     upgradeConstraintPolicy: Enforce
     version: <1.12
   status:
     conditions:
     - lastTransitionTime: "2024-06-11T15:56:09Z"
       message: installed from "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:e09d37bb1e754db42324fd18c1cb3e7ce77e7b7fcbf4932d0535391579938280"
       observedGeneration: 1
       reason: Success
       status: "True"
       type: Installed
     - lastTransitionTime: "2024-06-11T15:55:50Z"
       message: resolved to "registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:e09d37bb1e754db42324fd18c1cb3e7ce77e7b7fcbf4932d0535391579938280"
       observedGeneration: 1
       reason: Success
       status: "True"
       type: Resolved
     - lastTransitionTime: "2024-06-11T15:55:50Z"
       message: ""
       observedGeneration: 1
       reason: Deprecated
       status: "False"
       type: Deprecated
     - lastTransitionTime: "2024-06-11T15:55:50Z"
       message: ""
       observedGeneration: 1
       reason: Deprecated
       status: "False"
       type: PackageDeprecated
     - lastTransitionTime: "2024-06-11T15:55:50Z"
       message: ""
       observedGeneration: 1
       reason: Deprecated
       status: "False"
       type: ChannelDeprecated
     - lastTransitionTime: "2024-06-11T15:55:50Z"
       message: ""
       observedGeneration: 1
       reason: Deprecated
       status: "False"
       type: BundleDeprecated
     installedBundle:
       name: openshift-pipelines-operator-rh.v1.11.1
       version: 1.11.1
     resolvedBundle:
       name: openshift-pipelines-operator-rh.v1.11.1
       version: 1.11.1

   Copy to Clipboard Toggle word wrap

3. 次のいずれかの方法を使用して CR を編集します。

   • Operator または拡張機能を特定のバージョン (1.12.1 など) に固定する場合は、次の例のように CR を編集します。

     pipelines-operator.yaml CR の例

     apiVersion: olm.operatorframework.io/v1alpha1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       packageName: openshift-pipelines-operator-rh
       installNamespace: <namespace>
       version: "1.12.1" 

     1

     Copy to Clipboard Toggle word wrap

     1

     バージョンを 1.11.1 から 1.12.1 に更新します。

   • 許容可能な更新バージョンの範囲を定義する場合は、次の例のように CR を編集します。

     バージョン範囲を指定した CR の例

     apiVersion: olm.operatorframework.io/v1alpha1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       packageName: openshift-pipelines-operator-rh
       installNamespace: <namespace>
       version: ">1.11.1, <1.13" 

     1

     Copy to Clipboard Toggle word wrap

     1

     必要なバージョン範囲が、バージョン 1.11.1 より大きく、1.13 より小さいことを指定します。詳細は、「バージョン範囲のサポート」および「バージョン比較文字列」を参照してください。

   • チャネルから解決できる最新バージョンに更新する場合は、次の例のように CR を編集します。

     チャネルを指定した CR の例

     apiVersion: olm.operatorframework.io/v1alpha1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       packageName: openshift-pipelines-operator-rh
       installNamespace: <namespace>
       channel: pipelines-1.13 

     1

     Copy to Clipboard Toggle word wrap

     1

     指定されたチャネルから解決できる最新リリースをインストールします。チャネルへの更新は自動的にインストールされます。

   • チャネルとバージョンまたはバージョン範囲を指定する場合は、次の例のように CR を編集します。

     チャネルとバージョン範囲を指定した CR の例

     apiVersion: olm.operatorframework.io/v1alpha1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       packageName: openshift-pipelines-operator-rh
       installNamespace: <namespace>
       channel: latest
       version: "<1.13"

     Copy to Clipboard Toggle word wrap

     詳細は、「ターゲットバージョンを指定するカスタムリソース (CR) の例」を参照してください。

4. 次のコマンドを実行して、クラスターに更新を適用します。

   $ oc apply -f pipelines-operator.yaml

   Copy to Clipboard Toggle word wrap

   出力例

   clusterextension.olm.operatorframework.io/pipelines-operator configured

   Copy to Clipboard Toggle word wrap

   ヒント

   次のコマンドを実行すると、CLI から CR にパッチを適用して変更を適用できます。

   $ oc patch clusterextension/pipelines-operator -p \
     '{"spec":{"version":"<1.13"}}' \
     --type=merge

   Copy to Clipboard Toggle word wrap

   出力例

   clusterextension.olm.operatorframework.io/pipelines-operator patched

   Copy to Clipboard Toggle word wrap