gcp_compute_https_health_check – Создаёт GCP HttpsHealthCheck

Новая версия с 2.6.

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

Описание

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
check_interval_sec -		Частота (в секундах) отправки проверки работоспособности. Значение по умолчанию 5 секунд.
description -		Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
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 строка		Строка, представляющая содержимое файла JSON учетной записи службы. Не следует передавать это как словарь, а строку, содержащую точное содержимое файла 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_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно задать service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно задать auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно задать scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использованы только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

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

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Google Inc. (@googlecloudplatform)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

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