Provision
—— XP

Практика: первый плейбук

практика~40 минут+550 XP

Ad-hoc команды хороши для разовых вопросов. Настройку машины записывают в плейбук — файл, который можно запускать снова и снова. Сейчас ты напишешь первый: он поставит nginx, положит свою страницу и заведёт пользователя.

Начнём с плейбука из одной задачи и будем дописывать по одной, каждый раз запуская и глядя на результат. Машина та же, контейнер target из прошлой практики. Проверь, что он запущен: docker ps --filter name=target.

Шаг 1. Одна задача

Открой новый файл в каталоге ~/infra/ansible. Сверху — где и как выполнять, ниже — список задач, пока из одной.

nano ~/infra/ansible/site.yml
- name: Подготовка машины
  hosts: lab
  become: true
  tasks:
    - name: nginx установлен
      ansible.builtin.apt:
        name: nginx
        state: present

hosts: lab — группа из инвентаря, become: true — всё от root. Задача говорит не «поставь nginx», а «nginx должен быть установлен»: state: present. Имя задачи пишут так же — как описание нужного состояния. Флаг --syntax-check разбирает файл и ничего не выполняет.

ubuntu@stand:~$
ansible-playbook site.yml --syntax-check
ubuntu@stand:~$
playbook: site.yml

Одна строка с именем файла — ошибок нет. Ошибка отступа выглядит так: We were unable to read either as JSON nor YAML и номер строки. Теперь по-настоящему.

ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [Gathering Facts] ************** ok: [target]
TASK [nginx установлен] ************* changed: [target]
PLAY RECAP *************************************************
target : ok=2  changed=1  unreachable=0  failed=0

Gathering Facts Ansible делает сам перед каждым плеем: собирает сведения о машине — систему, адреса, память. changed у нашей задачи — пакет поставлен. Главная проверка — запусти ещё раз:

ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [nginx установлен] ************* ok: [target]
target : ok=2  changed=0  unreachable=0  failed=0

changed=0: nginx уже стоит, и модуль apt это увидел и ничего не делал. Это свойство называется идемпотентностью: сколько ни запускай, машина придёт в одно и то же состояние.

Шаг 2. Служба запущена

Пакет стоит, но работает ли nginx? Спросим, есть ли его процесс. Команда pgrep ищет процессы по имени.

ubuntu@stand:~$
docker exec target pgrep nginx

Пусто: установить не значит запустить. Допиши вторую задачу.

дописать в site.yml
    - name: nginx запущен
      ansible.builtin.service:
        name: nginx
        state: started
ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [nginx установлен] ************* ok: [target]
TASK [nginx запущен] **************** changed: [target]
target : ok=3  changed=1  unreachable=0  failed=0

В контейнере нет systemd, и модуль service сам возьмёт старый скрипт /etc/init.d/nginx. На настоящем сервере тот же модуль поговорит с systemd — плейбук менять не придётся.

Шаг 3. Своя страница

Третья задача кладёт страницу. Модуль copy с параметром content пишет файл с указанным текстом.

дописать в site.yml
    - name: Страница сайта на месте
      ansible.builtin.copy:
        dest: /var/www/html/index.html
        content: "Настроено Ansible\n"

Проверять страницу будем запросом изнутри контейнера, а curl в нём нет. Пусть его тоже ставит плейбук: в первой задаче замени name: nginx списком пакетов, а саму задачу переименуй — теперь она про пакеты вообще.

в site.yml, первая задача
    - name: Пакеты установлены
      ansible.builtin.apt:
        name: [nginx, curl]
        state: present
ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [Пакеты установлены] *********** changed: [target]
TASK [nginx запущен] **************** ok: [target]
TASK [Страница сайта на месте] ****** changed: [target]
target : ok=4  changed=2  unreachable=0  failed=0
ubuntu@stand:~$
docker exec target curl -s localhost
ubuntu@stand:~$
Настроено Ansible

Страница отдаётся сразу: файлы сайта nginx читает на каждый запрос, и перезапускать его ради них не нужно.

Шаг 4. Настройки и handler

С настройками самого nginx иначе: он читает их один раз при старте. Добавим маленький файл настроек — заголовок ответа, по которому видно, что сервер настроен Ansible.

дописать в site.yml
    - name: Заголовок в настройках nginx
      ansible.builtin.copy:
        dest: /etc/nginx/conf.d/provision.conf
        content: "add_header X-Managed-By ansible;\n"
ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [Заголовок в настройках nginx] * changed: [target]
target : ok=5  changed=1  unreachable=0  failed=0

Файл на месте. Флаг -I у curl просит только заголовки ответа, а grep -i ищет без учёта регистра.

ubuntu@stand:~$
docker exec target curl -sI localhost | grep -i managed

Пусто. Файл лежит, но nginx про него не знает — он не перечитывал настройки. Нужно попросить его об этом, но только когда настройки поменялись, а не на каждом прогоне. Для этого есть handler — задача, которая выполняется лишь по вызову. Вызов — строка notify у задачи; сработает он, только если задача что-то изменила. Допиши notify к последней задаче, а в конец файла, на уровне tasks, — сам handler.

в site.yml, у задачи с заголовком
      notify: nginx перечитан
дописать в конец site.yml
  handlers:
    - name: nginx перечитан
      ansible.builtin.service:
        name: nginx
        state: reloaded

Имя должно совпадать с тем, что в notify, буква в букву. Запусти плейбук — и handler не сработает: файл уже лежит, задача ничего не меняет, вызывать некого. Поэтому заодно поменяй в content слово ansible на provision.

ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [Заголовок в настройках nginx] * changed: [target]
RUNNING HANDLER [nginx перечитан] *** changed: [target]
target : ok=6  changed=2  unreachable=0  failed=0
ubuntu@stand:~$
docker exec target curl -sI localhost | grep -i managed
ubuntu@stand:~$
X-Managed-By: provision

Теперь заголовок есть. Ещё один прогон даст changed=0, и handler промолчит: менять нечего. Handler выполняется один раз в конце плея, даже если его позвали пять задач, — nginx перечитается однажды, а не пять раз подряд.

Шаг 5. Свежий список пакетов

Пакеты на свежей машине ставятся не всегда. Изобразим машину, где список пакетов давно не обновляли: удалим его и уберём curl.

ubuntu@stand:~$
docker exec target sh -c 'rm -rf /var/lib/apt/lists/*'

Звёздочку раскрывает оболочка, а docker exec своей оболочки не запускает — поэтому команда обёрнута в sh -c.

ubuntu@stand:~$
docker exec target apt-get remove -y curl
ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
fatal: [target]: FAILED! => {"msg": "No package matching 'curl' is available"}
target : ok=1  changed=0  unreachable=0  failed=1

apt ищет пакет в локальном списке, а список пуст. Параметр update_cache: true велит сначала обновить его — как apt-get update руками. Допиши его в задачу с пакетами.

в site.yml, у задачи с пакетами
        update_cache: true

Теперь плейбук проходит, но список обновляется на каждом прогоне — это поход в интернет и лишние секунды. Параметр cache_valid_time: 3600 говорит: не обновлять, если обновляли меньше часа назад.

в site.yml, у задачи с пакетами
        cache_valid_time: 3600

В нашем прогоне это дало 7,5 секунды вместо 9 на каждый запуск плейбука. На сервере с медленным зеркалом разница больше.

Шаг 6. Переменная и пользователь

Последняя задача — пользователь для выката. Имя запишем один раз, как переменную плея, и подставим, где нужно. Блок vars — в заголовок, перед tasks.

в site.yml, перед строкой tasks
  vars:
    deploy_user: deploy

Задача — в список tasks, после пакетов.

в site.yml, после задачи с пакетами
    - name: Пользователь для выката заведён
      ansible.builtin.user:
        name: "{{ deploy_user }}"
        shell: /bin/bash

Двойные фигурные скобки — подстановка переменной. Кавычки вокруг обязательны, иначе YAML примет скобки за свой синтаксис.

ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [Пользователь для выката заведён] changed: [target]
target : ok=6  changed=1  unreachable=0  failed=0
ubuntu@stand:~$
docker exec target id deploy
ubuntu@stand:~$
uid=1002(deploy) gid=1002(deploy) groups=1002(deploy)

Пользователь есть. Сверь итоговый файл — заголовок и пакеты:

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

Пользователь, служба и страница:

site.yml, середина
    - name: Пользователь для выката заведён
      ansible.builtin.user:
        name: "{{ deploy_user }}"
        shell: /bin/bash
    - name: nginx запущен
      ansible.builtin.service:
        name: nginx
        state: started
    - name: Страница сайта на месте
      ansible.builtin.copy:
        dest: /var/www/html/index.html
        content: "Настроено Ansible\n"

Настройки и handler:

site.yml, конец
    - name: Заголовок в настройках nginx
      ansible.builtin.copy:
        dest: /etc/nginx/conf.d/provision.conf
        content: "add_header X-Managed-By provision;\n"
      notify: nginx перечитан
  handlers:
    - name: nginx перечитан
      ansible.builtin.service:
        name: nginx
        state: reloaded

Шаг 7. Сломать идемпотентность

Посмотрим, как выглядит плохая задача. Допиши в конец списка tasks, перед handlers, задачу с shell, которая дописывает строку приветствия в файл /etc/motd — его показывают при входе на машину:

временно дописать в tasks
    - name: Плохая задача для опыта
      ansible.builtin.shell: echo "Добро пожаловать" >> /etc/motd

Для опыта берём именно этот файл, а не /etc/hosts, хотя в жизни так чаще портят его. В контейнере /etc/hosts подкладывает Docker, и править его на месте нельзя: sed -i упадёт с Device or resource busy.

Запусти плейбук два раза и посмотри на второй:

ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [Плохая задача для опыта] ****** changed: [target]

changed каждый раз: shell не знает, нужна ли строка, и дописывает её снова. Проверим, сколько строк набралось. Флаг -c у grep считает совпадения.

ubuntu@stand:~$
docker exec target grep -c Добро /etc/motd
ubuntu@stand:~$
2

Две одинаковые строки. Убери опытную задачу из site.yml в nano, а мусор из файла — sed с флагом -i, который правит файл на месте:

ubuntu@stand:~$
docker exec target sed -i '/Добро/d' /etc/motd

Правильный способ добавить строку — модуль lineinfile: он добавит её, только если строки нет.

Шаг 8. Поймать ручную правку

Представим, что кто-то зашёл на сервер и «на минутку» удалил страницу руками.

ubuntu@stand:~$
docker exec target rm /var/www/html/index.html

Флаг --check прогоняет плейбук, ничего не меняя, а --diff показывает, что именно поменялось бы.

ubuntu@stand:~$
ansible-playbook site.yml --check --diff
ubuntu@stand:~$
TASK [Страница сайта на месте] ***************************
--- before
+++ after: /var/www/html/index.html
@@ -0,0 +1 @@
+Настроено Ansible
changed: [target]

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

ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [Страница сайта на месте] ****** changed: [target]
target : ok=6  changed=1  unreachable=0  failed=0

У --check есть ограничение. На пустой машине он упадёт на задаче «nginx запущен» с Could not find the requested service nginx: в режиме проверки пакет ведь не ставится, и следующей задаче не на что опереться. Задачи, зависящие от предыдущих, он честно проверить не может, поэтому его берут на уже настроенных машинах — как здесь.

Шаг 9. Закоммитить

Плейбук — код, ему место в репозитории. Но прямой push в main с раздела 12 закрыт, поэтому с этого раздела каждую работу ведём так же, как на работе: в своей ветке, а в main она попадает через merge request. GitLab для этого должен быть запущен: если гасил его, выполни docker compose start в ~/gitlab и дождись healthy. Он держит около 6 ГБ, поэтому стенду в этом разделе нужно 8 ГБ, как в таблице из практики про стенд. Если памяти впритык, держи GitLab запущенным только на время push и слияния, а потом снова гаси docker compose stop: сам Ansible без GitLab работает.

Сначала ветка — флаг -c создаёт её и переходит в неё, несохранённые правки едут с тобой.

ubuntu@stand:~$
cd ~/infra
git switch -c ansible-base

Коммит, как обычно. Флаг -m — сообщение коммита.

ubuntu@stand:~$
git add ansible/
git commit -m "ansible: первый плейбук для машины target"

Отправляем ветку в GitLab. Удалённый репозиторий называется gitlab — так ты назвал его в практике про проект.

ubuntu@stand:~$
git push -u gitlab ansible-base

Открой ссылку merge_requests/new из вывода, создай merge request, дождись зелёного конвейера и нажми Merge. Затем вернись в main и забери слияние к себе.

ubuntu@stand:~$
git switch main
git pull

Этот приём — ветка, push, merge request, pull — дальше в разделах 13–15 будет одной строкой.

Шаг 10. Сдать

Выполни команду сдачи: она запустит плейбук ещё раз и проверит страницу.

Практика 02+550 XP

Написать плейбук, который поднимает nginx со своей страницей, и увидеть своими глазами три вещи: второй прогон ничего не меняет, handler срабатывает только по делу, --check --diff находит ручную правку.

  • Повторный прогон ничего не меняет
  • Страница отдаётся
  • Есть handler
  • Опытная задача с shell убрана
Команда сдачи — выполни на своей машине
команда
cd ~/infra/ansible; ansible-playbook site.yml | tail -3; docker exec target curl -s localhost; echo NOTIFY=$(grep -c 'notify:' site.yml); echo SHELL=$(grep -c 'builtin.shell' site.yml)

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