gcp_compute_https_health_check_facts – Сбор фактов для GCP HttpsHealthCheck
Новая в версии 2.7.
Описание
- Сбор фактов для GCP HttpsHealthCheck
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| filters - | Список пар значений фильтров. Доступные фильтры перечислены здесь https://cloud.google.com/sdk/gcloud/reference/topic/filters. Каждый дополнительный фильтр в списке будет добавлен как условие AND (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 https health check facts
gcp_compute_https_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. | |
| host строка | успех | Значение заголовка host в запросе HTTPS проверки работоспособности. Если оставить пустым (значение по умолчанию), будет использован общедоступный IP-адрес, от имени которого выполняется проверка работоспособности. | |
| id целое число | успех | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. | |
| name строка | успех | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | |
| port целое число | успех | Номер TCP-порта для запроса HTTPS проверки работоспособности. Значение по умолчанию — 80. | |
| request_path строка | успех | Путь запроса для HTTPS проверки работоспособности. Значение по умолчанию — /. | |
| timeout_sec целое число | успех | Время ожидания (в секундах) перед признанием ошибки. Значение по умолчанию — 5 секунд. Время ожидания (timeoutSec) не может быть больше интервала проверки (checkIntervalSec). | |
| unhealthy_threshold целое число | успех | Успешный экземпляр будет помечен как неисправный после такого количества последовательных ошибок. Значение по умолчанию — 2. | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/gcp_compute_https_health_check_facts_module.html