Общие соглашения

Эта часть руководства по лучшим практикам посвящена общим соглашениям.

Названия чартов

Названия чартов должны содержать только строчные буквы и цифры. Слова могут быть разделены дефисами (-):

Примеры:

drupal
nginx-lego
aws-cluster-autoscaler

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

Номера версий

По возможности Helm использует SemVer 2 для представления номеров версий. (Обратите внимание, что теги Docker-образов не обязательно соответствуют SemVer и поэтому считаются досадным исключением из этого правила.)

При хранении версий SemVer в метках Kubernetes символ + принято заменять на _, так как метки не допускают использование символа + в качестве значения.

Форматирование YAML

Файлы YAML должны использовать отступы в два пробела (и никогда табуляцию).

Использование слов Helm и чарт

Существует несколько соглашений по использованию слов Helm и helm.

• Helm относится к проекту в целом
• helm относится к клиентской команде
• Термин chart не нужно писать с заглавной буквы, так как это не имя собственное
• Однако Chart.yaml нужно писать с заглавной буквы, так как имя файла чувствительно к регистру

Если есть сомнения, используйте Helm (с заглавной «H»).

Шаблоны чартов и пространства имён

Избегайте определения свойства namespace в секции metadata шаблонов вашего чарта. Пространство имён для применения отрендеренных шаблонов должно указываться при вызове клиента Kubernetes через флаг --namespace. Helm рендерит ваши шаблоны как есть и отправляет их клиенту Kubernetes — будь то сам Helm или другая программа (kubectl, flux, spinnaker и т.д.).