Hi, Let us understand how to include notes for a chart.
As we discussed earlier, within the templates folder there could be three different type of files templates
file as such that's going to be the manifest for kubernetes.
And notes.txt thats going to have the notes for the file and other helper templates. Within
the notes.txt I can give the instructions on what are all the notes that should get displayed
once the chart is deployed.
or a release is made and this can act as another template where the normal template
Syntax can be included within the notes as well.
For example, I can access the global built in objects as well as the other rules of templates like
looping everything works within the notes as well.
Generally this will be displayed whenever
I am going to do a dry run or any deployment of the helm chart.
This notes will get displayed in the end so that that will be useful for the users to understand
What are all the instructions or the steps to follow further once the release is made.
Let's go ahead and create a sample notes. Within templates
I'm going to create a file called notes.txt
Let me include a sample content.
So here I am including some of the template derivative and some instructions so that this particular
instructions are these six lines will get displayed once the release is
done. Let me go ahead and do the installation of the chart. I'm providing the chart resource location
as well. The name of the release I am giving is notes demo
The chart got deployed and the instructions that we provided as a part of the notes that is getting displayed over here.
And this is the place where we will provide the connection configurations in case if I am providing
any database or deploying any database, I can provide the user ID, passwords or anything that I am
generating as a part of the template so that that will be useful for the users further to understand
what got deployed as well as how to connect to those resources and how to make use of those resources.
And what are all the care to be taken, especially when that particular release is made. Now let me
go ahead and uninstall this particular chart.
Here if you observe very carefully the release name got replaced and the exact command got generated.
I can uninstall the release as well using the same command.
And it is always recommended to have a clear notes on each and every charts.