5.6. Java ベースの Operator

手順

1. プロジェクトを作成します。

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

      $ mkdir memcached-operator

      Copy to Clipboard Toggle word wrap

   2. プロジェクトディレクトリーに移動します。

      $ cd memcached-operator

      Copy to Clipboard Toggle word wrap

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

      $ operator-sdk init \
          --plugins=quarkus \
          --domain=example.com \
          --project-name=memcached-operator

      Copy to Clipboard Toggle word wrap

2. API を作成します。

   単純な Memcached API を作成します。

   $ operator-sdk create api \
       --plugins quarkus \
       --group cache \
       --version v1 \
       --kind Memcached

   Copy to Clipboard Toggle word wrap

3. Operator イメージをビルドし、プッシュします。

   デフォルトの Makefile ターゲットを使用して Operator をビルドし、プッシュします。プッシュ先となるレジストリーを使用するイメージのプル仕様を使用して IMG を設定します。

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

   Copy to Clipboard Toggle word wrap

4. Operator を実行します。

   1. CRD をインストールします。

      $ make install

      Copy to Clipboard Toggle word wrap

   2. プロジェクトをクラスターにデプロイします。IMG をプッシュしたイメージに設定します。

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

      Copy to Clipboard Toggle word wrap

5. サンプルカスタムリソース (CR) を作成します。

   1. サンプル CR を作成します。

      $ oc apply -f config/samples/cache_v1_memcached.yaml \
          -n memcached-operator-system

      Copy to Clipboard Toggle word wrap

   2. Operator を調整する CR を確認します。

      $ oc logs deployment.apps/memcached-operator-controller-manager \
          -c manager \
          -n memcached-operator-system

      Copy to Clipboard Toggle word wrap

6. Delete a CR.

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

   $ oc delete -f config/samples/cache_v1_memcached.yaml -n memcached-operator-system

   Copy to Clipboard Toggle word wrap

7. クリーンアップします。

   以下のコマンドを実行して、この手順の一部として作成されたリソースをクリーンアップします。

   $ make undeploy

   Copy to Clipboard Toggle word wrap

手順

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

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

   Copy to Clipboard Toggle word wrap

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

   $ cd $HOME/projects/memcached-operator

   Copy to Clipboard Toggle word wrap

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

   $ operator-sdk init \
       --plugins=quarkus \
       --domain=example.com \
       --project-name=memcached-operator

   Copy to Clipboard Toggle word wrap

手順

1. 以下のコマンドを実行して API を作成します。

   $ operator-sdk create api \
       --plugins=quarkus \

   1

   
       --group=cache \

   2

   
       --version=v1 \

   3

   
       --kind=Memcached 

   4

   Copy to Clipboard Toggle word wrap

   1

   プラグインフラグを quarkus に設定します。

   2

   group フラグを cache に設定します。

   3

   version フラグを v1 に設定します。

   4

   kind フラグを Memcached に設定します。

検証

1. tree コマンドを実行して、ファイル構造を表示します。

   $ tree

   Copy to Clipboard Toggle word wrap

   出力例

   .
   ├── Makefile
   ├── PROJECT
   ├── pom.xml
   └── src
       └── main
           ├── java
           │   └── com
           │       └── example
           │           ├── Memcached.java
           │           ├── MemcachedReconciler.java
           │           ├── MemcachedSpec.java
           │           └── MemcachedStatus.java
           └── resources
               └── application.properties
   
   6 directories, 8 files

   Copy to Clipboard Toggle word wrap

手順

1. 以下の依存関係を pom.xml ファイルに追加します。

       <dependency>
         <groupId>commons-collections</groupId>
         <artifactId>commons-collections</artifactId>
         <version>3.2.2</version>
       </dependency>

   Copy to Clipboard Toggle word wrap

2. この例では、生成されたコントローラーファイル MemcachedReconciler.java を以下の実装例に置き換えます。

   例5.10 MemcachedReconciler.java の例

   package com.example;
   
   import io.fabric8.kubernetes.client.KubernetesClient;
   import io.javaoperatorsdk.operator.api.reconciler.Context;
   import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
   import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
   import io.fabric8.kubernetes.api.model.ContainerBuilder;
   import io.fabric8.kubernetes.api.model.ContainerPortBuilder;
   import io.fabric8.kubernetes.api.model.LabelSelectorBuilder;
   import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
   import io.fabric8.kubernetes.api.model.OwnerReferenceBuilder;
   import io.fabric8.kubernetes.api.model.Pod;
   import io.fabric8.kubernetes.api.model.PodSpecBuilder;
   import io.fabric8.kubernetes.api.model.PodTemplateSpecBuilder;
   import io.fabric8.kubernetes.api.model.apps.Deployment;
   import io.fabric8.kubernetes.api.model.apps.DeploymentBuilder;
   import io.fabric8.kubernetes.api.model.apps.DeploymentSpecBuilder;
   import org.apache.commons.collections.CollectionUtils;
   import java.util.HashMap;
   import java.util.List;
   import java.util.Map;
   import java.util.stream.Collectors;
   
   public class MemcachedReconciler implements Reconciler<Memcached> {
     private final KubernetesClient client;
   
     public MemcachedReconciler(KubernetesClient client) {
       this.client = client;
     }
   
     // TODO Fill in the rest of the reconciler
   
     @Override
     public UpdateControl<Memcached> reconcile(
         Memcached resource, Context context) {
         // TODO: fill in logic
         Deployment deployment = client.apps()
                 .deployments()
                 .inNamespace(resource.getMetadata().getNamespace())
                 .withName(resource.getMetadata().getName())
                 .get();
   
         if (deployment == null) {
             Deployment newDeployment = createMemcachedDeployment(resource);
             client.apps().deployments().create(newDeployment);
             return UpdateControl.noUpdate();
         }
   
         int currentReplicas = deployment.getSpec().getReplicas();
         int requiredReplicas = resource.getSpec().getSize();
   
         if (currentReplicas != requiredReplicas) {
             deployment.getSpec().setReplicas(requiredReplicas);
             client.apps().deployments().createOrReplace(deployment);
             return UpdateControl.noUpdate();
         }
   
         List<Pod> pods = client.pods()
             .inNamespace(resource.getMetadata().getNamespace())
             .withLabels(labelsForMemcached(resource))
             .list()
             .getItems();
   
         List<String> podNames =
             pods.stream().map(p -> p.getMetadata().getName()).collect(Collectors.toList());
   
   
         if (resource.getStatus() == null
                  || !CollectionUtils.isEqualCollection(podNames, resource.getStatus().getNodes())) {
              if (resource.getStatus() == null) resource.setStatus(new MemcachedStatus());
              resource.getStatus().setNodes(podNames);
              return UpdateControl.updateResource(resource);
         }
   
         return UpdateControl.noUpdate();
     }
   
     private Map<String, String> labelsForMemcached(Memcached m) {
       Map<String, String> labels = new HashMap<>();
       labels.put("app", "memcached");
       labels.put("memcached_cr", m.getMetadata().getName());
       return labels;
     }
   
     private Deployment createMemcachedDeployment(Memcached m) {
         Deployment deployment = new DeploymentBuilder()
             .withMetadata(
                 new ObjectMetaBuilder()
                     .withName(m.getMetadata().getName())
                     .withNamespace(m.getMetadata().getNamespace())
                     .build())
             .withSpec(
                 new DeploymentSpecBuilder()
                     .withReplicas(m.getSpec().getSize())
                     .withSelector(
                         new LabelSelectorBuilder().withMatchLabels(labelsForMemcached(m)).build())
                     .withTemplate(
                         new PodTemplateSpecBuilder()
                             .withMetadata(
                                 new ObjectMetaBuilder().withLabels(labelsForMemcached(m)).build())
                             .withSpec(
                                 new PodSpecBuilder()
                                     .withContainers(
                                         new ContainerBuilder()
                                             .withImage("memcached:1.4.36-alpine")
                                             .withName("memcached")
                                             .withCommand("memcached", "-m=64", "-o", "modern", "-v")
                                             .withPorts(
                                                 new ContainerPortBuilder()
                                                     .withContainerPort(11211)
                                                     .withName("memcached")
                                                     .build())
                                             .build())
                                     .build())
                             .build())
                     .build())
             .build();
       deployment.addOwnerReference(m);
       return deployment;
     }
   }

   Copy to Clipboard Toggle word wrap

   コントローラーのサンプルは、それぞれの Memcached カスタムリソース (CR) について以下の調整 (reconciliation) ロジックを実行します。

   • Memcached デプロイメントが存在しない場合に作成する。
   • デプロイメントのサイズが、Memcached CR 仕様で指定されたサイズになるようにする。
   • Memcached CR ステータスを memcached Pod の名前で更新する。

手順

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

   Copy to Clipboard Toggle word wrap

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.17 に更新します。

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

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

      Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap

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

      Copy to Clipboard Toggle word wrap

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

      $ go mod tidy

      Copy to Clipboard Toggle word wrap