Загальні домовленості

Ця частина Посібника з найкращих практик пояснює загальні домовленості.

Назви чартів

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

Приклади:

drupal
nginx-lego
aws-cluster-autoscaler

У назвах чартів не можна використовувати великі літери та підкреслення. Також не слід використовувати крапки.

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

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

Коли версії SemVer зберігаються в мітках Kubernetes, ми умовно змінюємо символ + на _, оскільки мітки не допускають використання знака + як значення.

Форматування YAML

Файли YAML повинні використовувати відступи у два пробіли (і ніколи табуляцією).

Використання слів Helm і Chart

Існує кілька конвенцій щодо використання слів Helm і helm.

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

У разі сумніву використовуйте Helm (з великої літери "H").