Provision
—— XP

Плейбук, идемпотентность и handlers

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

Типичный первый шаг новичка в автоматизации — скрипт на bash: apt install nginx, useradd deploy, echo ... >> /etc/hosts. На чистой машине он отрабатывает. Второй запуск падает на useradd, потому что пользователь уже есть, и дописывает в /etc/hosts вторую одинаковую строку. Скрипт описывает действия и рассчитывает на то, что машина пустая. В этом уроке ты увидишь, чем Ansible отвечает на эту проблему.

Плейбук (playbook) — YAML-файл, в котором по порядку записано, к какому состоянию привести машины. Внутри — один или несколько плеев: каждый говорит «на этих машинах выполни эти задачи». Задача — это вызов модуля с параметрами, ровно то, что ты делал ad-hoc командой, только записанное в файл и выполнимое сегодня, через месяц и на новой машине.

Главное свойство плейбука — идемпотентность: запускать его можно сколько угодно раз, и второй запуск ничего не сломает. Поэтому плейбуком настраивают сервер целиком, а не один раз при установке.

Устройство плейбука

Посмотрим на начало плейбука из следующей практики.

site.yml, начало
- name: Подготовка машины
  hosts: lab
  become: true
  tasks:
    - name: Пакеты установлены
      ansible.builtin.apt:
        name: [nginx, curl]
        state: present

Разбор сверху вниз. Дефис в первой строке — начало плея, name — его описание. hosts: lab — группа из инвентаря. become: true — выполнять от root, как флаг -b. Дальше tasks — список задач, у каждой своё name и модуль с параметрами.

Имена задач пишут как состояние, а не как действие: «пакеты установлены», а не «установить пакеты». Тогда вывод прогона читается как отчёт о машине.

Запускается плейбук отдельной программой: ansible-playbook site.yml.

Идемпотентность

За длинным словом идемпотентность прячется простая вещь: повтори действие хоть десять раз, результат будет как после первого. Нажмёшь кнопку лифта второй раз — лифт не приедет дважды. Модули устроены так же: apt с state: present ставит пакет, только если его нет.

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

В конце каждого прогона Ansible печатает итог по каждой машине:

итог прогона
PLAY RECAP *****************************************************
target : ok=5  changed=0  unreachable=0  failed=0  skipped=0

ok — задача проверила состояние, оно верное. changed — что-то поменяла. failed — упала. unreachable — до машины не достучались. Главная проверка любого плейбука: два прогона подряд, во втором changed=0. Если нет — жёлтые строки changed во втором прогоне прямо показывают виноватую задачу. Чаще всего это command или shell там, где был нужен модуль.

Но «безопасный» ещё не значит «предсказуемый»: на проде хочется знать, что именно поменяется, до того как оно поменялось.

Посмотреть заранее: --check --diff

Флаг --check запускает плейбук в режиме предпросмотра: модули проверяют состояние и говорят, что изменили бы, но ничего не меняют. Флаг --diff добавляет построчную разницу для файлов — как git diff.

Вместе они отвечают на вопрос, который задают перед каждым прогоном на проде: «что сейчас произойдёт?». И на второй: «не правил ли кто-то сервер руками?» Если --check на машине, где ничего не меняли, показывает changed, значит, кто-то поменял руками. Такое расхождение описания и реальности называют дрейфом.

Одна оговорка: задачи command и shell в режиме проверки пропускаются — Ansible не знает, что они сделали бы.

Handlers: перезапуск по необходимости

Поменял конфигурацию nginx — его надо перечитать. Не поменял — трогать не надо: лишний перезапуск рвёт соединения. Для этого есть handlers — задачи, которые выполняются только по вызову.

задача с вызовом и handler
    - name: Страница сайта на месте
      ansible.builtin.copy:
        dest: /var/www/html/index.html
        content: "Настроено Ansible\n"
      notify: nginx перечитан
  handlers:
    - name: nginx перечитан
      ansible.builtin.service: { name: nginx, state: reloaded }

notify называет handler по имени. Если задача дала changed, handler выполнится — один раз, в конце прогона, даже если его позвали три задачи. Если ok — не выполнится вовсе. Имя в notify должно совпадать с именем handler буква в букву, иначе Ansible ругнётся, что такого нет.

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

Плейбук
YAML-файл с плеями: на каких машинах какие задачи выполнить. ↩ к тексту
Задача
Вызов модуля с параметрами и человеческим именем в плейбуке. ↩ к тексту
Идемпотентность
Повторный прогон ничего не меняет. Проверка — два прогона подряд, во втором changed=0. ↩ к тексту
--check --diff
Предпросмотр прогона с построчной разницей файлов, ничего не меняя.
Handler
Задача, которая выполняется в конце прогона, только если её позвали через notify и вызвавшая задача дала changed. ↩ к тексту

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

  • Как проверить, что плейбук идемпотентен?
    Запустить дважды подряд. Во втором прогоне должно быть changed=0; задачи с changed во втором прогоне и есть проблема.
  • Зачем handlers, если можно просто перезапустить службу задачей?
    Задача перезапускала бы службу каждый прогон и рвала соединения. Handler срабатывает только при реальном изменении и один раз в конце.

Что дальше

Дальше — написать такой плейбук самому и проверить все эти свойства руками.

Проверь себя+220 XPдве попытки
1
Плейбук
Что задаёт ключ hosts в плейбуке?
2
Идемпотентность
Второй прогон плейбука подряд показал changed=2. Что это значит?
3
Посмотреть заранее
Что делает запуск с --check --diff?
4
Handlers
Когда выполнится handler, на который ссылается notify?
ответь на все вопросы, чтобы проверить

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