템플릿의 주석 및 인용

차트에서 메모를 남기는 방법은 두 가지입니다. 일반 YAML 주석과 특수한 템플릿 주석입니다. 두 방식은 렌더링 시 매우 다르게 동작합니다.

해시 기호로 시작하는 줄은 일반 YAML 주석입니다. 이 주석은 그대로 전달되어 렌더링된 출력에도 남으므로 누구나 읽을 수 있습니다.

Helm에는 완전히 사라지는 자체 주석이 있습니다. {{/* */}}로 텍스트를 감싸면 엔진이 출력 전에 제거합니다.

해시로 배포된 YAML을 문서화합니다. 사용자가 절대 보지 않아야 하는 템플릿 로직에 대한 메모에는 템플릿 주석을 사용합니다. 📝

템플릿 주석은 코드를 비활성화할 때 유용합니다. 액션을 {{/* */}}로 감싸면 Helm이 이를 건너뛰므로 렌더링도 오류도 발생하지 않습니다.

YAML은 종종 형식을 임의로 판단합니다. 1.10이라는 값이 1.1이 될 수 있고, yes가 true로 바뀔 수도 있습니다. 따옴표 사용을 통해 대신 명확한 문자열로 만들 수 있습니다.

Helm은 값을 큰따옴표로 감싸 주는 quote 함수를 제공합니다. 따라서 렌더링된 필드가 명확하게 문자열이 됩니다.

보통 액션 끝에서 quote를 파이프로 작성한 형태를 보게 됩니다. 값을 가져온 다음 quote를 적용한다는 뜻으로 자연스럽게 읽힙니다.

따옴표가 없으면 1.20 같은 버전이 마지막 0을 조용히 잃고 1.2가 될 수 있어 이미지 참조가 깨집니다. 따옴표를 사용하면 이를 방지할 수 있습니다. ⚠️

Kubernetes에서는 어노테이션의 포트처럼 숫자를 텍스트로 유지해야 할 때가 있습니다. quote를 파이프로 연결하면 안전하게 문자열로 유지할 수 있습니다.

YAML에 리터럴 따옴표를 직접 작성해도 됩니다. quote 함수는 값이 템플릿에서 올 때 프로그래밍 방식으로 따옴표를 추가할 뿐입니다.

배포된 YAML에 나타나지 않아야 하는 메모를 추가합니다.

이제 {{/* */}}로 메모를 숨기고, 해시로 표시할 메모를 유지하며, quote 함수로 깔끔한 문자열을 만들 수 있습니다. 🎯