hetzner.hcloud.hcloud_load_balancer_service – Создание и управление службами облачных балансировщиков на Hetzner Cloud.
Примечание
Этот плагин является частью коллекции hetzner.hcloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install hetzner.hcloud.
Для использования в книге задач укажите: hetzner.hcloud.hcloud_load_balancer_service.
Новое в версии 0.1.0: из hetzner.hcloud
Обзор
- Создание, обновление и управление службами облачных балансировщиков на Hetzner Cloud.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- hcloud-python >= 1.0.0
- hcloud-python >= 1.8.1
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| api_token строка / обязательно | Это токен API для Hetzner Cloud. | |||
| destination_port целое число | Порт, на который перенаправляется трафик, т.е. порт, на котором целевые серверы слушают и принимают подключения. Требуется, если службы не существуют и протокол — tcp. | |||
| endpoint строка | По умолчанию: "https://api.hetzner.cloud/v1" | Это конечная точка API для Hetzner Cloud. | ||
| health_check словарь | Настройка проверки работоспособности | |||
| http словарь | Дополнительная настройка проверок работоспособности с протоколами http/https | |||
| domain строка | Домен, который будет установлен в заголовке HTTP HOST | |||
| path строка | Путь, который будет проверен | |||
| response строка | Ожидаемый ответ; если ответ не входит в проверку работоспособности, целевой сервер считается неработоспособным | |||
| status_codes список / элементы=строка | Список кодов состояния HTTP, которые ожидаются при проверке работоспособности. | |||
| tls логическое значение |
| Проверка сертификата TLS, доступно только при протоколе проверки работоспособности https | ||
| interval целое число | Интервал проверок работоспособности в секундах | |||
| port целое число | Порт, на котором будет выполняться проверка работоспособности | |||
| protocol строка |
| Протокол, по которому будут выполняться проверки работоспособности | ||
| retries целое число | Количество попыток, прежде чем целевой сервер будет помечен как неработоспособный | |||
| timeout целое число | Таймаут проверок работоспособности в секундах | |||
| http словарь | Настройка для HTTP и HTTPS служб | |||
| certificates список / элементы=строка | Список имен или идентификаторов сертификатов | |||
| cookie_lifetime целое число | Срок действия cookie, который будет установлен при включении сессий с сохранением состояния, в секундах | |||
| cookie_name строка | Имя cookie, которое будет установлено при включении сессий с сохранением состояния | |||
| redirect_http логическое значение |
| Перенаправление трафика с порта 80 на порт 443, доступно только при протоколе https | ||
| sticky_sessions логическое значение |
| Включить или отключить sticky_sessions | ||
| listen_port целое число / обязательно | Порт, на котором слушает служба, т.е. порт, к которому могут подключаться пользователи. | |||
| load_balancer строка / обязательно | Имя балансировщика нагрузки Hetzner Cloud, к которому принадлежит служба | |||
| protocol строка |
| Протокол службы. Требуется, если балансировщик нагрузки не существует. | ||
| proxyprotocol логическое значение |
| Включить PROXY-протокол. | ||
| state строка |
| Состояние балансировщика нагрузки. | ||
См. также
См. также
- Документация API Hetzner Cloud
-
Полное руководство по API Hetzner Cloud.
Примеры
- name: Create a basic Load Balancer service with Port 80
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)
hcloud_load_balancer_service:
load_balancer: my-Load Balancer
protocol: http
listen_port: 80
state: absent
Значения возврата
Общие значения возврата описаны в данном месте, ниже приведены поля, уникальные для этого модуля:
| Ключевые параметры | Возвращаемое значение | Описание | |||
|---|---|---|---|---|---|
| hcloud_load_balancer_service сложный тип | Всегда | Экземпляр службы балансировки нагрузки | |||
| destination_port целое число | всегда | Порт, на который будет перенаправлен трафик, т.е. порт, на котором целевые серверы слушают и принимают подключения. Пример: 80 | |||
| health_check сложный тип | всегда | Настройка проверок работоспособности | |||
| http сложный тип | всегда | Дополнительная настройка проверок работоспособности с протоколами http/https | |||
| domain строка | всегда | Домен, который будет установлен в заголовке HTTP HOST. Пример: example.com | |||
| path строка | всегда | Путь, который будет запрошен. Пример: / | |||
| response строка | всегда | Ожидаемый ответ. Если ответ не соответствует ожидаемому, целевой сервер считается неработоспособным. | |||
| status_codes список / элементы=строка | всегда | Список ожидаемых кодов состояния HTTP при проверке работоспособности. Пример: ['2??', '3??'] | |||
| tls булево | всегда | Проверка сертификата TLS. Доступно только если протокол проверки работоспособности — https. | |||
| interval целое число | всегда | Интервал проверок работоспособности в секундах. Пример: 15 | |||
| port целое число | всегда | Порт, на котором будет проводиться проверка работоспособности. Пример: 80 | |||
| protocol строка | всегда | Протокол, используемый для проверок работоспособности. Пример: http | |||
| retries целое число | всегда | Количество попыток повтора, прежде чем целевой сервер будет помечен как неработоспособный. Пример: 3 | |||
| timeout целое число | всегда | Таймаут проверок работоспособности в секундах. Пример: 10 | |||
| http сложный тип | всегда | Настройка для HTTP и HTTPS служб. | |||
| certificates список / элементы=строка | всегда | Список имен или идентификаторов сертификатов. | |||
| cookie_lifetime целое число | всегда | Срок действия cookie, который будет установлен при включении сессий с сохранением состояния (sticky sessions), в секундах. Пример: 3600 | |||
| cookie_name строка | всегда | Имя cookie, которое будет установлено при включении сессий с сохранением состояния (sticky sessions). Пример: HCLBSTICKY | |||
| redirect_http булево | всегда | Перенаправление трафика с порта 80 на порт 443. Доступно только если протокол — https. | |||
| sticky_sessions булево | всегда | Включить или отключить сессии с сохранением состояния (sticky sessions). Пример: True | |||
| listen_port целое число | всегда | Порт, на котором служба прослушивает подключения. Пример: 443 | |||
| load_balancer строка | всегда | Имя балансировщика нагрузки, к которому принадлежит служба. Пример: my-load-balancer | |||
| protocol строка | всегда | Протокол службы. Пример: http | |||
| proxyprotocol булево | всегда | Включить протокол PROXY. | |||
Авторы
- Lukas Kaemmerling (@LKaemmerling)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/hetzner/hcloud/hcloud_load_balancer_service_module.html
