커스텀 리소스 데피니션(CRD)

이 부분은 모범사례 가이드의 일부로서 커스텀 리소스 데피니션 객체를 생성하고 사용하는 것을 다룬다.

커스텀 리소스 데피니션(CRD)를 다룰 때에는, 다음 2가지를 구분하는 것이 중요하다.

• CRD의 선언이 있다. 이것은 종류(kind)가 CustomResourceDefinition인 YAML 파일이다.
• 그리고 그 CRD를 사용하는 리소스들이 있다. 어떤 CRD가 foo.example.com/v1를 정의한다고 해보자. apiVersion: example.com/v1가 있고 종류(kind)가 Foo인 모든 리소스들은 그 CRD를 사용하는 리소스이다.

리소스를 사용하기 전에 CRD 선언을 설치하기

헬름은 되도록 많은 리소스들을 빨리 쿠버네티스 내에 로드(load)하도록 최적화되어 있다. 설계상, 쿠버네티스는 전체 매니페스트 세트를 받고 온라인으로 반영한다(이것을 조정(reconciliation) 루프라고 한다).

하지만 CRD의 경우는 약간 다르다.

해당 CRD 종류(kind) 리소스가 사용되기 전에, CRD 선언이 먼저 등록되어 있어야 한다. 그리고 등록 과정은 때에 따라 몇 초 정도 걸린다.

방법 1: helm이 처리하게 하기

헬름 3이 나오면서, 더 단순한 방안을 위해 구식 crd-install 훅(hook)은 없어졌다. 이제는 crds라는 특수 디렉토리가 있어서, CRD를 만들고자 할 때 차트 내에 생성할 수 있다. CRD는 템플릿은 아니지만 차트를 helm install으로 실행하면 기본으로 설치될 것이다. CRD가 이미 있으면, 경고(warning)가 나오면서 넘어가게 된다. CRD 설치 단계를 그냥 넘기고 싶다면, --skip-crds 플래그를 쓰면 된다.

주의사항 (및 설명)

지금으로서는 헬름으로 CRD를 업그레이드하거나 삭제하는 것이 지원되지 않는다. 이는 의도치 않은 데이터 유실 위험을 우려한 커뮤니티 상의 많은 논의에 따른 명시적인 결정이다. 또한, 현재로서는 CRD와 그 수명주기를 어떻게 다룰 지에 대해 커뮤니티의 컨센서스가 없다. 논의가 진행되면 헬름은 그러한 사용사례에 대해 지원할 수 있게 될 것이다.

현재 helm install와 helm upgrade의 --dry-run 플래그는 CRD를 지원하지 않는다. "드라이런(Dry Run)"의 목적은 차트가 실제로 서버에 전송되었을 때 처리되어 나올 결과물을 검증하는 것이다. 그런데 CRD는 서버의 행동 자체를 변경시킨다. 헬름은 드라이런으로 CRD를 설치할 수 없으므로, 디스커버리 클라이언트는 커스텀 리소스(CR)에 대해 알 수 없고 검증은 실패하게 될 것이다. 대안으로 CRD를 별도의 CRD 자체의 차트로 옮기거나, helm template을 사용할 수 있다.

CRD 지원 논의에서 고려할 다른 중요한 포인트는 템플릿 렌더링을 어떻게 처리할 것인지이다. 헬름 2에서 사용되던 crd-install의 뚜렷한 단점의 하나는 API 기능범위 변경 때문에 차트를 제대로 검증할 수 없다는 점이다(CRD는 쿠버네티스 클러스터에 사용가능한 API를 실제로 추가한다). 차트가 CRD를 설치하면, helm이 사용하던 유효한 API 버전 세트가 더 이상 유효하지 않은 것이다. 이는 CRD에서 템플릿 지원이 제거된 데에 깔린 이유이기도 한다. CRD를 설치하는 새로운 crds 방법에서는, helm이 클러스터의 현재 상태에 대해 완전히 유효한 정보를 가지고 있음이 보장된다.

방법 2: 차트 분리하기

다른 방법으로는 한 차트에는 CRD 정의(definition)를 넣고 다른 차트에는 CRD를 사용하는 리소스들을 넣는 방법이 있다.

이 방법으로 할 때는, 각 차트가 따로 설치되어야 한다. 하지만, 이러한 작업방식은 클러스터에 어드민으로 접근하는 클러스터 운영자들에게 더 유용할 것이다.