Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

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

Новое в версии 1.0.0: из community.aws

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

Обзор

  • Создаёт и удаляет проверки работоспособности DNS в сервисе Amazon Route53.
  • При обновлении существующих проверок работоспособности учитываются только параметры port, 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
путь
Расположение файла сертификата корневого центра для проверки SSL-сертификатов.
Используется только для модулей на основе boto3.
Примечание: Файл сертификата читается со стороны модуля и может потребоваться его явное копирование с контроллера, если модуль не запускается локально.
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:action", осуществлённых во время задачи, выводить набор в ключ 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 должны быть указаны. Если оба значения указаны, в заголовке HTTP-запроса используется `fqdn` в `Host:`.
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. Если не задан, используется значение переменной окружения 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 или HTTPS_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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/route53_health_check_module.html

Spec-Zone.ru

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