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 Chart 初始化项目。您可以使用其他标记（如 --helm-chart 标志）使用现有 Helm chart 初始化项目。

   init 命令创建 nginx-operator 项目，专门用于监视 API 版本为 example.com/v1 和 kind Nginx 的资源。

4. 对于基于 Helm 的项目，init 命令根据 chart 的默认清单部署的资源，在 config/rbac/role.yaml 文件中生成 RBAC 规则。验证此文件生成的规则是否满足 Operator 的权限要求。

流程

1. 通过添加 overrideValues 字段来编辑 watches.yaml 文件，使其包含基于环境变量的覆盖：

   ...
   - 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. 要确保 Chart 模板支持使用变量，请编辑 helm-charts/nginx/templates/deployment.yaml 文件中的 chart 模板，使其包含以下内容：

   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 的命名空间。例如，如果使用 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) 添加到 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. 检查 pod 和 CR 状态，以确认其状态是否使用 Nginx pod 名称更新。

   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. 清理本教程中创建的资源。

   • 如果使用 make deploy 命令来测试 Operator，请运行以下命令：

     $ make undeploy

   • 如果使用 operator-sdk run bundle 命令来测试 Operator，请运行以下命令：

     $ 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. 更新 kube-rbac-proxy 容器，以使用基于 Red Hat Enterprise Linux (RHEL) 9 的镜像：

   1. 在以下文件中找到 kube-rbac-proxy 容器的条目：

      • config/default/manager_auth_proxy_patch.yaml
      • Operator 项目的 bundle/manifests/<operator_name>.clusterserviceversion.yaml，如教程中的 memcached-operator.clusterserviceversion.yaml

   2. 将 pull spec 中的镜像名称从 ose-kube-rbac-proxy 更新至 ose-kube-rbac-proxy-rhel9，并将标签更新为 v4 ：

      ose-kube-rbac-proxy-rhel9 使用 v4 镜像标签拉取 spec 示例

      # ...
            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 插件现在稳定，在使用 go/v4,ansible/v1,helm/v1, 和 hybrid/v1-alpha 插件时，插件链中使用的默认版本。有关此默认构建的更多信息，请参阅 Kubebuilder 文档中的 Kustomize v2。

5. 如果您的 Operator 项目使用多平台或多架构，构建，将现有 docker-buildx 目标替换为项目 Makefile 中的以下定义：

   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 文件中进行以下更改。

   重要

   Kubebuilder 弃用 go/v3 插件，因此 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 | \