gcp_compute_health_check_facts – Сбор фактов для GCP HealthCheck
Новое в версии 2.7.
Обзор
- Сбор фактов для GCP HealthCheck
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| filters - | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие И (filter1 и filter2) | |
| project - | Значение по умолчанию: null | Проект Google Cloud Platform для использования. |
| scopes - | Массив используемых областей. | |
| service_account_email - | Дополнительный адрес электронной почты учетной записи сервиса, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file - | Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes с помощью переменной среды
GCP_SCOPES. - Значения переменных среды будут использованы только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: a health check facts
gcp_compute_health_check_facts:
filters:
- name = test_object
project: test_project
auth_kind: service_account
service_account_file: "/tmp/auth.pem"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращённое | Описание | ||
|---|---|---|---|---|
| items сложный | всегда | Список элементов | ||
| check_interval_sec целое число | успех | Частота (в секундах) отправки проверки состояния. Значение по умолчанию — 5 секунд. | ||
| creation_timestamp строка | успех | Отметка времени создания в формате RFC3339. | ||
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| healthy_threshold целое число | успех | Нездоровый до сих пор экземпляр будет помечен как здоровый после этого количества последовательных успехов. Значение по умолчанию — 2. | ||
| http_health_check сложный | успех | Вложенный ресурс-объект. | ||
| host строка | успех | Значение заголовка хоста в запросе проверки состояния HTTP. Если оставлено пустым (значение по умолчанию), будет использован публичный IP адрес, от имени которого выполняется эта проверка состояния. | ||
| port целое число | успех | Номер TCP-порта для запроса проверки состояния HTTP. Значение по умолчанию — 80. | ||
| port_name строка | успех | Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, приоритет имеет порт. | ||
| proxy_header строка | успех | Указывает тип заголовка прокси, который нужно добавить перед отправкой данных в бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE. | ||
| request_path строка | успех | Путь запроса проверки состояния HTTP. Значение по умолчанию — /. | ||
| https_health_check сложный | успех | Вложенный ресурс-объект. | ||
| host строка | успех | Значение заголовка хоста в запросе проверки состояния HTTPS. Если оставлено пустым (значение по умолчанию), будет использован публичный IP адрес, от имени которого выполняется эта проверка состояния. | ||
| port целое число | успех | Номер TCP-порта для запроса проверки состояния HTTPS. Значение по умолчанию — 443. | ||
| port_name строка | успех | Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, приоритет имеет порт. | ||
| proxy_header строка | успех | Указывает тип заголовка прокси, который нужно добавить перед отправкой данных в бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE. | ||
| request_path строка | успех | Путь запроса проверки состояния HTTPS. Значение по умолчанию — /. | ||
| id целое число | успех | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. | ||
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, длина имени должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| ssl_health_check сложный | успех | Вложенный ресурс-объект. | ||
| port целое число | успех | Номер TCP-порта для запроса проверки состояния SSL. Значение по умолчанию — 443. | ||
| port_name строка | успех | Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, приоритет имеет порт. | ||
| proxy_header строка | успех | Указывает тип заголовка прокси, который нужно добавить перед отправкой данных в бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE. | ||
| request строка | успех | Данные приложения, которые нужно отправить после установления SSL-соединения (значение по умолчанию — пустое). Если и запрос, и ответ пусты, установление соединения само по себе укажет на состояние здоровья. Данные запроса могут быть только ASCII. | ||
| response строка | успех | Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на состояние здоровья. Данные ответа могут быть только ASCII. | ||
| tcp_health_check сложный | успех | Вложенный ресурс-объект. | ||
| port целое число | успех | Номер TCP-порта для запроса проверки состояния TCP. Значение по умолчанию — 443. | ||
| port_name строка | успех | Имя порта, как определено в InstanceGroup#NamedPort#name. Если определены как порт, так и имя порта, приоритет имеет порт. | ||
| proxy_header строка | успех | Указывает тип заголовка прокси, который нужно добавить перед отправкой данных в бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE. | ||
| request строка | успех | Данные приложения, которые нужно отправить после установления TCP-соединения (значение по умолчанию — пустое). Если и запрос, и ответ пусты, установление соединения само по себе укажет на состояние здоровья. Данные запроса могут быть только ASCII. | ||
| response строка | успех | Байты для сопоставления с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на состояние здоровья. Данные ответа могут быть только ASCII. | ||
| timeout_sec целое число | успех | Время ожидания (в секундах) перед признанием ошибки. Значение по умолчанию — 5 секунд. Недопустимо, чтобы timeoutSec имел большее значение, чем checkIntervalSec. | ||
| type строка | успех | Указывает тип проверки состояния, TCP, SSL, HTTP или HTTPS. Если не указано, значение по умолчанию — TCP. Должен быть указан ровно один из полей проверки состояния, относящихся к протоколу, который должен совпадать с полем type. | ||
| unhealthy_threshold целое число | успех | Здоровый до сих пор экземпляр будет помечен как нездоровый после этого количества последовательных сбоев. Значение по умолчанию — 2. | ||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.7/modules/gcp_compute_health_check_facts_module.html
