Generating release notes
One special type of Helm template is called the NOTES.txt
file, located in a Helm chart’s templates/
folder. This file is used to dynamically generate usage instructions (or other details) for applications once they are installed with Helm.
A NOTES.txt
file uses the same exact templating syntax as Kubernetes resource templates and can be seen in the following example:
Follow these instructions to access your application. {{- if eq .Values.serviceType "NodePort" }} export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{.Release.Name }}) export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") echo "URL: http://$NODE_IP:$NODE_PORT {{- else }} export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Name }} wordpress --template "{{ range (index .status.loadBalancer.ingress...