Гайдлайны для Helm чарта Traefik

Данный документ описывает руководства по разработке, управлению и расширению Helm чарта Traefik.

Необязательность Все незначительные функции (функции, не обязательные для запуска Traefik) в Helm чарте должны быть необязательными. Все незначительные функции должны быть отключены (в комментариях) в файле values.yaml. Всякие необязательные незначительные функции должны быть отключены (в комментариях) в файле values.yaml, и иметь комментарий # (Необязательно) над строкой. Это позволяет использовать минимальную конфигурацию и облегчает расширение.

Пример критической функции

image:
  name: traefik

Эта функция является критической, поэтому она четко определена в файле values.yaml.

Пример незначительной функции

# storage:
#   controlNode:
#     type: emptyDir

Эта функция является незначительной, поэтому она закомментирована по умолчанию в файле values.yaml.

Чтобы это сделать возможным, шаблонные блоки, использующие эту функцию, должны рекурсивно проверять наличие значений перед использованием:

{{- if .Values.storage}}
  {{- if .Values.storage.controlNode }}
    //код
    {{ .Values.storage.controlNode.type }}
  {{- end }}
{{- end }}

По умолчанию значения для незначительных функций должны быть заполнены так, чтобы они могли быть включены просто путем удаления комментариев из секции файла values.yaml.## Пример необязательной незначительной функции

# storage:
#   controlNode:
#     type: emptyDir
#     # (Optional)
#     # volume: 1Gi

Опция volume явно необязательна и незначительна. Она закомментирована (кроме блока комментариев для секции storage), и также имеет комментарий # (Optional) над строкой. Это облегчает конфигурацию, когда секция storage разкомментирована, необязательные функции остаются выключенными по умолчанию.

Аналогично незначительным функциям, эти опции также должны проверять своё существование перед использованием в шаблонах.

Примечание Могут присутствовать необязательные значения в критических функциях. Они должны просто добавляться как неразмеченные незначительные функции:

image:
  name: traefik
  tag: 2.0.0
  # (Optional)
  # pullPolicy: IfNotPresent

Также первое значение под ключом основного значения не требует отметки как необязательное:

# ports:
#   http: 80
#   # (Optional)
#   # https: 443

Это потому что если основной подключ не определён, вся функциональность становится необязательной.

Пробелы

Дополнительные пробелы следует избегать в шаблонизации. Условия должны удалять лишние пробелы:

{{- if .Values }}
{{- end }}

Между каждым первичным ключом в файле values.yaml должна быть пустая закомментированная строка для разделения различных функциональностей друг от друга.## Дизайн файла values.yaml

Файл values.yaml предназначен для удобства пользователя. Он не обязан точно соответствовать шаблонизированному конфигурационному файлу, если это не практично. Аналогично, названия значений не обязательно должны соответствовать полям в шаблоне, если это не практично.

Комментарии

Файл values.yaml не должен содержать комментарии или объяснения того, какие опции доступны или какие значения могут быть использованы. Для этих целей используется таблица значений в файле README.