google.cloud.gcp_compute_https_health_check – Создаёт GCP HttpsHealthCheck

Примечание

Этот плагин входит в состав коллекции google.cloud (версия 1.0.2).

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_compute_https_health_check.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Ресурс HttpsHealthCheck. Этот ресурс определяет шаблон проверки работоспособности отдельных виртуальных машин через HTTPS.

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
check_interval_sec целое число		Периодичность (в секундах) отправки проверки работоспособности. Значение по умолчанию — 5 секунд.
description строка		Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
env_type строка		Указывает, в какой среде Ansible вы запускаете этот модуль. Это значение не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
healthy_threshold целое число		Неустойчивый экземпляр будет помечен как устойчивый после этого количества последовательных успехов. Значение по умолчанию — 2.
host строка		Значение заголовка host в запросе проверки работоспособности HTTPS. Если поле оставлено пустым (значение по умолчанию), будет использован общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.
name строка / обязательно		Имя ресурса. Клиент предоставляет его при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
port целое число		Номер TCP-порта для запроса проверки работоспособности HTTPS. Значение по умолчанию — 80.
project строка		Проект Google Cloud Platform для использования.
request_path строка		Путь запроса для проверки работоспособности HTTPS. Значение по умолчанию — /.
scopes список / элементы=строка		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, либо в виде словаря, либо как строка JSON, представляющая его.
service_account_email строка		Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
state строка	Варианты: present ← absent	Необходимо ли существование данного объекта в GCP
timeout_sec целое число		Время ожидания (в секундах) перед признанием ошибки. Значение по умолчанию — 5 секунд. Недопустимо, чтобы timeoutSec было больше, чем checkIntervalSec. псевдонимы: timeout_seconds
unhealthy_threshold целое число		Устойчивый экземпляр будет помечен как неустойчивый после этого количества последовательных ошибок. Значение по умолчанию — 2.

Примечания

Примечание

Ссылка на API: https://cloud.google.com/compute/docs/reference/v1/httpsHealthChecks
Добавление проверок работоспособности: https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks
для аутентификации можно установить service_account_file, используя переменную среды gcp_service_account_file.
для аутентификации можно установить service_account_contents, используя переменную среды GCP_SERVICE_ACCOUNT_CONTENTS.
для аутентификации можно установить service_account_email, используя переменную среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind, используя переменную среды GCP_AUTH_KIND.
для аутентификации можно установить scopes, используя переменную среды GCP_SCOPES.
Значения переменных среды будут использоваться только в том случае, если значения в книге задач не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a HTTPS health check
  google.cloud.gcp_compute_https_health_check:
    name: test_object
    healthy_threshold: 10
    port: 8080
    timeout_sec: 2
    unhealthy_threshold: 5
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Возвращаемые значения

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
checkIntervalSec целое число	success	Периодичность (в секундах) отправки проверки работоспособности. Значение по умолчанию — 5 секунд.
creationTimestamp строка	success	Дата и время создания в формате RFC3339.
description строка	success	Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
healthyThreshold целое число	success	Неустойчивый экземпляр будет помечен как устойчивый после этого количества последовательных успехов. Значение по умолчанию — 2.
host строка	success	Значение заголовка host в запросе проверки работоспособности HTTPS. Если поле оставлено пустым (значение по умолчанию), будет использован общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.
id целое число	success	Уникальный идентификатор ресурса. Этот идентификатор задаётся сервером.
name строка	success	Имя ресурса. Клиент предоставляет его при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
port целое число	success	Номер TCP-порта для запроса проверки работоспособности HTTPS. Значение по умолчанию — 80.
requestPath строка	success	Путь запроса для проверки работоспособности HTTPS. Значение по умолчанию — /.
timeoutSec целое число	success	Время ожидания (в секундах) перед признанием ошибки. Значение по умолчанию — 5 секунд. Недопустимо, чтобы timeoutSec было больше, чем checkIntervalSec.
unhealthyThreshold целое число	success	Устойчивый экземпляр будет помечен как неустойчивый после этого количества последовательных ошибок. Значение по умолчанию — 2.

Авторы

Google Inc. (@googlecloudplatform)

© 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/google/cloud/gcp_compute_https_health_check_module.html