gcp_compute_https_health_check – Создаёт GCP HttpsHealthCheck
Новая в версии 2.6.
Описание
- Ресурс HttpsHealthCheck. Этот ресурс определяет шаблон проверки работоспособности отдельных виртуальных машин через HTTPS.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind - / обязательно |
| Тип используемых учетных данных. |
| check_interval_sec - | Частота проверки состояния (в секундах). Значение по умолчанию — 5 секунд. | |
| description - | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. | |
| healthy_threshold - | Нездоровый экземпляр будет помечен как здоровый после такого количества последовательных успехов. Значение по умолчанию — 2. | |
| host - | Значение заголовка host в запросе проверки состояния HTTPS. Если поле пустое (значение по умолчанию), будет использован общедоступный IP-адрес, от имени которого выполняется проверка состояния. | |
| name - / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Длина имени должна быть от 1 до 63 символов и соответствовать RFC1035. То есть, длина должна быть от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — тире, строчная буква или цифра, за исключением последнего символа, который не может быть тире. | |
| port - | Номер TCP-порта для запроса проверки состояния HTTPS. Значение по умолчанию — 80. | |
| project - | По умолчанию: null | Проект Google Cloud Platform для использования. |
| request_path - | Путь запроса для проверки состояния HTTPS. Значение по умолчанию — /. | |
| scopes - | Массив используемых областей. | |
| service_account_email - | Необязательный адрес электронной почты учетной записи сервиса, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file - | Путь к файлу JSON учетной записи сервиса, если в качестве типа выбран serviceaccount. | |
| state - |
| Указывает, должен ли данный объект существовать в GCP |
| timeout_sec - | Время ожидания (в секундах) до признания ошибки. Значение по умолчанию — 5 секунд. Значение timeoutSec не должно быть больше checkIntervalSec. Псевдонимы: timeout_seconds | |
| unhealthy_threshold - | Здоровый экземпляр будет помечен как нездоровый после такого количества последовательных ошибок. Значение по умолчанию — 2. |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/latest/httpsHealthChecks
- Добавление проверок состояния: https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks
- Для аутентификации можно установить 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: create a https health check
gcp_compute_https_health_check:
name: "test_object"
healthy_threshold: 10
port: 8080
timeout_sec: 2
unhealthy_threshold: 5
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| check_interval_sec целое число | успех | Как часто (в секундах) отправлять проверку работоспособности. Значение по умолчанию составляет 5 секунд. |
| creation_timestamp строка | успех | Отметка времени создания в формате RFC3339. |
| description строка | успех | Необязательное описание этого ресурса. Укажите это свойство при создании ресурса. |
| healthy_threshold целое число | успех | Нездоровый экземпляр будет помечен как здоровый после такого количества последовательных успехов. Значение по умолчанию равно 2. |
| 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. [сообщество]
Авторы
- 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_module.html
