Spec-Zone.ru › Ansible 2.7

aws_rds – источник инстансов rds

  • Обзор
  • Требования
  • Параметры
  • Примеры
  • Статус

Обзор

  • Получение инстансов и кластеров из Amazon Web Services RDS.
  • Использует файл конфигурации YAML, который заканчивается на aws_rds.(yml|yaml).

Требования

Ниже перечислены требования к локальному узлу-мастеру, на котором выполняется этот инвентарь.

  • boto3
  • botocore

Параметры

Параметр Варианты/Значения по умолчанию Конфигурация Комментарии
aws_access_key_id
-
env:AWS_ACCESS_KEY_ID
env:AWS_ACCESS_KEY
env:EC2_ACCESS_KEY
AWS ключ доступа для использования. Если вы указали профиль, вам не нужно указывать ключ доступа/секретный ключ/токен сессии.
aws_secret_access_key
-
env:AWS_SECRET_ACCESS_KEY
env:AWS_SECRET_KEY
env:EC2_SECRET_KEY
AWS секретный ключ, соответствующий ключу доступа. Если вы указали профиль, вам не нужно указывать ключ доступа/секретный ключ/токен сессии.
aws_security_token
-
env:AWS_SECURITY_TOKEN
env:AWS_SESSION_TOKEN
env:EC2_SECURITY_TOKEN
AWS токен безопасности, если используется временный ключ доступа и секретный ключ.
boto_profile
-
env:AWS_PROFILE
env:AWS_DEFAULT_PROFILE
Используемый профиль boto. Плагин будет искать роль экземпляра, если учетные данные не предоставлены.
cache
boolean
По умолчанию:
"нет"
записи ini:

[инвентарь]
cache = нет

env:ANSIBLE_INVENTORY_CACHE
Включить/выключить кеширование данных источника инвентаря, для работы требуется настройка плагина кеша.
cache_connection
-
записи ini:

[инвентарь]
cache_connection = ЗНАЧЕНИЕ

env:ANSIBLE_INVENTORY_CACHE_CONNECTION
Данные подключения к кешу или путь, для получения специфики прочтите документацию к плагину кеша.
cache_plugin
-
записи ini:

[инвентарь]
cache_plugin = ЗНАЧЕНИЕ

env:ANSIBLE_INVENTORY_CACHE_PLUGIN
Плагин кеша для использования данных источника инвентаря.
cache_timeout
целое число
По умолчанию:
3600
записи ini:

[инвентарь]
cache_timeout = 3600

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
boolean
    Варианты:
  • нет ←
  • да
Включать ли запрос для Aurora кластеров, а также инстансов
keyed_groups
список
По умолчанию:
[]
добавление хостов в группу на основе значений переменной
regions
-
По умолчанию:
[]
Список областей, в которых нужно описать инстансы и кластеры RDS. Доступные регионы перечислены здесь https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
statuses
список
По умолчанию:
["создание", "доступен"]
Список желаемых состояний инстансов/кластеров для добавления в инвентарь. Для поиска всего установите ['все'].
strict
boolean
По умолчанию:
"нет"
Если true, неверные записи будут ошибкой, иначе будут пропущены и продолжены
Поскольку в выражениях можно использовать факты, они могут не всегда быть доступны, и мы игнорируем эти ошибки по умолчанию.
strict_permissions
boolean
    Варианты:
  • нет
  • да ←
По умолчанию, если возникает исключение 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

Статус

Авторы

  • 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.7/plugins/inventory/aws_rds.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API