Spec-Zone.ru › Ansible

модуль google.cloud.gcp_compute_health_check — создание GCP HealthCheck

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

string

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

auth_kind

string / обязательный

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

Варианты:

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

check_interval_sec

integer

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

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

description

string

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

env_type

string

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

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

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

grpc_health_check

dictionary

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

grpc_service_name

string

Имя службы gRPC для проверки работоспособности.

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

- Непустое serviceName означает состояние указанной службы gRPC, определяемое владельцем службы.

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

port

integer

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

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

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.

Если значение не задано, проверка работоспособности gRPC выполняется в соответствии с поведением, заданным полями `port` и `portName`.

Допустимые варианты: «USE_FIXED_PORT», «USE_NAMED_PORT», «USE_SERVING_PORT»

healthy_threshold

integer

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

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

http2_health_check

dictionary

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

host

string

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

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

port

integer

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

Значение по умолчанию — 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.

Если значение не задано, проверка работоспособности HTTP2 выполняется в соответствии с поведением, заданным полями `port` и `portName`.

Допустимые варианты: «USE_FIXED_PORT», «USE_NAMED_PORT», «USE_SERVING_PORT»

proxy_header

string

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

Допустимые варианты: «NONE», «PROXY_V1»

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

request_path

string

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

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

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

response

string

Байты, с которыми сравнивается начало данных ответа. Если оставить поле пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут содержать только символы 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»

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

request_path

string

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

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

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

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»

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

request_path

string

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

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

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

response

string

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

log_config

dictionary

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

enable

boolean

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

Варианты:

  • false
  • true

name

string / обязательный

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 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, и port_name, приоритет имеет port.

port_specification

string

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

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

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

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

Допустимые варианты: «USE_FIXED_PORT», «USE_NAMED_PORT», «USE_SERVING_PORT»

proxy_header

string

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

Допустимые варианты: «NONE», «PROXY_V1»

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

request

string

Данные приложения, отправляемые после установления SSL-соединения (значение по умолчанию — пустая строка). Если поля request и response пусты, работоспособность будет подтверждена одним лишь установлением соединения. Данные запроса могут содержать только символы 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, и port_name, приоритет имеет port.

port_specification

string

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

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

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

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

Допустимые значения: “USE_FIXED_PORT”, “USE_NAMED_PORT”, “USE_SERVING_PORT”

proxy_header

string

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

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

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

request

string

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

response

string

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

timeout_sec

псевдонимы: 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

integer

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

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

creationTimestamp

string

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

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

description

string

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

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

grpcHealthCheck

complex

Ресурс вложенного объекта.

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

grpcServiceName

string

Имя службы gRPC для проверки работоспособности.

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

- Непустое serviceName означает состояние этой службы gRPC, определяемое ее владельцем.

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

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

port

integer

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

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

Возвращается: 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.

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

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

healthyThreshold

integer

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

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

http2HealthCheck

complex

Ресурс вложенного объекта.

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

host

string

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

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

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

port

integer

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

Значение по умолчанию — 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.

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

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

proxyHeader

string

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

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

requestPath

string

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

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

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

response

string

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

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

httpHealthCheck

complex

Ресурс вложенного объекта.

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

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-соединения (по умолчанию поле пустое). Если поля request и response пусты, работоспособность будет подтверждена одним лишь установлением соединения. Данные запроса могут содержать только символы 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

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

Возвращено: успешно

request

string

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

Возвращено: успешно

response

string

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

Возвращено: успешно

timeoutSec

integer

Время ожидания (в секундах) до фиксации сбоя.

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

Возвращено: успешно

type

string

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

Возвращено: успешно

unhealthyThreshold

integer

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

Возвращено: успешно

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

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

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

Spec-Zone.ru

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