NOTES.txt 파일 만들기
NOTES.txt 파일 만들기 (Creating a NOTES.txt File)
이 문서는 차트 사용자에게 안내를 제공하는 Helm의 도구에 대해 설명해요. helm install이나 helm upgrade가 끝날 때 Helm이 유용한 정보 블록을 출력할 수 있어요.
출처: 문서
본문
이 섹션에서는 차트 사용자에게 안내를 제공하는 Helm의 도구에 대해 살펴볼 거예요. helm install이나 helm upgrade가 끝날 때 Helm은 사용자에게 유용한 정보 블록을 출력할 수 있어요. 이 정보는 템플릿을 사용해 자유롭게 사용자 정의할 수 있어요.
차트에 설치 안내(notes)를 추가하려면 templates/NOTES.txt 파일을 만들기만 하면 돼요. 이 파일은 일반 텍스트지만 템플릿처럼 처리되며, 모든 일반 템플릿 함수와 객체를 사용할 수 있어요.
간단한 NOTES.txt 파일을 만들어 봐요:
Thank you for installing {{ .Chart.Name }}.
Your release is named {{ .Release.Name }}.
To learn more about the release, try:
$ helm status {{ .Release.Name }}
$ helm get all {{ .Release.Name }}
이제 helm install rude-cardinal ./mychart을 실행하면 아래쪽에 다음 메시지가 보일 거예요:
RESOURCES:
==> v1/Secret
NAME TYPE DATA AGE
rude-cardinal-secret Opaque 1 0s
==> v1/ConfigMap
NAME DATA AGE
rude-cardinal-configmap 3 0s
NOTES:
Thank you for installing mychart.
Your release is named rude-cardinal.
To learn more about the release, try:
$ helm status rude-cardinal
$ helm get all rude-cardinal
이런 식으로 NOTES.txt를 사용하면 사용자에게 새로 설치된 차트를 어떻게 사용해야 하는지에 대한 자세한 정보를 줄 수 있는 좋은 방법이에요. NOTES.txt 파일을 만드는 것은 필수는 아니지만 강력히 권장돼요.