Повторное использование артефактов Ansible

Создание повторно используемых файлов и ролей

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

• Файл переменных содержит только переменные.
• Файл задач содержит только задачи.
• Плейбук содержит как минимум один плей и может содержать переменные, задачи и другие элементы. Можно повторно использовать узкоспециализированные плейбуки, но только статически, а не динамически.
• Роль содержит набор связанных задач, переменных, значений по умолчанию, обработчиков и даже модулей или других плагинов в заданной структуре файлов. В отличие от файлов переменных, файлов задач и плейбуков, роли можно легко загружать и распространять через Ansible Galaxy. Подробные сведения о создании ролей и работе с ними см. в разделе Роли.

Повторное использование плейбуков

Вы можете включить несколько плейбуков в главный плейбук. Однако для повторного использования плейбуков можно применять только импорт. Например:

- import_playbook: webservers.yml
- import_playbook: databases.yml

Импорт статически включает плейбуки в другие плейбуки. Ansible выполняет плейы и задачи каждого импортированного плейбука в указанном порядке, как если бы они были определены непосредственно в главном плейбуке.

Во время выполнения можно выбрать импортируемый плейбук, указав имя файла импортируемого плейбука с помощью переменной, а затем передав переменную с помощью --extra-vars или ключевого слова vars. Например:

- import_playbook: "/path/to/{{ import_from_extra_var }}"
- import_playbook: "{{ import_from_vars }}"
  vars:
    import_from_vars: /path/to/one_playbook.yml

Если запустить этот плейбук с помощью ansible-playbook my_playbook -e import_from_extra_var=other_playbook.yml, Ansible импортирует и one_playbook.yml, и other_playbook.yml.

Когда следует преобразовать плейбук в роль

Для некоторых сценариев хорошо подходят простые плейбуки. Однако после достижения определённого уровня сложности роли становятся предпочтительнее плейбуков. Роль позволяет хранить значения по умолчанию, обработчики, переменные и задачи в отдельных каталогах, а не в одном длинном документе. Роли легко публиковать в Ansible Galaxy. В сложных сценариях большинство пользователей считают, что роли проще читать, понимать и поддерживать, чем плейбуки, объединяющие всё в одном файле.

Повторное использование файлов и ролей

Ansible предлагает два способа повторного использования файлов и ролей в плейбуке: динамический и статический.

• Для динамического повторного использования добавьте задачу include_* в раздел задач плейа:

  • include_role
  • include_tasks
  • include_vars

• Для статического повторного использования добавьте задачу import_* в раздел задач плейа:

  • import_role
  • import_tasks

Инструкции включения и импорта задач можно использовать на произвольной глубине вложенности.

Для статического включения роли в плейбук на уровне плейа по-прежнему можно использовать ключевое слово roles без дополнительной конструкции. Однако ключевое слово include, которое раньше использовалось и для файлов задач, и для включений на уровне плейбука, теперь устарело.

tasks:
- import_tasks: wordpress.yml
  vars:
    wp_user: timmy

- import_tasks: wordpress.yml
  vars:
    wp_user: alice

- import_tasks: wordpress.yml
  vars:
    wp_user: bob

Повторное использование задач в качестве обработчиков

В разделе Обработчики: выполнение операций при изменении плейбука также можно использовать включения и импорт. Например, если нужно определить способ перезапуска Apache, достаточно сделать это один раз для всех плейбуков. Можно создать файл restarts.yml следующего вида:

# restarts.yml
- name: Restart apache
  ansible.builtin.service:
    name: apache
    state: restarted

- name: Restart mysql
  ansible.builtin.service:
    name: mysql
    state: restarted

Обработчики можно запускать как из импорта, так и из включения, но для каждого способа повторного использования процедура отличается. Если включить файл, необходимо уведомить само включение, которое запускает все задачи в restarts.yml. Если импортировать файл, необходимо уведомить отдельную задачу или задачи внутри restarts.yml. Можно сочетать обычные задачи и обработчики с включёнными или импортированными задачами и обработчиками.

- name: Trigger an included (dynamic) handler
  hosts: localhost
  handlers:
    - name: Restart services
      include_tasks: restarts.yml
  tasks:
    - command: "true"
      notify: Restart services

- name: Trigger an imported (static) handler
  hosts: localhost
  handlers:
    - name: Restart services
      import_tasks: restarts.yml
  tasks:
    - command: "true"
      notify: Restart apache
    - command: "true"
      notify: Restart mysql