gcp_healthcheck - Создание, обновление или удаление проверки работоспособности.
Новое в версии 2.4.
Обзор
- Создание, обновление или удаление проверки работоспособности. В настоящее время поддерживаются только проверки работоспособности HTTP и HTTPS. Проверки работоспособности используются для мониторинга отдельных экземпляров, управляемых групп экземпляров и/или сервисов обратного канала. Проверки работоспособности являются многоразовыми.
- Для получения обзора проверок работоспособности в GCP посетите https://cloud.google.com/compute/docs/load-balancing/health-checks.
- Подробные сведения об API проверок работоспособности HTTP см. по адресу https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks.
- Дополнительные сведения об API проверки работоспособности HTTPS см. по адресу https://cloud.google.com/compute/docs/reference/latest/httpsHealthChecks.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться данный модуль.
- python >= 2.6
- google-api-python-client >= 1.6.2
- google-auth >= 0.9.0
- google-auth-httplib2 >= 0.0.2
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| check_interval | Значение по умолчанию: 5 | Как часто (в секундах) отправлять проверку работоспособности. |
| credentials_file | Значение по умолчанию: None | Путь к JSON-файлу, связанному с адресом электронной почты учетной записи службы. |
| healthcheck_name обязательно | Имя проверки работоспособности. | |
| healthcheck_type обязательно |
| Тип проверки работоспособности. |
| healthy_threshold | Значение по умолчанию: 2 | Экземпляр, ранее неработающий, будет помечен как работающий после этого количества последовательных успехов. |
| host_header обязательно | Значение по умолчанию: | Значение заголовка host в запросе проверки работоспособности. Если поле оставлено пустым, будет использован публичный IP-адрес, от имени которого выполняется проверка работоспособности. |
| port | Номер TCP-порта для запроса проверки работоспособности. Значение по умолчанию — 443 для HTTPS и 80 для HTTP. | |
| project_id | Значение по умолчанию: None | Идентификатор вашего проекта GCP. |
| request_path | Значение по умолчанию: / | Путь запроса к проверке работоспособности HTTPS. |
| service_account_email | Значение по умолчанию: None | Адрес электронной почты учетной записи службы. |
| service_account_permissions (добавлен в 2.0) |
None | Разрешения учетной записи службы (см. https://cloud.google.com/sdk/gcloud/reference/compute/instances/create, раздел --scopes для получения подробной информации). |
| state обязательно |
| Состояние проверки работоспособности. |
| timeout | Значение по умолчанию: 5 | Время ожидания ответа (в секундах), прежде чем объявить об ошибке. Значение таймаута не должно превышать значение check_interval. |
| unhealthy_threshold | Значение по умолчанию: 2 | Экземпляр, ранее работающий, будет помечен как неработающий после этого количества последовательных сбоев. |
Примечания
Примечание
- В настоящее время поддерживаются только проверки работоспособности HTTP и HTTPS.
Примеры
- name: Create Minimum HealthCheck
gcp_healthcheck:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
healthcheck_name: my-healthcheck
healthcheck_type: HTTP
state: present
- name: Create HTTP HealthCheck
gcp_healthcheck:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
healthcheck_name: my-healthcheck
healthcheck_type: HTTP
host: my-host
request_path: /hc
check_interval: 10
timeout: 30
unhealthy_threshhold: 2
healthy_threshhold: 1
state: present
- name: Create HTTPS HealthCheck
gcp_healthcheck:
service_account_email: "{{ service_account_email }}"
credentials_file: "{{ credentials_file }}"
project_id: "{{ project_id }}"
healthcheck_name: "{{ https_healthcheck }}"
healthcheck_type: HTTPS
host_header: my-host
request_path: /hc
check_interval: 5
timeout: 5
unhealthy_threshold: 2
healthy_threshold: 1
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| healthcheck dict | Всегда. Обратитесь к документации GCP для получения подробных описаний полей. | Словарь проверки работоспособности GCP Пример: {'port': 443, 'requestPath': '/foo', 'name': 'my-hc'} |
| healthcheck_name str | Всегда | Имя проверки работоспособности Пример: my-url-map |
| healthcheck_type str | Всегда | Тип проверки работоспособности Пример: HTTP |
| state str | Всегда. | Состояние проверки работоспособности Пример: present |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- Tom Melendez (@supertom) <tom@supertom.com>
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/gcp_healthcheck_module.html