5.5. Helm 기반 Operator

절차

1. 프로젝트를 생성합니다.

   1. 프로젝트 디렉토리를 생성합니다.

      $ mkdir nginx-operator

   2. 프로젝트 디렉터리로 변경합니다.

      $ cd nginx-operator

   3. helm 플러그인과 함께 operator-sdk init 명령을 실행하여 프로젝트를 초기화합니다.

      $ operator-sdk init \
          --plugins=helm

2. API를 생성합니다.

   간단한 Nginx API를 생성합니다.

   $ operator-sdk create api \
       --group demo \
       --version v1 \
       --kind Nginx

   이 API는 helm create 명령의 기본 제공 Helm 차트 상용구를 사용합니다.

3. Operator 이미지를 빌드하여 내보냅니다.

   기본 Makefile 대상을 사용하여 Operator를 빌드하고 내보냅니다. 내보낼 수 있는 레지스트리를 사용하는 이미지의 가져오기 사양에 IMG를 설정합니다.

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

4. Operator를 실행합니다.

   1. CRD를 설치합니다.

      $ make install

   2. 클러스터에 프로젝트를 배포합니다. 내보낸 이미지에 IMG를 설정합니다.

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

5. SCC(보안 컨텍스트 제약 조건)를 추가합니다.

   Nginx 서비스 계정에는 OpenShift Container Platform에서 실행할 수 있는 권한이 필요합니다. nginx-sample Pod의 서비스 계정에 다음 SCC를 추가합니다.

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

6. 샘플 CR(사용자 정의 리소스)을 생성합니다.

   1. 샘플 CR을 생성합니다.

      $ oc apply -f config/samples/demo_v1_nginx.yaml \
          -n nginx-operator-system

   2. CR에서 Operator를 조정하는지 확인합니다.

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

7. $ oc delete -f config/samples/demo_v1_nginx -n nginx-operator-system

8. 정리합니다.

   다음 명령을 실행하여 이 절차의 일부로 생성된 리소스를 정리합니다.

   $ make undeploy

프로세스

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 차트를 사용하는 프로젝트를 초기화하려면 --helm-chart 플래그와 같은 추가 플래그를 사용하면 됩니다.

   init 명령은 API 버전이 example.com/v1이고 종류가 Nginx인 리소스를 조사하기 위해 특별히 nginx-operator 프로젝트를 생성합니다.

4. Helm 기반 프로젝트의 경우 init 명령은 차트의 기본 매니페스트에 의해 배포되는 리소스를 기반으로 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. ...
   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가 설치된 네임스페이스로 변경합니다. 예를 들어 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 Container Platform에서 실행할 수 있는 권한이 필요합니다. nginx-sample Pod의 서비스 계정에 다음 SCC(보안 컨텍스트 제약 조건)를 추가합니다.

   $ 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. $ 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. ...
   spec:
     template:
       spec:
         containers:
         - name: kube-rbac-proxy
           image: registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.11 1
           args:
           - "--secure-listen-address=0.0.0.0:8443"
           - "--upstream=http://127.0.0.1:8080/"
           - "--logtostderr=true"
           - "--v=0" 2
   ...
   resources:
     limits:
       cpu: 500m
       memory: 128Mi
     requests:
       cpu: 5m
       memory: 64Mi 3

   1

   2

   3

2. 1. BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
      ...

      BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
      
      # BUNDLE_GEN_FLAGS are the flags passed to the operator-sdk generate bundle command
      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

   2. $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)

      $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS)

   3. .PHONY: opm
      OPM = ./bin/opm
      opm: ## Download opm locally if necessary.
      ifeq (,$(wildcard $(OPM)))
      ifeq (,$(shell which opm 2>/dev/null))
      	@{ \
      	set -e ;\
      	mkdir -p $(dir $(OPM)) ;\
      	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
      	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.23.0/$${OS}-$${ARCH}-opm ;\ 1
      	chmod +x $(OPM) ;\
      	}
      else
      OPM = $(shell which opm)
      endif
      endif

      1

   4. $ make

3. Dockerfile 예

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

   1

절차

1. 프로젝트에 사용할 디렉터리를 생성합니다.

   $ mkdir -p $HOME/github.com/example/memcached-operator

2. 디렉터리로 변경합니다.

   $ cd $HOME/github.com/example/memcached-operator

3. $ operator-sdk init \
       --plugins=hybrid.helm.sdk.operatorframework.io \
       --project-version="3" \
       --domain example.com \
       --repo=github.com/example/memcached-operator

절차

1. 다음 명령을 실행하여 그룹 캐시 가 있는 Go API, 버전 v1 및 kind MemcachedBackup 을 생성합니다.

   $ operator-sdk create api \
       --group=cache \
       --version v1 \
       --kind MemcachedBackup \
       --resource \
       --controller \
       --plugins=go/v3

2. 메시지가 표시되면 리소스 및 컨트롤러를 모두 생성하도록 y 를 입력합니다.

   $ Create Resource [y/n]
   y
   Create Controller [y/n]
   y

절차

1. 다음 make 명령을 실행하여 Operator 이미지를 빌드하고 내보냅니다. 액세스할 수 있는 리포지토리를 참조하려면 다음 단계에서 IMG 인수를 수정합니다. Quay.io와 같은 리포지토리 사이트에 컨테이너를 저장하기 위해 계정을 받을 수 있습니다.

   1. 이미지를 빌드합니다.

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

      참고

      Operator용 SDK에서 생성한 Dockerfile은 Go 빌드에 대해 GOARCH=amd64 를 명시적으로 참조합니다. AMD64 이외의 아키텍처의 경우 GOARCH=$TARGETARCH 로 수정할 수 있습니다. Docker는 자동으로 -platform 에서 지정한 값으로 환경 변수를 설정합니다. Buildah를 사용하면 -build-arg 를 목적으로 사용해야 합니다. 자세한 내용은 다중 아키텍처를 참조하십시오.

   2. 이미지를 리포지토리로 내보냅니다.

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

      참고

      두 명령 모두 이미지의 이름과 태그(예: IMG=<registry>/<user>/<image_name>:<tag>)를 Makefile에 설정할 수 있습니다. 기본 이미지 이름을 설정하려면 IMG ?= controller:latest 값을 수정합니다.

2. 다음 명령을 실행하여 Operator를 배포합니다.

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

   기본적으로 이 명령은 <project_name>-system 형식으로 된 Operator 프로젝트 이름을 사용하여 네임스페이스를 생성하고 배포에 사용됩니다. 이 명령은 또한 config/rbac에서 RBAC 매니페스트를 설치합니다.

3. 다음 명령을 실행하여 Operator가 실행 중인지 확인합니다.

   $ oc get deployment -n <project_name>-system

   출력 예

   NAME                                    READY   UP-TO-DATE   AVAILABLE   AGE
   <project_name>-controller-manager       1/1     1            1           8m

절차

1. Operator가 설치된 네임스페이스로 변경합니다.

   $ oc project <project_name>-system

2. replicaCount 필드를 3 으로 업데이트하여 config/samples/cache_v1_memcached.yaml 파일에서 샘플 Memcached CR 매니페스트를 업데이트합니다.

   예 5.7. config/samples/cache_v1_memcached.yaml 파일의 예

   apiVersion: cache.my.domain/v1
   kind: Memcached
   metadata:
     name: memcached-sample
   spec:
     # Default values copied from <project_dir>/helm-charts/memcached/values.yaml
     affinity: {}
     autoscaling:
       enabled: false
       maxReplicas: 100
       minReplicas: 1
       targetCPUUtilizationPercentage: 80
     fullnameOverride: ""
     image:
       pullPolicy: IfNotPresent
       repository: nginx
       tag: ""
     imagePullSecrets: []
     ingress:
       annotations: {}
       className: ""
       enabled: false
       hosts:
       - host: chart-example.local
         paths:
         - path: /
           pathType: ImplementationSpecific
       tls: []
     nameOverride: ""
     nodeSelector: {}
     podAnnotations: {}
     podSecurityContext: {}
     replicaCount: 3
     resources: {}
     securityContext: {}
     service:
       port: 80
       type: ClusterIP
     serviceAccount:
       annotations: {}
       create: true
       name: ""
     tolerations: []

3. Memcached CR을 생성합니다.

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

4. Memcached Operator가 샘플 CR에 대한 배포를 올바른 크기로 생성하는지 확인합니다.

   $ oc get pods

   출력 예

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

5. 크기를 2 로 업데이트하여 config/samples/cache_v1_memcachedbackup.yaml 파일에서 샘플 MemcachedBackup CR 매니페스트를 업데이트합니다.

   예 5.8. config/samples/cache_v1_memcachedbackup.yaml 파일의 예

   apiVersion: cache.my.domain/v1
   kind: MemcachedBackup
   metadata:
     name: memcachedbackup-sample
   spec:
     size: 2

6. MemcachedBackup CR을 생성합니다.

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

7. memcachedbackup Pod 수가 CR에 지정된 것과 같은지 확인합니다.

   $ oc get pods

   출력 예

   NAME                                        READY     STATUS    RESTARTS   AGE
   memcachedbackup-sample-8649699989-4bbzg     1/1       Running   0          22m
   memcachedbackup-sample-8649699989-mq6mx     1/1       Running   0          22m

8. 위의 각 CR에서 사양 을 업데이트한 다음 다시 적용할 수 있습니다. 컨트롤러는 다시 조정하고 Pod의 크기가 각 CR의 사양에 지정된 대로 되도록 합니다.

9. 이 튜토리얼의 일부로 생성된 리소스를 정리합니다.

   1. Memcached 리소스를 삭제합니다.

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

   2. MemcachedBackup 리소스를 삭제합니다.

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

   3. make deploy 명령을 사용하여 Operator를 테스트한 경우 다음 명령을 실행합니다.

      $ make undeploy

절차

1. config/default/manager_auth_proxy_patch.yaml 파일을 다음과 같이 변경합니다.

   ...
   spec:
     template:
       spec:
         containers:
         - name: kube-rbac-proxy
           image: registry.redhat.io/openshift4/ose-kube-rbac-proxy:v4.11 1
           args:
           - "--secure-listen-address=0.0.0.0:8443"
           - "--upstream=http://127.0.0.1:8080/"
           - "--logtostderr=true"
           - "--v=0" 2
   ...
   resources:
     limits:
       cpu: 500m
       memory: 128Mi
     requests:
       cpu: 5m
       memory: 64Mi 3

   1

   태그 버전을 v4.10 에서 v4.11 로 업데이트합니다.

   2

   디버깅 로그 수준을 --v=10 에서 --v=0 으로 줄입니다.

   3

   리소스 요청 및 제한을 추가합니다.

2. Makefile 을 다음과 같이 변경합니다.

   1. Makefile 에 다음 환경 변수를 추가하여 이미지 다이제스트 지원을 활성화합니다.

      이전 Makefile

      BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
      ...

      새로운 Makefile

      BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION)
      
      # BUNDLE_GEN_FLAGS are the flags passed to the operator-sdk generate bundle command
      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

   2. Makefile 을 편집하여 번들 대상을 BUNDLE_GEN_FLAGS 환경 변수로 교체합니다.

      이전 Makefile

      $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)

      새로운 Makefile

      $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS)

   3. Makefile 을 편집하여 opm 을 버전 1.23.0으로 업데이트합니다.

      .PHONY: opm
      OPM = ./bin/opm
      opm: ## Download opm locally if necessary.
      ifeq (,$(wildcard $(OPM)))
      ifeq (,$(shell which opm 2>/dev/null))
      	@{ \
      	set -e ;\
      	mkdir -p $(dir $(OPM)) ;\
      	OS=$(shell go env GOOS) && ARCH=$(shell go env GOARCH) && \
      	curl -sSLo $(OPM) https://github.com/operator-framework/operator-registry/releases/download/v1.23.0/$${OS}-$${ARCH}-opm ;\ 1
      	chmod +x $(OPM) ;\
      	}
      else
      OPM = $(shell which opm)
      endif
      endif

      1

      v1.19.1 을 v1.23.0 으로 교체합니다.

   4. Kubernetes 1.24를 지원하도록 Makefile 의 ENVTEST_K8S_VERSION 및 controller-gen 필드를 업데이트합니다.

      ...
      ENVTEST_K8S_VERSION = 1.24 1
      ...
      sigs.k8s.io/controller-tools/cmd/controller-gen@v0.9.0 2

      1

      버전 1.22 를 1.24 로 업데이트합니다.

      2

      버전 0.7.0 을 0.9.0 으로 업데이트합니다.

   5. 다음 명령을 입력하여 Makefile 에 변경 사항을 적용하고 Operator를 다시 빌드합니다.

      $ make

3. Go .mod 파일을 다음과 같이 변경하여 Go 및 해당 종속 항목을 업데이트합니다.

   go 1.18 1
   
   require (
     github.com/onsi/ginkgo v1.16.5 2
     github.com/onsi/gomega v1.18.1 3
     k8s.io/api v0.24.0 4
     k8s.io/apimachinery v0.24.0 5
     k8s.io/client-go v0.24.0 6
     sigs.k8s.io/controller-runtime v0.12.1 7
   )

   1

   버전 1.16 을 1.18 로 업데이트합니다.

   2

   버전 v1.16.4 를 v1.16.5 로 업데이트합니다.

   3

   버전 v1.15.0 을 v1.18.1 로 업데이트합니다.

   4 5 6

   버전 v0.22.1 을 v0.24.0 으로 업데이트합니다.

   7

   v0.10.0 버전을 v0.12.1 로 업데이트합니다.

4. go.mod 파일을 편집하여 Helm Operator 플러그인을 업데이트합니다.

   github.com/operator-framework/helm-operator-plugins v0.0.11 1

   1

   버전 v0.0.8 을 v0.0.11 로 업데이트합니다.

5. Dockerfile을 다음과 같이 변경하여 버전 1.18로 이동합니다.

   이전 dockerfile.go 파일

   const dockerfileTemplate = `# Build the manager binary
   FROM golang:1.17 as builder

   새로운 dockerfile.go 파일

   const dockerfileTemplate = `# Build the manager binary
   FROM golang:1.18 as builder

6. 다음 명령을 입력하여 종속 항목을 다운로드하여 정리합니다.

   $ go mod tidy