Provision
—— XP

Практика: роль web и переменные группы

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

Плейбук из прошлой практики работает, но всё в нём вперемешку, и для второго сайта его пришлось бы копировать. Сейчас ты вынесешь настройку nginx в роль web, а текст страницы сделаешь переменной, которую каждая группа машин задаёт по-своему.

Сначала перенесём задачи в роль как есть, ничего не меняя, и убедимся, что машина этого не заметила. Потом по одному улучшению: шаблон вместо готового текста, переменная, пометка для того, кто откроет файл на сервере. Работаем в ~/infra/ansible, машина — тот же контейнер target.

Шаг 1. Скелет роли

Каталоги роли руками не заводят: это делает ansible-galaxy, программа, которая ставится вместе с Ansible.

ubuntu@stand:~$
cd ~/infra/ansible
ubuntu@stand:~$
ansible-galaxy role init roles/web
ubuntu@stand:~$
- Role roles/web was created successfully
ubuntu@stand:~$
ls roles/web
ubuntu@stand:~$
README.md  defaults  files  handlers  meta  tasks  templates  tests  vars

Нам нужны четыре: tasks — задачи, handlers — обработчики, templates — шаблоны и defaults — значения переменных по умолчанию. Остальные пусть лежат — пустые каталоги ничему не мешают.

Шаг 2. Перенести задачи как есть

Переносим из site.yml всё, что касается nginx: пакеты, службу, страницу и настройки. В файле роли нет плея и слова tasks: — только список задач, поэтому отступ меньше. Строки в roles/web/tasks/main.yml, оставленные ansible-galaxy, замени целиком.

nano roles/web/tasks/main.yml
---
- name: Пакеты установлены
  ansible.builtin.apt:
    name: [nginx, curl]
    state: present
    update_cache: true
    cache_valid_time: 3600
- name: nginx запущен
  ansible.builtin.service:
    name: nginx
    state: started
дописать в roles/web/tasks/main.yml
- name: Страница сайта на месте
  ansible.builtin.copy:
    dest: /var/www/html/index.html
    content: "Настроено Ansible\n"
- name: Заголовок в настройках nginx
  ansible.builtin.copy:
    dest: /etc/nginx/conf.d/provision.conf
    content: "add_header X-Managed-By provision;\n"
  notify: nginx перечитан

curl к веб-серверу не относится, но пусть пока едет с пакетами: в миссии раздела он уедет в свою роль. Handler переезжает в handlers роли.

nano roles/web/handlers/main.yml
---
- name: nginx перечитан
  ansible.builtin.service:
    name: nginx
    state: reloaded

Теперь site.yml становится коротким. Открой его и замени целиком.

nano ~/infra/ansible/site.yml
- name: Подготовка машины
  hosts: lab
  become: true
  vars:
    deploy_user: deploy
  roles:
    - web
  tasks:
    - name: Пользователь для выката заведён
      ansible.builtin.user:
        name: "{{ deploy_user }}"
        shell: /bin/bash

Пользователь остался в плейбуке: к веб-серверу он не относится. Роли выполняются раньше задач из tasks, в каком бы порядке ты их ни записал.

Шаг 3. Перенос ничего не поменял

Главная проверка любой перестройки — машина не должна её заметить.

ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [web : Пакеты установлены] ********** ok: [target]
TASK [web : nginx запущен] *************** ok: [target]
TASK [web : Страница сайта на месте] ***** ok: [target]
TASK [web : Заголовок в настройках nginx]  ok: [target]
TASK [Пользователь для выката заведён] *** ok: [target]
target : ok=6  changed=0  unreachable=0  failed=0

Перед именем задачи теперь стоит имя роли: web :. Всё ok, changed=0 — описание разложено по-новому, а машина та же. Если что-то стало жёлтым, при переносе потерялась или исказилась строка: сравни задачу с прошлой практикой.

Шаг 4. Страница из шаблона

Текст страницы зашит в задачу. Чтобы он зависел от машины и группы, страницу собирают из шаблона — файла, в котором вместо части текста стоят переменные. Начнём с шаблона без единой переменной, с тем же текстом, только в заголовке <h1>.

nano roles/web/templates/index.html.j2
<h1>Настроено Ansible</h1>

Расширение .j2 — от Jinja2, языка шаблонов, которым пользуется Ansible. В задаче со страницей замени copy на template: вместо content теперь src, имя шаблона.

в roles/web/tasks/main.yml, задача со страницей
- name: Страница сайта на месте
  ansible.builtin.template:
    src: index.html.j2
    dest: /var/www/html/index.html

Путь к шаблону не нужен: Ansible сам ищет его в templates этой роли. Флаг --diff покажет, что поменяется в файле.

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

Страница поменялась, handler при этом не позвали — и не нужно: файлы сайта nginx читает на каждый запрос, как ты видел в прошлой практике. notify остался там, где он к месту, — у настроек.

Шаг 5. Переменная и факты

Теперь вместо текста — переменные. Значение текста по умолчанию кладём в defaults роли.

nano roles/web/defaults/main.yml
---
web_message: "Настроено Ansible"

Имена переменных роли начинают с имени роли: web_message, а не message. Когда ролей станет пять, ты сразу поймёшь, чья это переменная. В шаблоне подставим её и имя машины.

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

{{ web_message }} возьмётся из переменных, {{ ansible_hostname }} — из фактов: сведений о машине, которые Ansible собирает сам в начале плея, в задаче Gathering Facts.

ubuntu@stand:~$
ansible-playbook site.yml --diff
ubuntu@stand:~$
TASK [web : Страница сайта на месте] *****************
@@ -1 +1,2 @@
 <h1>Настроено Ansible</h1>
+<p>Машина: 5e8b1c2d9a07</p>
changed: [target]

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

Шаг 6. Пометка «не править руками»

Тот, кто откроет страницу на сервере, не догадается, что её кладёт Ansible, и поправит руками — а следующий прогон молча вернёт старое. Допиши в шаблон первой строкой пометку.

в roles/web/templates/index.html.j2, первой строкой
<!-- {{ ansible_managed }} -->

ansible_managed — штатная переменная Ansible именно для такой пометки, по умолчанию она превращается в Ansible managed; текст можно поменять в ansible.cfg. Пометка спрятана в комментарий HTML, на странице её не видно.

ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
TASK [web : Страница сайта на месте] ***** changed: [target]
target : ok=6  changed=1  unreachable=0  failed=0
ubuntu@stand:~$
docker exec target curl -s localhost
ubuntu@stand:~$
<!-- Ansible managed -->
<h1>Настроено Ansible</h1>
<p>Машина: 5e8b1c2d9a07</p>

Запусти ещё раз: должно быть changed=0.

Шаг 7. Своё значение для группы

У группы lab текст будет свой. Переменные группы лежат в group_vars/<имя группы>.yml рядом с инвентарём.

ubuntu@stand:~$
mkdir group_vars
nano ~/infra/ansible/group_vars/lab.yml
---
web_message: "Учебный стенд lab"

Посмотрим заранее, что изменится. --check ничего не меняет, --diff показывает разницу.

ubuntu@stand:~$
ansible-playbook site.yml --check --diff
ubuntu@stand:~$
TASK [web : Страница сайта на месте] *****************
@@ -1,3 +1,3 @@
 <!-- Ansible managed -->
-<h1>Настроено Ansible</h1>
+<h1>Учебный стенд lab</h1>
 <p>Машина: 5e8b1c2d9a07</p>
changed: [target]

group_vars перекрыл defaults — роль при этом не менялась. Применяй: ansible-playbook site.yml без флагов.

Шаг 8. Кто сильнее всех

Флаг -e задаёт переменную из командной строки и побеждает всё. Попробуем в режиме предпросмотра, чтобы ничего не испортить.

ubuntu@stand:~$
ansible-playbook site.yml -e web_message=Тест --check --diff
ubuntu@stand:~$
-<h1>Учебный стенд lab</h1>
+<h1>Тест</h1>
changed: [target]

-e перебил и group_vars. Это удобно для разового запуска и опасно для постоянного: в репозитории от него не остаётся следа, и через неделю никто не вспомнит, откуда на сервере «Тест».

Шаг 9. Что получилось

Обычный прогон без -e — машина в состоянии, описанном в репозитории.

ubuntu@stand:~$
ansible-playbook site.yml
ubuntu@stand:~$
target : ok=6  changed=0  unreachable=0  failed=0

changed=0: страница уже собрана со значением группы, --check ничего не трогал. Роль web можно отдать другой группе машин, и она получит свой текст из своего group_vars, без единой правки в роли.

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

Роль, переменные группы и новый плейбук — одним коммитом.

Работаем в своей ветке: -c создаёт её и переходит в неё.

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

Коммит, флаг -m — его сообщение.

ubuntu@stand:~$
git add ansible/
git commit -m "ansible: роль web и переменные группы lab"

Флаг -u у push связывает новую ветку с GitLab.

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

Дальше как в практике про плейбук: слей merge request в GitLab, потом git switch main и git pull.

Шаг 11. Сдать

Выполни команду сдачи: она покажет раскладку роли, итог прогона, страницу и переменные группы.

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

Превратить плейбук в роль с defaults, шаблоном и handler, а различия машин вынести в group_vars — так одна роль настраивает любую группу.

  • Раскладка роли на месте
  • Повторный прогон ничего не меняет
  • Страница собрана из шаблона
  • Значение перекрыто из group_vars
Команда сдачи — выполни на своей машине
команда
cd ~/infra/ansible; ls roles/web; ansible-playbook site.yml | tail -2; docker exec target curl -s localhost; cat group_vars/lab.yml

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