gcp_compute_health_check_facts – Сбор фактов о проверке состояния GCP
Новое в версии 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 строка | Проект Google Cloud Platform для использования. | |
| scopes список | Массив используемых областей. | |
| service_account_contents строка | Строка, представляющая содержимое файла JSON учетной записи службы. Это не должно передаваться в виде словаря, а строка, содержащая точное содержимое файла json учетной записи службы (валидный JSON). | |
| service_account_email строка | Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file путь | Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить service_account_contents с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации можно установить 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: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| items сложный | всегда | Список элементов | ||
| checkIntervalSec целое число | успех | Как часто (в секундах) отправлять проверку работоспособности. Значение по умолчанию — 5 секунд. | ||
| creationTimestamp строка | успех | Маркер создания в формате RFC3339. | ||
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | ||
| healthyThreshold целое число | успех | Нездоровый до сих пор экземпляр будет помечен как здоровый после этого количества последовательных успехов. Значение по умолчанию — 2. | ||
| httpHealthCheck сложный | успех | Вложенный ресурс-объект. | ||
| host строка | успех | Значение заголовка host в запросе проверки работоспособности HTTP. Если оставлено пустым (значение по умолчанию), будет использован публичный IP-адрес, от имени которого выполняется проверка работоспособности. | ||
| port целое число | успех | Номер TCP-порта для запроса проверки работоспособности HTTP. Значение по умолчанию — 80. | ||
| portName строка | успех | Имя порта, как определено в InstanceGroup#NamedPort#name. Если заданы и порт, и имя порта, используется значение порта. | ||
| proxyHeader строка | успех | Указывает тип заголовка прокси, который нужно добавить перед отправкой данных на бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE. | ||
| requestPath строка | успех | Путь запроса для проверки работоспособности HTTP. Значение по умолчанию — /. | ||
| response строка | успех | Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII. | ||
| httpsHealthCheck сложный | успех | Вложенный ресурс-объект. | ||
| host строка | успех | Значение заголовка host в запросе проверки работоспособности HTTPS. Если оставлено пустым (значение по умолчанию), будет использован публичный IP-адрес, от имени которого выполняется проверка работоспособности. | ||
| port целое число | успех | Номер TCP-порта для запроса проверки работоспособности HTTPS. Значение по умолчанию — 443. | ||
| portName строка | успех | Имя порта, как определено в InstanceGroup#NamedPort#name. Если заданы и порт, и имя порта, используется значение порта. | ||
| proxyHeader строка | успех | Указывает тип заголовка прокси, который нужно добавить перед отправкой данных на бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE. | ||
| requestPath строка | успех | Путь запроса для проверки работоспособности HTTPS. Значение по умолчанию — /. | ||
| response строка | успех | Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII. | ||
| id целое число | успех | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. | ||
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов, и оно должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| sslHealthCheck сложный | успех | Вложенный ресурс-объект. | ||
| port целое число | успех | Номер TCP-порта для запроса проверки работоспособности SSL. Значение по умолчанию — 443. | ||
| portName строка | успех | Имя порта, как определено в InstanceGroup#NamedPort#name. Если заданы и порт, и имя порта, используется значение порта. | ||
| proxyHeader строка | успех | Указывает тип заголовка прокси, который нужно добавить перед отправкой данных на бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE. | ||
| request строка | успех | Данные приложения, которые нужно отправить после установления SSL-соединения (значение по умолчанию пустое). Если и request, и response пустые, то установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII. | ||
| response строка | успех | Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII. | ||
| tcpHealthCheck сложный | успех | Вложенный ресурс-объект. | ||
| port целое число | успех | Номер TCP-порта для запроса проверки работоспособности TCP. Значение по умолчанию — 443. | ||
| portName строка | успех | Имя порта, как определено в InstanceGroup#NamedPort#name. Если заданы и порт, и имя порта, используется значение порта. | ||
| proxyHeader строка | успех | Указывает тип заголовка прокси, который нужно добавить перед отправкой данных на бэкенд, либо NONE, либо PROXY_V1. По умолчанию — NONE. | ||
| request строка | успех | Данные приложения, которые нужно отправить после установления TCP-соединения (значение по умолчанию пустое). Если и request, и response пустые, то установление соединения само по себе укажет на работоспособность. Данные запроса могут быть только ASCII. | ||
| response строка | успех | Байты для сравнения с началом данных ответа. Если оставлено пустым (значение по умолчанию), любой ответ укажет на работоспособность. Данные ответа могут быть только ASCII. | ||
| timeoutSec целое число | успех | Сколько времени (в секундах) ждать перед признанием ошибки. Значение по умолчанию — 5 секунд. timeoutSec не может быть больше checkIntervalSec. | ||
| type строка | успех | Указывает тип проверки работоспособности (TCP, SSL, HTTP или HTTPS). Если не указано, по умолчанию — TCP. Должен быть указан ровно один из полей проверки работоспособности для конкретного протокола, который должен совпадать с типом поля. | ||
| unhealthyThreshold целое число | success | Здоровый экземпляр будет помечен как нездоровый после такого количества последовательных сбоев. Значение по умолчанию равно 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.8/modules/gcp_compute_health_check_facts_module.html
