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

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

Вы используете шаблон почти каждый раз, когда выполняете команду 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:
  hosts:
    host1:
      http_port: 80
      maxRequestsPerChild: 808
      ansible_host: 127.0.0.2

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

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

Порядок обработки шаблонов

Обработка немного специфическая и происходит в следующем порядке:

1. : и ,
2. &
3. !

Эта позиционировка учитывает только порядок обработки внутри каждой операции: a:b:&c:!d:!e == &c:a:!d:b:!e == !d:a:!e:&c:b

Всё это приводит к следующему:

Хост в/находится в (a или b) И хост в/находится во всех(c) И хост не в/не находится во всех(d, e).

Теперь a:b:!e:!d:&c — это небольшое изменение, так как !e обрабатывается до !d, хотя это не сильно меняет результат:

Хост в/находится в (a или b) И хост в/находится во всех(c) И хост не в/не находится во всех(e, d).

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

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

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

[webservers]
cobweb
webbing
weber

webservers[0]       # == cobweb
webservers[-1]      # == weber

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

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

Шаблоны и команды ad hoc

Вы можете изменить поведение шаблонов, определённых в командах ad hoc, с помощью параметров командной строки. Вы также можете ограничить хосты, на которые вы нацелены в конкретном запуске, с флагом --limit.

• Ограничение до одного хоста

$ ansible all -m <module> -a "<module options>" --limit "host1"

• Ограничение до нескольких хостов

$ ansible all -m <module> -a "<module options>" --limit "host1,host2"

• Ограничение с отрицанием. Обратите внимание, что одинарные кавычки ОБЯЗАТЕЛЬНО должны использоваться для предотвращения интерполяции bash.

$ ansible all -m <module> -a "<module options>" --limit 'all:!host1'

• Ограничение до группы хостов

$ ansible all -m <module> -a "<module options>" --limit 'group1'

Шаблоны и флаги ansible-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

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