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

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

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

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

Использование повторно playbooks

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

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

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

Вы можете выбрать, какой playbook импортировать во время выполнения, определив имя импортированного файла playbook с помощью переменной, а затем передав переменную с помощью --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

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

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

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

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

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

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

  • include_role
  • include_tasks
  • include_vars

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

  • import_role
  • import_tasks

Утверждения include и import задач могут использоваться на произвольной глубине.

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

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

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

Вы также можете использовать include и import в разделе Обработчики: выполнение операций при изменении плейбука. Например, если вы хотите определить, как перезапустить 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

Вы можете запускать обработчики из импорта или инклюда, но процедура отличается для каждого метода повторного использования. Если вы используете include, вы должны сообщить об этом самому include, что запустит все задачи в restarts.yml. Если вы используете import, вы должны сообщить об этом каждой отдельной задаче в 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