[Helm] 가이드 - NOTES.txt

helm install 또는 helm upgrade가 완료되면 Helm은 사용자에게 유용한 정보 블록을 출력할 수 있습니다. 이 정보는 템플릿을 사용하여 매우 사용자 정의가 가능합니다.

차트에 설치 노트를 추가하려면 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 파일을 만드는 것은 필수는 아니지만 강력히 권장됩니다.

레퍼런스

https://helm.sh/docs/chart_template_guide/notes_files/