gcp_compute_health_check_info – Сбор информации о GCP HealthCheck
Новое в версии 2.7.
Обзор
- Сбор информации о GCP HealthCheck
- Этот модуль назывался
gcp_compute_health_check_factsдо Ansible 2.9. Способ использования не изменился.
Псевдонимы: gcp_compute_health_check_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 с помощью переменной среды c(gcp_service_account_file).
- для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры 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 | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| healthyThreshold integer | успех | Нездоровый экземпляр будет помечен как здоровый после этого количества последовательных успехов. Значение по умолчанию - 2. | ||
| httpHealthCheck complex | успех | Вложенный ресурс-объект. | ||
| host string | успех | Значение заголовка хоста в запросе проверки работоспособности 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 порт, указанный для каждого сетевого узла, используется для проверки работоспособности. Для других бэкендов используется порт или имя порта, указанное в службе бэкенда. Если не указано, проверка работоспособности HTTP следует поведению, заданному в полях `port` и `portName`. | ||
| proxyHeader string | успех | Указывает тип заголовка прокси для добавления перед отправкой данных бэкенду, либо NONE, либо PROXY_V1. По умолчанию - NONE. | ||
| requestPath string | успех | Путь запроса проверки работоспособности HTTP. Значение по умолчанию - /. | ||
| response string | успех | Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ указывает на работоспособность. Данные ответа могут быть только ASCII. | ||
| httpsHealthCheck complex | успех | Вложенный ресурс-объект. | ||
| host string | успех | Значение заголовка хоста в запросе проверки работоспособности 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 порт, указанный для каждого сетевого узла, используется для проверки работоспособности. Для других бэкендов используется порт или имя порта, указанное в службе бэкенда. Если не указано, проверка работоспособности HTTPS следует поведению, заданному в полях `port` и `portName`. | ||
| proxyHeader string | успех | Указывает тип заголовка прокси для добавления перед отправкой данных бэкенду, либо NONE, либо PROXY_V1. По умолчанию - NONE. | ||
| requestPath string | успех | Путь запроса проверки работоспособности HTTPS. Значение по умолчанию - /. | ||
| response string | успех | Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ указывает на работоспособность. Данные ответа могут быть только ASCII. | ||
| id integer | успех | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. | ||
| name string | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| sslHealthCheck complex | успех | Вложенный ресурс-объект. | ||
| port integer | успех | Номер TCP-порта для запроса проверки работоспособности SSL. Значение по умолчанию - 443. | ||
| portName string | успех | Имя порта, определённое в InstanceGroup#NamedPort#name. Если определены как port, так и port_name, приоритет отдаётся port. | ||
| portSpecification string | успех | Указывает, как выбирается порт для проверки работоспособности, может принимать одно из следующих значений: * `USE_FIXED_PORT`: Номер порта в `port` используется для проверки работоспособности. * `USE_NAMED_PORT`: `portName` используется для проверки работоспособности. * `USE_SERVING_PORT`: Для NetworkEndpointGroup порт, указанный для каждого сетевого узла, используется для проверки работоспособности. Для других бэкендов используется порт или имя порта, указанное в службе бэкенда. Если не указано, проверка работоспособности SSL следует поведению, заданному в полях `port` и `portName`. | ||
| proxyHeader string | успех | Указывает тип заголовка прокси для добавления перед отправкой данных бэкенду, либо NONE, либо PROXY_V1. По умолчанию - NONE. | ||
| request string | успех | Данные приложения для отправки после установления соединения SSL (значение по умолчанию - пустое). Если как request, так и response пусты, то установление соединения само по себе указывает на работоспособность. Данные запроса могут быть только ASCII. | ||
| response string | success | Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII. | ||
| tcpHealthCheck complex | success | Вложенный ресурс-объект. | ||
| port integer | success | Номер TCP-порта для запроса проверки работоспособности TCP. Значение по умолчанию — 443. | ||
| portName string | success | Имя порта, определённое в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, приоритет имеет порт. | ||
| portSpecification string | success | Указывает, как порт выбирается для проверки работоспособности, может принимать одно из следующих значений: * `USE_FIXED_PORT`: Номер порта в `port` используется для проверки работоспособности. * `USE_NAMED_PORT`: Имя порта `portName` используется для проверки работоспособности. * `USE_SERVING_PORT`: Для NetworkEndpointGroup используется порт, указанный для каждого сетевого узла, для проверки работоспособности. Для других бэкендов используется порт или имя порта, указанные в службе бэкенда. Если не указано, проверка работоспособности TCP следует поведению, указанному в полях `port` и `portName`. | ||
| proxyHeader string | success | Указывает тип прокси-заголовка, который необходимо добавить перед отправкой данных бэкенду, либо NONE, либо PROXY_V1. По умолчанию — NONE. | ||
| request string | success | Данные приложения для отправки после установления TCP-соединения (значение по умолчанию — пустое). Если и запрос, и ответ пусты, установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII. | ||
| response string | success | Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII. | ||
| timeoutSec integer | success | Сколько времени (в секундах) ждать, прежде чем признать ошибку. Значение по умолчанию — 5 секунд. Недопустимо, чтобы timeoutSec имел большее значение, чем checkIntervalSec. | ||
| type string | success | Указывает тип проверки работоспособности, TCP, SSL, HTTP или HTTPS. Если не указано, значение по умолчанию — TCP. Должен быть указан ровно один из полей проверки работоспособности, соответствующий типу. | ||
| unhealthyThreshold integer | success | Состояние работоспособности инстанса изменится на неработоспособное после такого количества последовательных ошибок. Значение по умолчанию — 2. | ||
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом 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.9/modules/gcp_compute_health_check_info_module.html
