Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_health_check – Создаёт GCP HealthCheck

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: google.cloud.gcp_compute_health_check.

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

Обзор

  • Проверки работоспособности определяют, готовы ли экземпляры к работе и отвечают ли на запросы.
  • Они являются важной частью комплексной конфигурации балансировки нагрузки, так как позволяют контролировать экземпляры за балансировщиками нагрузки.
  • Проверки работоспособности проверяют экземпляры через заданные интервалы. Экземпляры, которые не отвечают на запросы в течение некоторого количества проверок подряд, отмечаются как неработоспособные. К неработоспособным экземплярам не отправляются новые соединения, хотя существующие соединения будут продолжены. Проверка работоспособности будет продолжать проверять неработоспособные экземпляры. Если экземпляр позже успешно ответит на некоторое количество последовательных проверок, он снова будет помечен как работоспособный и сможет принимать новые соединения.
  • ~>**ПРИМЕЧАНИЕ**: Устаревшие HTTP(S) проверки работоспособности должны использоваться для балансировщиков сети на основе целевых пулов. Обратитесь к [официальному руководству](https://cloud.google.com/load-balancing/docs/health-check-concepts#selecting_hc) для выбора типа проверки работоспособности.

Требования

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

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

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

строка / обязательно

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

check_interval_sec

целое число

Как часто (в секундах) отправлять проверку состояния. Значение по умолчанию — 5 секунд.

По умолчанию: 5

description

строка

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

env_type

строка

Указывает, в какой среде Ansible выполняется этот модуль.

Не устанавливайте это значение, если вы не знаете, что делаете.

Это изменяет только строку User Agent для всех запросов к API.

grpc_health_check

словарь

Вложенный ресурс.

grpc_service_name

строка

Имя gRPC-сервиса для проверки состояния.

Значение grpcServiceName имеет следующие значения по соглашению: - Пустое значение serviceName означает общее состояние всех сервисов на бэкенде.

  • Непустое значение serviceName означает состояние данного gRPC-сервиса, определенного владельцем сервиса.

grpcServiceName может содержать только символы ASCII.

port

целое число

Номер порта для запроса проверки состояния.

Должен быть указан, если portName и portSpecification не установлены или если port_specification равно USE_FIXED_PORT. Допустимые значения — от 1 до 65535.

port_name

строка

Имя порта, определенное в InstanceGroup#NamedPort#name. Если заданы port и port_name, имеет приоритет port.

port_specification

строка

Определяет, как выбирается порт для проверки состояния, может иметь следующие значения: * `USE_FIXED_PORT`: Используется номер порта из `port` для проверки состояния.

* `USE_NAMED_PORT`: Используется `portName` для проверки состояния.

* `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого узла, для проверки состояния. Для других бэкендов используется порт или имя порта, указанные в Backend Service для проверки состояния.

Если не указано, проверка состояния gRPC следует поведению, заданному в полях `port` и `portName`.

Некоторые допустимые значения включают: “USE_FIXED_PORT”, “USE_NAMED_PORT”, “USE_SERVING_PORT”

healthy_threshold

целое число

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

По умолчанию: 2

http2_health_check

словарь

Вложенный ресурс.

host

строка

Значение заголовка host в запросе проверки состояния HTTP2.

Если поле оставлено пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка состояния.

port

целое число

Номер TCP-порта для запроса проверки состояния HTTP2.

Значение по умолчанию — 443.

port_name

строка

Имя порта, определенное в InstanceGroup#NamedPort#name. Если заданы port и port_name, имеет приоритет port.

port_specification

строка

Определяет, как выбирается порт для проверки состояния, может иметь следующие значения: * `USE_FIXED_PORT`: Используется номер порта из `port` для проверки состояния.

* `USE_NAMED_PORT`: Используется `portName` для проверки состояния.

* `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого узла, для проверки состояния. Для других бэкендов используется порт или имя порта, указанные в Backend Service для проверки состояния.

Если не указано, проверка состояния HTTP2 следует поведению, заданному в полях `port` и `portName`.

Некоторые допустимые значения включают: “USE_FIXED_PORT”, “USE_NAMED_PORT”, “USE_SERVING_PORT”

proxy_header

строка

Указывает тип заголовка прокси, который нужно добавить перед отправкой данных на бэкенд.

Некоторые допустимые значения включают: “NONE”, “PROXY_V1”

По умолчанию: "NONE"

request_path

строка

Путь запроса для проверки состояния HTTP2.

Значение по умолчанию — /.

По умолчанию: "/"

response

строка

Байты для сопоставления с началом данных ответа. Если поле оставлено пустым (значение по умолчанию), любой ответ укажет на состояние работоспособности. Данные ответа могут содержать только символы ASCII.

http_health_check

dictionary

Вложенный объектный ресурс.

host

string

Значение заголовка host в запросе проверки состояния HTTP.

Если оставлено пустым (значение по умолчанию), будет использоваться публичный IP-адрес, от имени которого выполняется эта проверка состояния.

port

integer

Номер TCP-порта для запроса проверки состояния HTTP.

Значение по умолчанию — 80.

port_name

string

Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.

port_specification

string

Указывает, как выбирается порт для проверки состояния, может быть одним из следующих значений: * `USE_FIXED_PORT`: для проверки состояния используется номер порта в `port`.

* `USE_NAMED_PORT`: для проверки состояния используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup для проверки состояния используется порт, указанный для каждой конечной точки сети. Для других бэкэндов для проверки состояния используется порт или именованный порт, указанный в службе Backend Service.

Если не указано, проверка состояния HTTP следует поведению, указанному в полях `port` и `portName`.

Некоторые допустимые варианты включают: “USE_FIXED_PORT”, “USE_NAMED_PORT”, “USE_SERVING_PORT”

proxy_header

string

Указывает тип заголовка прокси-сервера, который необходимо добавить перед отправкой данных в бэкэнд.

Некоторые допустимые варианты включают: “NONE”, “PROXY_V1”

Default: "NONE"

request_path

string

Путь запроса для запроса проверки состояния HTTP.

Значение по умолчанию — /.

Default: "/"

response

string

Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.

https_health_check

dictionary

Вложенный объектный ресурс.

host

string

Значение заголовка host в запросе проверки состояния HTTPS.

Если оставлено пустым (значение по умолчанию), будет использоваться публичный IP-адрес, от имени которого выполняется эта проверка состояния.

port

integer

Номер TCP-порта для запроса проверки состояния HTTPS.

Значение по умолчанию — 443.

port_name

string

Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.

port_specification

string

Указывает, как выбирается порт для проверки состояния, может быть одним из следующих значений: * `USE_FIXED_PORT`: для проверки состояния используется номер порта в `port`.

* `USE_NAMED_PORT`: для проверки состояния используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup для проверки состояния используется порт, указанный для каждой конечной точки сети. Для других бэкэндов для проверки состояния используется порт или именованный порт, указанный в службе Backend Service.

Если не указано, проверка состояния HTTPS следует поведению, указанному в полях `port` и `portName`.

Некоторые допустимые варианты включают: “USE_FIXED_PORT”, “USE_NAMED_PORT”, “USE_SERVING_PORT”

proxy_header

string

Указывает тип заголовка прокси-сервера, который необходимо добавить перед отправкой данных в бэкэнд.

Некоторые допустимые варианты включают: “NONE”, “PROXY_V1”

Default: "NONE"

request_path

string

Путь запроса для запроса проверки состояния HTTPS.

Значение по умолчанию — /.

Default: "/"

response

string

Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.

log_config

dictionary

Настройка ведения журнала для этой проверки состояния.

enable

boolean

Указывает, следует ли экспортировать журналы. По умолчанию это значение false, что означает, что ведение журнала проверки состояния выполняться не будет.

Choices:

  • false ← (default)
  • true

name

string / required

Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна составлять от 1 до 63 символов, и оно должно соответствовать RFC1035. В частности, длина имени должна составлять от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

project

string

Проект Google Cloud Platform, который нужно использовать.

scopes

list / elements=string

Массив областей, которые будут использоваться.

service_account_contents

jsonarg

Содержимое файла JSON учетной записи сервиса, либо в виде словаря, либо как JSON-строка, представляющая его.

service_account_email

string

Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount и пользователь не хочет использовать значение по умолчанию.

service_account_file

path

Путь к файлу JSON учетной записи сервиса, если serviceaccount выбран в качестве типа.

ssl_health_check

dictionary

Вложенный ресурс объекта.

port

integer

Номер TCP-порта для запроса проверки состояния SSL.

Значение по умолчанию — 443.

port_name

string

Имя порта, определенное в InstanceGroup#NamedPort#name. Если заданы как порт, так и имя порта, приоритет имеет порт.

port_specification

string

Определяет, как выбирается порт для проверки состояния, может принимать следующие значения: * `USE_FIXED_PORT`: Номер порта в `port` используется для проверки состояния.

* `USE_NAMED_PORT`: Имя порта `portName` используется для проверки состояния.

* `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого конечного узла, для проверки состояния. Для других бэкэндов используется порт или имя порта, указанные в службе бэкэнда для проверки состояния.

Если не указано, проверка состояния SSL следует поведению, указанному в `port` и `portName`.

Некоторые допустимые значения: «USE_FIXED_PORT», «USE_NAMED_PORT», «USE_SERVING_PORT»

proxy_header

string

Указывает тип прокси-заголовка, который необходимо добавить перед отправкой данных в бэкэнд.

Допустимые значения: «NONE», «PROXY_V1»

По умолчанию: "NONE"

request

string

Данные приложения, отправляемые после установления соединения SSL (значение по умолчанию — пустая строка). Если и запрос, и ответ пустые, установление соединения будет свидетельствовать о работоспособности. Данные запроса могут быть только ASCII.

response

string

Байты, которые нужно сопоставить с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ указывает на работоспособность. Данные ответа могут быть только ASCII.

state

string

Указывает, должен ли данный объект существовать в GCP

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tcp_health_check

dictionary

Вложенный ресурс объекта.

port

integer

Номер TCP-порта для запроса проверки состояния TCP.

Значение по умолчанию — 443.

port_name

string

Имя порта, определенное в InstanceGroup#NamedPort#name. Если заданы как порт, так и имя порта, приоритет имеет порт.

port_specification

string

Определяет, как выбирается порт для проверки состояния, может принимать следующие значения: * `USE_FIXED_PORT`: Номер порта в `port` используется для проверки состояния.

* `USE_NAMED_PORT`: Имя порта `portName` используется для проверки состояния.

* `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого конечного узла, для проверки состояния. Для других бэкэндов используется порт или имя порта, указанные в службе бэкэнда для проверки состояния.

Если не указано, проверка состояния TCP следует поведению, указанному в `port` и `portName`.

Некоторые допустимые значения: «USE_FIXED_PORT», «USE_NAMED_PORT», «USE_SERVING_PORT»

proxy_header

string

Указывает тип прокси-заголовка, который необходимо добавить перед отправкой данных в бэкэнд.

Допустимые значения: «NONE», «PROXY_V1»

По умолчанию: "NONE"

request

string

Данные приложения, отправляемые после установления TCP-соединения (значение по умолчанию — пустая строка). Если и запрос, и ответ пустые, установление соединения будет свидетельствовать о работоспособности. Данные запроса могут быть только ASCII.

response

string

Байты, которые нужно сопоставить с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ указывает на работоспособность. Данные ответа могут быть только ASCII.

timeout_sec

aliases: timeout_seconds

integer

Сколько времени (в секундах) ждать, прежде чем считать попытку неудачной.

Значение по умолчанию — 5 секунд. Значение timeoutSec не должно быть больше checkIntervalSec.

По умолчанию: 5

type

string

Указывает тип healthCheck: TCP, SSL, HTTP или HTTPS. Если не указано, используется значение по умолчанию TCP. Должен быть указан ровно один из параметров, специфичных для протокола, который должен соответствовать полю type.

Некоторые допустимые значения: «TCP», «SSL», «HTTP», «HTTPS», «HTTP2»

unhealthy_threshold

integer

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

По умолчанию: 2

Примечания

Примечание

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

Примеры

- name: create a health check
  google.cloud.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: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

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

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

Ключ

Описание

checkIntervalSec

целое число

Как часто (в секундах) отправлять проверку состояния. Значение по умолчанию — 5 секунд.

Возвращается: успех

creationTimestamp

строка

Дата и время создания в формате RFC3339.

Возвращается: успех

description

строка

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

Возвращается: успех

grpcHealthCheck

сложный

Вложенный ресурс.

Возвращается: успех

grpcServiceName

строка

Имя gRPC-сервиса для проверки состояния.

Значение grpcServiceName имеет следующее значение по соглашению: - Пустое имя сервиса означает общий статус всех сервисов на бэкенде.

  • Непустое имя сервиса означает состояние этого gRPC-сервиса, как определено владельцем сервиса.

grpcServiceName может содержать только ASCII символы.

Возвращается: успех

port

целое число

Номер порта для запроса проверки состояния.

Должен быть указан, если portName и portSpecification не заданы или если port_specification равно USE_FIXED_PORT. Допустимые значения — от 1 до 65535.

Возвращается: успех

portName

строка

Имя порта, как определено в InstanceGroup#NamedPort#name. Если заданы как port, так и port_name, приоритет имеет port.

Возвращается: успех

portSpecification

строка

Указывает, как выбирается порт для проверки состояния, может принимать следующие значения: * `USE_FIXED_PORT`: Используется номер порта из `port` для проверки состояния.

* `USE_NAMED_PORT`: Используется `portName` для проверки состояния.

* `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого конечного узла, для проверки состояния. Для других бэкендов используется порт или имя порта, указанные в Backend Service, для проверки состояния.

Если не указано, проверка состояния gRPC следует поведению, указанному в полях `port` и `portName`.

Возвращается: успех

healthyThreshold

целое число

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

Возвращается: успех

http2HealthCheck

сложный

Вложенный ресурс.

Возвращается: успех

host

строка

Значение заголовка host в запросе HTTP2 проверки состояния.

Если оставлено пустым (значение по умолчанию), используется общедоступный IP-адрес от имени, от которого выполняется эта проверка состояния.

Возвращается: успех

port

целое число

Номер TCP-порта для запроса HTTP2 проверки состояния.

Значение по умолчанию — 443.

Возвращается: успех

portName

строка

Имя порта, как определено в InstanceGroup#NamedPort#name. Если заданы как port, так и port_name, приоритет имеет port.

Возвращается: успех

portSpecification

строка

Указывает, как выбирается порт для проверки состояния, может принимать следующие значения: * `USE_FIXED_PORT`: Используется номер порта из `port` для проверки состояния.

* `USE_NAMED_PORT`: Используется `portName` для проверки состояния.

* `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого конечного узла, для проверки состояния. Для других бэкендов используется порт или имя порта, указанные в Backend Service, для проверки состояния.

Если не указано, проверка состояния HTTP2 следует поведению, указанному в полях `port` и `portName`.

Возвращается: успех

proxyHeader

строка

Указывает тип заголовка прокси, который нужно добавить перед отправкой данных на бэкенд.

Возвращается: успех

requestPath

строка

Путь запроса для проверки состояния HTTP2.

Значение по умолчанию — /.

Возвращается: успех

response

строка

Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ указывает на работоспособность. Данные ответа могут содержать только ASCII символы.

Возвращается: успех

httpHealthCheck

сложный

Вложенный ресурс.

Возвращается: успех

host

string

Значение заголовка host в запросе HTTP-проверки работоспособности.

Если оставлено пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.

Возвращается: success

port

integer

Номер TCP-порта для запроса HTTP-проверки работоспособности.

Значение по умолчанию — 80.

Возвращается: success

portName

string

Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.

Возвращается: success

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности; может иметь одно из следующих значений: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта в поле `port`.

* `USE_NAMED_PORT`: для проверки работоспособности используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup для проверки работоспособности используется порт, указанный для каждой конечной точки сети. Для других бэкендов для проверки работоспособности используется порт или именованный порт, указанный в службе Backend Service.

Если не указано, HTTP-проверка работоспособности следует поведению, указанному в полях `port` и `portName`.

Возвращается: success

proxyHeader

string

Указывает тип заголовка прокси-сервера, который необходимо добавить перед отправкой данных в бэкенд.

Возвращается: success

requestPath

string

Путь запроса в запросе HTTP-проверки работоспособности.

Значение по умолчанию — /.

Возвращается: success

response

string

Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.

Возвращается: success

httpsHealthCheck

complex

Вложенный объектный ресурс.

Возвращается: success

host

string

Значение заголовка host в запросе HTTPS-проверки работоспособности.

Если оставлено пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.

Возвращается: success

port

integer

Номер TCP-порта для запроса HTTPS-проверки работоспособности.

Значение по умолчанию — 443.

Возвращается: success

portName

string

Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.

Возвращается: success

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности; может иметь одно из следующих значений: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта в поле `port`.

* `USE_NAMED_PORT`: для проверки работоспособности используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup для проверки работоспособности используется порт, указанный для каждой конечной точки сети. Для других бэкендов для проверки работоспособности используется порт или именованный порт, указанный в службе Backend Service.

Если не указано, HTTPS-проверка работоспособности следует поведению, указанному в полях `port` и `portName`.

Возвращается: success

proxyHeader

string

Указывает тип заголовка прокси-сервера, который необходимо добавить перед отправкой данных в бэкенд.

Возвращается: success

requestPath

string

Путь запроса в запросе HTTPS-проверки работоспособности.

Значение по умолчанию — /.

Возвращается: success

response

string

Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.

Возвращается: success

id

integer

Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.

Возвращается: success

logConfig

complex

Настройка ведения журнала для этой проверки работоспособности.

Возвращается: success

enable

boolean

Указывает, следует ли экспортировать журналы. По умолчанию это значение равно false, что означает, что ведение журнала проверки работоспособности выполняться не будет.

Возвращается: success

name

string

Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

Возвращено: success

sslHealthCheck

complex

Вложенный объектный ресурс.

Возвращено: success

port

integer

Номер TCP-порта для запроса проверки работоспособности SSL.

Значение по умолчанию — 443.

Возвращено: success

portName

string

Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.

Возвращено: success

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности, может быть одним из следующих значений: * `USE_FIXED_PORT`: Номер порта в `port` используется для проверки работоспособности.

* `USE_NAMED_PORT`: `portName` используется для проверки работоспособности.

* `USE_SERVING_PORT`: Для NetworkEndpointGroup для проверки работоспособности используется номер порта, указанный для каждой конечной точки сети. Для других бэкэндов используется порт или именованный порт, указанный в службе Backend Service.

Если не указано, проверка работоспособности SSL следует поведению, указанному в полях `port` и `portName`.

Возвращено: success

proxyHeader

string

Указывает тип заголовка прокси-сервера, который необходимо добавить перед отправкой данных в бэкэнд.

Возвращено: success

request

string

Прикладные данные для отправки после установления SSL-соединения (значение по умолчанию пустое). Если и запрос, и ответ пусты, само установление соединения будет указывать на работоспособность. Данные запроса могут быть только ASCII.

Возвращено: success

response

string

Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.

Возвращено: success

tcpHealthCheck

complex

Вложенный объектный ресурс.

Возвращено: success

port

integer

Номер TCP-порта для запроса проверки работоспособности TCP.

Значение по умолчанию — 443.

Возвращено: success

portName

string

Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port.

Возвращено: success

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности, может быть одним из следующих значений: * `USE_FIXED_PORT`: Номер порта в `port` используется для проверки работоспособности.

* `USE_NAMED_PORT`: `portName` используется для проверки работоспособности.

* `USE_SERVING_PORT`: Для NetworkEndpointGroup для проверки работоспособности используется номер порта, указанный для каждой конечной точки сети. Для других бэкэндов используется порт или именованный порт, указанный в службе Backend Service.

Если не указано, проверка работоспособности TCP следует поведению, указанному в полях `port` и `portName`.

Возвращено: success

proxyHeader

string

Указывает тип заголовка прокси-сервера, который необходимо добавить перед отправкой данных в бэкэнд.

Возвращено: success

request

string

Прикладные данные для отправки после установления TCP-соединения (значение по умолчанию пустое). Если и запрос, и ответ пусты, само установление соединения будет указывать на работоспособность. Данные запроса могут быть только ASCII.

Возвращено: success

response

string

Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут быть только ASCII.

Возвращено: success

timeoutSec

integer

Сколько времени (в секундах) ждать, прежде чем объявить об ошибке.

Значение по умолчанию — 5 секунд. Недопустимо, чтобы timeoutSec имело значение больше, чем checkIntervalSec.

Возвращено: success

type

string

Указывает тип healthCheck, TCP, SSL, HTTP или HTTPS. Если не указано, по умолчанию используется TCP. Должно быть указано ровно одно из полей проверки работоспособности, специфичных для протокола, которое должно соответствовать полю type.

Возвращено: success

unhealthyThreshold

целое число

Инстанция, которая до этого времени работала стабильно, будет помечена как неисправная после этого количества последовательных сбоев. Значение по умолчанию — 2.

Возвращаемое значение: успех

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на сборку

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (Исходные коды)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_health_check_module.html

Spec-Zone.ru

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