Как должна быть структурирована правильная роль в Ansible?

Правильная роль в Ansible обычно имеет следующую структуру:

my_role/
├── tasks/
│   ├── main.yml          // Главный файл с основными задачами роли
│   └── another_task.yml  // Дополнительные файлы с задачами (при необходимости)
├── handlers/
│   └── main.yml          // Файл с обработчиками (для перезапуска сервисов и т.п.)
├── vars/
│   └── main.yml          // Файл с переменными, специфичными для роли
├── defaults/
│   └── main.yml          // Файл с переменными по умолчанию (низкий приоритет)
├── files/                // Каталог для статических файлов, которые нужно скопировать
│   └── some_file.txt
├── templates/            // Каталог для шаблонов с использованием Jinja2
│   └── some_template.conf.j2
├── meta/                 // Каталог с метаданными роли
│   └── main.yml          // Информация о роли, зависимостях, платформенной совместимости
├── library/              // Каталог для пользовательских модулей (редко используется)
├── module_utils/       // Утилиты для пользовательских модулей (редко используется)
└── tests/                // Каталог для тестов роли (например, с Molecule)
    ├── inventory
    └── test.yml

Пояснения к каталогам:

• tasks: Содержит основные файлы плейбуков, выполняющих задачи роли. main.yml является точкой входа.
• handlers: Содержит задачи, которые вызываются только при уведомлении (notify). Используется для действий, которые нужно выполнить только после изменения чего-то (например, перезапуск сервиса).
• vars: Переменные, специфичные для данной роли, которые могут меняться в зависимости от окружения. Имеют более высокий приоритет, чем переменные из defaults.
• defaults: Переменные с наименьшим приоритетом, применяемые по умолчанию, если они не переопределены в других местах (например, в инвентаре или в плейбуке).
• files: Содержит статические файлы, которые задачами из tasks должны быть скопированы на целевые машины без изменений.
• templates: Содержит файлы-шаблоны, которые обрабатываются с использованием движка Jinja2 перед копированием на целевые машины. Позволяет вставлять динамические значения (переменные).
• meta: Содержит метаинформацию, такую как зависимости от других ролей, поддерживаемые платформы и авторство. main.yml обязателен, если у роли есть зависимости.
• library/module_utils: Используются для создания пользовательских модулей или утилит для них. Необходимы только при создании сложных, нестандартных модулей.
• tests: Каталог для автоматических тестов роли. Часто используются инструменты типа Molecule.

Главные принципы:

• Модульность: Каждая роль должна быть самодостаточным блоком, выполняющим одну логическую функцию (установка и настройка приложения, конфигурирование сервиса и т.д.).
• Идемпотентность: Задачи в роли должны быть идемпотентными, то есть повторное выполнение не должно приводить к нежелательным побочным эффектам.
• Переиспользуемость: Роли должны быть легко переиспользуемы в разных плейбуках и проектах. Использование переменных помогает в этом.
• Читаемость: Структурирование делает роль более читаемой и понятной другим пользователям.