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