Provision
—— XP

Чарт изнутри: шаблоны и значения

теория~6 минут+260 XP

Как одним каталогом описать и стенд, и прод, если у них разное число реплик, разные образы и разные имена? В прошлом разделе ответа не было: каталог пришлось бы копировать. В практике с podinfo ты уже менял чужой чарт одним флагом, не открывая ни одного файла. Этот урок о том, что внутри чарта делает такое возможным, — чтобы в следующей практике собрать свой.

Шаблон в Helm — обычное описание Kubernetes, в котором часть значений заменена подстановками в двойных фигурных скобках: {{ .Values.replicaCount }}. При установке Helm заменяет каждую подстановку значением и получает готовый YAML — как бланк заявления, который сто человек заполняют по-своему. Язык подстановок взят из языка Go, на котором написан Helm.

На шаблонах держится вся польза Helm: имя приложения пишется в одном месте, отличия сред — в маленьком файле, а описания для любой среды собираются из одного чарта.

Из чего состоит чарт

Чарт — каталог со строгой раскладкой. Helm ищет файлы по именам, поэтому переименованный файл просто перестанет работать.

Дерево чарта: Chart.yaml с метаданными, values.yaml со значениями по умолчанию, схема проверки, каталог templates с шаблонами объектов и NOTES.txt, каталог charts с зависимостями.
Helm собирает шаблоны со значениями и получает обычные описания Kubernetes.

Обязательных частей три. Chart.yaml — паспорт: имя и версии. values.yaml — значения по умолчанию. Каталог templates/ — шаблоны, по одному объекту или нескольким на файл. Остальное в схеме — charts/ с зависимостями, NOTES.txt с подсказкой после установки, схема значений — встретится в чужих чартах, а своему для начала не нужно.

Chart.yaml: две версии

Паспорт чарта короткий, и главное в нём — две разные версии.

Chart.yaml
apiVersion: v2
name: provision
version: 0.1.0        # версия ЧАРТА
appVersion: "1.0.0"   # версия ПРИЛОЖЕНИЯ

version меняют, когда правят шаблоны. appVersion — когда меняется образ программы. Это те же две колонки, что ты видел в helm search repo, и путают их постоянно: поправил шаблон — подними version, даже если приложение прежнее.

Подстановки в шаблоне

Посмотри на кусок шаблона Deployment. Узнаваемый YAML, только вместо чисел и имён — подстановки.

templates/30-deployment.yaml, кусок
metadata:
  name: {{ .Release.Name }}-{{ .Chart.Name }}
spec:
  replicas: {{ .Values.replicaCount }}

Внутри скобок — откуда брать значение. .Values — всё из значений, .Release.Name — имя релиза, которое ты дал при установке, .Chart.Name — имя из Chart.yaml. При установке релиза provision с replicaCount: 3 этот кусок превратится в name: provision-provision и replicas: 3.

Повторяющиеся куски — имя объекта, набор меток — выносят в файл templates/_helpers.tpl как именованные шаблоны и вставляют конструкцией include. Например, {{ include "provision.fullname" . }} подставит полное имя, описанное один раз. Точка в конце — «передай шаблону все данные». Ещё встретишь | quote — взять значение в кавычки — и | nindent 4 — вставить с переносом и отступом в четыре пробела; в YAML отступ решает всё, и без nindent многострочная вставка ломает разметку.

Откуда берутся значения

Значения приходят из нескольких мест, и знать их старшинство важнее синтаксиса: иначе выкатится не то, что ты правил.

Четыре уровня приоритета значений снизу вверх: values.yaml чарта, values родительского чарта, файлы по флагу -f и флаг --set, побеждающий всё. Ниже пример команды.
Каждый следующий источник перекрывает предыдущий. Флаг --set удобен в конвейере и вреден для остального: он не оставляет следа в репозитории.

Снизу вверх: умолчания из values.yaml чарта, затем файлы, переданные флагом -f (каждый следующий перекрывает предыдущий), и наверху --set. Отсюда рабочая схема: в values.yaml — разумные умолчания, в values-prod.yaml — только отличия прода, пять-десять строк, а --set — для единственного значения, которое меняется при каждом выкате, обычно тега образа.

Проверить до установки

Шаблон легко написать так, что он соберётся в кривой YAML или подставит пустоту. Поэтому собранный результат смотрят до кластера.

ubuntu@stand:~$
helm template provision ./provision | grep kind:
ubuntu@stand:~$
kind: ConfigMap
kind: Service
kind: Deployment

helm template печатает собранные описания и в кластер не ходит. Без grep ты увидишь их целиком, и над каждым — строку # Source: с именем файла шаблона, из которого он получился. Рядом живёт helm lint — проверка чарта на типичные ошибки, она тоже работает без кластера.

Две ошибки встретишь почти сразу. nil pointer evaluating interface {}.tag — шаблон обратился к значению, которого нет в values.yaml: опечатка в имени или пропущенный раздел. error converting YAML to JSON — уехал отступ, и разбираться надо в выводе helm template, а не в самом шаблоне.

Словарь урока

Шаблон
Описание Kubernetes с подстановками {{ }}. Helm заменяет их значениями при установке. ↩ к тексту
.Values
Все значения релиза: умолчания чарта, файлы -f и флаги --set.
version и appVersion
Версия упаковки и версия программы внутри. Меняются независимо.
_helpers.tpl
Файл именованных шаблонов: имя, метки. Вставляются через include.
helm template
Собрать и напечатать описания, не трогая кластер.

Что спросят на собеседовании

  • Как задать отличия прода от стенда?
    Отдельным файлом значений только с отличиями, передать его флагом -f. values.yaml чарта остаётся с умолчаниями.
  • Почему --set не стоит использовать для всего подряд?
    Значение не остаётся в репозитории, и через месяц никто не вспомнит, почему выкатилось именно так. Им передают только то, что меняется каждый выкат, — обычно тег образа.
  • Как отлаживают шаблон, который собирается не так?
    helm template и helm lint локально: смотрят на собранный YAML, а не на шаблон.

Что дальше

Устройство понятно. В практике ты соберёшь чарт стенда из файлов прошлого раздела — копированием и заменой нескольких строк.

Проверь себя+260 XPдве попытки
1
Chart.yaml
Ты поправил шаблон, а образ приложения не менялся. Какую версию поднимают в Chart.yaml?
2
Подстановка
Что подставит шаблон replicas: {{ .Values.replicaCount }}?
3
Старшинство
replicaCount задан в values.yaml, в файле -f values-prod.yaml и флагом --set. Что победит?
4
Проверка
Чем helm template отличается от helm install?
ответь на все вопросы, чтобы проверить

Нашёл ошибку или непонятное место? Наведи на абзац — слева появится «+», нажми и напиши, что не так. Замечание увидит автор курса.Нашёл ошибку или непонятное место? Нажми «+» справа от заголовка раздела и напиши, что не так. Замечание увидит автор курса.