5.7. 定义集群服务版本（CSV）

1. generate kustomize manifests
2. generate bundle
3. bundle validate

流程

1. 为 Operator 在 config/manager/manager.yaml 文件中被 Operator 使用的额外镜像引用设置环境变量：

   例 5.9. config/manager/manager.yaml 文件示例

   ...
   spec:
     ...
       spec:
         ...
         containers:
         - command:
           - /manager
           ...
           env:
           - name: <related_image_environment_variable> 1
             value: "<related_image_reference_with_tag>" 2

   1

   定义 环境变量，如 RELATED_IMAGE_MEMCACHED。

   2

   设置相关的镜像引用和标签，如 docker.io/memcached:1.4.36-alpine。

2. 将硬编码镜像引用替换为 Operator 项目类型的相关文件中的环境变量：

   • 对于基于 Go 的 Operator 项目，将环境变量添加到 controllers/memcached_controller.go 文件中，如下例所示：

     例 5.10. controllers/memcached_controller.go 文件示例

       // deploymentForMemcached returns a memcached Deployment object
     
     ...
     
     	Spec: corev1.PodSpec{
             	Containers: []corev1.Container{{
     -			Image:   "memcached:1.4.36-alpine", 1
     +			Image:   os.Getenv("<related_image_environment_variable>"), 2
     			Name:    "memcached",
     			Command: []string{"memcached", "-m=64", "-o", "modern", "-v"},
     			Ports: []corev1.ContainerPort{{
     
     ...

     1

     删除镜像引用和标签。

     2

     使用 os.Getenv 函数调用 <related_image_environment_variable>。

     注意

     如果未设置变量，则 os.Getenv 函数会返回空字符串。在更改文件前设置 <related_image_environment_variable>。

   • 对于基于 Ansible 的 Operator 项目，将环境变量添加到 roles/memcached/tasks/main.yml 文件，如下例所示：

     例 5.11. roles/memcached/tasks/main.yml 文件示例

     spec:
       containers:
       - name: memcached
         command:
         - memcached
         - -m=64
         - -o
         - modern
         - -v
     -   image: "docker.io/memcached:1.4.36-alpine" 1
     +   image: "{{ lookup('env', '<related_image_environment_variable>') }}" 2
         ports:
           - containerPort: 11211
     
     ...

     1

     删除镜像引用和标签。

     2

     使用 lookup 功能调用 <related_image_environment_variable>。

   • 对于基于 Helm 的 Operator 项目，将 overrideValues 字段添加到 watches.yaml 文件中，如下例所示：

     例 5.12. watches.yaml 文件示例

     ...
     - group: demo.example.com
       version: v1alpha1
       kind: Memcached
       chart: helm-charts/memcached
       overrideValues: 1
         relatedImage: ${<related_image_environment_variable>} 2

     1

     添加 overrideValues 字段。

     2

     使用 <related_image_environment_variable> 来定义 overrideValues 字段，如 RELATED_IMAGE_MEMCACHED。

     1. 将 overrideValues 字段的值添加到 helm-charts/memchached/values.yaml 文件中，如下例所示：

        helm-charts/memchached/values.yaml 文件示例

        ...
        relatedImage: ""

     2. 编辑 helm-charts/memcached/templates/deployment.yaml 文件中的 chart 模板，如下例所示：

        例 5.13. helm-charts/memcached/templates/deployment.yaml 文件示例

        containers:
          - name: {{ .Chart.Name }}
            securityContext:
              - toYaml {{ .Values.securityContext | nindent 12 }}
            image: "{{ .Values.image.pullPolicy }}
            env: 1
              - name: related_image 2
                value: "{{ .Values.relatedImage }}" 3

        1

        添加 env 字段。

        2

        命名环境变量。

        3

        定义环境变量的值。

3. 使用以下更改将 BUNDLE_GEN_FLAGS 变量定义添加到 Makefile 中：

   Makefile示例

      BUNDLE_GEN_FLAGS ?= -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
   
      # USE_IMAGE_DIGESTS defines if images are resolved via tags or digests
      # You can enable this value if you would like to use SHA Based Digests
      # To enable set flag to true
      USE_IMAGE_DIGESTS ?= false
      ifeq ($(USE_IMAGE_DIGESTS), true)
            BUNDLE_GEN_FLAGS += --use-image-digests
      endif
   
   ...
   
   -  $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS) 1
   +  $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS) 2
   
   ...

   1

   删除 Makefile 中的这一行。

   2

   将上面的行替换为这一行。

4. 要将 Operator 镜像更新为使用摘要(SHA)而不是标签，请运行 make bundle 命令，并将 USE_IMAGE_DIGESTS 设置为 true ：

   $ make bundle USE_IMAGE_DIGESTS=true

5. 添加 disconnected 注解，这表示 Operator 在断开连接的环境中工作：

   metadata:
     annotations:
       operators.openshift.io/infrastructure-features: '["disconnected"]'

   OperatorHub 中可根据此基础架构功能来过滤 Operator。

1. 在 Operator 项目的 go.mod 文件中，将 operator-framework/operator-lib 添加为所需的库：

   module github.com/example-inc/memcached-operator
   
   go 1.15
   
   require (
     k8s.io/apimachinery v0.19.2
     k8s.io/client-go v0.19.2
     sigs.k8s.io/controller-runtime v0.7.0
     operator-framework/operator-lib v0.3.0
   )

2. 在 Operator 逻辑中编写您自己的构造器会导致以下结果：

   • 接受 controller-runtime 客户端。
   • 接受 conditionType。
   • 返回一个 Condition 接口以更新或添加条件。

   由于 OLM 目前支持 Upgradeable 条件，因此可以创建一个接口，它具有访问 Upgradeable 条件的方法。例如：

   import (
     ...
     apiv1 "github.com/operator-framework/api/pkg/operators/v1"
   )
   
   func NewUpgradeable(cl client.Client) (Condition, error) {
     return NewCondition(cl, "apiv1.OperatorUpgradeable")
   }
   
   cond, err := NewUpgradeable(cl);

   在这个示例中，NewUpgradeable constructor 被进一步使用来创建类型为 Condition 的一个变量 cond。cond 变量依次使用 Get 和 Set 方法，可用于处理 OLM 的 Upgradeable 条件。