Шаблоны: нацеливание на хосты и группы

При выполнении Ansible через команду ad hoc или запуск playbooks, необходимо выбрать управляемые узлы или группы, на которые следует выполнить операции. Шаблоны позволяют запускать команды и playbooks на конкретных хостах и/или группах в вашем инвентаре. Шаблон Ansible может ссылаться на один хост, IP-адрес, группу инвентаря, набор групп или все хосты в вашем инвентаре. Шаблоны очень гибкие — вы можете исключить или потребовать подмножества хостов, использовать подстановочные знаки или регулярные выражения и многое другое. Ansible выполняется на всех хостах инвентаря, включённых в шаблон.

• Использование шаблонов
• Общие шаблоны
• Ограничения шаблонов

• Дополнительные параметры шаблонов

  • Использование переменных в шаблонах
  • Использование позиции группы в шаблонах
  • Использование регулярных выражений в шаблонах
• Шаблоны и флаги ansible-playbook

Использование шаблонов

Вы используете шаблон почти всегда при выполнении команды ad hoc или playbook. Шаблон — единственный элемент команды ad hoc, у которого нет флага. Обычно это второй элемент:

ansible <pattern> -m <module_name> -a "<module options>"

Например:

ansible webservers -m service -a "name=httpd state=restarted"

В playbook шаблон — содержимое строки hosts: для каждого выполнения:

- name: <play_name>
  hosts: <pattern>

Например:

- name: restart webservers
  hosts: webservers

Поскольку вы часто хотите выполнить команду или playbook сразу на нескольких хостах, шаблоны часто ссылаются на группы инвентаря. И команда ad hoc, и playbook выше будут выполняться на всех машинах в группе webservers.

Общие шаблоны

В этой таблице перечислены общие шаблоны для нацеливания на хосты и группы инвентаря.

После того, как вы узнаете основные шаблоны, вы можете их комбинировать. Этот пример:

webservers:dbservers:&staging:!phoenix

направлен на все машины в группах «webservers» и «dbservers», которые также находятся в группе «staging», за исключением любых машин в группе «phoenix».

Вы можете использовать шаблоны с подстановочными знаками с полными именами домена (FQDN) или IP-адресами, если хосты в вашем инвентаре названы FQDN или IP-адресом:

192.0.\*
\*.example.com
\*.com

Вы можете смешивать шаблоны с подстановочными знаками и группы одновременно:

one*.com:dbservers

Ограничения шаблонов

Шаблоны зависят от инвентаря. Если хост или группа не указаны в вашем инвентаре, вы не можете использовать шаблон для их нацеливания. Если ваш шаблон включает IP-адрес или имя хоста, которые не появляются в вашем инвентаре, вы увидите ошибку, похожую на эту:

[WARNING]: No inventory was parsed, only implicit localhost is available
[WARNING]: Could not match supplied host pattern, ignoring: *.not_in_inventory.com

Ваш шаблон должен соответствовать синтаксису вашего инвентаря. Если вы определили хост как псевдоним:

atlanta:
  host1:
    http_port: 80
    maxRequestsPerChild: 808
    host: 127.0.0.2

вы должны использовать псевдоним в своём шаблоне. В примере выше, вы должны использовать host1 в своём шаблоне. Если вы используете IP-адрес, вы снова получите ошибку:

[WARNING]: Could not match supplied host pattern, ignoring: 127.0.0.2

Дополнительные параметры шаблонов

Общие шаблоны, описанные выше, удовлетворят большинство ваших потребностей, но Ansible предлагает несколько других способов определения хостов и групп, на которые вы хотите нацелиться.

Использование переменных в шаблонах

Вы можете использовать переменные для передачи спецификаторов групп через аргумент -e к ansible-playbook:

webservers:!{{ excluded }}:&{{ required }}

Использование позиции группы в шаблонах

Вы можете определить хост или подмножество хостов по его позиции в группе. Например, при следующей группе:

[webservers]
cobweb
webbing
weber

вы можете использовать индексы для выбора отдельных хостов или диапазонов в группе webservers:

webservers[0]       # == cobweb
webservers[-1]      # == weber
webservers[0:2]     # == webservers[0],webservers[1]
                    # == cobweb,webbing
webservers[1:]      # == webbing,weber
webservers[:3]      # == cobweb,webbing,weber

Использование регулярных выражений в шаблонах

Вы можете указать шаблон как регулярное выражение, начав шаблон с ~:

~(web|db).*\.example\.com

Шаблоны и флаги ansible-playbook

Вы можете изменить поведение шаблонов, определённых в playbooks, с помощью опций командной строки. Например, вы можете запустить playbook, который определяет hosts: all на одном хосте, указав -i 127.0.0.2, (обратите внимание на заключительную запятую). Это работает даже если хост, на который вы нацеливаетесь, не определён в вашем инвентаре. Вы также можете ограничить хосты, на которые вы нацеливаетесь в конкретном запуске, с помощью флага --limit:

ansible-playbook site.yml --limit datacenter2

Наконец, вы можете использовать --limit для чтения списка хостов из файла, добавив префикс к имени файла @:

ansible-playbook site.yml --limit @retry_hosts.txt

Если RETRY_FILES_ENABLED установлено в True, файл .retry будет создан после выполнения ansible-playbook и будет содержать список неудачных хостов из всех выполнений. Этот файл перезаписывается каждый раз, когда выполняется ansible-playbook.

ansible-playbook site.yml –limit @site.retry

Для применения ваших знаний о шаблонах с командами и playbooks Ansible, прочитайте Введение в команды ad hoc и Введение в playbooks.