Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Требования

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

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

Параметры

Параметр

Комментарии

access_token

string

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

auth_kind

string / required

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

Варианты:

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

check_interval_sec

integer

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

description

string

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

env_type

string

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

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

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

healthy_threshold

integer

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

host

string

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

name

string / required

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

port

integer

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

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

project

string

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

request_path

string

Путь запроса для запроса проверки HTTPS.

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

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" ← (по умолчанию)
  • "absent"

timeout_sec

aliases: timeout_seconds

integer

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

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

unhealthy_threshold

integer

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

Примечания

Примечание

  • API Reference: https://cloud.google.com/compute/docs/reference/v1/httpsHealthChecks
  • Adding Health Checks: 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 HTTPS health check
  google.cloud.gcp_compute_https_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 секунд.

Возвращено: success

creationTimestamp

строка

Дата и время создания в формате RFC3339.

Возвращено: success

description

строка

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

Возвращено: success

healthyThreshold

целое число

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

Возвращено: success

host

строка

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

Возвращено: success

id

целое число

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

Возвращено: success

name

строка

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

Возвращено: success

port

целое число

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

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

Возвращено: success

requestPath

строка

Путь запроса для проверки работоспособности HTTPS.

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

Возвращено: success

timeoutSec

целое число

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

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

Возвращено: success

unhealthyThreshold

целое число

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

Возвращено: success

Авторы

  • 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_https_health_check_module.html

Spec-Zone.ru

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