5.5. Helm ベースの Operator

手順

1. helm-charts/nginx/values.yaml ファイルには、デフォルトで replicaCount という名前の値が 1 に設定されています。デプロイメントに 2 つの Nginx インスタンスを設定するには、CR 仕様に replicaCount: 2 が含まれる必要があります。

   config/samples/demo_v1_nginx.yaml ファイルを編集し、replicaCount: 2 を設定します。

   apiVersion: demo.example.com/v1
   kind: Nginx
   metadata:
     name: nginx-sample
   ...
   spec:
   ...
     replicaCount: 2

2. 同様に、デフォルトのサービスポートは 80 に設定されます。8080 を使用するには、config/samples/demo_v1_nginx.yaml ファイルを編集し、spec.port: 8080 を設定します。これにより、サービスポートの上書きが追加されます。

   apiVersion: demo.example.com/v1
   kind: Nginx
   metadata:
     name: nginx-sample
   spec:
     replicaCount: 2
     service:
       port: 8080

手順

1. プロジェクトの root レベルの Dockerfile をサポートされるイメージを使用するように更新します。以下のデフォルトのビルダーイメージの参照を変更します。

   FROM quay.io/operator-framework/helm-operator:v1.3.0

   以下のように変更してください。

   FROM registry.redhat.io/openshift4/ose-helm-operator:v4.7

   重要

   Operator SDK バージョンに一致するビルダーイメージのバージョンを使用します。これを実行できないと、プロジェクトのレイアウトまたは スキャフォールディング による問題や、とくに Operator SDK の新規アップストリームバージョンをダウンストリームの OpenShift Container Platform ビルダーイメージと組み合わせて使用する場合に差異による問題が生じる可能性があります。

2. config/default/manager_auth_proxy_patch.yaml ファイルで、以下の image の値を変更します。

   gcr.io/kubebuilder/kube-rbac-proxy:<tag>

   サポートされるイメージを使用するには、以下へ変更します。

   registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.7

手順

1. 以下の make コマンドを実行して Operator イメージをビルドし、プッシュします。以下の手順の IMG 引数を変更して、アクセス可能なリポジトリーを参照します。Quay.io などのリポジトリーサイトにコンテナーを保存するためのアカウントを取得できます。

   1. イメージをビルドします。

      $ make docker-build IMG=<registry>/<user>/<image_name>:<tag>

      注記

      Operator の SDK によって生成される Dockerfile は、go build について GOARCH=amd64 を明示的に参照します。これは、AMD64 アーキテクチャー以外の場合は GOARCH=$TARGETARCH に修正できます。Docker は、-platform で指定された値に環境変数を自動的に設定します。Buildah では、そのために -build-arg を使用する必要があります。詳細は、Multiple Architectures を参照してください。

   2. イメージをリポジトリーにプッシュします。

      $ make docker-push IMG=<registry>/<user>/<image_name>:<tag>

      注記

      両方のコマンドのイメージの名前とタグ (例: IMG=<registry>/<user>/<image_name>:<tag>) を Makefile に設定することもできます。IMG ?= controller:latest の値を変更して、デフォルトのイメージ名を設定します。

2. 以下のコマンドを実行して Operator をデプロイします。

   $ make deploy IMG=<registry>/<user>/<image_name>:<tag>

   デフォルトで、このコマンドは <project_name>-system の形式で Operator プロジェクトの名前で namespace を作成し、デプロイメントに使用します。このコマンドは、config/rbac から RBAC マニフェストもインストールします。

3. Operator が実行されていることを確認します。

   $ oc get deployment -n <project_name>-system

   出力例

   NAME                                    READY   UP-TO-DATE   AVAILABLE   AGE
   <project_name>-controller-manager       1/1     1            1           8m

手順

1. 以下の make コマンドを Operator プロジェクトディレクトリーで実行し、Operator イメージをビルドし、プッシュします。以下の手順の IMG 引数を変更して、アクセス可能なリポジトリーを参照します。Quay.io などのリポジトリーサイトにコンテナーを保存するためのアカウントを取得できます。

   1. イメージをビルドします。

      $ make docker-build IMG=<registry>/<user>/<operator_image_name>:<tag>

      注記

      Operator の SDK によって生成される Dockerfile は、go build について GOARCH=amd64 を明示的に参照します。これは、AMD64 アーキテクチャー以外の場合は GOARCH=$TARGETARCH に修正できます。Docker は、-platform で指定された値に環境変数を自動的に設定します。Buildah では、そのために -build-arg を使用する必要があります。詳細は、Multiple Architectures を参照してください。

   2. イメージをリポジトリーにプッシュします。

      $ make docker-push IMG=<registry>/<user>/<operator_image_name>:<tag>

2. Operator SDK generate bundle および bundle validate のサブコマンドを含む複数のコマンドを呼び出す make bundle コマンドを実行し、Operator バンドルマニフェストを作成します。

   $ make bundle IMG=<registry>/<user>/<operator_image_name>:<tag>

   Operator のバンドルマニフェストは、アプリケーションを表示し、作成し、管理する方法を説明します。make bundle コマンドは、以下のファイルおよびディレクトリーを Operator プロジェクトに作成します。

   • ClusterServiceVersion オブジェクトを含む bundle/manifests という名前のバンドルマニフェストディレクトリー
   • bundle/metadata という名前のバンドルメタデータディレクトリー
   • config/crd ディレクトリー内のすべてのカスタムリソース定義 (CRD)
   • Dockerfile bundle.Dockerfile

   続いて、これらのファイルは operator-sdk bundle validate を使用して自動的に検証され、ディスク上のバンドル表現が正しいことを確認します。

3. 以下のコマンドを実行し、バンドルイメージをビルドしてプッシュします。OLM は、1 つ以上のバンドルイメージを参照するインデックスイメージを使用して Operator バンドルを使用します。

   1. バンドルイメージをビルドします。イメージをプッシュしようとするレジストリー、ユーザー namespace、およびイメージタグの詳細で BUNDLE_IMAGE を設定します。

      $ make bundle-build BUNDLE_IMG=<registry>/<user>/<bundle_image_name>:<tag>

   2. バンドルイメージをプッシュします。

      $ docker push <registry>/<user>/<bundle_image_name>:<tag>

4. 以下の Operator SDK コマンドを使用して、クラスターで OLM のステータスを確認します。

   $ operator-sdk olm status \
       --olm-namespace=openshift-operator-lifecycle-manager

5. Operator SDK で OLM 統合を使用して、クラスターで Operator を実行します。

   $ operator-sdk run bundle \
       [-n <namespace>] \1
       <registry>/<user>/<bundle_image_name>:<tag>

   1

   デフォルトで、このコマンドは ~/.kube/config ファイルの現在アクティブなプロジェクトに Operator をインストールします。-n フラグを追加して、インストールに異なる namespace スコープを設定できます。

   このコマンドは、以下の操作を実行します。

   • バンドルイメージをインジェクトしてインデックスイメージを作成します。
   • 新規インデックスイメージを参照するカタログソースを作成します。これにより、OperatorHub が Operator を検出できるようになります。
   • Operator グループ、サブスクリプション、インストール計画、および RBAC を含むその他の必要なオブジェクトすべてを作成して、Operator をクラスターにデプロイします。