Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_compute_http_health_check – Создает GCP HttpHealthCheck

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в playbook, укажите: google.cloud.gcp_compute_http_health_check.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Описание

  • Ресурс HttpHealthCheck. Этот ресурс определяет шаблон проверки работоспособности отдельных виртуальных машин посредством HTTP.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_token

string

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

string / required

Тип используемых учетных данных.

Варианты:

  • "application"
  • "machineaccount"
  • "serviceaccount"
  • "accesstoken"

check_interval_sec

aliases: check_interval_seconds

integer

Как часто (в секундах) отправлять проверку работоспособности. Значение по умолчанию — 5 секунд.

Значение по умолчанию: 5

description

string

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

env_type

string

Указывает, в какой среде Ansible вы запускаете этот модуль.

Это не должно устанавливаться, если вы не знаете, что делаете.

Это только изменяет строку User Agent для любых запросов API.

healthy_threshold

integer

Пока нерабочий экземпляр будет помечен как работоспособный после такого количества последовательных успехов. Значение по умолчанию — 2.

host

string

Значение заголовка host в запросе проверки работоспособности HTTP. Если оставить пустым (значение по умолчанию), будет использоваться общедоступный IP-адрес, от имени которого выполняется эта проверка работоспособности.

name

string / required

Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

port

integer

Номер TCP-порта для запроса проверки работоспособности HTTP.

Значение по умолчанию — 80.

project

string

Проект Google Cloud Platform для использования.

request_path

string

Путь запроса запроса проверки работоспособности HTTP.

Значение по умолчанию — /.

scopes

list / elements=string

Массив областей, которые будут использоваться

service_account_contents

jsonarg

Содержимое файла JSON учетной записи службы, либо в словаре, либо в виде представляющей его строки JSON.

service_account_email

string

Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать электронную почту по умолчанию.

service_account_file

path

Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.

state

string

Должен ли данный объект существовать в GCP

Варианты:

  • "present" ← (default)
  • "absent"

timeout_sec

aliases: timeout_seconds

integer

Как долго (в секундах) ждать, прежде чем заявить об ошибке.

Значение по умолчанию — 5 секунд. Для timeoutSec недопустимо иметь значение большее, чем checkIntervalSec.

unhealthy_threshold

integer

Пока работоспособный экземпляр будет помечен как нерабочий после такого количества последовательных сбоев. Значение по умолчанию — 2.

Примечания

Примечание

  • API Reference: https://cloud.google.com/compute/docs/reference/v1/httpHealthChecks
  • Добавление проверок работоспособности: 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.
  • Для аутентификации можно установить access_token с помощью переменной окружения GCP_ACCESS_TOKEN.
  • Для аутентификации можно установить auth_kind с помощью переменной окружения GCP_AUTH_KIND.
  • Для аутентификации можно установить scopes с помощью переменной окружения GCP_SCOPES.
  • Значения переменных окружения будут использоваться только в том случае, если значения в playbook не установлены.
  • Параметры service_account_email и service_account_file являются взаимоисключающими.

Примеры

- name: create a HTTP health check
  google.cloud.gcp_compute_http_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

строка

Значение заголовка хоста в запросе HTTP проверки состояния. Если оставить пустым (значение по умолчанию), будет использован публичный IP-адрес, от имени которого выполняется эта проверка состояния.

Возвращается: успех

id

целое число

Уникальный идентификатор ресурса. Этот идентификатор определяется сервером.

Возвращается: успех

name

строка

Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно быть длиной от 1 до 63 символов и соответствовать RFC1035. То есть, имя должно быть длиной от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом.

Возвращается: успех

port

целое число

Номер TCP-порта для запроса HTTP проверки состояния.

Значение по умолчанию — 80.

Возвращается: успех

requestPath

строка

Путь запроса HTTP проверки состояния.

Значение по умолчанию — /.

Возвращается: успех

timeoutSec

целое число

Сколько времени (в секундах) ждать, прежде чем считать это ошибкой.

Значение по умолчанию — 5 секунд. Не допускается значение timeoutSec больше, чем checkIntervalSec.

Возвращается: успех

unhealthyThreshold

целое число

Здоровый до сих пор экземпляр будет помечен как нездоровый после этого количества последовательных неудач. Значение по умолчанию — 2.

Возвращается: успех

Авторы

  • Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

  • Система отслеживания проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/google/cloud/gcp_compute_http_health_check_module.html

Spec-Zone.ru

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