Руководство по управлению динамическим и статическим инвентарем в Ansible

Инвентарь Ansible отвечает на один практический вопрос: к каким системам должна применяться эта автоматизация? Если ваш инвентарь неверен, даже хороший плейбук может нацелиться не на тот хост, пропустить новый сервер или использовать неправильные переменные подключения.

Это руководство охватывает статические файлы инвентаря, динамические источники инвентаря и проверки с помощью ansible-inventory, которые помогают убедиться, что Ansible видит ту же инфраструктуру, которую вы ожидаете.

Понимание инвентаря Ansible

По своей сути инвентарь Ansible — это список хостов и групп. Ansible использует эту информацию, чтобы определить, к каким машинам подключаться и на каких выполнять задачи. Расположение файла инвентаря по умолчанию — /etc/ansible/hosts, но вы можете указать другой файл инвентаря для любой команды или плейбука Ansible с помощью флага -i.

Существует два основных способа управления инвентарем:

Статический инвентарь: Это ручное определение хостов и групп в файле (формат INI или YAML).
Динамический инвентарь: Использование скриптов или плагинов для динамической генерации инвентаря хостов из внешних источников, таких как облачные провайдеры (AWS, Azure, GCP), платформы виртуализации (VMware) или CMDB.

Файлы статического инвентаря

Статические инвентари просты для сред со стабильным набором серверов. Обычно они записываются в формате, похожем на INI, или в YAML.

Формат INI

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

Пример /etc/ansible/hosts (формат INI):

[webservers]
web1.example.com
web2.example.com ansible_user=deployer

[databases]
db1.example.com
db2.example.com

[all:vars]
ansible_ssh_private_key_file=~/.ssh/id_rsa
ansible_python_interpreter=/usr/bin/python3

В этом примере:

[webservers] и [databases] определяют группы.
web1.example.com и web2.example.com — хосты в группе webservers.
ansible_user=deployer устанавливает конкретного пользователя SSH для web2.example.com.
[all:vars] определяет переменные, которые применяются ко всем хостам в инвентаре.

Формат YAML

Формат YAML обеспечивает большую гибкость для сложных структур инвентаря и определения переменных.

Пример /etc/ansible/hosts (формат YAML):

all:
  children:
    webservers:
      hosts:
        web1.example.com:
        web2.example.com:
          ansible_user: deployer
    databases:
      hosts:
        db1.example.com:
        db2.example.com:
  vars:
    ansible_ssh_private_key_file: ~/.ssh/id_rsa
    ansible_python_interpreter: /usr/bin/python3

Эта структура YAML достигает той же группировки и назначения переменных, что и пример INI.

Динамический инвентарь

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

Использование плагинов динамического инвентаря

Ansible поставляется с широким спектром встроенных плагинов динамического инвентаря для популярных облачных провайдеров и сервисов. Чтобы использовать один из них, обычно создается файл конфигурации инвентаря (часто в YAML), который указывает плагин и его параметры.

Пример: Конфигурация динамического инвентаря AWS EC2 (aws_ec2.yml)

plugin: amazon.aws.aws_ec2
regions:
  - us-east-1
  - us-west-2
keyed_groups:
  # Группировка инстансов по их тегам EC2
  - key: tags
    prefix: tag
filters:
  # Включать только работающие инстансы
  instance-state-name: running
compose:
  # Установить ansible_host на частный IP-адрес
  ansible_host: private_ip_address

Чтобы использовать это с Ansible, вы должны выполнить команду, подобную этой:

ansible-inventory -i aws_ec2.yml --graph

Эта команда запросит AWS для получения работающих инстансов в указанных регионах и отобразит их в виде иерархического графа на основе их тегов и других атрибутов.

Для многих облачных плагинов инвентаря требуется установка соответствующей коллекции. Для AWS EC2 это обычно означает amazon.aws, а также рабочие учетные данные AWS в вашем окружении, профиле или роли инстанса.

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

Если встроенный плагин не соответствует вашим потребностям, вы можете написать свой собственный скрипт (например, на Python), который выводит данные инвентаря в формате JSON. Этот скрипт должен быть исполняемым и возвращать JSON-объект, представляющий ваш инвентарь.

Пример скрипта Python (my_dynamic_inventory.py):

#!/usr/bin/env python

import json

# Имитация получения данных инвентаря
hosts_data = {
    "_meta": {
        "hostvars": {
            "host1.example.com": {"ansible_user": "admin"},
            "host2.example.com": {"ansible_user": "user"}
        }
    },
    "webservers": {
        "hosts": ["host1.example.com", "host2.example.com"]
    },
    "databases": {
        "hosts": ["db1.example.com"]
    }
}

print(json.dumps(hosts_data))

Сделайте скрипт исполняемым:

chmod +x my_dynamic_inventory.py

А затем используйте его с Ansible:

ansible-inventory -i my_dynamic_inventory.py --list

Управление инвентарем с помощью `ansible-inventory`

Команда ansible-inventory — это мощная утилита для проверки и управления вашим инвентарем. Она может анализировать различные источники инвентаря и отображать хосты и связанные с ними переменные.

Просмотр активных хостов

Чтобы увидеть плоский список всех хостов в вашем инвентаре:

ansible-inventory -i /path/to/your/inventory --list

Эта команда выведет JSON-структуру, представляющую весь ваш инвентарь, включая группы и переменные хостов.

Группировка систем

Как показано в примерах статического инвентаря, группировка необходима для нацеливания на конкретные наборы машин. Вы можете создавать группы для разных ролей (веб-серверы, базы данных, серверы приложений), сред (продакшн, стейджинг) или любой логической категоризации, которая имеет смысл для вашей инфраструктуры.

Ansible автоматически создает группы на основе вашего файла инвентаря. Вы также можете определять специальные группы, такие как all (включает каждый хост) и ungrouped (хосты, не назначенные ни в одну конкретную группу).

Использование встроенных флагов команды инвентаря

Команда ansible-inventory предлагает несколько флагов для детальной проверки:

--graph: Отображает инвентарь в виде иерархического дерева, показывая группы и их участников.

ansible-inventory -i /etc/ansible/hosts --graph

Пример вывода:

@all
├──@databases
│  ├──db1.example.com
│  └──db2.example.com
└──@webservers
   ├──web1.example.com
   └──web2.example.com

--host <hostname>: Показывает все переменные, связанные с конкретным хостом.

ansible-inventory -i /etc/ansible/hosts --host web2.example.com