Как вызывать Ansible Role в Playbook

Вызов Ansible Role в Playbook: Основные подходы

Вызов ролей (Roles) в Ansible Playbook — это фундаментальный навык для структурирования и повторного использования конфигураций. Роли инкапсулируют задачи, переменные, обработчики и другие артефакты для настройки конкретного компонента инфраструктуры (например, веб-сервера, базы данных). Вот основные способы их интеграции в плейбук.

Основной синтаксис: Директива roles

Самый распространенный и рекомендуемый способ — использование директивы roles: в блоке Play.

---
- name: Deploy and configure web application
  hosts: web_servers
  become: true

  roles:
    - common             # Вызов роли по имени (из каталога `roles/`)
    - role: nginx        # Явное указание роли
    - { role: postgresql, become_user: postgres }  # Старый синтаксис с параметрами (устарел, но работает)
    - role: app_deploy
      vars:
        app_version: "2.1.0"

В этом примере Ansible выполняет роли в порядке их перечисления: common, nginx, postgresql, app_deploy. Для каждой роли Ansible автоматически загружает её содержимое: задачи из tasks/main.yml, обработчики из handlers/main.yml, переменные из vars/main.yml и defaults/main.yml, а также зависимости, объявленные в meta/main.yml.

Импорт и Включение ролей: import_role и include_role

Для более гибкого, динамического или условного выполнения ролей используются модули import_role и include_role внутри блока tasks:.

---
- name: Conditional deployment playbook
  hosts: all
  tasks:
    - name: Import system baseline role (статически, на этапе парсинга)
      ansible.builtin.import_role:
        name: baseline

    - name: Include database role only for DB hosts (динамически, во время выполнения)
      ansible.builtin.include_role:
        name: postgresql
      when: inventory_hostname in groups['database']

    - name: Include monitoring role with custom variables
      ansible.builtin.include_role:
        name: monitoring_agent
        vars:
          agent_mode: "pull"

Ключевые различия:

• import_role — операции "импорта". Роль импортируется на этапе парсинга плейбука. Все задачи роли становятся частью основного списка задач. Не поддерживает применение директивы when к самому импорту (условия нужно задавать внутри роли). Используется для статических, обязательных компонентов.
• include_role — операция "включения" (динамическая). Роль выполняется во время выполнения (runtime) задачи. Можно применять условные операторы (when:, loop:) непосредственно к задаче включения. Идеально для условного или повторяющегося выполнения ролей.

Передача переменных в роль

Переменные для роли можно задать несколькими способами, с разной степенью приоритета:

---
- name: Configure application with parameters
  hosts: app_servers
  roles:
    - role: java_app
      app_port: 8080          # Переменные, определенные здесь, имеют высокий приоритет
      app_threads: 4
      tags: deploy            # Теги, применяемые ко всем задачам роли

Также переменные можно передать через модули include_role/import_role с помощью ключа vars:, как показано в примере выше. Важно помнить об иерархии переменных Ansible: переменные, переданные непосредственно в вызове роли, имеют приоритет над переменными, определенными в vars/ каталоге роли, но более низкий, чем переменные, заданные через --extra-vars в командной строке.

Управление зависимостями через meta/dependencies.yml

Роли могут автоматически вызывать другие роли как зависимости. Это управляется не в плейбуке, а в файле roles/<role_name>/meta/main.yml самой роли.

# roles/wordpress/meta/main.yml
dependencies:
  - role: nginx
  - role: php_fpm
    php_version: '8.1'
  - role: mysql
    when: database_type == 'mysql'

Когда плейбук вызывает роль wordpress, Ansible сначала выполнит все её зависимости (nginx, php_fpm, mysql) в указанном порядке, если не задана директива allow_duplicates: false для предотвращения повторных выполнений.

Рекомендации по использованию в продакшене

1. Основной выбор: Для большинства случаев используйте директиву roles: в плейбуке. Это лаконично, понятно и четко определяет архитектуру развертывания.
2. Для динамической логики: При необходимости условного (when:) или циклического (loop:) выполнения роли — используйте include_role.
3. Для статической структуры: Если логика вызова ролей фиксирована и определяется на этапе написания плейбука, можно использовать import_role для небольшого выигрыша в производительности.
4. Избегайте устаревшего синтаксиса: Старый синтаксис roles: [ 'role: nginx', { role: 'db', port: 5432 } ] считается устаревшим. Отдавайте предпочтение списковому синтаксису или модулям include_role/import_role.
5. Тегирование: Всегда присваивайте теги (tags:) как самим ролям в плейбуке, так и задачам внутри ролей. Это позволяет выполнять частичные конфигурации, например: ansible-playbook site.yml --tags "nginx,deploy".

Таким образом, выбор метода вызова роли зависит от требуемой динамики выполнения и структуры вашей автоматизации. Использование ролей — это мощная практика, которая значительно повышает читаемость, сопровождаемость и возможность повторного использования ваших Ansible-плейбуков.