Ansible playbooks kit for different purposes
Go to file
Ilgiz Kalmetyev 30ab2cd91f initial commit 2 2024-06-14 18:38:53 +05:00
bin initial commit 2 2024-06-14 18:38:53 +05:00
integrations/telegram initial commit 2 2024-06-14 18:38:53 +05:00
inventory initial commit 2 2024-06-14 18:38:53 +05:00
inventory.lab initial commit 2 2024-06-14 18:38:53 +05:00
licenses initial commit 2 2024-06-14 18:38:53 +05:00
playbooks initial commit 2 2024-06-14 18:38:53 +05:00
playbooks.lab initial commit 2 2024-06-14 18:38:53 +05:00
private initial commit 2 2024-06-14 18:38:53 +05:00
roles initial commit 2 2024-06-14 18:38:53 +05:00
.gitignore initial commit 2 2024-06-14 18:38:53 +05:00
.yamllint initial commit 2 2024-06-14 18:38:53 +05:00
README.md first commit 2024-06-14 18:36:59 +05:00
ansible.cfg initial commit 2 2024-06-14 18:38:53 +05:00
copyright initial commit 2 2024-06-14 18:38:53 +05:00
requirements.txt initial commit 2 2024-06-14 18:38:53 +05:00
requirements.yml initial commit 2 2024-06-14 18:38:53 +05:00

README.md

anicod

проект anicod - "ansible, networking, it-infrastructure, code".

Репозиторий: ilgiz/anicod

Роли Ansible

Роли применяются для автоматизации:

  • типовых задач для серверов (Linux) и сетевых устройств,
  • повторяемых/воспроизводимых задач,
  • сложных задач, для которых Ansible используется в качестве своеобразной инструкции по установке и развёртыванию

При написании ролей, помимо собственно конфигурационных деклараций, формируются тесты для проверки правильности выполнения ролей.

Далее по тексту, сущность - в зависимости от контекста - единица физического оборудования или виртуального инстанса, пользователя, пакета и т. п.

Структура ролей:

  1. Первый (топ) уровень - формирует "пирог" развёртывамых сущностей по уровням развёртывания и администрирования:
Префикс Уровень Сущности Пояснение
infra Инфраструктура Аппартура. Виртуальная ферма. Как минимум отвечает за настройку "стандартного" способа подключения к сущености для последующего управления. Помимо собственно "нижнего" слоя объектов инфраструктуры сюда относятся в т.ч. вещи, связанные с разворачиванием и настройкой элементов CI/CD, мониторинга, инвентаризации (точек истины) и т.п.
system Система Узлы. Системное ПО. Развёртывание системных сущностей в зависимости от специфики инфраструктуры и независящих от дальнейшего прикладного назначения: операционные системы и утилиты, библиотеки, системные базы данных,..
app Приложение Приложения. Развёртывание приложений: веб-серверы, балансировщики нагрузки, прикладные базы данных, пользовательские интерфейсы,..
service Сервис Сервисы Взаимосвязанные приложения, обеспечивающие нужную функциональность, возможно, в отказоустойчивой конфигурации
deploy Деплой Опубликованный сервис Совокупность cервисов, обеспечивающая нужную функциональность, подготовленная к применению, управляемая единообразно и одним центром ответственности, имеющая необходимый уровень надёжности и штатные средства масштабирования производительности
secur Безопасность Все. Базовые и стыковочные задачи информационной безопасности

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

  • Безопасность:
    • автоматизированные задачи по настройке информационной безопасности на сущности;
    • реализация задач по стыковке сущности с системами безопасности;
    • задачи в соответствии с политикой информационной безопасности, например, замена паролей;
  1. Второй уровень формирует жизненный цикл сущностей по стадиям:
Префикс Стадия Назначение
plan Планирование Пред-инициализационные действия: планирование и резервирование; выяснение условий, состояний и наличия
init Инициализация Инициализация сущности: создание, организация базового доступа для управления сущностью
start Запуск Запуск сущности в указанной среде
ctrl Отслеживание Отслеживание состояний сущности в процессе операционнной деятельности
conf Изменения Конфигурация сущности для тестирования и запуска в работу, а также оперативные изменения конфигурации сущности в процессе операционнной деятельности
fault Отказы Контроль и реакции на отказы сущности
acct Учёт Сбор данных об объёмах потребления мощностей и выполненной работы сущности
maint Обслуживание Временный вывод из работы сущности без уничтожения
stop Останов Уничтожение сущности

Стадии жизненного цикла включают следующие задачи:

  • Планирование:

    • определение: назначение имён и необходимых логических (IP-адресация, образы дисков,..) и физических (серверы, оборудование, каналы связи) ресурсов;
    • типизация: определение ролевых функций внедряемых сущностей;
    • резервирование: внесение предварительной информации о новой сущности в информационные системы;
    • готовность: проверка совместимости сущности и имеющихся средств (наличия готовых модулей) автоматизации;
    • обеспечение: генерация конфигураций системы автоматизации для выполнения последующих стадий жизненного цикла;
  • Инициализация:

    • назначение: внесение/активация информации о новой сущности в информационных системах, например, CMDB, мониторинг, системы резервного копирования, системы автоматизации,..;
    • развёртывание: создание экземпляра создаваемой сущности в исходном виде;
    • актуализация: приведение версии экземпляра сущности к требуемому виду, например, обновление поставляемого ПО;
    • доступ: настройка возможности обращения к сущности для выполнения любых требуемых далее действий, например, создание локальных пользователей, поднятие сервисов SSH/HTTP/.. , настройка IP-маршрутизации,..;
    • базовая конфигурация: приведение всех конфигурационных параметров к состояниям по умолчанию сущности определённой роли, например, блокирование интерфейсных и сетевых портов, запрет определённых протоколов и сервисов, установка ПО, которое безусловно должно наличествовать;
    • передача данных в информационные системы: мониторинг, инвентаризация,..;
  • Запуск:

    • тестирования в тестовом окружении: автономные, функциональные, нагрузочные, проверка надёжности,..;
    • согласования готовности к запуску;
    • генерация рабочей конфигурации;
    • накатка на рабочую среду;
    • тестирования в рабочем окружении;
  • Отслеживание:

    • автоматизированные задачи по контролю состояния сущности в составе/параллельно/совместно с системами мониторинга, журналирования, инвентаризации;
    • автоматизированные задачи по контролю неконсистентности состояния экземпляра сущности и зафиксированных состояниях в информационных системах, например, модель или состав модулей устройства, запущенного и/или установленного программного обеспечения, контроль текущих версий ПО, состояний лицензий, работы сервисов, состояний действующих протоколов, ..;
    • выполнение резервного копирования конфигураций и другой информации устройства;
  • Изменения:

    • автоматизированные задачи по контролю неконсистентности конфигураций сущностей;
    • выполнение изменений конфигураций;
  • Отказы:

    • автоматизированные задачи по обработке событий отказов сущности в составе/параллельно/совместно с системами мониторинга, биллинга;
  • Учёт:

    • автоматизированные задачи по обработке собранных значений счётчиков, данных о загрузке каналов , .. сущности в составе/параллельно/совместно с системами мониторинга, биллинга;
  • Обслуживание:

    • автоматизированные задачи по корректному выводу/вводу сущности из/в промышленной среды (перенос нагрузки на другие мощности) для выполнения планово-профилактических работ, модернизации и т. п.;
  • Вывод из эксплуатации:

    • корректный вывод сущности из эксплуатации - высвобождение мощностей, уничтожение данных, архивирование данных, внесение сведений в информационные системы;

Создание ролей Ansible

Роли создаются либо в общем случае с помощью команды ansible-galaxy:

ansible-galaxy role init <role-name>

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

molecule init role <the_role_name>

Применение ролей Ansible

Тестирование с помощью molecule

Установка molecule выполняется командой pip (pip3), опционально с указанием применяемого драйвера, например, docker:

pip3 install molecule[docker]
pip3 install molecule[podman]

Проверка установленного пакета molecule:

ilgiz@ansible:~/.ansible$ molecule --version
molecule 3.6.1 using python 3.9
    ansible:2.10.8
    delegated:3.6.1 from molecule
    docker:1.1.0 from molecule_docker requiring collections: community.docker>=1.9.1
    podman:1.1.0 from molecule_podman requiring collections: containers.podman>=1.7.0 ansible.posix>=1.3.0

Создать новую роль с помощью molecule:

$ molecule init role <the_role_name>

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

molecule init scenario -r <the_already_existing_role_name>

Независимо от того, как вы инициализируете Molecule, новая папка Molecule добавляется в корневую папку проекта. В результате макет папки выглядит следующим образом:

.
├── README.md
├── files/                                                
├── handlers/                                              
├── meta/                                                            
├── tasks/                                                 
├── templates/                                              
├── tests/                                               
├── vars/                                              
└── molecule/
        └── default                        
                ├── molecule.yml                        
                ├── converge.yml                        
                ├── verify.yml                                               
                └── INSTALL.rst

Лучшие практики Ansible

  • В части переменных:

    • применять в именах ролевых переменных префиксы, формирующие namespaces
    • не применять в ролях глобальные переменные
    • не применять переменные из других ролей
    • формирование значений параметров задач выносить в описание переменных, чтобы не размывать логику задач логикой формирования применяемых значений
  • В части написания файлов задач и ролей:

    • делать узкоспециализированные роли
    • формировать небольшие задачи вместо монструозных сценариев
    • комплектовать сложные сценарии из мелких узких ролей инструментах более высокого уровня
    • избегать написания нескольких параметров/ключей в одной строке (горизонтально); для лучшего понимания логики задач нагляднее применение вертикального перечисления параметров
    • присваивать плейбукам и задачам, короткие, но понятные для восприятия имена и описания
    • разделять задачи по настройке, разворачиванию и запуску в работу
    • Ansible декларативен (объявляет целевой результат выполнения задачи), а не императивен (не описывает выполняемые действия), поэтому использовать модуль command только в безвыходном случае; предпочитать command а не shell
    • задачи debug убирать из продуктовых плейбуков или повышать им уровень в параметре verbosity
  • Использовать факты и кеши собранных фактов

  • В части инвентори:

    • именовать ноды в инвентарном списке в легко воспринимаемом человеком виде
    • группы - чем больше, тем лучше
    • использовать один истинный источник inventory, при чём ansible может унифицировать несколько источников в один
    • динамические инвентори сокращают риски человеческих ошибок, при этом для них существует масса уже готовых модулей

Работа с репозиторием Git

Настройка игнорирования Git файлов и каталогов в файле .gitignore.