Spec-Zone.ru › Ansible 2.4

gcp_healthcheck - Создание, обновление или удаление проверки работоспособности.

Новое в версии 2.4.

  • Обзор
  • Требования (для хоста, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Обзор

  • Создание, обновление или удаление проверки работоспособности. В настоящее время поддерживаются только проверки работоспособности HTTP и HTTPS. Проверки работоспособности используются для мониторинга отдельных экземпляров, управляемых групп экземпляров и/или служб обратного канала. Проверки работоспособности являются многократно используемыми.
  • См. https://cloud.google.com/compute/docs/load-balancing/health-checks для общего обзора проверок работоспособности в GCP.
  • См. https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks для получения подробной информации об API проверок работоспособности HTTP.
  • См. https://cloud.google.com/compute/docs/reference/latest/httpsHealthChecks для получения дополнительной информации об API проверок работоспособности HTTPS.

Требования (для хоста, на котором выполняется модуль)

  • 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
нет
Путь к JSON-файлу, связанному с адресом электронной почты учетной записи службы
healthcheck_name
да
Имя проверки работоспособности.
healthcheck_type
да
  • HTTP
  • HTTPS
Тип проверки работоспособности.
healthy_threshold
нет 2
Неуспешный до этого экземпляр будет помечен как успешный после этого количества последовательных успехов.
host_header
да
Значение заголовка хоста в запросе проверки работоспособности. Если оставлено пустым, будет использоваться публичный IP-адрес от имени которого выполняется эта проверка работоспособности.
port
нет
Номер TCP-порта для запроса проверки работоспособности. Значение по умолчанию составляет 443 для HTTPS и 80 для HTTP.
project_id
нет
Ваш идентификатор проекта GCP
request_path
нет /
Путь запроса HTTPS-запроса проверки работоспособности.
service_account_email
нет
адрес электронной почты учетной записи службы
service_account_permissions
(добавлено в 2.0)
нет
  • bigquery
  • cloud-platform
  • compute-ro
  • compute-rw
  • useraccounts-ro
  • useraccounts-rw
  • datastore
  • logging-write
  • monitoring
  • sql-admin
  • storage-full
  • storage-ro
  • storage-rw
  • taskqueue
  • userinfo-email
разрешения учетной записи службы (см. https://cloud.google.com/sdk/gcloud/reference/compute/instances/create, раздел --scopes для получения подробной информации)
state
да
  • present
  • absent
Состояние проверки работоспособности.
timeout
нет 5
Сколько времени (в секундах) ожидать ответа перед объявлением о сбое. Недопустимо, чтобы timeout имел большее значение, чем check_interval.
unhealthy_threshold
нет 2
После этого количества последовательных сбоев успешный до этого момента экземпляр будет помечен как неисправный.

Примеры

- 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
Словарь проверки работоспособности GCP
Всегда. Обратитесь к документации GCP для получения подробных описаний полей. dict {'port': 443, 'requestPath': '/foo', 'name': 'my-hc'}
healthcheck_name
Имя проверки работоспособности
Всегда str my-url-map
healthcheck_type
Тип проверки работоспособности
Всегда str HTTP
state
состояние проверки работоспособности
Всегда. str present

Примечания

Примечание

  • В настоящее время поддерживаются только проверки работоспособности HTTP и HTTPS.

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информация о сообществе и сотрудничество, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/gcp_healthcheck_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API