hetzner.hcloud.load_balancer_service модуль — Создание и управление службами облачных балансировщиков нагрузки на Hetzner Cloud.

Примечание

Этот модуль входит в состав коллекции hetzner.hcloud (версия 3.1.1).

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

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

Для использования в книге задач укажите: hetzner.hcloud.load_balancer_service.

Новинка в hetzner.hcloud 0.1.0

Описание
Требования
Параметры
См. также
Примеры
Возвращаемые значения

Описание

Создание, обновление и управление службами облачных балансировщиков нагрузки на Hetzner Cloud.

Псевдонимы: hcloud_load_balancer_service

Требования

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

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint строка	Конечная точка API для Hetzner Cloud. Вы также можете установить это значение, используя переменную среды `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_token строка / обязательно	Токен API для Hetzner Cloud. Вы также можете установить это значение, используя переменную среды `HCLOUD_TOKEN`.
destination_port целое число	Порт, на который будет перенаправлен трафик, т.е. порт, на котором целевые узлы слушают и принимают подключения. Требуется, если служба не существует и протокол — tcp.
health_check словарь	Настройка проверок работоспособности
http словарь	Дополнительная настройка проверок работоспособности для протоколов http/https
domain строка	Домен, который будет задан в заголовке HTTP HOST
path строка	Путь, который будет запрошен
response строка	Ожидаемый ответ. Если ответ не соответствует ожидаемому, целевой узел считается неработоспособным.
status_codes список / элементы=строка	Список ожидаемых кодов состояния HTTP при проверке работоспособности.
tls логическое значение	Проверить сертификат TLS, доступно только если протокол проверки — https Варианты: `false` ← (по умолчанию) `true`
interval целое число	Интервал проверок работоспособности, в секундах
port целое число	Порт, на котором будет выполняться проверка работоспособности
protocol строка	Протокол, по которому будут выполняться проверки работоспособности Варианты: `"http"` `"https"` `"tcp"`
retries целое число	Количество попыток, прежде чем узел будет помечен как неработоспособный
timeout целое число	Таймаут проверок работоспособности, в секундах
http словарь	Настройка для HTTP и HTTPS служб
certificates список / элементы=строка	Список имён или идентификаторов сертификатов
cookie_lifetime целое число	Срок действия cookie, который будет установлен при включении постоянных сессий, в секундах
cookie_name строка	Имя cookie, которое будет установлено при включении постоянных сессий
redirect_http логическое значение	Перенаправлять трафик с порта 80 на порт 443, доступно только если протокол — https Варианты: `false` ← (по умолчанию) `true`
sticky_sessions логическое значение	Включить или выключить постоянные сессии Варианты: `false` ← (по умолчанию) `true`
listen_port целое число / обязательно	Порт, на котором служба слушает подключения, т.е. порт, к которому пользователи могут подключиться.

load_balancer строка / обязательно	Имя или идентификатор балансировщика нагрузки Hetzner Cloud, к которому принадлежит служба.
protocol строка	Протокол службы. Требуется, если балансировщик нагрузки не существует. Выбираемые значения: `"http"` `"https"` `"tcp"`
proxyprotocol логическое значение	Включить PROXY-протокол. Выбираемые значения: `false` ← (по умолчанию) `true`
state строка	Состояние балансировщика нагрузки. Выбираемые значения: `"absent"` `"present"` ← (по умолчанию)

См. также

Документация API Hetzner Cloud: Полная справка по API Hetzner Cloud.

Примеры

- name: Create a basic Load Balancer service with Port 80
  hetzner.hcloud.load_balancer_service:
    load_balancer: my-load-balancer
    protocol: http
    listen_port: 80
    state: present

- name: Ensure the Load Balancer is absent (remove if needed)
  hetzner.hcloud.load_balancer_service:
    load_balancer: my-Load Balancer
    protocol: http
    listen_port: 80
    state: absent

Возвращаемые значения

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

Ключ	Описание
hcloud_load_balancer_service complex	Экземпляр службы балансировки нагрузки Возвращается: Всегда
destination_port integer	Порт, на который перенаправляется трафик, т.е. порт, на котором целевые объекты прослушивают и принимают соединения. Возвращается: всегда Пример: `80`
health_check complex	Конфигурация проверок работоспособности Возвращается: всегда
http complex	Дополнительная конфигурация проверок работоспособности с протоколом http/https Возвращается: всегда
domain string	Домен, который будет установлен в заголовке HTTP HOST Возвращается: всегда Пример: `"example.com"`
path string	Путь, к которому будет осуществляться доступ Возвращается: всегда Пример: `"/"`
response string	Ожидаемый ответ. Если ответ не соответствует ожидаемому, целевой объект считается неработоспособным. Возвращается: всегда
status_codes list / elements=string	Список кодов состояния HTTP, которые ожидается получить при выполнении проверки работоспособности. Возвращается: всегда Пример: `["2??", "3??"]`
tls boolean	Проверить сертификат TLS, доступно только если протокол проверки работоспособности - https Возвращается: всегда Пример: `false`
interval integer	Интервал проверок работоспособности, в секундах Возвращается: всегда Пример: `15`
port integer	Порт, на котором будет выполняться проверка работоспособности Возвращается: всегда Пример: `80`
protocol string	Протокол, по которому будут выполняться проверки работоспособности Возвращается: всегда Пример: `"http"`
retries integer	Количество попыток, прежде чем целевой объект будет помечен как неработоспособный Возвращается: всегда Пример: `3`
timeout integer	Тайм-аут проверок работоспособности, в секундах Возвращается: всегда Пример: `10`
http complex	Конфигурация для служб HTTP и HTTPS Возвращается: всегда
certificates list / elements=string	Список имен или ID сертификатов Возвращается: всегда
cookie_lifetime integer	Время жизни cookie, который будет установлен при включении sticky sessions, в секундах Возвращается: всегда Пример: `3600`

cookie_name string	Имя cookie, которое будет установлено при включении сессий с сохранением состояния Возвращаемое значение: всегда Пример: `"HCLBSTICKY"`
redirect_http boolean	Перенаправление трафика с порта 80 на порт 443, доступно только если протокол https Возвращаемое значение: всегда Пример: `false`
sticky_sessions boolean	Включить или выключить sticky_sessions Возвращаемое значение: всегда Пример: `true`
listen_port integer	Порт, на котором служба прослушивает подключения. Возвращаемое значение: всегда Пример: `443`
load_balancer string	Имя балансировщика нагрузки, к которому относится служба Возвращаемое значение: всегда Пример: `"my-load-balancer"`
protocol string	Протокол службы Возвращаемое значение: всегда Пример: `"http"`
proxyprotocol boolean	Включить PROXY-протокол. Возвращаемое значение: всегда Пример: `false`

Авторы

Lukas Kaemmerling (@LKaemmerling)

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

© 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/hetzner/hcloud/load_balancer_service_module.html