gcp_compute_health_check – Создаёт GCP HealthCheck

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

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

Описание

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

Требования

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

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_kind - / обязательно		Варианты: machineaccount serviceaccount application	Тип используемых учетных данных.
check_interval_sec -		Значение по умолчанию: 5	Частота (в секундах) проверки состояния. Значение по умолчанию — 5 секунд.
description -			Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
healthy_threshold -			Нездоровый экземпляр будет помечен как здоровый после этого количества последовательных успехов. Значение по умолчанию — 2.
http_health_check -			Вложенный ресурс-объект.
	host -		Значение заголовка хоста в запросе проверки состояния HTTP. Если оставлено пустым (значение по умолчанию), используется общедоступный IP-адрес, от имени которого выполняется проверка состояния.
	port -		Номер TCP-порта для запроса проверки состояния HTTP. Значение по умолчанию — 80.
	port_name -		Имя порта, определенное в InstanceGroup#NamedPort#name. Если определены и port, и port_name, приоритет имеет port.
	proxy_header -	Варианты: NONE PROXY_V1	Указывает тип заголовка прокси, добавляемого перед отправкой данных на бэкенд. Может быть NONE или PROXY_V1. Значение по умолчанию — NONE.
	request_path -		Путь запроса проверки состояния HTTP. Значение по умолчанию — /.
https_health_check -			Вложенный ресурс-объект.
	host -		Значение заголовка хоста в запросе проверки состояния HTTPS. Если оставлено пустым (значение по умолчанию), используется общедоступный IP-адрес, от имени которого выполняется проверка состояния.
	port -		Номер TCP-порта для запроса проверки состояния HTTPS. Значение по умолчанию — 443.
	port_name -		Имя порта, определенное в InstanceGroup#NamedPort#name. Если определены и port, и port_name, приоритет имеет port.
	proxy_header -	Варианты: NONE PROXY_V1	Указывает тип заголовка прокси, добавляемого перед отправкой данных на бэкенд. Может быть NONE или PROXY_V1. Значение по умолчанию — NONE.
	request_path -		Путь запроса проверки состояния HTTPS. Значение по умолчанию — /.
name -			Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов, и имя должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.
project -		Значение по умолчанию: null	Проект Google Cloud Platform для использования.
scopes -			Массив используемых областей.
service_account_email -			Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.
service_account_file -			Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.
ssl_health_check -			Вложенный ресурс-объект.
	port -		Номер TCP-порта для запроса проверки состояния SSL. Значение по умолчанию — 443.
	port_name -		Имя порта, определенное в InstanceGroup#NamedPort#name. Если определены и port, и port_name, приоритет имеет port.
	proxy_header -	Варианты: NONE PROXY_V1	Указывает тип заголовка прокси, добавляемого перед отправкой данных на бэкенд. Может быть NONE или PROXY_V1. Значение по умолчанию — NONE.
	request -		Данные приложения, которые нужно отправить после установления SSL-соединения (значение по умолчанию — пустое). Если и request, и response пусты, установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII.
	response -		Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII.
state -		Варианты: present ← absent	Нужно ли данному объекту существовать в GCP
tcp_health_check -			Вложенный ресурс-объект.
	port -		Номер TCP-порта для запроса проверки состояния TCP. Значение по умолчанию — 443.
	port_name -		Имя порта, определенное в InstanceGroup#NamedPort#name. Если определены и port, и port_name, приоритет имеет port.
	proxy_header -	Варианты: NONE PROXY_V1	Указывает тип заголовка прокси, добавляемого перед отправкой данных на бэкенд. Может быть NONE или PROXY_V1. Значение по умолчанию — NONE.
	request -		Данные приложения, которые нужно отправить после установления TCP-соединения (значение по умолчанию — пустое). Если и request, и response пусты, установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII.
	response -		Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII.
timeout_sec -		Значение по умолчанию: 5	Время ожидания (в секундах) перед заявлением об ошибке. Значение по умолчанию — 5 секунд. Значение timeoutSec не должно быть больше, чем checkIntervalSec. псевдонимы: timeout_seconds
type -		Варианты: TCP SSL HTTP	Указывает тип проверки состояния, TCP, SSL, HTTP или HTTPS. Если не указано, значение по умолчанию — TCP. Должен быть указан ровно один из параметров, относящихся к протоколу, и он должен соответствовать полю type.

unhealthy_threshold

Значение по умолчанию:

В случае если инстанс ранее считался здоровым, он будет помечен как нездоровый после такого количества последовательных сбоев. Значение по умолчанию равно 2.

Примечания

Примечание

Для аутентификации можно задать service_account_file используя переменную окружения GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно задать service_account_email используя переменную окружения GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно задать auth_kind используя переменную окружения GCP_AUTH_KIND.
Для аутентификации можно задать scopes используя переменную окружения GCP_SCOPES.
Значения переменных окружения будут использованы только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a health check
  gcp_compute_health_check:
      name: "test_object"
      type: TCP
      tcp_health_check:
        port_name: service-health
        request: ping
        response: pong
      healthy_threshold: 10
      timeout_sec: 2
      unhealthy_threshold: 5
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

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

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

Ключ		Возвращено	Описание
check_interval_sec целое число		успех	Частота (в секундах) отправки проверки работоспособности. Значение по умолчанию 5 секунд.
creation_timestamp строка		успех	Дата и время создания в формате RFC3339.
description строка		успех	Необязательное описание данного ресурса. Укажите данное свойство при создании ресурса.
healthy_threshold целое число		успех	В случае если инстанс ранее считался нездоровым, он будет помечен как здоровый после такого количества последовательных успешных проверок. Значение по умолчанию равно 2.
http_health_check сложный		успех	Вложенный ресурс.
	host строка	успех	Значение заголовка host в запросе проверки работоспособности HTTP. Если оставлено пустым (значение по умолчанию), используется общедоступный IP-адрес, от имени которого выполняется проверка работоспособности.
	port целое число	успех	Номер TCP-порта для запроса проверки работоспособности HTTP. Значение по умолчанию 80.
	port_name строка	успех	Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, используется порт.
	proxy_header строка	успех	Указывает тип заголовка прокси, который необходимо добавить перед отправкой данных на бэкенд, либо NONE, либо PROXY_V1. По умолчанию NONE.
	request_path строка	успех	Путь запроса проверки работоспособности HTTP. Значение по умолчанию /.
https_health_check сложный		успех	Вложенный ресурс.
	host строка	успех	Значение заголовка host в запросе проверки работоспособности HTTPS. Если оставлено пустым (значение по умолчанию), используется общедоступный IP-адрес, от имени которого выполняется проверка работоспособности.
	port целое число	успех	Номер TCP-порта для запроса проверки работоспособности HTTPS. Значение по умолчанию 443.
	port_name строка	успех	Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, используется порт.
	proxy_header строка	успех	Указывает тип заголовка прокси, который необходимо добавить перед отправкой данных на бэкенд, либо NONE, либо PROXY_V1. По умолчанию NONE.
	request_path строка	успех	Путь запроса проверки работоспособности HTTPS. Значение по умолчанию /.
id целое число		успех	Уникальный идентификатор ресурса. Этот идентификатор определён сервером.
name строка		успех	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — тире, строчные буквы или цифры, за исключением последнего символа, который не может быть тире.
ssl_health_check сложный		успех	Вложенный ресурс.
	port целое число	успех	Номер TCP-порта для запроса проверки работоспособности SSL. Значение по умолчанию 443.
	port_name строка	успех	Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, используется порт.
	proxy_header строка	успех	Указывает тип заголовка прокси, который необходимо добавить перед отправкой данных на бэкенд, либо NONE, либо PROXY_V1. По умолчанию NONE.
	request строка	успех	Данные приложения, которые необходимо отправить после установления SSL-соединения (значение по умолчанию пустое). Если и запрос, и ответ пусты, то установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII.
	response строка	успех	Байты, с которыми нужно сравнить начало данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII.
tcp_health_check сложный		успех	Вложенный ресурс.
	port целое число	успех	Номер TCP-порта для запроса проверки работоспособности TCP. Значение по умолчанию 443.
	port_name строка	успех	Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, используется порт.
	proxy_header строка	успех	Указывает тип заголовка прокси, который необходимо добавить перед отправкой данных на бэкенд, либо NONE, либо PROXY_V1. По умолчанию NONE.
	request строка	успех	Данные приложения, которые необходимо отправить после установления TCP-соединения (значение по умолчанию пустое). Если и запрос, и ответ пусты, то установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII.
	response строка	успех	Байты, с которыми нужно сравнить начало данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII.
timeout_sec целое число		успех	Время ожидания (в секундах) перед объявлением сбоя. Значение по умолчанию 5 секунд. Значение timeoutSec не может быть больше, чем checkIntervalSec.
type строка		успех	Указывает тип проверки работоспособности, либо TCP, либо SSL, либо HTTP, либо HTTPS. Если не указано, по умолчанию TCP. Должен быть указан ровно один из полей проверки работоспособности, соответствующий типу.
unhealthy_threshold целое число		успех	В случае если инстанс ранее считался здоровым, он будет помечен как нездоровый после такого количества последовательных сбоев. Значение по умолчанию равно 2.

Статус

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

END_OF_DOCUMENT_MARKER

Авторы

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