Spec-Zone.ru › Ansible 2.6

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
Путь к 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
Экземпляр, до этого считавшийся исправным, будет помечен как неисправный после этого количества последовательных сбоев.

Примечания

Примечание

  • В настоящее время поддерживаются только проверки состояния 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

Пример:
{'name': 'my-hc', 'port': 443, 'requestPath': '/foo'}
healthcheck_name
str
Всегда
Имя проверки состояния

Пример:
my-url-map
healthcheck_type
str
Всегда
Тип проверки состояния

Пример:
HTTP
state
str
Всегда.
Состояние проверки состояния

Пример:
present


Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/gcp_healthcheck_module.html

Spec-Zone.ru

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