5.7. CSV(클러스터 서비스 버전) 정의

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

프로세스

1. config/manager/manager.yaml 파일에서 Operator에서 사용하는 추가 이미지 참조에 대한 환경 변수를 설정합니다.

   예 5.10. 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.11. 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.12. 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 프로젝트의 경우 다음 예와 같이 watches.yaml 파일에 overrideValues 필드를 추가합니다.

     예 5.13. 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_MEMCACHED 와 같이 < related_image_environment_variable >을 사용하여 overrideValues 필드를 정의합니다.

     1. 다음 예와 같이 overrideValues 필드의 값을 helm-charts/memchached/values.yaml 파일에 추가합니다.

        helm-charts/memchached/values.yaml 파일의 예

        ...
        relatedImage: ""

     2. 다음 예와 같이 helm-charts/memcached/templates/deployment.yaml 파일에서 차트 템플릿을 편집합니다.

        예 5.14. 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. 태그가 아닌 다이제스트(SHA)를 사용하도록 Operator 이미지를 업데이트하려면 make bundle 명령을 실행하고 USE_IMAGE_DIGESTS 를 true 로 설정합니다.

   $ make bundle USE_IMAGE_DIGESTS=true

5. 연결이 끊긴 환경에서도 Operator가 작동함을 나타내는 Disconnected 주석을 추가합니다.

   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);

   이 예제에서는 유형 Condition의 변수 cond를 생성하는 데 NewUpgradeable 생성자가 추가로 사용됩니다. 결국 cond 변수에는 OLM Upgradeable 조건을 처리하는 데 사용할 수 있는 Get 및 Set 방법이 포함됩니다.