aws_rds – источник экземпляров rds
Обзор
- Получение экземпляров и кластеров из Amazon Web Services RDS.
- Использует файл конфигурации YAML, который заканчивается на aws_rds.(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 строка | По умолчанию: "memory" | записи 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 - | По умолчанию: {} | Словарь пар значений фильтров. Доступные фильтры перечислены здесь https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html#options. Если вы фильтруете по db-cluster-id и include_clusters имеет значение True, это будет применяться и к кластерам. | |
| groups словарь | По умолчанию: {} | Добавление хостов в группу на основе условных выражений Jinja2. | |
| include_clusters логическое |
| Включать ли запрос для Aurora-кластеров наряду с экземплярами | |
| keyed_groups список | По умолчанию: [] | Добавление хостов в группу на основе значений переменной. | |
| regions - | По умолчанию: [] | Список регионов, в которых необходимо описать экземпляры и кластеры RDS. Доступные регионы перечислены здесь https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
| |
| statuses список | По умолчанию: ["creating", "available"] | Список желаемых состояний экземпляров/кластеров для добавления в инвентаризацию. Установите ['all'] в качестве сокращения для поиска всего. | |
| strict логическое |
| Если yes сделать недопустимые записи ошибкой, в противном случае пропустить и продолжить.Поскольку возможно использовать факты в выражениях, они могут не всегда быть доступными, и мы игнорируем эти ошибки по умолчанию. | |
| strict_permissions логическое |
| По умолчанию, если встречается исключение AccessDenied, этот плагин завершит работу. Вы можете установить strict_permissions в False в файле конфигурации инвентаризации, что позволит игнорировать ограничения. |
Примеры
plugin: aws_rds
regions:
- us-east-1
- ca-central-1
keyed_groups:
- key: 'db_parameter_groups|json_query("[].db_parameter_group_name")'
prefix: rds_parameter_group
- key: engine
prefix: rds
- key: tags
- key: region
Статус
- Эта инвентаризация не гарантирует обратную совместимость. [preview]
- Эта инвентаризация поддерживается сообществом Ansible. [community]
Авторы
- Sloane Hertel (@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.8/plugins/inventory/aws_rds.html
