Комментарии и кавычки в шаблонах

В чарте есть два способа оставить примечания: обычные комментарии YAML и специальные комментарии шаблона. При рендеринге они ведут себя совершенно по-разному.

Строка, начинающаяся с решётки, является обычным комментарием YAML. Она проходит без изменений и остаётся в итоговом выводе, чтобы её могли прочитать другие.

У Helm есть собственный тип комментариев, который исчезает полностью. Оберните текст в {{/* */}}, и движок удалит его до вывода.

Используйте решётку, чтобы документировать развёрнутый YAML. Комментарий шаблона предназначен для заметок о логике шаблона, которые пользователи не должны видеть. 📝

Комментарии шаблона удобно использовать для отключения кода. Оберните действие в {{/* */}}, и Helm пропустит его: без рендеринга и ошибок.

YAML часто угадывает типы. Значение 1.10 может превратиться в 1.1, а yes — в true. Кавычки вместо этого принудительно задают обычную строку.

В Helm есть функция quote, которая сама заключает значение в двойные кавычки, поэтому отрендеренное поле однозначно воспринимается как строка.

Обычно quote записывают как конвейер в конце действия. Это читается естественно: взять значение, а затем заключить его в кавычки.

Без кавычек версия вроде 1.20 может незаметно потерять конечный ноль и превратиться в 1.2, из-за чего ссылка на образ перестанет работать. Кавычки предотвращают это. ⚠️

Иногда Kubernetes требуется сохранить число как текст, например порт в аннотации. Передача значения через quote безопасно сохраняет его как строку.

Вы также можете самостоятельно записать литеральные кавычки в YAML. Функция quote просто делает это программно, когда значение поступает из шаблона.

Вы добавляете примечание, которое не должно появиться в развёрнутом YAML.

Теперь вы умеете скрывать примечания с помощью {{/* */}}, оставлять видимые примечания с помощью решётки и принудительно задавать строки с помощью функции quote. 🎯