Provision
—— XP

Роли, переменные и шаблоны

теория~5 минут+220 XP

Плейбук на одну машину читается легко. Когда машин становится три, а сайтов два, его начинают копировать: site-stand.yml, site-prod.yml, site-prod-new.yml. Через месяц в копиях разные версии одной и той же задачи, и никто не помнит, какая правильная. Этот урок о том, как собрать настройку один раз и подставлять в неё отличия.

Выход — роль (role): папка, куда складывают всё для одной задачи — поставить nginx, настроить пользователей, подготовить Docker. Раскладка внутри у всех ролей одинаковая, поэтому чужую роль читаешь как свою. Плейбук перестаёт быть длинным списком дел вперемешку и становится коротким: «на этих машинах примени роли base и web». Задачи в роли общие, а значения — порт, имя сайта, текст страницы — приходят из переменных.

Роль пишут один раз, а пользуются много: одна роль web настраивает и стенд, и прод, и десятый сервер, а различия лежат в одном файле переменных группы.

Раскладка роли

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

Дерево каталогов роли: defaults с низким приоритетом, vars с высоким, tasks как точка входа, handlers, templates, files, meta и README. У каждого пояснение.
Имена каталогов здесь часть договора, а не оформление: Ansible ищет файлы по ним сам. Положили задачи не в tasks/main.yml — роль подключится и не сделает ничего, без единой ошибки.

Тебе нужны четыре каталога: tasks — задачи, handlers — handlers, defaults — значения переменных по умолчанию, templates — шаблоны. В каждом главный файл называется main.yml. Скелет роли создаёт команда ansible-galaxy role init, руками каталоги не заводят.

Подключается роль в плейбуке одной строкой:

site.yml с ролью
- name: Подготовка машины
  hosts: lab
  become: true
  roles:
    - web

Но роль с зашитым внутрь текстом страницы ничем не лучше копии плейбука: стенду и проду нужны разные значения, и где-то они должны жить.

Переменные и кто победит

Переменную можно задать в десятке мест, и рано или поздно одна и та же окажется в двух. Ansible решает спор по приоритету.

Одиннадцать главных уровней приоритета переменных снизу вверх, упрощённо: от defaults роли до флага -e в командной строке, который побеждает всегда.
Практическое следствие внизу: настройки роли кладут в defaults, отличия сред в group_vars, а флаг командной строки оставляют для разового — он не оставляет следа в репозитории.

На схеме упрощение: в документации Ansible полный список — 22 уровня, многие из которых на практике не встречаются. Джуну хватает трёх, снизу вверх. defaults роли — самые слабые: работают, если больше нигде не задано. group_vars — файл group_vars/<группа>.yml рядом с инвентарём: значения для всех машин группы, здесь живут отличия стенда от прода. -e в командной строке — побеждает всё, его берут для разового запуска.

Есть ещё vars/main.yml внутри роли — он сильнее group_vars, и туда кладут то, что снаружи менять не должны. Новички путают его с defaults и потом удивляются, почему значение из group_vars «не работает».

Пока значение живёт только в YAML, nginx о нём ничего не знает: его нужно доставить внутрь конфигурационного файла на машине.

Шаблоны Jinja2

Модуль copy кладёт файл как есть. Модуль template сначала подставляет в него переменные, а потом кладёт. Шаблоны пишут на языке Jinja2 и дают им окончание .j2.

roles/web/templates/index.html.j2
<h1>{{ web_message }}</h1>
<p>Машина: {{ ansible_hostname }}</p>

{{ web_message }} — переменная из defaults или group_vars. {{ ansible_hostname }} — факт, который Ansible собрал о машине сам. На двух машинах один шаблон даст два разных файла.

В шаблонах бывают и циклы, и условия — {% for %} и {% if %}, — например, чтобы развернуть список серверов в upstream nginx. Здесь достаточно знать, что такое есть; первым делом тебе понадобится именно подстановка.

Первая строка любого шаблона на работе — комментарий о том, что файл управляется Ansible и правки руками будут затёрты. Для этого есть штатная переменная {{ ansible_managed }}: в комментарии она превращается в Ansible managed. Без такой пометки коллега поправит файл на сервере, а следующий прогон молча вернёт как было.

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

Роль
Каталог с раскладкой tasks, handlers, defaults, templates для одной задачи. ↩ к тексту
defaults
Значения переменных роли по умолчанию, самый слабый уровень. ↩ к тексту
group_vars
Файл переменных для всех машин группы инвентаря. Здесь отличия сред. ↩ к тексту
-e
Переменная из командной строки, побеждает всё. Для разовых запусков.
Шаблон
Файл .j2 с подстановками {{ переменная }}, который кладёт модуль template. ↩ к тексту

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

  • Чем defaults роли отличается от vars роли?
    defaults — самый слабый уровень, его перекрывает group_vars и всё остальное. vars роли сильнее group_vars — туда кладут то, что снаружи менять не должны.
  • Как сделать одну роль для стенда и прода?
    Значения по умолчанию — в defaults роли, отличия — в group_vars соответствующих групп. Сама роль не меняется.

Что дальше

Дальше — разложить свой плейбук по роли и перекрыть её значение из group_vars.

Проверь себя+220 XPдве попытки
1
Роль
Где Ansible ищет задачи роли web?
2
Переменные
Куда класть значения переменных роли по умолчанию?
3
Переменные
Одна переменная задана в defaults роли, в group_vars и через -e. Что победит?
4
Шаблоны
Чем модуль template отличается от copy?
ответь на все вопросы, чтобы проверить

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