5.5. Helm ベースの Operator

手順

1. プロジェクトのディレクトリーを作成します。

   $ mkdir -p $HOME/projects/nginx-operator

2. ディレクトリーに切り替えます。

   $ cd $HOME/projects/nginx-operator

3. helm プラグインを指定して operator-sdk init コマンドを実行し、プロジェクトを初期化します。

   $ operator-sdk init \
       --plugins=helm \
       --domain=example.com \
       --group=demo \
       --version=v1 \
       --kind=Nginx

   注記

   デフォルトで、helm プラグインは、ボイラープレート Helm チャートを使用してプロジェクトを初期化します。--helm-chart フラグなどの追加のフラグを使用すると、既存の Helm チャートを使用してプロジェクトを初期化できます。

   init コマンドは、API バージョン example.com/v1 および Kind Nginx でのリソースの監視に特化した nginx-operator プロジェクトを作成します。

4. Helm ベースのプロジェクトの場合、init コマンドは、チャートのデフォルトマニフェストによってデプロイされるリソースに基づいて config/rbac/role.yaml ファイルに RBAC ルールを生成します。このファイルで生成されるルールが Operator のパーミッション要件を満たしていることを確認します。

手順

1. watches.yaml ファイルを編集し、overrideValues フィールドを追加して、環境変数に基づいてオーバーライドを含めます。

   ...
   - group: demo.example.com
     version: v1alpha1
     kind: Nginx
     chart: helm-charts/nginx
     overrideValues:
       proxy.http: $HTTP_PROXY
   ...

2. helm-charts/nginx/values.yaml ファイルに proxy.http 値を追加します。

   ...
   proxy:
     http: ""
     https: ""
     no_proxy: ""

3. チャートテンプレートで変数の使用がサポートされているようにするには、helm-charts/nginx/templates/deployment.yaml ファイルのチャートテンプレートを編集して以下を追加します。

   containers:
     - name: {{ .Chart.Name }}
       securityContext:
         - toYaml {{ .Values.securityContext | nindent 12 }}
       image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
       imagePullPolicy: {{ .Values.image.pullPolicy }}
       env:
         - name: http_proxy
           value: "{{ .Values.proxy.http }}"

4. 以下を config/manager/manager.yaml ファイルに追加して、Operator デプロイメントに環境変数を設定します。

   containers:
    - args:
      - --leader-elect
      - --leader-election-id=ansible-proxy-demo
      image: controller:latest
      name: manager
      env:
        - name: "HTTP_PROXY"
          value: "http_proxy_test"

手順

1. Operator がインストールされている namespace へ変更します。たとえば、make deploy コマンドを使用して Operator をデプロイした場合は、以下のようになります。

   $ oc project nginx-operator-system

2. config/samples/demo_v1_nginx.yaml で Nginx CR マニフェストのサンプルを編集し、以下の仕様が含まれるようにします。

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

3. Nginx サービスアカウントを OpenShift Dedicated で実行するには、特権アクセスが必要です。以下の SCC (Security Context Constraints) を nginx-sample Pod のサービスアカウントに追加します。

   $ oc adm policy add-scc-to-user \
       anyuid system:serviceaccount:nginx-operator-system:nginx-sample

4. CR を作成します。

   $ oc apply -f config/samples/demo_v1_nginx.yaml

5. Nginx Operator が、正しいサイズで CR サンプルのデプロイメントを作成することを確認します。

   $ oc get deployments

   出力例

   NAME                                    READY   UP-TO-DATE   AVAILABLE   AGE
   nginx-operator-controller-manager       1/1     1            1           8m
   nginx-sample                            3/3     3            3           1m

6. ステータスが Nginx Pod 名で更新されていることを確認するために、Pod および CR ステータスを確認します。

   1. Pod を確認します。

      $ oc get pods

      出力例

      NAME                                  READY     STATUS    RESTARTS   AGE
      nginx-sample-6fd7c98d8-7dqdr          1/1       Running   0          1m
      nginx-sample-6fd7c98d8-g5k7v          1/1       Running   0          1m
      nginx-sample-6fd7c98d8-m7vn7          1/1       Running   0          1m

   2. CR ステータスを確認します。

      $ oc get nginx/nginx-sample -o yaml

      出力例

      apiVersion: demo.example.com/v1
      kind: Nginx
      metadata:
      ...
        name: nginx-sample
      ...
      spec:
        replicaCount: 3
      status:
        nodes:
        - nginx-sample-6fd7c98d8-7dqdr
        - nginx-sample-6fd7c98d8-g5k7v
        - nginx-sample-6fd7c98d8-m7vn7

7. デプロイメントサイズを更新します。

   1. config/samples/demo_v1_nginx.yaml ファイルを更新して、Nginx CR の spec.size フィールドを 3 から 5 に変更します。

      $ oc patch nginx nginx-sample \
          -p '{"spec":{"replicaCount": 5}}' \
          --type=merge

   2. Operator がデプロイメントサイズを変更することを確認します。

      $ oc get deployments

      出力例

      NAME                                    READY   UP-TO-DATE   AVAILABLE   AGE
      nginx-operator-controller-manager       1/1     1            1           10m
      nginx-sample                            5/5     5            5           3m

8. 次のコマンドを実行して CR を削除します。

   $ oc delete -f config/samples/demo_v1_nginx.yaml

9. このチュートリアルの一環として作成したリソースをクリーンアップします。

   • Operator のテストに make deploy コマンドを使用した場合は、以下のコマンドを実行します。

     $ make undeploy

   • Operator のテストに operator-sdk run bundle コマンドを使用した場合は、以下のコマンドを実行します。

     $ operator-sdk cleanup <project_name>

手順

1. 次の例に示すように、Operator プロジェクトの Makefile を編集して、Operator SDK バージョンを v1.36.1-ocp に更新します。

   Makefile の例

   # Set the Operator SDK version to use. By default, what is installed on the system is used.
   # This is useful for CI or a project to utilize a specific version of the operator-sdk toolkit.
   OPERATOR_SDK_VERSION ?= v1.36.1-ocp

2. Red Hat Enterprise Linux (RHEL) 9 ベースのイメージを使用するように kube-rbac-proxy コンテナーを更新します。

   1. 次のファイルで kube-rbac-proxy コンテナーのエントリーを見つけます。

      • config/default/manager_auth_proxy_patch.yaml
      • Operator プロジェクトの bundle/manifests/<operator_name>.clusterserviceversion.yaml (チュートリアルの memcached-operator.clusterserviceversion.yaml など)

   2. プル仕様のイメージ名を ose-kube-rbac-proxy から ose-kube-rbac-proxy-rhel9 に更新し、タグを v4 に更新します。

      v4 イメージタグを使用した ose-kube-rbac-proxy-rhel9 プル仕様の例

      # ...
            containers:
            - name: kube-rbac-proxy
              image: registry.redhat.io/openshift4/ose-kube-rbac-proxy-rhel9:v4
      # ...

3. 次の例に示すように、Operator の Dockerfile を編集して、ose-Helm-rhel9-operator イメージタグを 4 に更新します。

   Dockerfile の例

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

4. kustomize/v2 プラグインは、現在 stable であり、go/v4、ansible/v1、helm/v1、hybrid/v1-alpha プラグインを使用するときにプラグインチェーンで使用されるデフォルトのバージョンです。このデフォルトのスキャフォールドの詳細は、Kubebuilder ドキュメントの Kustomize v2 を参照してください。

5. Operator プロジェクトでマルチプラットフォームビルドまたはマルチアーキテクチャービルドを使用する場合は、プロジェクト Makefile 内の既存の docker-buildx ターゲットを次の定義に置き換えます。

   Makefile の例

   docker-buildx:
   ## Build and push the Docker image for the manager for multi-platform support
   	- docker buildx create --name project-v3-builder
   	docker buildx use project-v3-builder
   	- docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile .
   	- docker buildx rm project-v3-builder

6. Operator プロジェクトの Kubernetes バージョンを、1.29 を使用するようにアップグレードする必要があります。プロジェクト構造、Makefile、go.mod ファイルに次の変更を加える必要があります。

   重要

   go/v3 プラグインは Kubebuilder によって非推奨化が進められています。そのため、Operator SDK も今後のリリースで go/v4 に移行します。

   1. go.mod ファイルを更新して、依存関係をアップグレードします。

      k8s.io/api v0.29.2
      k8s.io/apimachinery v0.29.2
      k8s.io/client-go v0.29.2
      sigs.k8s.io/controller-runtime v0.17.3

   2. 次のコマンドを実行して、アップグレードした依存関係をダウンロードします。

      $ go mod tidy

7. 以下の変更を加えて、Makefile 内の Kustomize バージョンを更新します。

   - curl -sSLo - https://github.com/kubernetes-sigs/kustomize/releases/download/kustomize/v5.2.1/kustomize_v5.2.1_$(OS)_$(ARCH).tar.gz | \
   + curl -sSLo - https://github.com/kubernetes-sigs/kustomize/releases/download/kustomize/v5.3.0/kustomize_v5.3.0_$(OS)_$(ARCH).tar.gz | \