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.3. Go 기반 Operator
5.3.1. Go 기반 Operator를 위한 Operator SDK 시작하기 링크 복사링크가 클립보드에 복사되었습니다!
Operator 개발자는 Operator SDK에서 제공하는 툴 및 라이브러리를 사용하여 Go 기반 Operator를 설정 및 실행하는 기본 동작을 설명하기 위해 분산형 키-값 저장소인 Memcached에 대한 Go 기반 Operator 예제를 빌드하고 클러스터에 배포할 수 있습니다.
5.3.1.1. 사전 요구 사항 링크 복사링크가 클립보드에 복사되었습니다!
- Operator SDK CLI가 설치됨
-
OpenShift CLI(
oc) v4.11 이상이 설치됨 - Go v1.18+
-
cluster-admin권한이 있는 계정으로oc를 사용하여 OpenShift Container Platform 4.11 클러스터에 로그인함 - 클러스터에서 이미지를 가져올 수 있도록 하려면 이미지를 내보내는 리포지토리를 공개로 설정하거나 이미지 가져오기 보안을 구성해야 합니다.
5.3.1.2. Go 기반 Operator 생성 및 배포 링크 복사링크가 클립보드에 복사되었습니다!
Operator SDK를 사용하여 Memcached에 대한 간단한 Go 기반 Operator를 빌드하고 배포할 수 있습니다.
절차
프로젝트를 생성합니다.
프로젝트 디렉토리를 생성합니다.
mkdir memcached-operator
$ mkdir memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow 프로젝트 디렉터리로 변경합니다.
cd memcached-operator
$ cd memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow operator-sdk init명령을 실행하여 프로젝트를 초기화합니다.operator-sdk init \ --domain=example.com \ --repo=github.com/example-inc/memcached-operator$ operator-sdk init \ --domain=example.com \ --repo=github.com/example-inc/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow 명령은 기본적으로 Go 플러그인을 사용합니다.
API를 생성합니다.
간단한 Memcached API를 생성합니다.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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
샘플 CR(사용자 정의 리소스)을 생성합니다.
샘플 CR을 생성합니다.
oc apply -f config/samples/cache_v1_memcached.yaml \ -n memcached-operator-system$ oc apply -f config/samples/cache_v1_memcached.yaml \ -n memcached-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow CR에서 Operator를 조정하는지 확인합니다.
oc logs deployment.apps/memcached-operator-controller-manager \ -c manager \ -n memcached-operator-system$ oc logs deployment.apps/memcached-operator-controller-manager \ -c manager \ -n memcached-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow
CR 삭제
다음 명령을 실행하여 CR을 삭제합니다.
oc delete -f config/samples/cache_v1_memcached -n memcached-operator-system
$ oc delete -f config/samples/cache_v1_memcached -n memcached-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 정리합니다.
다음 명령을 실행하여 이 절차의 일부로 생성된 리소스를 정리합니다.
make undeploy
$ make undeployCopy to Clipboard Copied! Toggle word wrap Toggle overflow
5.3.1.3. 다음 단계 링크 복사링크가 클립보드에 복사되었습니다!
5.3.2. Go 기반 Operator를 위한 Operator SDK 튜토리얼 링크 복사링크가 클립보드에 복사되었습니다!
Operator 개발자는 Operator SDK의 Go 프로그래밍 언어 지원을 활용하여 분산형 키-값 저장소인 Memcached에 대한 Go 기반 Operator 예제를 빌드하고 라이프사이클을 관리할 수 있습니다.
이 프로세스는 Operator 프레임워크의 두 가지 주요 요소를 사용하여 수행됩니다.
- Operator SDK
-
operator-sdkCLI 툴 및controller-runtime라이브러리 API - OLM(Operator Lifecycle Manager)
- 클러스터에 대한 Operator의 설치, 업그레이드, RBAC(역할 기반 액세스 제어)
5.3.2.1. 사전 요구 사항 링크 복사링크가 클립보드에 복사되었습니다!
- Operator SDK CLI가 설치됨
-
OpenShift CLI(
oc) v4.11 이상이 설치됨 - Go v1.18+
-
cluster-admin권한이 있는 계정으로oc를 사용하여 OpenShift Container Platform 4.11 클러스터에 로그인함 - 클러스터에서 이미지를 가져올 수 있도록 하려면 이미지를 내보내는 리포지토리를 공개로 설정하거나 이미지 가져오기 보안을 구성해야 합니다.
5.3.2.2. 프로젝트 생성 링크 복사링크가 클립보드에 복사되었습니다!
Operator SDK CLI를 사용하여 memcached-operator라는 프로젝트를 생성합니다.
프로세스
프로젝트에 사용할 디렉터리를 생성합니다.
mkdir -p $HOME/projects/memcached-operator
$ mkdir -p $HOME/projects/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow 디렉터리로 변경합니다.
cd $HOME/projects/memcached-operator
$ cd $HOME/projects/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow Go 모듈에 대한 지원을 활성화합니다.
export GO111MODULE=on
$ export GO111MODULE=onCopy to Clipboard Copied! Toggle word wrap Toggle overflow operator-sdk init명령을 실행하여 프로젝트를 초기화합니다.operator-sdk init \ --domain=example.com \ --repo=github.com/example-inc/memcached-operator$ operator-sdk init \ --domain=example.com \ --repo=github.com/example-inc/memcached-operatorCopy to Clipboard Copied! Toggle word wrap Toggle overflow 참고operator-sdk init명령은 기본적으로 Go 플러그인을 사용합니다.operator-sdk init명령은 Go 모듈과 함께 사용할go.mod파일을 생성합니다.$GOPATH/src/외부에서 프로젝트를 생성할 때는 생성된 파일에 유효한 모듈 경로가 필요하기 때문에--repo플래그가 있어야 합니다.
5.3.2.2.1. PROJECT 파일 링크 복사링크가 클립보드에 복사되었습니다!
operator-sdk init 명령으로 생성된 파일 중에는 Kubebuilder PROJECT 파일이 있습니다. 이어서 프로젝트 루트에서 실행되는 operator-sdk 명령과 help 출력에서는 이 파일을 읽고 프로젝트 유형이 Go임을 확인합니다. 예를 들면 다음과 같습니다.
5.3.2.2.2. Manager 정보 링크 복사링크가 클립보드에 복사되었습니다!
Operator의 기본 프로그램은 Manager를 초기화하고 실행하는 main.go 파일입니다. Manager는 모든 CR(사용자 정의 리소스) API 정의에 대한 스키마를 자동으로 등록하고 컨트롤러 및 Webhook를 설정 및 실행합니다.
Manager는 모든 컨트롤러에서 리소스를 조사하는 네임스페이스를 제한할 수 있습니다.
mgr, err := ctrl.NewManager(cfg, manager.Options{Namespace: namespace})
mgr, err := ctrl.NewManager(cfg, manager.Options{Namespace: namespace})
기본적으로 Manager는 Operator가 실행되는 네임스페이스를 조사합니다. 모든 네임스페이스를 조사하려면 namespace 옵션을 비워두면 됩니다.
mgr, err := ctrl.NewManager(cfg, manager.Options{Namespace: ""})
mgr, err := ctrl.NewManager(cfg, manager.Options{Namespace: ""})
MultiNamespacedCacheBuilder 기능을 사용하여 특정 네임스페이스 세트를 조사할 수도 있습니다.
var namespaces []string
mgr, err := ctrl.NewManager(cfg, manager.Options{
NewCache: cache.MultiNamespacedCacheBuilder(namespaces),
})
var namespaces []string
mgr, err := ctrl.NewManager(cfg, manager.Options{
NewCache: cache.MultiNamespacedCacheBuilder(namespaces),
})
5.3.2.2.3. 다중 그룹 API 정보 링크 복사링크가 클립보드에 복사되었습니다!
API 및 컨트롤러를 생성하기 전에 Operator에 여러 API 그룹이 필요한지 확인하도록 합니다. 이 튜토리얼에서는 단일 그룹 API의 기본 사례를 다루지만 프로젝트의 레이아웃을 변경하여 다중 그룹 API를 지원하려면 다음 명령을 실행하면 됩니다.
operator-sdk edit --multigroup=true
$ operator-sdk edit --multigroup=true
이 명령은 다음 예와 유사한 PROJECT 파일을 업데이트합니다.
domain: example.com layout: go.kubebuilder.io/v3 multigroup: true ...
domain: example.com
layout: go.kubebuilder.io/v3
multigroup: true
...
다중 그룹 프로젝트의 경우 API Go 유형 파일은 apis/<group>/<version>/ 디렉터리에 생성되고 컨트롤러는 controllers/<group>/ 디렉터리에 생성됩니다. 그런 다음 Dockerfile이 적절하게 업데이트됩니다.
추가 리소스
- 다중 그룹 프로젝트로 마이그레이션하는 방법에 대한 자세한 내용은 Kubebuilder 설명서를 참조하십시오.
5.3.2.3. API 및 컨트롤러 생성 링크 복사링크가 클립보드에 복사되었습니다!
Operator SDK CLI를 사용하여 CRD(사용자 정의 리소스 정의) API 및 컨트롤러를 생성합니다.
절차
다음 명령을 실행하여 그룹이
cache이고 버전이v1, 종류가Memcached인 API를 생성합니다.operator-sdk create api \ --group=cache \ --version=v1 \ --kind=Memcached$ operator-sdk create api \ --group=cache \ --version=v1 \ --kind=MemcachedCopy to Clipboard Copied! Toggle word wrap Toggle overflow 메시지가 표시되면 리소스 및 컨트롤러 모두 생성하도록
y를 입력합니다.Create Resource [y/n] y Create Controller [y/n] y
Create Resource [y/n] y Create Controller [y/n] yCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
Writing scaffold for you to edit... api/v1/memcached_types.go controllers/memcached_controller.go ...
Writing scaffold for you to edit... api/v1/memcached_types.go controllers/memcached_controller.go ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow
이 프로세스는 api/v1/memcached_types.go에 Memcached 리소스 API를 생성하고 controllers/memcached_controller.go에 컨트롤러를 생성합니다.
5.3.2.3.1. API 정의 링크 복사링크가 클립보드에 복사되었습니다!
Memcached CR(사용자 정의 리소스)의 API를 정의합니다.
절차
spec및status가 다음과 같도록api/v1/memcached_types.go에서 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명령을 실행하여 해당 리소스 유형에 대해 생성된 코드를 업데이트해야 합니다.위의 Makefile 대상은
controller-gen유틸리티를 호출하여api/v1/zz_generated.deepcopy.go파일을 업데이트합니다. 이렇게 하면 API Go 유형 정의에서 모든 종류의 유형에서 구현해야 하는runtime.Object인터페이스를 구현할 수 있습니다.
5.3.2.3.2. CRD 매니페스트 생성 링크 복사링크가 클립보드에 복사되었습니다!
spec 및 status 필드 그리고 CRD(사용자 정의 리소스 정의) 검증 마커를 사용하여 API를 정의한 후에는 CRD 매니페스트를 생성할 수 있습니다.
절차
다음 명령을 실행하여 CRD 매니페스트를 생성하고 업데이트합니다.
make manifests
$ make manifestsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 이 Makefile 대상은
controller-gen유틸리티를 호출하여config/crd/bases/cache.example.com_memcacheds.yaml파일에서 CRD 매니페스트를 생성합니다.
5.3.2.3.2.1. OpenAPI 검증 정보 링크 복사링크가 클립보드에 복사되었습니다!
매니페스트가 생성될 때 spec.validation 블록의 CRD 매니페스트에 OpenAPIv3 스키마가 추가됩니다. 이 검증 블록을 사용하면 Memcached CR(사용자 정의 리소스)을 생성하거나 업데이트할 때 Kubernetes에서 해당 속성을 검증할 수 있습니다.
마커 또는 주석을 사용하여 API에 대한 검증을 구성할 수 있습니다. 이러한 마커에는 항상 +kubebuilder:validation 접두사가 있습니다.
5.3.2.4. 컨트롤러 구현 링크 복사링크가 클립보드에 복사되었습니다!
새 API 및 컨트롤러를 생성하면 컨트롤러 논리를 구현할 수 있습니다.
절차
이 예제에서는 생성된 컨트롤러 파일
controllers/memcached_controller.go를 다음 예제 구현으로 교체합니다.예 5.1.
memcached_controller.go의 예Copy to Clipboard Copied! Toggle word wrap Toggle overflow 예제 컨트롤러는 각
MemcachedCR(사용자 정의 리소스)에 대해 다음 조정 논리를 실행합니다.- Memcached 배포가 없는 경우 생성합니다.
-
배포 크기가
MemcachedCR 사양에 지정된 것과 같은지 확인합니다. -
MemcachedCR 상태를memcachedPod의 이름으로 업데이트합니다.
다음 하위 섹션에서는 구현 예제의 컨트롤러에서 리소스를 조사하는 방법과 조정 반복문을 트리거하는 방법을 설명합니다. 이러한 하위 섹션을 건너뛰고 Operator 실행 으로 직접 이동할 수 있습니다.
5.3.2.4.1. 컨트롤러에서 조사하는 리소스 링크 복사링크가 클립보드에 복사되었습니다!
controllers/memcached_controller.go의 SetupWithManager() 함수는 해당 컨트롤러에서 보유하고 관리하는 CR 및 기타 리소스를 조사하기 위해 컨트롤러를 빌드하는 방법을 지정합니다.
NewControllerManagedBy()에서는 다양한 컨트롤러 구성을 허용하는 컨트롤러 빌더를 제공합니다.
For(&cachev1.Memcached{})는 조사할 기본 리소스로 Memcached 유형을 지정합니다. Memcached 유형에 대한 각 추가, 업데이트 또는 삭제 이벤트의 경우 조정 반복문은 해당 Memcached 오브젝트의 조정 Request 인수(네임스페이스 및 이름 키로 구성됨)로 전송됩니다.
Owns(&appsv1.Deployment{})는 조사할 보조 리소스로 Deployment 유형을 지정합니다. 이벤트 핸들러는 Deployment 유형, 즉 추가, 업데이트 또는 삭제 이벤트가 발생할 때마다 각 이벤트를 배포 소유자의 조정 요청에 매핑합니다. 이 경우 소유자는 배포가 생성된 Memcached 오브젝트입니다.
5.3.2.4.2. 컨트롤러 구성 링크 복사링크가 클립보드에 복사되었습니다!
기타 여러 유용한 구성을 사용하여 컨트롤러를 초기화할 수 있습니다. 예를 들면 다음과 같습니다.
MaxConcurrentReconciles옵션을 사용하여 컨트롤러에 대한 최대 동시 조정 수를 설정합니다. 기본값은1입니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 서술자를 사용하여 조사 이벤트를 필터링합니다.
-
조정 반복문에 대한 요청을 조정하기 위해 조사 이벤트를 변환하는 방법을 변경하려면 EventHandler 유형을 선택합니다. 기본 및 보조 리소스보다 복잡한 Operator 관계의 경우
EnqueueRequestsFromMapFunc핸들러를 사용하여 조사 이벤트를 임의의 조정 요청 세트로 변환할 수 있습니다.
5.3.2.4.3. 조정 반복문 링크 복사링크가 클립보드에 복사되었습니다!
모든 컨트롤러에는 조정 반복문을 구현하는 Reconcile() 메서드가 포함된 조정기 오브젝트가 있습니다. 조정 반복문에는 캐시에서 기본 리소스 오브젝트인 Memcached를 찾는 데 사용되는 네임스페이스 및 이름 키인 Request 인수가 전달됩니다.
반환 값, 결과, 오류에 따라 요청이 다시 큐에 추가되고 조정 루프가 다시 트리거될 수 있습니다.
Result.RequeueAfter를 설정하여 유예 기간 후 요청을 다시 큐에 추가할 수 있습니다.
import "time"
// Reconcile for any reason other than an error after 5 seconds
return ctrl.Result{RequeueAfter: time.Second*5}, nil
import "time"
// Reconcile for any reason other than an error after 5 seconds
return ctrl.Result{RequeueAfter: time.Second*5}, nil
주기적으로 CR을 조정하도록 RequeueAfter를 설정하여 Result를 반환할 수 있습니다.
조정기, 클라이언트, 리소스 이벤트와의 상호 작용에 대한 자세한 내용은 Controller Runtime Client API 설명서를 참조하십시오.
5.3.2.4.4. 권한 및 RBAC 매니페스트 링크 복사링크가 클립보드에 복사되었습니다!
컨트롤러에서 관리하는 리소스와 상호 작용하려면 특정 RBAC 권한이 필요합니다. 이러한 권한은 다음과 같은 RBAC 마커를 사용하여 지정합니다.
config/rbac/role.yaml의 ClusterRole 오브젝트 매니페스트는 make manifests 명령이 실행될 때마다 controller-gen 유틸리티를 사용하여 이전 마커에서 생성됩니다.
5.3.2.5. 프록시 지원 활성화 링크 복사링크가 클립보드에 복사되었습니다!
Operator 작성자는 네트워크 프록시를 지원하는 Operator를 개발할 수 있습니다. 클러스터 관리자는 OLM(Operator Lifecycle Manager)에서 처리하는 환경 변수에 대한 프록시 지원을 구성합니다. 프록시된 클러스터를 지원하려면 Operator에서 다음 표준 프록시 변수에 대한 환경을 검사하고 해당 값을 Operands에 전달해야 합니다.
-
HTTP_PROXY -
HTTPS_PROXY -
NO_PROXY
이 튜토리얼에서는 예제 환경 변수로 HTTP_PROXY를 사용합니다.
사전 요구 사항
- 클러스터 전체 egress 프록시가 활성화된 클러스터입니다.
프로세스
다음을 포함하도록
controllers/memcached_controller.go파일을 편집합니다.operator-lib라이브러리에서프록시패키지를 가져옵니다.import ( ... "github.com/operator-framework/operator-lib/proxy" )
import ( ... "github.com/operator-framework/operator-lib/proxy" )Copy to Clipboard Copied! Toggle word wrap Toggle overflow 조정 루프에
proxy.ReadProxyVarsFromEnv도우미 함수를 추가하고 Operand 환경에 결과를 추가합니다.for i, container := range dep.Spec.Template.Spec.Containers { dep.Spec.Template.Spec.Containers[i].Env = append(container.Env, proxy.ReadProxyVarsFromEnv()...) } ...for i, container := range dep.Spec.Template.Spec.Containers { dep.Spec.Template.Spec.Containers[i].Env = append(container.Env, proxy.ReadProxyVarsFromEnv()...) } ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow
config/manager/manager.yaml파일에 다음을 추가하여 Operator 배포에서 환경 변수를 설정합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
5.3.2.6. Operator 실행 링크 복사링크가 클립보드에 복사되었습니다!
다음 세 가지 방법으로 Operator SDK CLI를 사용하여 Operator를 빌드하고 실행할 수 있습니다.
- Go 프로그램으로 클러스터 외부에서 로컬로 실행합니다.
- 클러스터에서 배포로 실행합니다.
- Operator를 번들로 제공하고 OLM(Operator Lifecycle Manager)을 사용하여 클러스터에 배포합니다.
Go 기반 Operator를 OpenShift Container Platform의 배포 또는 OLM을 사용하는 번들로 실행하려면 지원되는 이미지를 사용하도록 프로젝트를 업데이트해야 합니다.
5.3.2.6.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.3.2.6.2. 클러스터에서 배포로 실행 링크 복사링크가 클립보드에 복사되었습니다!
Operator 프로젝트를 클러스터에서 배포로 실행할 수 있습니다.
사전 요구 사항
- 지원되는 이미지로 프로젝트를 업데이트하여 OpenShift Container Platform에서 Go 기반 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.3.2.6.3. Operator 번들링 및 Operator Lifecycle Manager를 통한 배포 링크 복사링크가 클립보드에 복사되었습니다!
5.3.2.6.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가 Go 기반인 경우 OpenShift Container Platform에서 실행하기 위해 지원되는 이미지를 사용하도록 프로젝트를 업데이트해야 함
프로세스
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 참고Operator에 대해 SDK에서 생성한 Dockerfile은
Go 빌드를 위해GOARCH=amd64를 명시적으로 참조합니다. 이는AMD64 이외의 아키텍처의 경우GOARCH=$CACHEGETARCH에 수정될 수 있습니다. Docker는 환경 변수를-platform에서 지정한 값으로 자동 설정합니다. Buildah를 사용하면-build-arg를 목적으로 사용해야 합니다. 자세한 내용은 여러 아키텍처를 참조하십시오.이미지를 리포지토리로 내보냅니다.
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.3.2.6.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가 Go 기반인 경우 OpenShift Container Platform에서 실행하기 위해 지원되는 이미지를 사용하도록 프로젝트를 업데이트해야 함
프로세스
다음 명령을 입력하여 클러스터에서 Operator를 실행합니다.
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 - 1
run bundle명령은 유효한 파일 기반 카탈로그를 생성하고 OLM을 사용하여 클러스터에 Operator 번들을 설치합니다.- 2
- 선택 사항: 기본적으로 이 명령은 현재 활성 프로젝트에
~/.kube/config파일에 Operator를 설치합니다.-n플래그를 추가하면 설치에 다른 네임스페이스 범위를 설정할 수 있습니다. - 3
- 이미지를 지정하지 않으면 명령에서
quay.io/operator-framework/opm:latest를 기본 인덱스 이미지로 사용합니다. 이미지를 지정하면 명령에서 번들 이미지 자체를 인덱스 이미지로 사용합니다.
중요OpenShift Container Platform 4.11부터
run bundle명령은 기본적으로 Operator 카탈로그의 파일 기반 카탈로그 형식을 지원합니다. Operator 카탈로그의 더 이상 사용되지 않는 SQLite 데이터베이스 형식은 계속 지원되지만 향후 릴리스에서 제거됩니다. Operator 작성자는 해당 워크플로우를 파일 기반 카탈로그 형식으로 마이그레이션하는 것이 좋습니다.이 명령은 다음 작업을 수행합니다.
- 번들 이미지를 참조하는 인덱스 이미지를 생성합니다. 인덱스 이미지는 불투명하고 일시적이지만 프로덕션에서 카탈로그에 번들을 추가하는 방법을 정확하게 반영합니다.
- OperatorHub에서 Operator를 검색할 수 있도록 새 인덱스 이미지를 가리키는 카탈로그 소스를 생성합니다.
-
OperatorGroup,Subscription,InstallPlan및 RBAC를 포함한 기타 모든 필수 리소스를 생성하여 Operator를 클러스터에 배포합니다.
5.3.2.7. 사용자 정의 리소스 생성 링크 복사링크가 클립보드에 복사되었습니다!
Operator가 설치되면 Operator에서 현재 클러스터에 제공하는 CR(사용자 정의 리소스)을 생성하여 Operator를 테스트할 수 있습니다.
사전 요구 사항
-
MemcachedCR을 제공하는 Memcached Operator의 예가 클러스터에 설치됨
프로세스
Operator가 설치된 네임스페이스로 변경합니다. 예를 들어
make deploy명령을 사용하여 Operator를 배포한 경우 다음을 실행합니다.oc project memcached-operator-system
$ oc project memcached-operator-systemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 다음 사양을 포함하도록
config/samples/cache_v1_memcached.yaml의 샘플MemcachedCR 매니페스트를 편집합니다.Copy to Clipboard Copied! Toggle word wrap Toggle overflow CR을 생성합니다.
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 MemcachedOperator에서 샘플 CR에 대한 배포를 올바른 크기로 생성하는지 확인합니다.oc get deployments
$ oc get deploymentsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
NAME READY UP-TO-DATE AVAILABLE AGE memcached-operator-controller-manager 1/1 1 1 8m memcached-sample 3/3 3 3 1m
NAME READY UP-TO-DATE AVAILABLE AGE memcached-operator-controller-manager 1/1 1 1 8m memcached-sample 3/3 3 3 1mCopy to Clipboard Copied! Toggle word wrap Toggle overflow Pod 및 CR 상태를 확인하여 상태가 Memcached Pod 이름으로 업데이트되었는지 확인합니다.
Pod를 확인합니다.
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 1m memcached-sample-6fd7c98d8-g5k7v 1/1 Running 0 1m memcached-sample-6fd7c98d8-m7vn7 1/1 Running 0 1m
NAME READY STATUS RESTARTS AGE memcached-sample-6fd7c98d8-7dqdr 1/1 Running 0 1m memcached-sample-6fd7c98d8-g5k7v 1/1 Running 0 1m memcached-sample-6fd7c98d8-m7vn7 1/1 Running 0 1mCopy to Clipboard Copied! Toggle word wrap Toggle overflow CR 상태 확인:
oc get memcached/memcached-sample -o yaml
$ oc get memcached/memcached-sample -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 출력 예
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
배포 크기를 업데이트합니다.
config/samples/cache_v1_memcached.yaml파일을 업데이트하여MemcachedCR의spec.size필드를3에서5로 변경합니다.oc patch memcached memcached-sample \ -p '{"spec":{"size": 5}}' \ --type=merge$ oc patch memcached memcached-sample \ -p '{"spec":{"size": 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 memcached-operator-controller-manager 1/1 1 1 10m memcached-sample 5/5 5 5 3m
NAME READY UP-TO-DATE AVAILABLE AGE memcached-operator-controller-manager 1/1 1 1 10m memcached-sample 5/5 5 5 3mCopy to Clipboard Copied! Toggle word wrap Toggle overflow
다음 명령을 실행하여 CR을 삭제합니다.
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 이 튜토리얼의 일부로 생성된 리소스를 정리합니다.
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.3.3. Go 기반 Operator의 프로젝트 레이아웃 링크 복사링크가 클립보드에 복사되었습니다!
operator-sdk CLI에서는 각 Operator 프로젝트에 대해 다양한 패키지 및 파일을 생성하거나 스캐폴드를 지정할 수 있습니다.
5.3.3.1. Go 기반 프로젝트 레이아웃 링크 복사링크가 클립보드에 복사되었습니다!
operator-sdk init 명령을 사용하여 생성된 기본 유형의 Go 기반 Operator 프로젝트에는 다음 파일과 디렉터리가 포함됩니다.
| 파일 또는 디렉터리 | 목적 |
|---|---|
|
|
Operator의 기본 프로그램으로, 모든 CRD(사용자 정의 리소스 정의)를 |
|
|
CRD의 API를 정의하는 디렉터리 트리입니다. |
|
|
컨트롤러 구현입니다. |
|
| CRD, RBAC, 인증서를 포함하여 클러스터에 컨트롤러를 배포하는 데 사용하는 Kubernetes 매니페스트입니다. |
|
| 컨트롤러를 빌드하고 배포하는 데 사용하는 대상입니다. |
|
| 컨테이너 엔진에서 Operator를 빌드하는 데 사용하는 지침입니다. |
|
| CRD 등록, RBAC 설정, Operator를 배포로 배포하는 Kubernetes 매니페스트입니다. |
5.3.4. 최신 Operator SDK 버전에 대한 Go 기반 Operator 프로젝트 업데이트 링크 복사링크가 클립보드에 복사되었습니다!
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.3.4.1. Operator SDK 1.22.2의 Go 기반 Operator 프로젝트 업데이트 링크 복사링크가 클립보드에 복사되었습니다!
다음 절차에서는 1.22.2와의 호환성을 위해 기존 Go 기반 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으로 바꿉니다.
Makefile을 편집하여go get대상을go install대상으로 바꿉니다.이전
MakefileCopy to Clipboard Copied! Toggle word wrap Toggle overflow 새
MakefileCopy to Clipboard Copied! Toggle word wrap Toggle overflow Makefile의ENVTEST_K8S_VERSION및controller-gen필드를 업데이트하여 Kubernetes 1.24를 지원합니다.... 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 tidy
$ go mod tidyCopy to Clipboard Copied! Toggle word wrap Toggle overflow api/webhook_suitetest.go및controllers/suite_test.go제품군 테스트 파일을 사용하는 경우 다음과 같이 변경합니다.이전 제품군 테스트 파일
cfg, err := testEnv.Start()
cfg, err := testEnv.Start()Copy to Clipboard Copied! Toggle word wrap Toggle overflow 새로운 제품군 테스트 파일
var err error // cfg is defined in this file globally. cfg, err = testEnv.Start()
var err error // cfg is defined in this file globally. cfg, err = testEnv.Start()Copy to Clipboard Copied! Toggle word wrap Toggle overflow Kubernetes 선언 플러그인을 사용하는 경우 다음과 같은 변경 사항으로 Dockerfile을 업데이트합니다.
COPY 컨트롤러/컨트롤러/:를 시작하는 행 아래에 다음 변경 사항을 추가합니다.https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/blob/master/docs/addon/walkthrough/README.md#adding-a-manifest Stage channels and make readable
# https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/blob/master/docs/addon/walkthrough/README.md#adding-a-manifest # Stage channels and make readable COPY channels/ /channels/ RUN chmod -R a+rx /channels/Copy to Clipboard Copied! Toggle word wrap Toggle overflow COPY --from=builder /workspace/manager를 시작하는 행 아래에 다음 변경 사항을 추가합니다.:copy channels
# copy channels COPY --from=builder /channels /channelsCopy to Clipboard Copied! Toggle word wrap Toggle overflow