拡張機能

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

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"

手順

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

   my-redhat-operators.yaml ファイルの例

   apiVersion: olm.operatorframework.io/v1
   kind: ClusterCatalog
   metadata:
     name: my-redhat-operators 1
   spec:
     priority: 1000 2
     source:
       image:
         pollIntervalMinutes: 10 3
         ref: registry.redhat.io/redhat/community-operator-index:v4.18 4
       type: Image

   1

   カタログは、クラスターに適用されると、metadata.name フィールドの値で自動的にラベル付けされます。ラベルとカタログの選択の詳細は、「カタログコンテンツの解決」を参照してください。

   2

   オプション: クラスター上の他のカタログに対するカタログの優先度を指定します。詳細は、「優先度によるカタログの選択」を参照してください。

   3

   新しいイメージダイジェストを確認するためにリモートレジストリーでポーリングする間隔を分単位で指定します。ポーリングを無効にする場合は、フィールドを設定しないでください。

   4

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

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

   $ oc apply -f my-redhat-operators.yaml

   出力例

   clustercatalog.olm.operatorframework.io/my-redhat-operators created

手順

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

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

      $ mkdir <catalog_dir>

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

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

      1

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

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

      ディレクトリー構造の例

      . 1
      ├── <catalog_dir> 2
      └── <catalog_dir>.Dockerfile 3

      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

      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

   1

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

   2

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

   注記

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

3. バンドルのチャネルエントリーを追加します。たとえば、次の例を仕様に合わせて変更し、<catalog_dir>/index.yaml ファイルに追加します。

   チャネルエントリーの例

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

   1

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

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

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

      $ opm validate <catalog_dir>

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

      $ echo $?

      出力例

      0

5. podman build コマンドを実行して、カタログイメージをビルドします。

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

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

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

      $ podman login <registry>

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

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

手順

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

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

   注記

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

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

   重要

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

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

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

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

     ---
     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
     ---

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

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

   $ opm validate <catalog_dir>

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

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

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

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

検証

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

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

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

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

手順

1. AllNamespaces インストールモードをサポートし、Webhook を使用しない拡張機能のリストを返すには、次のコマンドを入力します。

   $ opm render <catalog_registry_url>:<tag> \
     | jq -cs '[.[] | select(.schema == "olm.bundle" \
     and (.properties[] | select(.type == "olm.csv.metadata").value.installModes[] \
     | select(.type == "AllNamespaces" and .supported == true)) \
     and .spec.webhookdefinitions == null) | .package] | unique[]'

   ここでは

   catalog_registry_url

   カタログレジストリーの URL (registry.redhat.io/redhat/redhat-operator-index など) を指定します。

   tag

   カタログのタグまたはバージョン (v4.18 や latest など) を指定します。

   例10.1 コマンドの例

   $ opm render \
     registry.redhat.io/redhat/redhat-operator-index:v4.18 \
     | jq -cs '[.[] | select(.schema == "olm.bundle" \
     and (.properties[] | select(.type == "olm.csv.metadata").value.installModes[] \
     | select(.type == "AllNamespaces" and .supported == true)) \
     and .spec.webhookdefinitions == null) | .package] | unique[]'

   例10.2 出力例

   "3scale-operator"
   "amq-broker-rhel8"
   "amq-online"
   "amq-streams"
   "amq-streams-console"
   "ansible-automation-platform-operator"
   "ansible-cloud-addons-operator"
   "apicast-operator"
   "authorino-operator"
   "aws-load-balancer-operator"
   "bamoe-kogito-operator"
   "cephcsi-operator"
   "cincinnati-operator"
   "cluster-logging"
   "cluster-observability-operator"
   "compliance-operator"
   "container-security-operator"
   "cryostat-operator"
   "datagrid"
   "devspaces"
   ...

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

   $ opm render <catalog_registry_url>:<tag> \
     | jq -s '.[] | select( .schema == "olm.package") \
     | select( .name == "<package_name>")'

   例10.3 コマンドの例

   $ opm render \
     registry.redhat.io/redhat/redhat-operator-index:v4.18 \
     | jq -s '.[] | select( .schema == "olm.package") \
     | select( .name == "openshift-pipelines-operator-rh")'

   例10.4 出力例

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

手順

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

   apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: <clusterextension_name>
     spec:
       namespace: <installed_namespace> 1
       serviceAccount:
         name: <service_account_installer_name> 2
       source:
         sourceType: Catalog
         catalog:
           packageName: <package_name>
           channels:
             - <channel_name> 3
           version: <version_or_version_range> 4
           upgradeConstraintPolicy: CatalogProvided 5

   1

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

   2

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

   3

   オプション: チャネル名を、pipelines-1.14 や latest などの配列の形で指定します。

   4

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

   5

   オプション: アップグレード制約ポリシーを指定します。指定されていない場合、デフォルト設定は CatalogProvided になります。CatalogProvided 設定が更新されるのは、新しいバージョンがパッケージ作成者によって設定されたアップグレード制約を満たしている場合だけです。更新またはロールバックを強制するには、フィールドを SelfCertified に設定します。詳細は、「更新またはロールバックの強制」を参照してください。

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

   $ oc apply -f pipeline-operator.yaml

   出力例

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

検証

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

   $ oc get clusterextension pipelines-operator -o yaml

   例10.11 出力例

   apiVersion: v1
   items:
   - apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       annotations:
         kubectl.kubernetes.io/last-applied-configuration: |
           {"apiVersion":"olm.operatorframework.io/v1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipes"},"spec":{"namespace":"pipelines","serviceAccount":{"name":"pipelines-installer"},"source":{"catalog":{"packageName":"openshift-pipelines-operator-rh","version":"1.14.x"},"sourceType":"Catalog"}}}
       creationTimestamp: "2025-02-18T21:48:13Z"
       finalizers:
       - olm.operatorframework.io/cleanup-unpack-cache
       - olm.operatorframework.io/cleanup-contentmanager-cache
       generation: 1
       name: pipelines-operator
       resourceVersion: "72725"
       uid: e18b13fb-a96d-436f-be75-a9a0f2b07993
     spec:
       namespace: pipelines
       serviceAccount:
         name: pipelines-installer
       source:
         catalog:
           packageName: openshift-pipelines-operator-rh
           upgradeConstraintPolicy: CatalogProvided
           version: 1.14.x
         sourceType: Catalog
     status:
       conditions:
       - lastTransitionTime: "2025-02-18T21:48:13Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: Deprecated
       - lastTransitionTime: "2025-02-18T21:48:13Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: PackageDeprecated
       - lastTransitionTime: "2025-02-18T21:48:13Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: ChannelDeprecated
       - lastTransitionTime: "2025-02-18T21:48:13Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: BundleDeprecated
       - lastTransitionTime: "2025-02-18T21:48:16Z"
         message: Installed bundle registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:f7b19ce26be742c4aaa458d37bc5ad373b5b29b20aaa7d308349687d3cbd8838
           successfully
         observedGeneration: 1
         reason: Succeeded
         status: "True"
         type: Installed
       - lastTransitionTime: "2025-02-18T21:48:16Z"
         message: desired state reached
         observedGeneration: 1
         reason: Succeeded
         status: "True"
         type: Progressing
       install:
         bundle:
           name: openshift-pipelines-operator-rh.v1.14.5
           version: 1.14.5
   kind: List
   metadata:
     resourceVersion: ""

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

   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

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

手順

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

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

      $ opm render <catalog_registry_url>:<tag> \
        | jq -s '.[] | select( .schema == "olm.channel" ) \
        | select( .package == "openshift-pipelines-operator-rh") | .name'

      例10.12 コマンドの例

      $ opm render registry.redhat.io/redhat/redhat-operator-index:v4.18 \
        | jq -s '.[] | select( .schema == "olm.channel" ) \
        | select( .package == "openshift-pipelines-operator-rh") | .name'

      例10.13 出力例

      "latest"
      "pipelines-1.14"
      "pipelines-1.15"
      "pipelines-1.16"
      "pipelines-1.17"

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

      $ opm render <catalog_registry_url>:<tag> \
        | jq -s '.[] | select( .package == "<package_name>" ) \
        | select( .schema == "olm.channel" ) \
        | select( .name == "<channel_name>" ) | .entries \
        | .[] | .name'

      例10.14 コマンドの例

      $ opm render registry.redhat.io/redhat/redhat-operator-index:v4.18 \
        | jq -s '.[] | select( .package == "openshift-pipelines-operator-rh" ) \
        | select( .schema == "olm.channel" ) | select( .name == "latest" ) \
        | .entries | .[] | .name'

      例10.15 出力例

      "openshift-pipelines-operator-rh.v1.15.0"
      "openshift-pipelines-operator-rh.v1.16.0"
      "openshift-pipelines-operator-rh.v1.17.0"
      "openshift-pipelines-operator-rh.v1.17.1"

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

   $ oc get clusterextension <operator_name> -o yaml

   コマンドの例

   $ oc get clusterextension pipelines-operator -o yaml

   例10.16 出力例

   apiVersion: v1
   items:
   - apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       annotations:
         kubectl.kubernetes.io/last-applied-configuration: |
           {"apiVersion":"olm.operatorframework.io/v1","kind":"ClusterExtension","metadata":{"annotations":{},"name":"pipes"},"spec":{"namespace":"pipelines","serviceAccount":{"name":"pipelines-installer"},"source":{"catalog":{"packageName":"openshift-pipelines-operator-rh","version":"1.14.x"},"sourceType":"Catalog"}}}
       creationTimestamp: "2025-02-18T21:48:13Z"
       finalizers:
       - olm.operatorframework.io/cleanup-unpack-cache
       - olm.operatorframework.io/cleanup-contentmanager-cache
       generation: 1
       name: pipelines-operator
       resourceVersion: "72725"
       uid: e18b13fb-a96d-436f-be75-a9a0f2b07993
     spec:
       namespace: pipelines
       serviceAccount:
         name: pipelines-installer
       source:
         catalog:
           packageName: openshift-pipelines-operator-rh
           upgradeConstraintPolicy: CatalogProvided
           version: 1.14.x
         sourceType: Catalog
     status:
       conditions:
       - lastTransitionTime: "2025-02-18T21:48:13Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: Deprecated
       - lastTransitionTime: "2025-02-18T21:48:13Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: PackageDeprecated
       - lastTransitionTime: "2025-02-18T21:48:13Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: ChannelDeprecated
       - lastTransitionTime: "2025-02-18T21:48:13Z"
         message: ""
         observedGeneration: 1
         reason: Deprecated
         status: "False"
         type: BundleDeprecated
       - lastTransitionTime: "2025-02-18T21:48:16Z"
         message: Installed bundle registry.redhat.io/openshift-pipelines/pipelines-operator-bundle@sha256:f7b19ce26be742c4aaa458d37bc5ad373b5b29b20aaa7d308349687d3cbd8838
           successfully
         observedGeneration: 1
         reason: Succeeded
         status: "True"
         type: Installed
       - lastTransitionTime: "2025-02-18T21:48:16Z"
         message: desired state reached
         observedGeneration: 1
         reason: Succeeded
         status: "True"
         type: Progressing
       install:
         bundle:
           name: openshift-pipelines-operator-rh.v1.14.5
           version: 1.14.5
   kind: List
   metadata:
     resourceVersion: ""

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

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

     pipelines-operator.yaml CR の例

     apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       namespace: pipelines
       serviceAccount:
         name: pipelines-installer
       source:
         sourceType: Catalog
         catalog:
           packageName: openshift-pipelines-operator-rh
           version: "1.15.0" 1

     1

     バージョンを 1.14.x から 1.15.0 に更新します。

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

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

     apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       namespace: pipelines
       serviceAccount:
         name: pipelines-installer
       source:
         sourceType: Catalog
         catalog:
           packageName: openshift-pipelines-operator-rh
           version: ">1.15, <1.17" 1

     1

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

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

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

     apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       namespace: pipelines
       serviceAccount:
         name: pipelines-installer
       source:
         sourceType: Catalog
         catalog:
           packageName: openshift-pipelines-operator-rh
           channels:
             - latest 1

     1

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

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

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

     apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: pipelines-operator
     spec:
       namespace: pipelines
       serviceAccount:
         name: pipelines-installer
       source:
         sourceType: Catalog
         catalog:
           packageName: openshift-pipelines-operator-rh
           channels:
             - latest
           version: "<1.16"

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

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

   $ oc apply -f pipelines-operator.yaml

   出力例

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

手順

1. インストールされたクラスター拡張機能にデフォルトのクラスターロールがない場合は、1 つ以上のロールを手動で作成します。

   1. 「ユーザー用の一般的なデフォルトクラスターロール」で説明されているロールセットのユースケースを検討します。

      たとえば、次の ClusterRole オブジェクト定義を 1 つ以上作成し、<cluster_extension_api_group> と <cluster_extension_custom_resource> を、インストールされたクラスター拡張機能によって提供される実際の API グループとリソース名に置き換えます。

      view-custom-resource.yaml ファイルの例

      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRole
      metadata:
        name: view-custom-resource
      rules:
      - apiGroups:
        - <cluster_extension_api_group>
        resources:
        - <cluster_extension_custom_resources>
        verbs:
        - get
        - list
        - watch

      edit-custom-resource.yaml ファイルの例

      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRole
      metadata:
        name: edit-custom-resource
      rules:
      - apiGroups:
        - <cluster_extension_api_group>
        resources:
        - <cluster_extension_custom_resources>
        verbs:
        - get
        - list
        - watch
        - create
        - update
        - patch
        - delete

      admin-custom-resource.yaml ファイルの例

      apiVersion: rbac.authorization.k8s.io/v1
      kind: ClusterRole
      metadata:
        name: admin-custom-resource
      rules:
      - apiGroups:
        - <cluster_extension_api_group>
        resources:
        - <cluster_extension_custom_resources>
        verbs:
        - '*' 1

      1

      verbs にワイルドカード (*) を設定すると、指定したリソースに対するすべてのアクションが許可されます。

   2. 作成した YAML ファイルに対して次のコマンドを実行して、クラスターロールを作成します。

      $ oc create -f <filename>.yaml

2. クラスターロールを個々のユーザー名またはグループ名にバインドすることで、クラスターロールを特定のユーザーまたはグループに関連付け、リソースに対する必要な権限を付与します。

   1. すべての namespace へのアクセスを許可する クラスターロールバインディング、または特定の namespace 内でアクセスを許可する ロールバインディング のオブジェクト定義を作成します。

      • 次のクラスターロールバインディングの例では、すべての namespace のカスタムリソースに対する読み取り専用の view アクセスを許可します。

        ユーザーの ClusterRoleBinding オブジェクトの例

        apiVersion: rbac.authorization.k8s.io/v1
        kind: ClusterRoleBinding
        metadata:
          name: view-custom-resource-binding
        subjects:
        - kind: User
          name: <user_name>
        roleRef:
          kind: ClusterRole
          name: view-custom-resource
          apiGroup: rbac.authorization.k8s.io

        ユーザーの ClusterRoleBinding オブジェクトの例

        apiVersion: rbac.authorization.k8s.io/v1
        kind: ClusterRoleBinding
        metadata:
          name: view-custom-resource-binding
        subjects:
        - kind: Group
          name: <group_name>
        roleRef:
          kind: ClusterRole
          name: view-custom-resource
          apiGroup: rbac.authorization.k8s.io

      • 次のロールバインディングでは、edit 権限を特定の namespace に制限します。

        ユーザーの RoleBinding オブジェクトの例

        apiVersion: rbac.authorization.k8s.io/v1
        kind: RoleBinding
        metadata:
          name: edit-custom-resource-edit-binding
          namespace: <namespace>
        subjects:
        - kind: User
          name: <username>
        roleRef:
          kind: Role
          name: custom-resource-edit
          apiGroup: rbac.authorization.k8s.io

   2. オブジェクト定義を YAML ファイルに保存します。

   3. 以下のコマンドを実行してオブジェクトを作成します。

      $ oc create -f <filename>.yaml

手順

1. クラスター拡張機能によって提供される API グループとリソースを指定するクラスターロールのオブジェクト定義を作成し、集約ラベルを追加して 1 つ以上の既存のデフォルトクラスターロールを拡張します。

   集約ラベルを使用した ClusterRole オブジェクトの例

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: view-custom-resource-aggregated
     labels:
       rbac.authorization.k8s.io/aggregate-to-view: "true"
   rules:
     - apiGroups:
         - <cluster_extension_api_group>
       resources:
         - <cluster_extension_custom_resource>
       verbs:
         - get
         - list
         - watch

   create、update、delete などの適切な動詞を使用して、edit および admin 用の同様の ClusterRole オブジェクトを作成できます。集約ラベルを使用すると、カスタムリソースの権限がデフォルトのロールに追加されます。

2. オブジェクト定義を YAML ファイルに保存します。

3. 以下のコマンドを実行してオブジェクトを作成します。

   $ oc create -f <filename>.yaml

手順

1. 次の例に示すように、Operator または拡張機能のカスタムリソース (CR) を編集します。

   CR の例:

   apiVersion: olm.operatorframework.io/v1
     kind: ClusterExtension
     metadata:
       name: <clusterextension_name>
     spec:
       namespace: <installed_namespace> 1
       serviceAccount:
         name: <service_account_installer_name> 2
       source:
         sourceType: Catalog
         catalog:
           packageName: <package_name>
           channels:
             - <channel_name> 3
           version: <version_or_version_range> 4
           upgradeConstraintPolicy: SelfCertified 5

   1

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

   2

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

   3

   オプション: チャネル名を、pipelines-1.14 や latest などの配列の形で指定します。

   4

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

   5

   オプション: アップグレード制約ポリシーを指定します。更新またはロールバックを強制するには、フィールドを SelfCertified に設定します。指定されていない場合、デフォルト設定は CatalogProvided になります。CatalogProvided 設定が更新されるのは、新しいバージョンがパッケージ作成者によって設定されたアップグレード制約を満たしている場合だけです。

2. 次のコマンドを実行して、Operator または拡張機能 CR に変更を適用します。

   $ oc apply -f <extension_name>.yaml

手順

1. CRD の ClusterExtension オブジェクトを編集します。

   $ oc edit clusterextension <clusterextension_name>

2. preflight.crdUpgradeSafety.disabled フィールドを true に設定します。

   例10.19 ClusterExtension オブジェクトの例

   apiVersion: olm.operatorframework.io/v1alpha1
   kind: ClusterExtension
   metadata:
       name: clusterextension-sample
   spec:
       installNamespace: default
       packageName: argocd-operator
       version: 0.6.0
       preflight:
           crdUpgradeSafety:
               disabled: true 1

   1

   true に設定します。