gcp_compute_http_health_check – Создаёт GCP HttpHealthCheck

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

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

Описание

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

Требования

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
check_interval_sec -	По умолчанию: "5"	Периодичность проверок состояния (в секундах). Значение по умолчанию — 5 секунд. псевдонимы: check_interval_seconds
description -		Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.
healthy_threshold -		Состояние нездоровой до сих пор инстанции будет считаться здоровой после указанного количества последовательных успешных проверок. Значение по умолчанию — 2.
host -		Значение заголовка host в запросе HTTP для проверки состояния. Если оставлено пустым (по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка состояния.
name - / обязательно		Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие — тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
port -		Номер TCP-порта для запроса HTTP-проверки состояния. Значение по умолчанию — 80.
project строка		Проект Google Cloud Platform, который будет использоваться.
request_path -		Путь запроса HTTP-проверки состояния. Значение по умолчанию — /.
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/httpHealthChecks
Добавление проверок состояния: 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 http health check
  gcp_compute_http_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 в запросе HTTP для проверки состояния. Если оставлено пустым (по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка состояния.
id целое число	success	Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.
name строка	success	Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие — тире, строчной буквой или цифрой, за исключением последнего символа, который не может быть тире.
port целое число	success	Номер TCP-порта для запроса HTTP-проверки состояния. Значение по умолчанию — 80.
requestPath строка	success	Путь запроса HTTP-проверки состояния. Значение по умолчанию — /.
timeoutSec целое число	success	Время ожидания (в секундах) перед признанием ошибки. Значение по умолчанию — 5 секунд. Значение timeoutSec не может быть больше checkIntervalSec.
unhealthyThreshold целое число	success	Состояние здоровой до сих пор инстанции будет считаться нездоровой после указанного количества последовательных сбоев. Значение по умолчанию — 2.

Статус

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

Авторы

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_http_health_check_module.html