Comments and Quoting in Templates

A chart has two ways to leave notes: plain YAML comments and special template comments. They behave very differently at render time.

A line starting with a hash is a normal YAML comment. It passes straight through and stays in the rendered output for anyone to read.

Helm has its own comment that disappears entirely. Wrap text in {{/* */}} and the engine strips it before output.

Use a hash to document the deployed YAML. Use a template comment for notes about the template logic that users should never see. 📝

Template comments are handy for disabling code. Wrap an action in {{/* */}} and Helm skips it, no rendering, no errors.

YAML often guesses types. The value 1.10 may become 1.1, and yes may turn into true. Quoting forces a clean string instead.

Helm ships a quote function that wraps a value in double quotes for you, so the rendered field is unambiguously a string.

You will usually see quote written as a pipe at the end of an action. It reads naturally: take the value, then quote it.

Without quotes a version like 1.20 can silently lose its trailing zero and become 1.2, breaking your image reference. Quoting prevents that. ⚠️

Kubernetes sometimes wants a number kept as text, like a port in an annotation. Piping through quote keeps it a string safely.

You can also write literal quotes yourself in YAML. The quote function just does it programmatically when the value comes from a template.

You add a note that should not appear in the deployed YAML.

You can now hide notes with {{/* */}}, keep visible ones with a hash, and force clean strings using the quote function. 🎯