Плагины Vars

• Включение плагинов vars
• Использование плагинов vars
• Списки плагинов

Плагины vars добавляют дополнительные переменные в выполнение Ansible, которые не поступают из источника инвентаризации, плейбука или командной строки. Конструкции плейбука, такие как ‘host_vars’ и ‘group_vars’, работают с помощью плагинов vars.

Плагины vars были частично реализованы в Ansible 2.0 и переписаны для полной реализации начиная с Ansible 2.4.

Плагин host_group_vars, поставляемый с Ansible, позволяет считывать переменные из Назначение переменной одному компьютеру: переменные хоста и Назначение переменной многим компьютерам: переменные группы.

Включение плагинов vars

Вы можете активировать пользовательский плагин vars, поместив его в директорию vars_plugins рядом с вашим плейбуком, внутри роли или поместив его в один из каталогов-источников, настроенных в ansible.cfg.

Большинство плагинов vars по умолчанию отключены. Чтобы включить плагин vars, установите vars_plugins_enabled в разделе defaults файла ansible.cfg или установите переменную окружения ANSIBLE_VARS_ENABLED в список плагинов vars, которые вы хотите выполнить. По умолчанию плагин host_group_vars, поставляемый с Ansible, включён.

Начиная с Ansible 2.10, вы можете использовать плагины vars в коллекциях. Все плагины vars в коллекциях должны быть явно включены и должны использовать полное имя коллекции в формате namespace.collection_name.vars_plugin_name.

[defaults]
vars_plugins_enabled = host_group_vars,namespace.collection_name.vars_plugin_name

Использование плагинов vars

По умолчанию плагины vars используются по требованию автоматически после их включения.

Начиная с Ansible 2.10, плагины vars можно запустить в определенные моменты. ansible-inventory не использует эти настройки и всегда загружает плагины vars.

Глобальная настройка RUN_VARS_PLUGINS может быть установлена в ansible.cfg с помощью run_vars_plugins в разделе defaults или переменной окружения ANSIBLE_RUN_VARS_PLUGINS. По умолчанию, demand, запускает все включенные плагины vars относительно источников инвентаризации всякий раз, когда переменные запрашиваются задачами. Вы можете использовать опцию start для запуска всех включенных плагинов vars относительно источников инвентаризации после импорта этого источника инвентаризации.

Вы также можете управлять выполнением плагинов vars на основе каждого плагина для плагинов vars, которые поддерживают опцию stage. Чтобы запустить плагин host_group_vars после импорта инвентаризации, вы можете добавить следующее в ansible.cfg:

[vars_host_group_vars]
stage = inventory

Списки плагинов

Вы можете использовать ansible-doc -t vars -l для просмотра списка доступных плагинов. Используйте ansible-doc -t vars <plugin name> для просмотра конкретной документации и примеров для каждого плагина.