Komentarze i cudzysłowy w szablonach

Wykres udostępnia dwa sposoby dodawania notatek: zwykłe komentarze YAML i specjalne komentarze szablonów. Podczas renderowania zachowują się one zupełnie inaczej.

Wiersz rozpoczynający się od znaku hash jest zwykłym komentarzem YAML. Jest przekazywany bezpośrednio i pozostaje w wyrenderowanym wyniku, aby każdy mógł go przeczytać.

Helm ma własny rodzaj komentarza, który znika całkowicie. Tekst należy umieścić w {{/* */}}, a silnik usunie go przed wygenerowaniem wyniku.

Znaku hash należy używać do dokumentowania wdrożonego YAML-a. Komentarza szablonu należy używać do notatek dotyczących logiki szablonu, których użytkownicy nigdy nie powinni widzieć. 📝

Komentarze szablonu są przydatne do wyłączania kodu. Umieszczenie akcji w {{/* */}} powoduje, że Helm ją pomija — bez renderowania i bez błędów.

YAML często automatycznie rozpoznaje typy. Wartość 1.10 może zostać zmieniona na 1.1, a yes może stać się true. Ujęcie w cudzysłowy wymusza użycie zwykłego ciągu znaków.

Helm udostępnia funkcję quote, która automatycznie ujmuje wartość w podwójne cudzysłowy, dzięki czemu wyrenderowane pole jest jednoznacznie ciągiem znaków.

Funkcję quote zwykle można zobaczyć zapisaną jako potok na końcu akcji. Czyta się to naturalnie: pobierz wartość, a następnie przekaż ją do quote.

Bez cudzysłowów wersja taka jak 1.20 może po cichu stracić końcowe zero i stać się wartością 1.2, co zepsuje referencję obrazu. Ujęcie w cudzysłowy temu zapobiega. ⚠️

Kubernetes czasami wymaga zachowania liczby jako tekstu, na przykład portu w adnotacji. Przekazanie jej przez quote bezpiecznie zachowuje ją jako ciąg znaków.

Można również samodzielnie zapisywać cudzysłowy w YAML-u. Funkcja quote robi to programowo, gdy wartość pochodzi z szablonu.

Dodano notatkę, która nie powinna pojawić się we wdrożonym YAML-u.

Można już ukrywać notatki za pomocą {{/* */}}, zachowywać widoczne komentarze przy użyciu znaku hash oraz wymuszać poprawne ciągi znaków za pomocą funkcji quote. 🎯