Плагины обратного вызова

• Примеры плагинов обратного вызова
• Включение плагинов обратного вызова
• Установка плагина обратного вызова для ansible-playbook
• Установка плагина обратного вызова для ад-хок команд
• Список плагинов

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

Примеры плагинов обратного вызова

Плагин обратного вызова log_plays — пример того, как записывать события playbook в файл журнала, а плагин обратного вызова mail отправляет электронные письма при сбоях в playbook.

Плагин обратного вызова say отвечает компьютерным синтезированным голосом в отношении событий playbook.

Включение плагинов обратного вызова

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

Плагины загружаются в алфавитном порядке. Например, плагин, реализованный в файле с именем 1_first.py, будет выполняться до файла плагина с именем 2_second.py.

Большинство плагинов обратного вызова, поставляемых с Ansible, по умолчанию отключены и должны быть включены в вашем файле ansible.cfg, чтобы они работали. Например:

#callback_enabled = timer, mail, profile_roles, collection_namespace.collection_name.custom_callback

Установка плагина обратного вызова для ansible-playbook

Вы можете иметь только один плагин, который будет основным менеджером вывода на консоль. Если вы хотите заменить стандартный, вы должны определить CALLBACK_TYPE = stdout в подклассе, а затем настроить плагин stdout в ansible.cfg. Например:

stdout_callback = dense

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

stdout_callback = mycallback

Это по умолчанию влияет только на ansible-playbook.

Установка плагина обратного вызова для ад-хок команд

Команда ansible ад-хок специально использует другой плагин обратного вызова для stdout, поэтому вам нужно добавить дополнительную настройку в Ansible Configuration Settings, чтобы использовать плагин stdout, определенный выше:

[defaults]
bin_ansible_callbacks=True

Вы также можете установить это как переменную среды:

export ANSIBLE_LOAD_CALLBACK_PLUGINS=1

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

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