Spec-Zone.ru › Ansible 2.10

community.aws.route53_health_check – Добавление или удаление проверок работоспособности в службе DNS Amazon Route 53

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.route53_health_check.

Новое в версии 1.0.0: коллекции community.aws

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

Обзор

  • Создает и удаляет проверки работоспособности DNS в службе Amazon Route 53.
  • При обновлении существующих проверок работоспособности учитываются только порт, resource_path, string_match и request_interval.

Требования

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

  • python >= 2.6
  • boto

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если установлен параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_access_key и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение пакета сертификатов CA для проверки SSL-сертификатов.
Используется только для модулей на основе boto3.
Примечание: пакет CA считывается со стороны модуля и может потребоваться явное копирование с контроллера, если он не выполняется локально.
aws_config
словарь
Словарь для модификации конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. Дополнительную информацию о конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если установлен параметр profile, этот параметр игнорируется.
Одновременное указание параметров aws_secret_key и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
логический тип
    Варианты:
  • нет ←
  • да
Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время выполнения задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url
строка
URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, для которых требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть.

псевдонимы: aws_endpoint_url, endpoint_url
failure_threshold
целое число
    Варианты:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
По умолчанию:
3
Количество последовательных проверок работоспособности, которые должны пройти или завершиться неудачей для того, чтобы Amazon Route 53 изменил текущий статус конечной точки с неисправной на исправную или наоборот.
fqdn
строка
Имя домена конечной точки для проверки. Должен быть указан либо этот, либо ip_address. Когда оба указаны, `fqdn` используется в заголовке `Host:` HTTP-запроса.
ip_address
строка
IP-адрес конечной точки для проверки. Должен быть указан либо этот, либо fqdn.
port
целое число
Порт на конечной точке, на котором Amazon Route 53 должен выполнять проверки работоспособности. Требуется для проверок TCP.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка одновременного указания их вместе с profile устарела.
aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
region
строка
Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
request_interval
целое число
    Варианты:
  • 10
  • 30
По умолчанию:
30
Количество секунд между временем, когда Amazon Route 53 получает ответ от вашей конечной точки, и временем, когда он отправляет следующий запрос проверки работоспособности.
resource_path
строка
Путь, который вы хотите, чтобы Amazon Route 53 запрашивал при выполнении проверок работоспособности. Путь может иметь любое значение, для которого ваша конечная точка будет возвращать HTTP-код состояния 2xx или 3xx, когда конечная точка работоспособна, например, файл /docs/route53-health-check.html.
Требуется для всех проверок, кроме TCP.
Путь должен начинаться с /
Максимальная длина 255 символов.
security_token
строка
AWS STS security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если установлен параметр profile, этот параметр игнорируется.
Одновременное указание параметров security_token и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01.

псевдонимы: aws_security_token, access_token
state
строка
    Варианты:
  • present ←
  • absent
Указывает действие, которое нужно выполнить.
string_match
строка
Если тип проверки равен HTTP_STR_MATCH или HTTP_STR_MATCH, строка, которую вы хотите, чтобы Amazon Route 53 искал в теле ответа от указанного ресурса. Если строка появляется в первых 5120 байтах тела ответа, Amazon Route 53 считает ресурс работоспособным.
type
строка / обязательно
    Варианты:
  • HTTP
  • HTTPS
  • HTTP_STR_MATCH
  • HTTPS_STR_MATCH
  • TCP
Тип проверки работоспособности, который вы хотите создать, показывающий, как Amazon Route 53 определяет, работоспособна ли конечная точка.
validate_certs
логический тип
    Варианты:
  • нет
  • да ←
При установке значения «нет», SSL-сертификаты для версий boto >= 2.6.0 не будут проверены.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
  • Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

- name: Create a health-check for host1.example.com and use it in record
  community.aws.route53_health_check:
    state: present
    fqdn: host1.example.com
    type: HTTP_STR_MATCH
    resource_path: /
    string_match: "Hello"
    request_interval: 10
    failure_threshold: 2
  register: my_health_check

- community.aws.route53:
    action: create
    zone: "example.com"
    type: CNAME
    record: "www.example.com"
    value: host1.example.com
    ttl: 30
    # Routing policy
    identifier: "host1@www"
    weight: 100
    health_check: "{{ my_health_check.health_check.id }}"

- name: Delete health-check
  community.aws.route53_health_check:
    state: absent
    fqdn: host1.example.com

Авторы

  • zimbatm (@zimbatm)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/route53_health_check_module.html

Spec-Zone.ru

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