This documentation is for a release that is no longer maintained
See documentation for the latest supported version 3 or the latest supported version 4.5.5. Helm 기반 Operator
5.5.1. Helm 기반 Operator를 위한 Operator SDK 시작하기 링크 복사링크가 클립보드에 복사되었습니다!
Operator SDK에는 Go 코드를 작성하지 않고도 기존 Helm 차트를 활용하여 Kubernetes 리소스를 통합 애플리케이션으로 배포하는 Operator 프로젝트를 생성하는 옵션이 포함되어 있습니다.
Operator 개발자는 Operator SDK에서 제공하는 툴 및 라이브러리를 사용하여 Helm 기반 Operator를 설정 및 실행하는 기본 동작을 설명하기 위해 Nginx에 대한 Helm 기반 Operator 예제를 빌드하고 클러스터에 배포할 수 있습니다.
5.5.1.1. 사전 요구 사항 링크 복사링크가 클립보드에 복사되었습니다!
- Operator SDK CLI가 설치됨
-
OpenShift CLI(
oc) v4.11 이상이 설치됨 -
cluster-admin권한이 있는 계정으로oc를 사용하여 OpenShift Container Platform 4.11 클러스터에 로그인함 - 클러스터가 이미지를 가져올 수 있도록 하려면 이미지를 내보내는 리포지토리를 공개로 설정하거나 이미지 가져오기 보안을 구성해야 합니다.
5.5.1.2. Helm 기반 Operator 생성 및 배포 링크 복사링크가 클립보드에 복사되었습니다!
Operator SDK를 사용하여 Nginx에 대한 간단한 Helm 기반 Operator를 빌드하고 배포할 수 있습니다.
절차
프로젝트를 생성합니다.
프로젝트 디렉토리를 생성합니다.
mkdir nginx-operator
$ mkdir nginx-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow 프로젝트 디렉터리로 변경합니다.
cd nginx-operator
$ cd nginx-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow helm플러그인과 함께operator-sdk init명령을 실행하여 프로젝트를 초기화합니다.operator-sdk init \ --plugins=helm$ operator-sdk init \ --plugins=helmCopy to Clipboard Copied! Toggle word wrap Toggle overflow
API를 생성합니다.
간단한 Nginx API를 생성합니다.
operator-sdk create api \ --group demo \ --version v1 \ --kind Nginx$ operator-sdk create api \ --group demo \ --version v1 \ --kind NginxCopy to Clipboard Copied! Toggle word wrap Toggle overflow 이 API는
helm create명령의 기본 제공 Helm 차트 상용구를 사용합니다.Operator 이미지를 빌드하여 내보냅니다.
기본
Makefile대상을 사용하여 Operator를 빌드하고 내보냅니다. 내보낼 수 있는 레지스트리를 사용하는 이미지의 가져오기 사양에IMG를 설정합니다.make docker-build docker-push IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-build docker-push IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Operator를 실행합니다.
CRD를 설치합니다.
make install
$ make installCopy to Clipboard Copied! Toggle word wrap Toggle overflow 클러스터에 프로젝트를 배포합니다. 내보낸 이미지에
IMG를 설정합니다.make deploy IMG=<registry>/<user>/<image_name>:<tag>
$ make deploy IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
SCC(보안 컨텍스트 제약 조건)를 추가합니다.
Nginx 서비스 계정에는 OpenShift Container Platform에서 실행할 수 있는 권한이 필요합니다.
nginx-samplePod의 서비스 계정에 다음 SCC를 추가합니다.oc adm policy add-scc-to-user \ anyuid system:serviceaccount:nginx-operator-system:nginx-sample$ oc adm policy add-scc-to-user \ anyuid system:serviceaccount:nginx-operator-system:nginx-sampleCopy to Clipboard Copied! Toggle word wrap Toggle overflow 샘플 CR(사용자 정의 리소스)을 생성합니다.
샘플 CR을 생성합니다.
oc apply -f config/samples/demo_v1_nginx.yaml \ -n nginx-operator-system$ oc apply -f config/samples/demo_v1_nginx.yaml \ -n nginx-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow CR에서 Operator를 조정하는지 확인합니다.
oc logs deployment.apps/nginx-operator-controller-manager \ -c manager \ -n nginx-operator-system$ oc logs deployment.apps/nginx-operator-controller-manager \ -c manager \ -n nginx-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow
oc delete -f config/samples/demo_v1_nginx -n nginx-operator-system
$ oc delete -f config/samples/demo_v1_nginx -n nginx-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 정리합니다.
다음 명령을 실행하여 이 절차의 일부로 생성된 리소스를 정리합니다.
make undeploy
$ make undeployCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.1.3. 다음 단계 링크 복사링크가 클립보드에 복사되었습니다!
5.5.2. helm 기반 Operator를 위한 Operator SDK 튜토리얼 링크 복사링크가 클립보드에 복사되었습니다!
Operator 개발자는 Operator SDK에서 Helm 지원을 활용하여 Nginx에 대한 Helm 기반 Operator 예제를 빌드하고 라이프사이클을 관리할 수 있습니다. 이 튜토리얼에서는 다음 프로세스를 안내합니다.
- Nginx 배포 생성
-
배포 크기가
NginxCR(사용자 정의 리소스) 사양에 지정된 것과 같은지 확인합니다. -
상태 작성기를 사용하여
NginxCR 상태를nginxPod의 이름으로 업데이트합니다.
이 프로세스는 Operator 프레임워크의 두 가지 주요 요소를 사용하여 수행됩니다.
- Operator SDK
-
operator-sdkCLI 툴 및controller-runtime라이브러리 API - OLM(Operator Lifecycle Manager)
- 클러스터에 대한 Operator의 설치, 업그레이드, RBAC(역할 기반 액세스 제어)
5.5.2.1. 사전 요구 사항 링크 복사링크가 클립보드에 복사되었습니다!
- Operator SDK CLI가 설치됨
-
OpenShift CLI(
oc) v4.11 이상이 설치됨 -
cluster-admin권한이 있는 계정으로oc를 사용하여 OpenShift Container Platform 4.11 클러스터에 로그인함 - 클러스터가 이미지를 가져올 수 있도록 하려면 이미지를 내보내는 리포지토리를 공개로 설정하거나 이미지 가져오기 보안을 구성해야 합니다.
5.5.2.2. 프로젝트 생성 링크 복사링크가 클립보드에 복사되었습니다!
Operator SDK CLI를 사용하여 nginx-operator라는 프로젝트를 생성합니다.
프로세스
프로젝트에 사용할 디렉터리를 생성합니다.
mkdir -p $HOME/projects/nginx-operator
$ mkdir -p $HOME/projects/nginx-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow 디렉터리로 변경합니다.
cd $HOME/projects/nginx-operator
$ cd $HOME/projects/nginx-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow helm플러그인과 함께operator-sdk init명령을 실행하여 프로젝트를 초기화합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow 참고기본적으로
helm플러그인은 상용구 Helm 차트를 사용하여 프로젝트를 초기화합니다. 기존 Helm 차트를 사용하는 프로젝트를 초기화하려면--helm-chart플래그와 같은 추가 플래그를 사용하면 됩니다.init명령은 API 버전이example.com/v1이고 종류가Nginx인 리소스를 조사하기 위해 특별히nginx-operator프로젝트를 생성합니다.-
Helm 기반 프로젝트의 경우
init명령은 차트의 기본 매니페스트에 의해 배포되는 리소스를 기반으로config/rbac/role.yaml파일에 RBAC 규칙을 생성합니다. 이 파일에 생성된 규칙이 Operator의 권한 요구 사항을 충족하는지 확인합니다.
5.5.2.2.1. 기존 Helm 차트 링크 복사링크가 클립보드에 복사되었습니다!
상용구 Helm 차트로 프로젝트를 생성하는 대신 다음 플래그를 사용하여 로컬 파일 시스템 또는 원격 차트 리포지토리에서 기존 차트를 사용할 수 있습니다.
-
--helm-chart -
--helm-chart-repo -
--helm-chart-version
--helm-chart 플래그가 지정되면 --group, --version, --kind 플래그가 선택 사항이 됩니다. 설정되지 않으면 다음 기본값이 사용됩니다.
| 플래그 | 값 |
|---|---|
|
|
|
|
|
|
|
|
|
|
| 지정된 차트에서 추론됨 |
--helm-chart 플래그가 로컬 차트 아카이브(예: example-chart-1.2.0.tgz 또는 디렉터리)를 지정하는 경우 차트를 검증하고 압축을 풀거나 프로젝트에 복사합니다. 그러지 않으면 Operator SDK가 원격 리포지토리에서 차트를 가져옵니다.
--helm-chart-repo 플래그로 사용자 정의 리포지토리 URL이 지정되지 않는 경우 다음 차트 참조 형식이 지원됩니다.
| 형식 | 설명 |
|---|---|
|
|
|
|
| 지정된 URL에서 Helm 차트 아카이브를 가져옵니다. |
사용자 정의 리포지토리 URL이 --helm-chart-repo로 지정된 경우 다음 차트 참조 형식이 지원됩니다.
| 형식 | 설명 |
|---|---|
|
|
|
--helm-chart-version 플래그를 설정하지 않으면 Operator SDK에서 사용 가능한 최신 버전의 Helm 차트를 가져옵니다. 그러지 않으면 지정된 버전을 가져옵니다. --helm-chart 플래그로 지정한 차트에서 특정 버전을 참조하는 경우(예: 로컬 경로 또는 URL) 선택적 --helm-chart-version 플래그는 사용되지 않습니다.
자세한 내용 및 예를 보려면 다음을 실행합니다.
operator-sdk init --plugins helm --help
$ operator-sdk init --plugins helm --help
5.5.2.2.2. PROJECT 파일 링크 복사링크가 클립보드에 복사되었습니다!
operator-sdk init 명령으로 생성된 파일 중에는 Kubebuilder PROJECT 파일이 있습니다. 이어서 프로젝트 루트에서 실행되는 operator-sdk 명령과 help 출력에서는 이 파일을 읽고 프로젝트 유형이 Helm임을 확인합니다. 예를 들면 다음과 같습니다.
5.5.2.3. Operator 논리 이해 링크 복사링크가 클립보드에 복사되었습니다!
이 예제에서 nginx-operator 프로젝트는 각 Nginx CR(사용자 정의 리소스)에 대해 다음과 같은 조정 논리를 실행합니다.
- Nginx 배포가 없는 경우 해당 배포를 생성합니다.
- Nginx 서비스가 없는 경우 해당 서비스를 생성합니다.
- Nginx 수신이 활성화되어 있지만 없는 경우 해당 수신을 생성합니다.
-
배포, 서비스, 선택적 수신이
NginxCR에 지정된 대로 원하는 구성(예 : 복제본 수, 이미지, 서비스 유형)과 일치하는지 확인합니다.
기본적으로 nginx-operator 프로젝트는 watches.yaml 파일에 표시된 Nginx 리소스 이벤트를 조사하고 지정된 차트를 사용하여 Helm 릴리스를 실행합니다.
5.5.2.3.1. 샘플 Helm 차트 링크 복사링크가 클립보드에 복사되었습니다!
Helm Operator 프로젝트가 생성되면 Operator SDK는 간단한 Nginx 릴리스에 대한 일련의 템플릿이 포함된 샘플 Helm 차트를 생성합니다.
이 예제에서는 Helm 차트 개발자가 릴리스에 대한 유용한 정보를 전달하는 데 사용하는 NOTES.txt 템플릿과 함께 배포, 서비스, 수신 리소스에 대해 템플릿을 사용할 수 있습니다.
Helm 차트에 대해 잘 모르는 경우 Helm 개발자 설명서를 검토하십시오.
5.5.2.3.2. 사용자 정의 리소스 사양 수정 링크 복사링크가 클립보드에 복사되었습니다!
Helm은 값이라는 개념을 사용하여 values.yaml 파일에 정의된 Helm 차트 기본값에 대한 사용자 정의 기능을 제공합니다.
CR(사용자 정의 리소스) 사양에 원하는 값을 설정하여 이러한 기본값을 덮어쓸 수 있습니다. 예를 들어 복제본 수를 사용할 수 있습니다.
프로세스
helm-charts/nginx/values.yaml파일에는replicaCount라는 값이 있으며 기본적으로1로 설정되어 있습니다. 배포에 Nginx 인스턴스를 두 개 포함하려면 CR 사양에replicaCount: 2를 포함해야 합니다.config/samples/demo_v1_nginx.yaml파일을 편집하여replicaCount: 2를 설정합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow 마찬가지로 기본 서비스 포트는
80으로 설정됩니다.8080을 사용하려면config/samples/demo_v1_nginx.yaml파일을 편집하여 서비스 포트 덮어쓰기를 추가하는spec.port: 8080을 설정합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Helm Operator는 helm install -f ./overrides.yaml 명령과 마찬가지로 값 파일의 콘텐츠인 것처럼 전체 사양을 적용합니다.
5.5.2.4. 프록시 지원 활성화 링크 복사링크가 클립보드에 복사되었습니다!
Operator 작성자는 네트워크 프록시를 지원하는 Operator를 개발할 수 있습니다. 클러스터 관리자는 OLM(Operator Lifecycle Manager)에서 처리하는 환경 변수에 대한 프록시 지원을 구성합니다. 프록시된 클러스터를 지원하려면 Operator에서 다음 표준 프록시 변수에 대한 환경을 검사하고 해당 값을 Operands에 전달해야 합니다.
-
HTTP_PROXY -
HTTPS_PROXY -
NO_PROXY
이 튜토리얼에서는 예제 환경 변수로 HTTP_PROXY를 사용합니다.
사전 요구 사항
- 클러스터 전체 egress 프록시가 활성화된 클러스터입니다.
절차
overrideValues필드를 추가하여 환경 변수에 따라 덮어쓰기를 포함하도록watches.yaml파일을 편집합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow ... proxy: http: "" https: "" no_proxy: ""
... proxy: http: "" https: "" no_proxy: ""Copy to Clipboard Copied! Toggle word wrap Toggle overflow 차트 템플릿이 변수 사용을 지원하는지 확인하려면 다음을 포함하도록
helm-charts/nginx/templates/deployment.yaml파일에서 차트 템플릿을 편집합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow config/manager/manager.yaml파일에 다음을 추가하여 Operator 배포에서 환경 변수를 설정합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.2.5. Operator 실행 링크 복사링크가 클립보드에 복사되었습니다!
다음 세 가지 방법으로 Operator SDK CLI를 사용하여 Operator를 빌드하고 실행할 수 있습니다.
- Go 프로그램으로 클러스터 외부에서 로컬로 실행합니다.
- 클러스터에서 배포로 실행합니다.
- Operator를 번들로 제공하고 OLM(Operator Lifecycle Manager)을 사용하여 클러스터에 배포합니다.
5.5.2.5.1. 클러스터 외부에서 로컬로 실행 링크 복사링크가 클립보드에 복사되었습니다!
Operator 프로젝트를 클러스터 외부의 Go 프로그램으로 실행할 수 있습니다. 이는 배포 및 테스트 속도를 높이기 위한 개발 목적에 유용합니다.
절차
다음 명령을 실행하여
~/.kube/config파일에 구성된 클러스터에 CRD(사용자 정의 리소스 정의)를 설치하고 Operator를 로컬로 실행합니다.make install run
$ make install runCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.2.5.2. 클러스터에서 배포로 실행 링크 복사링크가 클립보드에 복사되었습니다!
Operator 프로젝트를 클러스터에서 배포로 실행할 수 있습니다.
절차
다음
make명령을 실행하여 Operator 이미지를 빌드하고 내보냅니다. 액세스할 수 있는 리포지토리를 참조하려면 다음 단계에서IMG인수를 수정합니다. Quay.io와 같은 리포지토리 사이트에 컨테이너를 저장하기 위해 계정을 받을 수 있습니다.이미지를 빌드합니다.
make docker-build IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-build IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 참고Operator에 대해 SDK에서 생성한 Dockerfile은
Go 빌드를 위해GOARCH=amd64를 명시적으로 참조합니다. 이는AMD64 이외의 아키텍처의 경우GOARCH=$CACHEGETARCH에 수정될 수 있습니다. Docker는 환경 변수를-platform에서 지정한 값으로 자동 설정합니다. Buildah를 사용하면-build-arg를 목적으로 사용해야 합니다. 자세한 내용은 여러 아키텍처를 참조하십시오.이미지를 리포지토리로 내보냅니다.
make docker-push IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-push IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 참고두 명령 모두 이미지의 이름과 태그(예:
IMG=<registry>/<user>/<image_name>:<tag>)를 Makefile에 설정할 수 있습니다. 기본 이미지 이름을 설정하려면IMG ?= controller:latest값을 수정합니다.
다음 명령을 실행하여 Operator를 배포합니다.
make deploy IMG=<registry>/<user>/<image_name>:<tag>
$ make deploy IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 기본적으로 이 명령은
<project_name>-system형식으로 된 Operator 프로젝트 이름을 사용하여 네임스페이스를 생성하고 배포에 사용됩니다. 이 명령은 또한config/rbac에서 RBAC 매니페스트를 설치합니다.다음 명령을 실행하여 Operator가 실행 중인지 확인합니다.
oc get deployment -n <project_name>-system
$ oc get deployment -n <project_name>-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
NAME READY UP-TO-DATE AVAILABLE AGE <project_name>-controller-manager 1/1 1 1 8m
NAME READY UP-TO-DATE AVAILABLE AGE <project_name>-controller-manager 1/1 1 1 8mCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.2.5.3. Operator 번들링 및 Operator Lifecycle Manager를 통한 배포 링크 복사링크가 클립보드에 복사되었습니다!
5.5.2.5.3.1. Operator 번들 링크 복사링크가 클립보드에 복사되었습니다!
Operator 번들 형식은 Operator SDK 및 Operator Lifecycle Manager (OLM)의 기본 패키지 메서드입니다. Operator SDK를 사용하여 Operator 프로젝트를 번들 이미지로 빌드하고 푸시하여 OLM에서 Operator를 사용할 수 있습니다.
사전 요구 사항
- 개발 워크스테이션에 Operator SDK CLI가 설치됨
-
OpenShift CLI(
oc) v4.11 이상이 설치됨 - Operator SDK를 사용하여 Operator 프로젝트를 초기화함
절차
Operator 프로젝트 디렉터리에서 다음
make명령을 실행하여 Operator 이미지를 빌드하고 내보냅니다. 액세스할 수 있는 리포지토리를 참조하려면 다음 단계에서IMG인수를 수정합니다. Quay.io와 같은 리포지토리 사이트에 컨테이너를 저장하기 위해 계정을 받을 수 있습니다.이미지를 빌드합니다.
make docker-build IMG=<registry>/<user>/<operator_image_name>:<tag>
$ make docker-build IMG=<registry>/<user>/<operator_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 참고이미지를 리포지토리로 내보냅니다.
make docker-push IMG=<registry>/<user>/<operator_image_name>:<tag>
$ make docker-push IMG=<registry>/<user>/<operator_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Operator SDK
generate bundle및bundle validate명령을 비롯한 다양한 명령을 호출하는make bundle명령을 실행하여 Operator 번들 매니페스트를 생성합니다.make bundle IMG=<registry>/<user>/<operator_image_name>:<tag>
$ make bundle IMG=<registry>/<user>/<operator_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Operator의 번들 매니페스트는 애플리케이션을 표시, 생성, 관리하는 방법을 설명합니다.
make bundle명령은 Operator 프로젝트에서 다음 파일 및 디렉터리를 생성합니다.-
ClusterServiceVersion오브젝트를 포함하는bundle/manifests라는 번들 매니페스트 디렉터리 -
bundle/metadata라는 번들 메타데이터 디렉터리 -
config/crd디렉터리의 모든 CRD(사용자 정의 리소스 정의) -
Dockerfile
bundle.Dockerfile
그런 다음
operator-sdk bundle validate를 사용하여 이러한 파일을 자동으로 검증하고 디스크상의 번들 표현이 올바른지 확인합니다.-
다음 명령을 실행하여 번들 이미지를 빌드하고 내보냅니다. OLM에서는 하나 이상의 번들 이미지를 참조하는 인덱스 이미지를 통해 Operator 번들을 사용합니다.
번들 이미지를 빌드합니다. 이미지를 내보낼 레지스트리, 사용자 네임스페이스, 이미지 태그에 대한 세부 정보를 사용하여
BUNDLE_IMG를 설정합니다.make bundle-build BUNDLE_IMG=<registry>/<user>/<bundle_image_name>:<tag>
$ make bundle-build BUNDLE_IMG=<registry>/<user>/<bundle_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 번들 이미지를 내보냅니다.
docker push <registry>/<user>/<bundle_image_name>:<tag>
$ docker push <registry>/<user>/<bundle_image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.2.5.3.2. Operator Lifecycle Manager를 사용하여 Operator 배포 링크 복사링크가 클립보드에 복사되었습니다!
OLM(Operator Lifecycle Manager)은 Kubernetes 클러스터에서 Operator 및 관련 서비스를 설치, 업데이트하고 라이프사이클을 관리하는 데 도움이 됩니다. OLM은 기본적으로 OpenShift Container Platform에 설치되고 Kubernetes 확장으로 실행되므로 추가 툴 없이 모든 Operator 라이프사이클 관리 기능에 웹 콘솔과 OpenShift CLI(oc)를 사용할 수 있습니다.
Operator 번들 형식은 Operator SDK 및 OLM의 기본 패키지 메서드입니다. Operator SDK를 사용하여 OLM에서 번들 이미지를 신속하게 실행하여 올바르게 실행되는지 확인할 수 있습니다.
사전 요구 사항
- 개발 워크스테이션에 Operator SDK CLI가 설치됨
- Operator 번들 이미지를 빌드하여 레지스트리로 내보냄
-
Kubernetes 기반 클러스터에 OLM이 설치되어 있음(
apiextensions.k8s.io/v1CRD(예: OpenShift Container Platform 4.11)를 사용하는 경우 v1.16.0 이상 -
cluster-admin권한이 있는 계정을 사용하여oc로 클러스터에 로그인됨
프로세스
operator-sdk run bundle \ -n <namespace> \ <registry>/<user>/<bundle_image_name>:<tag>$ operator-sdk run bundle \1 -n <namespace> \2 <registry>/<user>/<bundle_image_name>:<tag>3 Copy to Clipboard Copied! Toggle word wrap Toggle overflow 중요OpenShift Container Platform 4.11부터
run bundle명령은 기본적으로 Operator 카탈로그의 파일 기반 카탈로그 형식을 지원합니다. Operator 카탈로그의 더 이상 사용되지 않는 SQLite 데이터베이스 형식은 계속 지원되지만 향후 릴리스에서 제거됩니다.이 명령은 다음 작업을 수행합니다.
- 번들 이미지를 참조하는 인덱스 이미지를 생성합니다. 인덱스 이미지는 불투명하고 일시적이지만 프로덕션에서 카탈로그에 번들을 추가하는 방법을 정확하게 반영합니다.
- OperatorHub에서 Operator를 검색할 수 있도록 새 인덱스 이미지를 가리키는 카탈로그 소스를 생성합니다.
5.5.2.6. 사용자 정의 리소스 생성 링크 복사링크가 클립보드에 복사되었습니다!
Operator가 설치되면 Operator에서 현재 클러스터에 제공하는 CR(사용자 정의 리소스)을 생성하여 Operator를 테스트할 수 있습니다.
사전 요구 사항
-
NginxCR을 제공하는 Nginx Operator 예제가 클러스터에 설치되어 있음
절차
Operator가 설치된 네임스페이스로 변경합니다. 예를 들어
make deploy명령을 사용하여 Operator를 배포한 경우 다음을 실행합니다.oc project nginx-operator-system
$ oc project nginx-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 다음 사양을 포함하도록
config/samples/demo_v1_nginx.yaml에서 샘플NginxCR 매니페스트를 편집합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow Nginx 서비스 계정에는 OpenShift Container Platform에서 실행할 수 있는 권한이 필요합니다.
nginx-samplePod의 서비스 계정에 다음 SCC(보안 컨텍스트 제약 조건)를 추가합니다.oc adm policy add-scc-to-user \ anyuid system:serviceaccount:nginx-operator-system:nginx-sample$ oc adm policy add-scc-to-user \ anyuid system:serviceaccount:nginx-operator-system:nginx-sampleCopy to Clipboard Copied! Toggle word wrap Toggle overflow CR을 생성합니다.
oc apply -f config/samples/demo_v1_nginx.yaml
$ oc apply -f config/samples/demo_v1_nginx.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow NginxOperator에서 샘플 CR에 대한 배포를 올바른 크기로 생성하는지 확인합니다.oc get deployments
$ oc get deploymentsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
NAME READY UP-TO-DATE AVAILABLE AGE nginx-operator-controller-manager 1/1 1 1 8m nginx-sample 3/3 3 3 1m
NAME READY UP-TO-DATE AVAILABLE AGE nginx-operator-controller-manager 1/1 1 1 8m nginx-sample 3/3 3 3 1mCopy to Clipboard Copied! Toggle word wrap Toggle overflow Pod 및 CR 상태를 확인하여 상태가 Nginx Pod 이름으로 업데이트되었는지 확인합니다.
Pod를 확인합니다.
oc get pods
$ oc get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
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
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 1mCopy to Clipboard Copied! Toggle word wrap Toggle overflow CR 상태 확인:
oc get nginx/nginx-sample -o yaml
$ oc get nginx/nginx-sample -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
배포 크기를 업데이트합니다.
config/samples/demo_v1_nginx.yaml파일을 업데이트하여NginxCR의spec.size필드를3에서5로 변경합니다.oc patch nginx nginx-sample \ -p '{"spec":{"replicaCount": 5}}' \ --type=merge$ oc patch nginx nginx-sample \ -p '{"spec":{"replicaCount": 5}}' \ --type=mergeCopy to Clipboard Copied! Toggle word wrap Toggle overflow Operator에서 배포 크기를 변경하는지 확인합니다.
oc get deployments
$ oc get deploymentsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
NAME READY UP-TO-DATE AVAILABLE AGE nginx-operator-controller-manager 1/1 1 1 10m nginx-sample 5/5 5 5 3m
NAME READY UP-TO-DATE AVAILABLE AGE nginx-operator-controller-manager 1/1 1 1 10m nginx-sample 5/5 5 5 3mCopy to Clipboard Copied! Toggle word wrap Toggle overflow
oc delete -f config/samples/demo_v1_nginx.yaml
$ oc delete -f config/samples/demo_v1_nginx.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 이 튜토리얼의 일부로 생성된 리소스를 정리합니다.
make deploy명령을 사용하여 Operator를 테스트한 경우 다음 명령을 실행합니다.make undeploy
$ make undeployCopy to Clipboard Copied! Toggle word wrap Toggle overflow operator-sdk run bundle명령을 사용하여 Operator를 테스트한 경우 다음 명령을 실행합니다.operator-sdk cleanup <project_name>
$ operator-sdk cleanup <project_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.3. Helm 기반 Operator의 프로젝트 레이아웃 링크 복사링크가 클립보드에 복사되었습니다!
operator-sdk CLI에서는 각 Operator 프로젝트에 대해 다양한 패키지 및 파일을 생성하거나 스캐폴드를 지정할 수 있습니다.
5.5.3.1. Helm 기반 프로젝트 레이아웃 링크 복사링크가 클립보드에 복사되었습니다!
operator-sdk init --plugins helm 명령을 사용하여 생성된 Helm 기반 Operator 프로젝트에는 다음 디렉터리 및 파일이 포함됩니다.
| 파일/폴더 | 목적 |
|---|---|
|
| Kubernetes 클러스터에 Operator를 배포하는 Kustomize 매니페스트입니다. |
|
|
|
|
|
|
|
| GVK(그룹/버전/종류) 및 Helm 차트 위치입니다. |
|
| 프로젝트 관리에 사용되는 대상입니다. |
|
| Operator의 메타데이터 정보가 포함된 YAML 파일입니다. |
5.5.4. 링크 복사링크가 클립보드에 복사되었습니다!
5.5.4.1. 링크 복사링크가 클립보드에 복사되었습니다!
사전 요구 사항
프로세스
Copy to Clipboard Copied! Toggle word wrap Toggle overflow BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION) ...
BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION) ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow Copy to Clipboard Copied! Toggle word wrap Toggle overflow $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)Copy to Clipboard Copied! Toggle word wrap Toggle overflow $(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS)
$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS)Copy to Clipboard Copied! Toggle word wrap Toggle overflow Copy to Clipboard Copied! Toggle word wrap Toggle overflow make
$ makeCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Dockerfile 예
FROM registry.redhat.io/openshift4/ose-helm-operator:v4.11
FROM registry.redhat.io/openshift4/ose-helm-operator:v4.111 Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.5. Operator SDK의 Helm 지원 링크 복사링크가 클립보드에 복사되었습니다!
5.5.5.1. Helm 차트 링크 복사링크가 클립보드에 복사되었습니다!
Operator 프로젝트를 생성하기 위한 Operator SDK 옵션 중 하나는 Go 코드를 작성하지 않고 Kubernetes 리소스를 통합 애플리케이션으로 배포하기 위해 기존 Helm 차트를 활용하는 것입니다. 이러한 Helm 기반 Operator는 차트의 일부로 생성되는 Kubernetes 오브젝트에 변경 사항을 적용해야 하기 때문에 롤아웃 시 논리가 거의 필요하지 않은 상태 비저장 애플리케이션에서 잘 작동하도록 설계되었습니다. 이는 제한적으로 들릴 수 있지만 Kubernetes 커뮤니티에서 빌드한 Helm 차트의 확산으로 알 수 있듯이 대용량 사용 사례에도 충분할 수 있습니다.
Operator의 주요 기능은 애플리케이션 인스턴스를 표시하는 사용자 정의 오브젝트에서 읽고 원하는 상태가 실행 중인 것과 일치하도록 하는 것입니다. Helm 기반 Operator의 경우 오브젝트의 spec 필드는 일반적으로 Helm values.yaml 파일에 설명된 구성 옵션의 목록입니다. Helm CLI(예: helm install -f values.yaml)를 사용하여 이러한 값을 플래그로 설정하는 대신 CR(사용자 정의 리소스) 내에 표시할 수 있습니다. 그러면 네이티브 Kubernetes 개체로서 여기에 적용된 RBAC 및 감사 추적의 이점을 활용할 수 있습니다.
Tomcat이라는 간단한 CR 예제를 살펴보겠습니다.
이 경우 replicaCount 값인 2가 다음이 사용되는 차트의 템플릿으로 전파됩니다.
{{ .Values.replicaCount }}
{{ .Values.replicaCount }}
Operator를 빌드하고 배포한 후에는 CR 인스턴스를 새로 생성하여 앱의 새 인스턴스를 배포하거나 oc 명령을 사용하여 모든 환경에서 실행 중인 다른 인스턴스를 나열할 수 있습니다.
oc get Tomcats --all-namespaces
$ oc get Tomcats --all-namespaces
Helm CLI를 사용하거나 Tiller를 설치할 필요가 없습니다. Helm 기반 Operator는 Helm 프로젝트에서 코드를 가져옵니다. Operator의 인스턴스를 실행하고 CRD(사용자 정의 리소스 정의)를 사용하여 CR을 등록하기만 하면 됩니다. RBAC를 준수하기 때문에 프로덕션이 변경되는 것을 더 쉽게 방지할 수 있습니다.
5.5.6. 하이브리드 Helm Operator를 위한 Operator SDK 튜토리얼 링크 복사링크가 클립보드에 복사되었습니다!
Operator SDK의 표준 Helm 기반 Operator 지원은 Operator 완성 모델의 Auto Pilot 기능(level V)에 도달한 Go 기반 및 Ansible 기반 Operator 지원에 비해 기능이 제한되어 있습니다.
하이브리드 Helm Operator는 Go API를 통해 기존 Helm 기반 지원 기능을 향상시킵니다. 이 Helm 및 Go의 하이브리드 접근 방식을 통해 Operator SDK를 사용하면 Operator 작성자가 다음 프로세스를 사용할 수 있습니다.
- Helm과 동일한 프로젝트에서 Go API에 대한 기본 구조 또는 스캐폴드 를 생성합니다.
-
하이브리드 Helm Operator에서 제공하는 라이브러리를 통해 프로젝트의
main.go파일에서 Helm 조정 프로그램을 구성합니다.
하이브리드 Helm Operator는 기술 프리뷰 기능 전용입니다. 기술 프리뷰 기능은 Red Hat 프로덕션 서비스 수준 계약(SLA)에서 지원되지 않으며 기능적으로 완전하지 않을 수 있습니다. 따라서 프로덕션 환경에서 사용하는 것은 권장하지 않습니다. 이러한 기능을 사용하면 향후 제품 기능을 조기에 이용할 수 있어 개발 과정에서 고객이 기능을 테스트하고 피드백을 제공할 수 있습니다.
Red Hat 기술 프리뷰 기능의 지원 범위에 대한 자세한 내용은 기술 프리뷰 기능 지원 범위를 참조하십시오.
5.5.6.1. 사전 요구 사항 링크 복사링크가 클립보드에 복사되었습니다!
- Operator SDK CLI가 설치됨
-
OpenShift CLI(
oc) v4.11 이상이 설치됨
5.5.6.2. 프로젝트 생성 링크 복사링크가 클립보드에 복사되었습니다!
Operator SDK CLI를 사용하여 memcached-operator라는 프로젝트를 생성합니다.
절차
프로젝트에 사용할 디렉터리를 생성합니다.
mkdir -p $HOME/github.com/example/memcached-operator
$ mkdir -p $HOME/github.com/example/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow 디렉터리로 변경합니다.
cd $HOME/github.com/example/memcached-operator
$ cd $HOME/github.com/example/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow operator-sdk init \ --plugins=hybrid.helm.sdk.operatorframework.io \ --project-version="3" \ --domain example.com \ --repo=github.com/example/memcached-operator$ operator-sdk init \ --plugins=hybrid.helm.sdk.operatorframework.io \ --project-version="3" \ --domain example.com \ --repo=github.com/example/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow
추가 리소스
5.5.6.3. 링크 복사링크가 클립보드에 복사되었습니다!
절차
operator-sdk create api \ --plugins helm.sdk.operatorframework.io/v1 \ --group cache \ --version v1 \ --kind Memcached$ operator-sdk create api \ --plugins helm.sdk.operatorframework.io/v1 \ --group cache \ --version v1 \ --kind MemcachedCopy to Clipboard Copied! Toggle word wrap Toggle overflow
operator-sdk create api --plugins helm.sdk.operatorframework.io/v1 --help
$ operator-sdk create api --plugins helm.sdk.operatorframework.io/v1 --help
추가 리소스
5.5.6.3.1. Helm API의 Operator 논리 링크 복사링크가 클립보드에 복사되었습니다!
기본적으로 스캐폴드된 Operator 프로젝트는 watches.yaml 파일에 표시된 Memcached 리소스 이벤트를 감시하고 지정된 차트를 사용하여 Helm 릴리스를 실행합니다.
예 5.2. watches.yaml 파일의 예
추가 리소스
- 차트를 통해 Helm Operator 논리를 사용자 정의하는 방법에 대한 자세한 내용은 Operator 논리 이해를 참조하십시오.
5.5.6.3.2. 제공된 라이브러리 API를 사용하여 사용자 정의 Helm 조정기 구성 링크 복사링크가 클립보드에 복사되었습니다!
기존 Helm 기반 Operator의 단점은 사용자가 추상화되기 때문에 Helm 조정기를 구성할 수 없다는 것입니다. Helm 기반 Operator가 기존 Helm 차트를 재사용하는 Seamless Upgrades 기능(레벨 II 이상)에 도달할 수 있도록, Go와 Helm Operator 유형 간의 하이브리드에는 값이 추가됩니다.
helm-operator-plugins 라이브러리에 제공된 API를 사용하여 Operator 작성자는 다음과 같은 구성을 만들 수 있습니다.
- 클러스터 상태에 따라 값 매핑 사용자 정의
- 조정자의 이벤트 레코드를 구성하여 특정 이벤트에서 코드 실행
- 조정자의 로거 사용자 지정
-
조정자가 조사한 사용자 정의 리소스에 있는 주석을 기반으로 Helm의 작업을 구성할 수 있도록
Install,Upgrade,Uninstallannotations -
사전및사후후크로 실행되도록 조정기 구성
조정기에 대한 위의 구성은 main.go 파일에서 수행할 수 있습니다.
main.go 파일 예
5.5.6.4. Go API 생성 링크 복사링크가 클립보드에 복사되었습니다!
Operator SDK CLI를 사용하여 Go API를 생성합니다.
절차
다음 명령을 실행하여 그룹
캐시가 있는 Go API, 버전v1및 kindMemcachedBackup을 생성합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow 메시지가 표시되면 리소스 및 컨트롤러를 모두 생성하도록
y를 입력합니다.Create Resource [y/n]
$ Create Resource [y/n] y Create Controller [y/n] yCopy to Clipboard Copied! Toggle word wrap Toggle overflow
이 절차에서는 api/v1/memcachedbackup_types.go 에 MemcachedBackup 리소스 API를 생성하고 controllers/memcachedbackup_controller.go 에 컨트롤러를 생성합니다.
5.5.6.4.1. API 정의 링크 복사링크가 클립보드에 복사되었습니다!
MemcachedBackup CR(사용자 정의 리소스)의 API를 정의합니다.
MemcachedBackup 유형을 정의하여 MemcachedBackupSpec.Size 필드를 지정하여 배포할 MemcachedBackupSpec.Size 필드가 있고 CR의 Pod 이름을 저장할 MemcachedBackupStatus.Nodes 필드를 나타냅니다.
Node 필드는 상태 필드의 예를 설명하는 데 사용됩니다.
절차
api/v1/memcachedbackup_types.go파일에서 다음spec및status를 갖도록 Go 유형 정의를 수정하여MemcachedBackupCR의 API를 정의합니다.예 5.3.
api/v1/memcachedbackup_types.go파일의 예Copy to Clipboard Copied! Toggle word wrap Toggle overflow 리소스 유형에 대해 생성된 코드를 업데이트합니다.
make generate
$ make generateCopy to Clipboard Copied! Toggle word wrap Toggle overflow 작은 정보*_types.go파일을 수정한 후에는make generate명령을 실행하여 해당 리소스 유형에 대해 생성된 코드를 업데이트해야 합니다.spec및status필드 및 CRD 검증 마커를 사용하여 API를 정의한 후 CRD 매니페스트를 생성하고 업데이트합니다.make manifests
$ make manifestsCopy to Clipboard Copied! Toggle word wrap Toggle overflow
이 Makefile 대상은 controller-gen 유틸리티를 호출하여 config/crd/bases/cache.my.domain_memcachedbackups.yaml 파일에서 CRD 매니페스트를 생성합니다.
5.5.6.4.2. 컨트롤러 구현 링크 복사링크가 클립보드에 복사되었습니다!
이 튜토리얼의 컨트롤러는 다음 작업을 수행합니다.
-
Memcached배포가 없는 경우 생성합니다. -
배포 크기가
MemcachedCR 사양에 지정된 것과 같은지 확인합니다. -
MemcachedCR 상태를memcachedPod의 이름으로 업데이트합니다.
위에 언급된 작업을 수행하도록 컨트롤러를 구성하는 방법에 대한 자세한 내용은 표준 Go 기반 Operator에 대한 Operator SDK 튜토리얼의 컨트롤러 구현 을 참조하십시오.
5.5.6.4.3. main.go의 차이점 링크 복사링크가 클립보드에 복사되었습니다!
표준 Go 기반 Operator 및 하이브리드 Helm Operator의 경우 main.go 파일은 Go API에 대한 Manager 프로그램의 초기화 및 실행을 스캐폴딩합니다. 그러나 하이브리드 Helm Operator의 경우 main.go 파일은 watches.yaml 파일을 로드하고 Helm 조정기를 구성하는 논리도 노출합니다.
예 5.4. main.go 파일 예
관리자는 Helm 및 Go 조정기를 모두 사용하여 초기화됩니다.
예 5.5. Helm 및 Go 조정기의 예
5.5.6.4.4. 권한 및 RBAC 매니페스트 링크 복사링크가 클립보드에 복사되었습니다!
컨트롤러에서 관리하는 리소스와 상호 작용하려면 특정 RBAC(역할 기반 액세스 제어) 권한이 필요합니다. Go API의 경우 표준 Go 기반 Operator를 위해 Operator SDK 튜토리얼에 표시된 대로 RBAC 마커로 지정됩니다.
Helm API의 경우 roles.yaml 에서 권한이 기본적으로 스캐폴드됩니다. 그러나 현재 Go API가 스캐폴드되면 알려진 문제로 인해 Helm API에 대한 권한을 덮어씁니다. 이 문제로 인해 roles.yaml 에 정의된 권한이 사용자의 요구 사항과 일치하는지 확인합니다.
이 알려진 문제는 https://github.com/operator-framework/helm-operator-plugins/issues/142 에서 추적 중입니다.
다음은 Memcached Operator의 role.yaml 의 예입니다.
예 5.6. Helm 및 Go 조정기의 예
추가 리소스
5.5.6.5. 클러스터 외부에서 로컬로 실행 링크 복사링크가 클립보드에 복사되었습니다!
Operator 프로젝트를 클러스터 외부의 Go 프로그램으로 실행할 수 있습니다. 이는 배포 및 테스트 속도를 높이기 위한 개발 목적에 유용합니다.
절차
다음 명령을 실행하여
~/.kube/config파일에 구성된 클러스터에 CRD(사용자 정의 리소스 정의)를 설치하고 Operator를 로컬로 실행합니다.make install run
$ make install runCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.6.6. 클러스터에서 배포로 실행 링크 복사링크가 클립보드에 복사되었습니다!
Operator 프로젝트를 클러스터에서 배포로 실행할 수 있습니다.
절차
다음
make명령을 실행하여 Operator 이미지를 빌드하고 내보냅니다. 액세스할 수 있는 리포지토리를 참조하려면 다음 단계에서IMG인수를 수정합니다. Quay.io와 같은 리포지토리 사이트에 컨테이너를 저장하기 위해 계정을 받을 수 있습니다.이미지를 빌드합니다.
make docker-build IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-build IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 참고Operator용 SDK에서 생성한 Dockerfile은
Go 빌드에대해GOARCH=amd64를 명시적으로 참조합니다. AMD64 이외의 아키텍처의 경우GOARCH=$TARGETARCH로 수정할 수 있습니다. Docker는 자동으로-platform에서 지정한 값으로 환경 변수를 설정합니다. Buildah를 사용하면-build-arg를 목적으로 사용해야 합니다. 자세한 내용은 다중 아키텍처를 참조하십시오.이미지를 리포지토리로 내보냅니다.
make docker-push IMG=<registry>/<user>/<image_name>:<tag>
$ make docker-push IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 참고두 명령 모두 이미지의 이름과 태그(예:
IMG=<registry>/<user>/<image_name>:<tag>)를 Makefile에 설정할 수 있습니다. 기본 이미지 이름을 설정하려면IMG ?= controller:latest값을 수정합니다.
다음 명령을 실행하여 Operator를 배포합니다.
make deploy IMG=<registry>/<user>/<image_name>:<tag>
$ make deploy IMG=<registry>/<user>/<image_name>:<tag>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 기본적으로 이 명령은
<project_name>-system형식으로 된 Operator 프로젝트 이름을 사용하여 네임스페이스를 생성하고 배포에 사용됩니다. 이 명령은 또한config/rbac에서 RBAC 매니페스트를 설치합니다.다음 명령을 실행하여 Operator가 실행 중인지 확인합니다.
oc get deployment -n <project_name>-system
$ oc get deployment -n <project_name>-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
NAME READY UP-TO-DATE AVAILABLE AGE <project_name>-controller-manager 1/1 1 1 8m
NAME READY UP-TO-DATE AVAILABLE AGE <project_name>-controller-manager 1/1 1 1 8mCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.6.7. 사용자 정의 리소스 생성 링크 복사링크가 클립보드에 복사되었습니다!
Operator가 설치되면 Operator가 이제 클러스터에 제공하는 CR(사용자 정의 리소스)을 생성하여 Operator를 테스트할 수 있습니다.
절차
Operator가 설치된 네임스페이스로 변경합니다.
oc project <project_name>-system
$ oc project <project_name>-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow replicaCount필드를3으로 업데이트하여config/samples/cache_v1_memcached.yaml파일에서 샘플MemcachedCR 매니페스트를 업데이트합니다.예 5.7.
config/samples/cache_v1_memcached.yaml파일의 예Copy to Clipboard Copied! Toggle word wrap Toggle overflow MemcachedCR을 생성합니다.oc apply -f config/samples/cache_v1_memcached.yaml
$ oc apply -f config/samples/cache_v1_memcached.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Memcached Operator가 샘플 CR에 대한 배포를 올바른 크기로 생성하는지 확인합니다.
oc get pods
$ oc get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
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
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 18mCopy to Clipboard Copied! Toggle word wrap Toggle overflow 크기를2로 업데이트하여config/samples/cache_v1_memcachedbackup.yaml파일에서 샘플MemcachedBackupCR 매니페스트를 업데이트합니다.예 5.8.
config/samples/cache_v1_memcachedbackup.yaml파일의 예Copy to Clipboard Copied! Toggle word wrap Toggle overflow MemcachedBackupCR을 생성합니다.oc apply -f config/samples/cache_v1_memcachedbackup.yaml
$ oc apply -f config/samples/cache_v1_memcachedbackup.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow memcachedbackupPod 수가 CR에 지정된 것과 같은지 확인합니다.oc get pods
$ oc get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
NAME READY STATUS RESTARTS AGE memcachedbackup-sample-8649699989-4bbzg 1/1 Running 0 22m memcachedbackup-sample-8649699989-mq6mx 1/1 Running 0 22m
NAME READY STATUS RESTARTS AGE memcachedbackup-sample-8649699989-4bbzg 1/1 Running 0 22m memcachedbackup-sample-8649699989-mq6mx 1/1 Running 0 22mCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
위의 각 CR에서
사양을 업데이트한 다음 다시 적용할 수 있습니다. 컨트롤러는 다시 조정하고 Pod의 크기가 각 CR의 사양에 지정된 대로 되도록 합니다. 이 튜토리얼의 일부로 생성된 리소스를 정리합니다.
Memcached리소스를 삭제합니다.oc delete -f config/samples/cache_v1_memcached.yaml
$ oc delete -f config/samples/cache_v1_memcached.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow MemcachedBackup리소스를 삭제합니다.oc delete -f config/samples/cache_v1_memcachedbackup.yaml
$ oc delete -f config/samples/cache_v1_memcachedbackup.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow make deploy명령을 사용하여 Operator를 테스트한 경우 다음 명령을 실행합니다.make undeploy
$ make undeployCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.5.6.8. 프로젝트 레이아웃 링크 복사링크가 클립보드에 복사되었습니다!
하이브리드 Helm Operator 스캐폴딩은 Helm 및 Go API와 호환되도록 사용자 지정할 수 있습니다.
| 파일/폴더 | 목적 |
|---|---|
|
|
컨테이너 엔진에서 |
|
| 프로젝트 작업에 도움이 되는 도우미 대상을 사용하여 파일을 빌드합니다.Build file with helper targets to help you work with your project. |
|
| Operator의 메타데이터 정보가 포함된 YAML 파일입니다. 프로젝트의 구성을 나타내며 CLI 및 플러그인에 대한 유용한 정보를 추적하는 데 사용됩니다. |
|
|
프로젝트를 로컬로 실행하는 데 사용되는 |
|
| 클러스터에서 Operator 프로젝트를 시작하는 모든 Kustomize 매니페스트를 포함한 구성 파일을 포함합니다. Plugins는 이를 사용하여 기능을 제공할 수 있습니다. 예를 들어 Operator SDK에서 Operator 번들을 생성하는 데 도움이 되는 CLI는 이 디렉터리에 스캐폴드된 CRD 및 CR을 찾습니다.
|
|
| Go API 정의를 포함합니다. |
|
| Go API용 컨트롤러를 포함합니다. |
|
| 프로젝트 파일에 대한 라이센스 헤더를 스캐폴드하는 데 사용되는 파일과 같은 유틸리티 파일이 포함되어 있습니다. |
|
|
Operator의 기본 프로그램으로, |
|
|
Helm 플러그인으로 |
|
| GVK(그룹/버전/종류) 및 Helm 차트 위치가 포함되어 있습니다. Helm 감시를 구성하는 데 사용됩니다. |
5.5.7. 최신 Operator SDK 버전의 하이브리드 Helm 기반 프로젝트 업데이트 링크 복사링크가 클립보드에 복사되었습니다!
OpenShift Container Platform 4.11은 Operator SDK 1.22.2를 지원합니다. 워크스테이션에 1.16.0 CLI가 이미 설치되어 있는 경우 최신 버전을 설치하여 CLI를 1.22.2로 업데이트할 수 있습니다.
그러나 기존 Operator 프로젝트에서 Operator SDK 1.22.2와의 호환성을 유지하려면 1.16.0 이후의 중단된 변경 사항에 대한 업데이트 단계가 필요합니다. 1.16.0을 사용하여 이전에 생성되거나 유지 관리되는 Operator 프로젝트에서 업데이트 단계를 수동으로 수행해야 합니다.
5.5.7.1. Operator SDK 1.22.2의 하이브리드 Helm 기반 Operator 프로젝트 업데이트 링크 복사링크가 클립보드에 복사되었습니다!
다음 절차에서는 1.22.2와의 호환성을 위해 기존 하이브리드 Helm 기반 Operator 프로젝트를 업데이트합니다.
사전 요구 사항
- Operator SDK 1.22.2가 설치되어 있어야 합니다.
- Operator SDK 1.16.0을 사용하여 Operator 프로젝트를 생성하거나 유지 관리합니다.
절차
config/default/manager_auth_proxy_patch.yaml파일을 다음과 같이 변경합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow Makefile을 다음과 같이 변경합니다.Makefile에 다음 환경 변수를 추가하여 이미지 다이제스트 지원을 활성화합니다.이전
MakefileBUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION) ...
BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:v$(VERSION) ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow 새로운
MakefileCopy to Clipboard Copied! Toggle word wrap Toggle overflow Makefile을 편집하여 번들 대상을BUNDLE_GEN_FLAGS환경 변수로 교체합니다.이전
Makefile$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle -q --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)Copy to Clipboard Copied! Toggle word wrap Toggle overflow 새로운
Makefile$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS)
$(KUSTOMIZE) build config/manifests | operator-sdk generate bundle $(BUNDLE_GEN_FLAGS)Copy to Clipboard Copied! Toggle word wrap Toggle overflow Makefile을 편집하여opm을 버전 1.23.0으로 업데이트합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
v1.19.1을v1.23.0으로 교체합니다.
Kubernetes 1.24를 지원하도록
Makefile의ENVTEST_K8S_VERSION및controller-gen필드를 업데이트합니다.... ENVTEST_K8S_VERSION = 1.24 ... sigs.k8s.io/controller-tools/cmd/controller-gen@v0.9.0
... ENVTEST_K8S_VERSION = 1.241 ... sigs.k8s.io/controller-tools/cmd/controller-gen@v0.9.02 Copy to Clipboard Copied! Toggle word wrap Toggle overflow 다음 명령을 입력하여
Makefile에 변경 사항을 적용하고 Operator를 다시 빌드합니다.make
$ makeCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Go
.mod 파일을 다음과 같이변경하여 Go 및 해당 종속 항목을 업데이트합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow go.mod파일을 편집하여 Helm Operator 플러그인을 업데이트합니다.github.com/operator-framework/helm-operator-plugins v0.0.11
github.com/operator-framework/helm-operator-plugins v0.0.111 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 버전
v0.0.8을v0.0.11로 업데이트합니다.
Dockerfile을 다음과 같이 변경하여 버전 1.18로 이동합니다.
이전
dockerfile.go파일const dockerfileTemplate = `# Build the manager binary FROM golang:1.17 as builder
const dockerfileTemplate = `# Build the manager binary FROM golang:1.17 as builderCopy to Clipboard Copied! Toggle word wrap Toggle overflow 새로운
dockerfile.go파일const dockerfileTemplate = `# Build the manager binary FROM golang:1.18 as builder
const dockerfileTemplate = `# Build the manager binary FROM golang:1.18 as builderCopy to Clipboard Copied! Toggle word wrap Toggle overflow 다음 명령을 입력하여 종속 항목을 다운로드하여 정리합니다.
go mod tidy
$ go mod tidyCopy to Clipboard Copied! Toggle word wrap Toggle overflow