gcp_compute_http_health_check - Создаёт GCP HttpHealthCheck
Новое в версии 2.6.
Обзор
- Ресурс HttpHealthCheck. Этот ресурс определяет шаблон проверки работоспособности отдельных виртуальных машин через HTTP.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_kind обязательно |
| Тип используемых учетных данных. |
| check_interval_sec | Периодичность отправки проверки работоспособности (в секундах). Значение по умолчанию — 5 секунд. псевдонимы: check_interval_seconds | |
| description | Необязательное описание данного ресурса. Укажите это свойство при создании ресурса. | |
| healthy_threshold | После этого количества последовательных успехов нездоровый экземпляр будет помечен как здоровый. Значение по умолчанию — 2. | |
| host | Значение заголовка хоста в запросе проверки работоспособности по HTTP. Если оставить пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности. | |
| name обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов, а имя должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — тире, строчная буква или цифра, за исключением последнего символа, который не может быть тире. | |
| port | Номер TCP-порта для запроса проверки работоспособности по HTTP. Значение по умолчанию — 80. | |
| project | Проект Google Cloud Platform, который нужно использовать. | |
| request_path | Путь запроса проверки работоспособности по HTTP. Значение по умолчанию — /. | |
| scopes обязательно | Массив используемых областей. | |
| service_account_email | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | |
| service_account_file | Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount. | |
| state обязательно |
| Нужно ли, чтобы данный объект существовал в GCP |
| timeout_sec | Время ожидания (в секундах) до объявления о сбое. Значение по умолчанию — 5 секунд. timeoutSec не может быть больше checkIntervalSec. псевдонимы: timeout_seconds | |
| unhealthy_threshold | После этого количества последовательных сбоев здоровый экземпляр будет помечен как нездоровый. Значение по умолчанию — 2. |
Примечания
Примечание
- Для аутентификации можно установить service_account_file, используя переменную среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации можно установить service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации можно установить auth_kind, используя переменную среды
GCP_AUTH_KIND. - Для аутентификации можно установить scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в плейбуке не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a http health check
gcp_compute_http_health_check:
name: testObject
healthy_threshold: 10
port: 8080
timeout_sec: 2
unhealthy_threshold: 5
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/compute
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| check_interval_sec int | success | Периодичность отправки проверки работоспособности (в секундах). Значение по умолчанию — 5 секунд. |
| creation_timestamp str | success | Дата и время создания в формате RFC3339. |
| description str | success | Необязательное описание данного ресурса. Укажите это свойство при создании ресурса. |
| healthy_threshold int | success | После этого количества последовательных успехов нездоровый экземпляр будет помечен как здоровый. Значение по умолчанию — 2. |
| host str | success | Значение заголовка хоста в запросе проверки работоспособности по HTTP. Если оставить пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности. |
| id int | success | Уникальный идентификатор ресурса. Этот идентификатор определяется сервером. |
| name str | success | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть длина должна быть от 1 до 63 символов, а имя должно соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — тире, строчная буква или цифра, за исключением последнего символа, который не может быть тире. |
| port int | success | Номер TCP-порта для запроса проверки работоспособности по HTTP. Значение по умолчанию — 80. |
| request_path str | success | Путь запроса проверки работоспособности по HTTP. Значение по умолчанию — /. |
| timeout_sec int | success | Время ожидания (в секундах) до объявления о сбое. Значение по умолчанию — 5 секунд. timeoutSec не может быть больше checkIntervalSec. |
| unhealthy_threshold int | success | После этого количества последовательных сбоев здоровый экземпляр будет помечен как нездоровый. Значение по умолчанию — 2. |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом 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.6/modules/gcp_compute_http_health_check_module.html
