google.cloud.gcp_compute_health_check_info – Сбор информации о проверке состояния GCP
Примечание
Этот плагин входит в коллекцию google.cloud (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install google.cloud.
Для использования в плейбуке укажите: google.cloud.gcp_compute_health_check_info.
Обзор
- Сбор информации о проверке состояния GCP HealthCheck
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. |
| env_type строка | Указывает, в какой среде Ansible выполняется этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API. | |
| filters список / элементы=строка | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2). | |
| project строка | Проект Google Cloud Platform, который нужно использовать. | |
| scopes список / элементы=строка | Массив используемых областей | |
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в словаре, либо в строке JSON, представляющей его. | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- для аутентификации можно установить service_account_file, используя переменную среды
gcp_service_account_file. - для аутентификации можно установить service_account_contents, используя переменную среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения плейбука не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: get info on a health check
gcp_compute_health_check_info:
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны в этом месте, следующие — это поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| resources complex | всегда | Список ресурсов | ||
| checkIntervalSec integer | успех | Как часто (в секундах) отправлять проверку работоспособности. Значение по умолчанию - 5 секунд. | ||
| creationTimestamp string | успех | Маркер создания в формате RFC3339. | ||
| description string | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| grpcHealthCheck complex | успех | Вложенный ресурс объекта. | ||
| grpcServiceName string | успех | Имя gRPC-службы для проверки работоспособности. Значение grpcServiceName по умолчанию имеет следующие значения: - Пустое имя службы означает общий статус всех служб на бэкенде. - Непустое имя службы означает работоспособность конкретной gRPC-службы, определенной владельцем службы. Имя grpcServiceName может содержать только символы ASCII. | ||
| port integer | успех | Номер порта для запроса проверки работоспособности. Должен быть указан, если portName и portSpecification не заданы или если port_specification равен USE_FIXED_PORT. Допустимые значения - от 1 до 65535. | ||
| portName string | успех | Имя порта, определенное в InstanceGroup#NamedPort#name. Если оба port и port_name определены, приоритет отдается port. | ||
| portSpecification string | успех | Указывает, как выбирается порт для проверки работоспособности. Может принимать следующие значения: * `USE_FIXED_PORT`: Используется номер порта из `port` для проверки работоспособности. * `USE_NAMED_PORT`: Используется `portName` для проверки работоспособности. * `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого узла, для проверки работоспособности. Для других бэкендов используется порт или имя порта, указанные в Backend Service для проверки работоспособности. Если не указано, проверка gRPC работоспособности следует поведению, указанному в полях `port` и `portName`. | ||
| healthyThreshold integer | успех | Неработающий до сих пор экземпляр будет помечен как работающий после этого количества последовательных успехов. Значение по умолчанию - 2. | ||
| http2HealthCheck complex | успех | Вложенный ресурс объекта. | ||
| host string | успех | Значение заголовка host в запросе проверки работоспособности HTTP2. Если оставлено пустым (значение по умолчанию), будет использован публичный IP-адрес от имени, от которого выполняется проверка работоспособности. | ||
| port integer | успех | Номер TCP-порта для запроса проверки работоспособности HTTP2. Значение по умолчанию - 443. | ||
| portName string | успех | Имя порта, определенное в InstanceGroup#NamedPort#name. Если оба port и port_name определены, приоритет отдается port. | ||
| portSpecification string | успех | Указывает, как выбирается порт для проверки работоспособности. Может принимать следующие значения: * `USE_FIXED_PORT`: Используется номер порта из `port` для проверки работоспособности. * `USE_NAMED_PORT`: Используется `portName` для проверки работоспособности. * `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого узла, для проверки работоспособности. Для других бэкендов используется порт или имя порта, указанные в Backend Service для проверки работоспособности. Если не указано, проверка HTTP2 работоспособности следует поведению, указанному в полях `port` и `portName`. | ||
| proxyHeader string | успех | Указывает тип заголовка прокси, который будет добавлен перед отправкой данных на бэкенд. | ||
| requestPath string | успех | Путь запроса для проверки работоспособности HTTP2. Значение по умолчанию - /. | ||
| response string | успех | Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ указывает работоспособность. Данные ответа могут содержать только символы ASCII. | ||
| httpHealthCheck complex | успех | Вложенный ресурс объекта. | ||
| host string | успех | Значение заголовка host в запросе проверки работоспособности HTTP. Если оставлено пустым (значение по умолчанию), будет использован публичный IP-адрес от имени, от которого выполняется проверка работоспособности. | ||
| port integer | успех | Номер TCP-порта для запроса проверки работоспособности HTTP. Значение по умолчанию - 80. | ||
| portName string | успех | Имя порта, определенное в InstanceGroup#NamedPort#name. Если оба port и port_name определены, приоритет отдается port. | ||
| portSpecification string | успех | Указывает, как выбирается порт для проверки работоспособности. Может принимать следующие значения: * `USE_FIXED_PORT`: Используется номер порта из `port` для проверки работоспособности. * `USE_NAMED_PORT`: Используется `portName` для проверки работоспособности. * `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого узла, для проверки работоспособности. Для других бэкендов используется порт или имя порта, указанные в Backend Service для проверки работоспособности. Если не указано, проверка HTTP работоспособности следует поведению, указанному в полях `port` и `portName`. | ||
| proxyHeader string | успех | Указывает тип заголовка прокси, который будет добавлен перед отправкой данных на бэкенд. | ||
| requestPath string | успех | Путь запроса для проверки работоспособности HTTP. Значение по умолчанию - /. | ||
| response string | успех | Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ указывает работоспособность. Данные ответа могут содержать только символы ASCII. | ||
| httpsHealthCheck complex | успех | Вложенный ресурс объекта. | ||
| host string | успех | Значение заголовка host в запросе проверки работоспособности HTTPS. Если оставлено пустым (значение по умолчанию), будет использован публичный IP-адрес от имени, от которого выполняется проверка работоспособности. | ||
| port integer | успех | Номер TCP-порта для запроса проверки работоспособности HTTPS. Значение по умолчанию - 443. | ||
| portName string | успех | Имя порта, определенное в InstanceGroup#NamedPort#name. Если оба port и port_name определены, приоритет отдается port. | ||
| portSpecification string | успех | Указывает, как выбирается порт для проверки работоспособности. Может принимать следующие значения: * `USE_FIXED_PORT`: Используется номер порта из `port` для проверки работоспособности. * `USE_NAMED_PORT`: Используется `portName` для проверки работоспособности. * `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого узла, для проверки работоспособности. Для других бэкендов используется порт или имя порта, указанные в Backend Service для проверки работоспособности. Если не указано, проверка HTTPS работоспособности следует поведению, указанному в полях `port` и `portName`. | ||
| proxyHeader string | успех | Указывает тип заголовка прокси, который будет добавлен перед отправкой данных на бэкенд. | ||
| requestPath string | success | Путь запроса HTTPS-проверки состояния. Значение по умолчанию — /. | ||
| response string | success | Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII. | ||
| id integer | success | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. | ||
| name string | success | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| sslHealthCheck complex | success | Вложенный ресурс типа объект. | ||
| port integer | success | Номер TCP-порта для запроса проверки состояния SSL. Значение по умолчанию — 443. | ||
| portName string | success | Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port. | ||
| portSpecification string | success | Указывает, как выбирается порт для проверки состояния, может принимать одно из следующих значений: * `USE_FIXED_PORT`: Номер порта в `port` используется для проверки состояния. * `USE_NAMED_PORT`: Для проверки состояния используется `portName`. * `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого узла, для проверки состояния. Для других бэкэндов используется порт или имя порта, указанные в службе бэкэнда для проверки состояния. Если не указано, проверка состояния SSL следует поведению, указанному в полях `port` и `portName`. | ||
| proxyHeader string | success | Указывает тип заголовка прокси, который необходимо добавить перед отправкой данных бэкенду. | ||
| request string | success | Данные приложения, которые необходимо отправить после установления SSL-соединения (значение по умолчанию пустое). Если и request, и response пусты, установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII. | ||
| response string | success | Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII. | ||
| tcpHealthCheck complex | success | Вложенный ресурс типа объект. | ||
| port integer | success | Номер TCP-порта для запроса проверки состояния TCP. Значение по умолчанию — 443. | ||
| portName string | success | Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет имеет port. | ||
| portSpecification string | success | Указывает, как выбирается порт для проверки состояния, может принимать одно из следующих значений: * `USE_FIXED_PORT`: Номер порта в `port` используется для проверки состояния. * `USE_NAMED_PORT`: Для проверки состояния используется `portName`. * `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого узла, для проверки состояния. Для других бэкэндов используется порт или имя порта, указанные в службе бэкэнда для проверки состояния. Если не указано, проверка состояния TCP следует поведению, указанному в полях `port` и `portName`. | ||
| proxyHeader string | success | Указывает тип заголовка прокси, который необходимо добавить перед отправкой данных бэкенду. | ||
| request string | success | Данные приложения, которые необходимо отправить после установления TCP-соединения (значение по умолчанию пустое). Если и request, и response пусты, установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII. | ||
| response string | success | Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII. | ||
| timeoutSec integer | success | Время ожидания (в секундах) перед признанием сбоя. Значение по умолчанию — 5 секунд. Недопустимо, чтобы timeoutSec имело большее значение, чем checkIntervalSec. | ||
| type string | success | Указывает тип проверки состояния: TCP, SSL, HTTP или HTTPS. Если не указано, значение по умолчанию — TCP. Должен быть указан ровно один параметр проверки состояния протокола, который должен соответствовать полю type. | ||
| unhealthyThreshold integer | success | Состояние работоспособности экземпляра будет считаться неработоспособным после этого количества последовательных неудач. Значение по умолчанию — 2. | ||
Авторы
- Google Inc. (@googlecloudplatform)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_health_check_info_module.html
