Модуль cloudscale_ch.cloud.load_balancer_health_monitor – Управление балансировщиками нагрузки в службе IaaS cloudscale.ch

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cloudscale_ch.cloud.

Для использования в playbook, укажите: cloudscale_ch.cloud.load_balancer_health_monitor.

Новое в cloudscale_ch.cloud 2.3.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Получение, создание, обновление, удаление мониторов работоспособности в службе IaaS cloudscale.ch.

Параметры

Параметр	Комментарии
api_timeout integer	Тайм-аут в секундах для вызовов API cloudscale.ch. Это также может быть передано в переменной окружения `CLOUDSCALE_API_TIMEOUT`. По умолчанию: `45`
api_token string / required	Токен API cloudscale.ch. Это также может быть передано в переменной окружения `CLOUDSCALE_API_TOKEN`.
api_url string добавлено в cloudscale_ch.cloud 1.3.0	URL API cloudscale.ch. Это также может быть передано в переменной окружения `CLOUDSCALE_API_URL`. По умолчанию: `"https://api.cloudscale.ch/v1"`
delay_s integer	Задержка между двумя последовательными проверками в секундах.
down_threshold integer	Количество проверок, которые должны завершиться неудачей, прежде чем состояние monitor_status участника пула изменится на «недоступен».
http dictionary	Дополнительные параметры для мониторов работоспособности типа «http» или «https».
expected_codes list / elements=string	HTTP-коды состояния, допустимые для успешной проверки. См. подробности в [документации API](https://www.cloudscale.ch/en/api/v1#http-attribute-specification).
host string	Имя сервера в заголовке HTTP Host, используемое для проверки. Требуется, чтобы version была установлена в «1.1».
method string	HTTP-метод, используемый для проверки.
url_path string	URL, используемый для проверки.
version string	Версия HTTP, используемая для проверки.
pool string	Пул монитора работоспособности.
state string	Состояние монитора работоспособности балансировщика нагрузки. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags dictionary	Теги, связанные с балансировщиком нагрузки. Установите это значение в `{}`, чтобы очистить все теги.
timeout_s integer	Максимальное время, разрешенное для отдельной проверки, в секундах.
type string	Тип монитора работоспособности. См. допустимые параметры в [документации API](https://www.cloudscale.ch/en/api/v1#create-a-health-monitor).
up_threshold integer	Количество проверок, которые должны завершиться успешно, прежде чем состояние monitor_status участника пула изменится на «доступен».
uuid string	UUID монитора работоспособности балансировщика нагрузки.

Примечания

Примечание

Мониторы работоспособности не имеют имен. Для ссылки на мониторы работоспособности используются uuid.
Все операции выполняются с использованием публичного API cloudscale.ch v1.
Для получения подробной информации обратитесь к полной документации по API: https://www.cloudscale.ch/en/api/v1.
Для всех операций требуется действительный токен API. Вы можете создать столько токенов, сколько вам нужно, используя панель управления cloudscale.ch по адресу https://control.cloudscale.ch.

Примеры

# Create a simple health monitor for a pool
- name: Create a load balancer pool
  cloudscale_ch.cloud.load_balancer_pool:
    name: 'swimming-pool'
    load_balancer: '3d41b118-f95c-4897-ad74-2260fea783fc'
    algorithm: 'round_robin'
    protocol: 'tcp'
    api_token: xxxxxx
  register: load_balancer_pool

- name: Create a load balancer health monitor (ping)
  cloudscale_ch.cloud.load_balancer_health_monitor:
    pool: '{{ load_balancer_pool.uuid }}'
    type: 'ping'
    api_token: xxxxxx
  register: load_balancer_health_monitor

# Get load balancer health monitor facts by UUID
- name: Get facts of a load balancer health monitor by UUID
  cloudscale_ch.cloud.load_balancer_health_monitor:
    uuid: '{{ load_balancer_health_monitor.uuid }}'
    api_token: xxxxxx

# Update a health monitor
- name: Update HTTP method of a load balancer health monitor from GET to CONNECT
  cloudscale_ch.cloud.load_balancer_health_monitor:
    uuid: '{{ load_balancer_health_monitor_http.uuid }}'
    delay_s: 2
    timeout_s: 1
    up_threshold: 2
    down_threshold: 3
    type: 'http'
    http:
      expected_codes:
        - 200
        - 202
      method: 'CONNECT'
      url_path: '/'
      version: '1.1'
      host: 'host1'
    tags:
      project: ansible-test
      stage: production
      sla: 24-7
    api_token: xxxxxx
  register: load_balancer_health_monitor

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
created_at строка	Дата и время создания монитора балансировщика нагрузки Возвращаемое значение: успех, когда state != отсутствует Пример: `"2023-02-22T09:55:38.285018Z"`
delay_s целое число	Задержка между двумя последовательными проверками в секундах Возвращаемое значение: успех, когда state != отсутствует Пример: `2`
down_threshold целое число	Количество проверок, которые должны завершиться ошибкой, прежде чем статус монитора pool member изменится на «отключен» Возвращаемое значение: успех, когда state != отсутствует Пример: `3`
href строка	API URL для получения подробностей о мониторе балансировщика нагрузки Возвращаемое значение: успех, когда state != отсутствует Пример: `"https://api.cloudscale.ch/v1/load-balancers/health-monitors/ee4952d4-2eba-4dec-8957-7911b3ce245b"`
http словарь	Расширенные параметры для мониторов состояния с типом «http» или «https» Возвращаемое значение: успех, когда state != отсутствует Пример: `[{"expected_codes": ["200"], "host": null, "method": "GET", "url_path": "/", "version": "1.0"}]`
pool словарь	Группа монитора состояния Возвращаемое значение: успех, когда state != отсутствует Пример: `[{"href": "https://api.cloudscale.ch/v1/load-balancers/pools/618a6cc8-d757-4fab-aa10-d49dc47e667b"}, {"uuid": "618a6cc8-d757-4fab-aa10-d49dc47e667b"}, {"name": "swimming pool"}]`
tags словарь	Теги, связанные с балансировщиком нагрузки Возвращаемое значение: успех Пример: `{"project": "my project"}`
timeout_s целое число	Максимальное время, разрешенное для отдельной проверки в секундах Возвращаемое значение: успех, когда state != отсутствует Пример: `1`
type строка	Тип монитора состояния Возвращаемое значение: успех, когда state != отсутствует
up_threshold целое число	Количество успешных проверок, необходимых для изменения статуса монитора pool member на «включен» Возвращаемое значение: успех, когда state != отсутствует Пример: `2`
uuid строка	Уникальный идентификатор этого монитора балансировщика нагрузки Возвращаемое значение: успех Пример: `"ee4952d4-2eba-4dec-8957-7911b3ce245b"`

Авторы

Gaudenz Steinlin (@gaudenz)
Kenneth Joss (@k-304)

Ссылки на сборку

© 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/cloudscale_ch/cloud/load_balancer_health_monitor_module.html