Плейбуки Ansible

Синтаксис плейбуков

Плейбуки записываются в формате YAML с минимальным количеством синтаксических конструкций. Если вы не знакомы с YAML, ознакомьтесь с обзором синтаксиса YAML и установите дополнение для текстового редактора (см. раздел Другие инструменты и программы), которое поможет вам писать корректный синтаксис YAML в плейбуках.

Плейбук состоит из одного или нескольких «плеев», перечисленных в заданном порядке. Термины «плейбук» и «плей» заимствованы из спортивной терминологии. Каждый плей выполняет часть общей задачи плейбука, запуская одну или несколько задач. Каждая задача вызывает модуль Ansible.

Выполнение плейбуков

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

• Управляемые узлы, для которых он предназначен, с помощью шаблона.
• Как минимум одну задачу для выполнения.

В Ansible 2.10 и более поздних версиях в плейбуках следует использовать полное имя коллекции (FQCN). Использование FQCN гарантирует, что вы выбрали нужный модуль, поскольку разные коллекции могут содержать модули с одинаковыми именами. Например, user. См. раздел Использование коллекций в плейбуке.

В следующем примере первый плей предназначен для веб-серверов, а второй — для серверов баз данных.

---
- name: Update web servers
  hosts: webservers
  remote_user: root

  tasks:
  - name: Ensure apache is at the latest version
    ansible.builtin.yum:
      name: httpd
      state: latest

  - name: Write the apache config file
    ansible.builtin.template:
      src: /srv/httpd.j2
      dest: /etc/httpd.conf

- name: Update db servers
  hosts: databases
  remote_user: root

  tasks:
  - name: Ensure postgresql is at the latest version
    ansible.builtin.yum:
      name: postgresql
      state: latest

  - name: Ensure that postgresql is started
    ansible.builtin.service:
      name: postgresql
      state: started

Плейбук может содержать не только строку hosts и задачи. Например, в плейбуке выше для каждого плей задан remote_user. remote_user — это учетная запись пользователя для SSH-подключения. На уровне плейбука, плейа или задачи можно добавить другие ключевые слова плейбука, чтобы изменить поведение Ansible. Ключевые слова плейбука позволяют управлять плагином подключения, определять, использовать ли повышение привилегий, задавать обработку ошибок и многое другое. Для поддержки различных сред многие из этих параметров можно задать с помощью флагов командной строки в конфигурации Ansible или в инвентаре. Знание правил приоритета для этих источников данных поможет вам по мере расширения экосистемы Ansible.

ansible-playbook playbook.yml -f 10

ansible-playbook --check playbook.yaml

Ansible-Pull

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

Команда ansible-pull — это небольшой скрипт, который получает из git репозиторий с инструкциями по конфигурации, а затем запускает ansible-playbook для его содержимого.

Если распределить нагрузку между серверами, на которых размещены репозитории, ansible-pull сможет масштабироваться без ограничений.

Подробности см. в разделе ansible-pull --help.

Проверка плейбуков

Чтобы выявить синтаксические ошибки и другие проблемы до запуска плейбуков, их можно проверить. Команда ansible-playbook предлагает несколько вариантов проверки, включая --check, --diff, --list-hosts, --list-tasks и --syntax-check. В разделе Инструменты для проверки плейбуков описаны другие инструменты для проверки и тестирования плейбуков.

$ ansible-lint verify-apache.yml
[403] Package installs should not use latest
verify-apache.yml:8
Task/Handler: ensure apache is at the latest version