Плагины Vars

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

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

Большинство плагинов 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 для просмотра списка доступных плагинов vars. Используйте ansible-doc -t vars <plugin name> для просмотра документации и примеров, специфичных для каждого плагина.