aws_ec2 – Источник инвентаризации EC2
Обзор
- Получение узлов инвентаризации из Amazon Web Services EC2.
- Использует файл конфигурации YAML, который заканчивается
aws_ec2.(yml|yaml.
Требования
Ниже приведены требования к локальному мастер-узлу, на котором выполняется эта инвентаризация.
- boto3
- botocore
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| aws_access_key строка | env:EC2_ACCESS_KEY env:AWS_ACCESS_KEY env:AWS_ACCESS_KEY_ID | Ключ доступа AWS для использования. псевдонимы: aws_access_key_id | |
| aws_profile строка | env:AWS_DEFAULT_PROFILE env:AWS_PROFILE | Профиль AWS псевдонимы: boto_profile | |
| aws_secret_key строка | env:EC2_SECRET_KEY env:AWS_SECRET_KEY env:AWS_SECRET_ACCESS_KEY | Секретный ключ AWS, соответствующий ключу доступа. псевдонимы: aws_secret_access_key | |
| aws_security_token строка | env:EC2_SECURITY_TOKEN env:AWS_SESSION_TOKEN env:AWS_SECURITY_TOKEN | Токен безопасности AWS, если используется временный ключ доступа и секретный ключ. | |
| cache логическое |
| записи ini: [inventory] env:ANSIBLE_INVENTORY_CACHE | Включить/выключить кэширование исходных данных инвентаризации. Требует настройки плагина кэша для работы. |
| cache_connection строка | записи ini: [defaults] [inventory] env:ANSIBLE_CACHE_PLUGIN_CONNECTION env:ANSIBLE_INVENTORY_CACHE_CONNECTION | Данные или путь к соединению кэша. Обратитесь к документации плагина кэша для получения подробностей. | |
| cache_plugin строка | По умолчанию: "память" | записи ini: [defaults] [inventory] env:ANSIBLE_CACHE_PLUGIN env:ANSIBLE_INVENTORY_CACHE_PLUGIN | Плагин кэша для исходных данных инвентаризации. |
| cache_prefix - | По умолчанию: "ansible_inventory_" | записи ini: [default] [inventory] env:ANSIBLE_CACHE_PLUGIN_PREFIX env:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX | Префикс для файлов/таблиц плагина кэша |
| cache_timeout целое число | По умолчанию: 3600 | записи ini: [defaults] [inventory] env:ANSIBLE_CACHE_PLUGIN_TIMEOUT env:ANSIBLE_INVENTORY_CACHE_TIMEOUT | Срок действия кэша в секундах |
| compose словарь | По умолчанию: {} | Создать переменные из выражений jinja2. | |
| filters словарь | По умолчанию: {} | Словарь пар значений фильтров. Доступные фильтры перечислены здесь http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html#options. | |
| groups словарь | По умолчанию: {} | Добавить узлы в группу на основе условных операторов Jinja2. | |
| hostnames список | По умолчанию: [] | Список в порядке приоритета для переменных имен узлов. Вы можете использовать опции, указанные в http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html#options. Чтобы использовать метки в качестве имен узлов, используйте синтаксис метка:Имя=Значение для использования имени узла Имя_Значение, или метка:Имя для использования значения метки Имя. | |
| iam_role_arn - добавлен в 2.9 | ARN роли IAM для взятия на себя роли для выполнения поиска инвентаризации. Вы по-прежнему должны предоставить учетные данные AWS с достаточными привилегиями для выполнения действия AssumeRole. | ||
| include_extra_api_calls логическое добавлен в 2.8 |
| Добавление двух дополнительных вызовов API для каждого экземпляра, чтобы включить переменные узлов 'persistent' и 'events'. Экземпляры spot могут быть постоянными, и экземпляры могут иметь связанные события. | |
| keyed_groups список | По умолчанию: [] | Добавить узлы в группу на основе значений переменной. | |
| plugin - / обязательно |
| Токен, который гарантирует, что это файл источника для плагина. | |
| regions список | По умолчанию: [] | Список регионов, в которых необходимо описать экземпляры EC2. Если пусто (по умолчанию), это будет включать все регионы, за исключением, возможно, ограниченных, таких как us-gov-west-1 и cn-north-1. | |
| strict логическое |
| Если yes сделать недействительные записи ошибкой, в противном случае пропустить и продолжить.Поскольку использование фактов в выражениях возможно, они могут быть недоступны, и мы игнорируем эти ошибки по умолчанию. | |
| strict_permissions логическое |
| По умолчанию, если встречается код ошибки 403 (Запрещено), этот плагин завершится ошибкой. Вы можете установить это значение в ложное в файле конфигурации инвентаризации, что позволит избежать ошибок 403. | |
| use_contrib_script_compatible_sanitization логическое добавлен в 2.8 |
| По умолчанию этот плагин использует общую очистку имен групп для создания безопасных и пригодных для использования имен групп для использования в Ansible. Эта опция позволяет вам переопределить это, в стремлении разрешить миграцию из старого скрипта инвентаризации и соответствует очистке групп при установке опции скрипта ``replace_dash_in_groups`` в ``False``. Для воспроизведения поведения ``replace_dash_in_groups = True`` с созданными группами, вам необходимо заменить дефисы подчёркиваниями с помощью фильтра regex_replace для этих записей. Для этого вы также должны отключить установку TRANSFORM_INVALID_GROUP_CHARS, в противном случае основная программа просто использует стандартную очистку поверх. Это не по умолчанию, так как такие имена нарушают определенные функции, так как не все символы являются допустимыми идентификаторами Python, которые имена групп в конечном итоге используются как. |
Примечания
Примечание
- Если учетные данные не предоставлены, а у контрольного узла есть связанный профиль IAM, то роль будет использоваться для проверки подлинности.
Примеры
# Minimal example using environment vars or instance role credentials
# Fetch all hosts in us-east-1, the hostname is the public DNS if it exists, otherwise the private IP address
plugin: aws_ec2
regions:
- us-east-1
# Example using filters, ignoring permission errors, and specifying the hostname precedence
plugin: aws_ec2
boto_profile: aws_profile
# Populate inventory with instances in these regions
regions:
- us-east-1
- us-east-2
filters:
# All instances with their `Environment` tag set to `dev`
tag:Environment: dev
# All dev and QA hosts
tag:Environment:
- dev
- qa
instance.group-id: sg-xxxxxxxx
# Ignores 403 errors rather than failing
strict_permissions: False
# Note: I(hostnames) sets the inventory_hostname. To modify ansible_host without modifying
# inventory_hostname use compose (see example below).
hostnames:
- tag:Name=Tag1,Name=Tag2 # Return specific hosts only
- tag:CustomDNSName
- dns-name
- private-ip-address
# Example using constructed features to create groups and set ansible_host
plugin: aws_ec2
regions:
- us-east-1
- us-west-1
# keyed_groups may be used to create custom groups
strict: False
keyed_groups:
# Add e.g. x86_64 hosts to an arch_x86_64 group
- prefix: arch
key: 'architecture'
# Add hosts to tag_Name_Value groups for each Name/Value tag pair
- prefix: tag
key: tags
# Add hosts to e.g. instance_type_z3_tiny
- prefix: instance_type
key: instance_type
# Create security_groups_sg_abcd1234 group for each SG
- key: 'security_groups|json_query("[].group_id")'
prefix: 'security_groups'
# Create a group for each value of the Application tag
- key: tags.Application
separator: ''
# Create a group per region e.g. aws_region_us_east_2
- key: placement.region
prefix: aws_region
# Create a group (or groups) based on the value of a custom tag "Role" and add them to a metagroup called "project"
- key: tags['Role']
prefix: foo
parent_group: "project"
# Set individual variables with compose
compose:
# Use the private IP address to connect to the host
# (note: this does not modify inventory_hostname, which is set via I(hostnames))
ansible_host: private_ip_address
Статус
- От этой инвентаризации не гарантируется обратная совместимость интерфейса. [превью]
- Эта инвентаризация поддерживается сообществом Ansible. [сообщество]
Авторы
- Слоун Хертел (@s-hertel)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
Подсказка
Элементы конфигурации для каждого типа записи имеют порядок приоритета от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/plugins/inventory/aws_ec2.html