Spec-Zone.ru › Ansible

Модуль vultr.cloud.load_balancer — управление балансировщиками нагрузки в Vultr

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install vultr.cloud.

Чтобы использовать её в плейбуке, укажите: vultr.cloud.load_balancer.

Добавлено в vultr.cloud 1.14.0

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

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

  • Создание, обновление или удаление балансировщиков нагрузки в Vultr.

Параметры

Параметр

Комментарии

api_endpoint

string

URL конечной точки API (без завершающей косой черты).

Резервная переменная окружения VULTR_API_ENDPOINT.

По умолчанию: "https://api.vultr.com/v2"

api_key

string / обязательный

Ключ API Vultr.

Резервная переменная окружения VULTR_API_KEY.

api_results_per_page

integer

добавлено в vultr.cloud 1.14.0

При получении большого количества ресурсов укажите, сколько результатов возвращать за один вызов API.

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

Максимальное значение для API Vultr — 500.

Резервная переменная окружения VULTR_API_RESULTS_PER_PAGE.

По умолчанию: 100

api_retries

integer

Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out.

Резервная переменная окружения VULTR_API_RETRIES.

По умолчанию: 5

api_retry_max_delay

integer

Задержка между повторными попытками увеличивается экспоненциально до указанного максимального значения в секундах.

Резервная переменная окружения VULTR_API_RETRY_MAX_DELAY.

По умолчанию: 12

api_timeout

integer

Тайм-аут HTTP-запроса к API Vultr.

Резервная переменная окружения VULTR_API_TIMEOUT.

По умолчанию: 180

auto_ssl

dictionary

Конфигурация Auto SSL. Для использования Auto SSL необходимо использовать DNS Vultr.

domain_sub

string

Поддомен, добавляемый к доменной зоне

domain_zone

string

Доменная зона (например, example.com)

balancing_algorithm

string

Алгоритм балансировки.

Варианты:

  • "roundrobin" ← (по умолчанию)
  • "leastconn"

firewall_rules

list / элементы=dictionary

Массив объектов правил брандмауэра.

forwarding_rules

list / элементы=dictionary

Массив объектов правил перенаправления.

backend_port

integer / обязательный

Порт на серверной стороне.

backend_protocol

string / обязательный

Протокол на серверной стороне.

frontend_port

integer / обязательный

Порт на клиентской стороне.

frontend_protocol

string / обязательный

Протокол на клиентской стороне.

global_regions

list / элементы=string

Массив идентификаторов регионов, в которых будут развернуты дочерние балансировщики нагрузки.

health_check

dictionary

Конфигурация проверки работоспособности.

check_interval

integer

Интервал между проверками работоспособности в секундах.

healthy_threshold

integer

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

path

string

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

port

integer

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

protocol

string

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

response_timeout

integer

Тайм-аут ответа на проверку работоспособности в секундах.

unhealthy_threshold

integer

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

http2

boolean

Если значение true, будет включён трафик HTTP2.

Чтобы включить этот параметр, необходимо настроить правило перенаправления HTTPS -> HTTPS.

Варианты:

  • false
  • true

http3

boolean

Если значение true, будет включён трафик HTTP3/QUIC.

Необходимо включить HTTP2.

Варианты:

  • false
  • true

instances

list / элементы=string

Массив идентификаторов экземпляров, подключаемых к этому балансировщику нагрузки. Экземпляры будут подключены или отключены в соответствии с указанным массивом.

label

псевдонимы: name

string / обязательный

Метка балансировщика нагрузки.

nodes

integer

Количество узлов, добавляемых в балансировщик нагрузки (1–99); число должно быть нечётным. По умолчанию — 1.

По умолчанию: 1

proxy_protocol

boolean

Если указано значение true, необходимо настроить серверные узлы для приёма протокола Proxy.

Варианты:

  • false ← (по умолчанию)
  • true

region

string / обязательный

Регион, в котором будет создан балансировщик нагрузки.

ssl_redirect

boolean

Если значение true, весь трафик HTTP будет перенаправляться на HTTPS.

Чтобы включить этот параметр, необходимо настроить правило HTTPS и установить сертификат SSL на балансировщике нагрузки.

Варианты:

  • false
  • true

state

string

Состояние балансировщика нагрузки.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

sticky_session

dictionary

Включает закрепление сеансов за балансировщиком нагрузки, если задан параметр cookie_name.

timeout

integer

Максимальное время в секундах, в течение которого соединение может оставаться неактивным до истечения тайм-аута. По умолчанию — 600.

По умолчанию: 600

validate_certs

boolean

Проверять SSL-сертификаты API Vultr.

Варианты:

  • false
  • true ← (по умолчанию)

vpc

string

Идентификатор используемой VPC. Если не указан, используется общедоступная сеть.

Примечания

Примечание

  • См. также документацию API: https://www.vultr.com/api/.

Примеры

---
- name: Create a basic load balancer
  vultr.cloud.load_balancer:
    label: "example-lb"
    region: "ewr"
    forwarding_rules:
      - frontend_protocol: "http"
        frontend_port: 80
        backend_protocol: "http"
        backend_port: 80
      - frontend_protocol: "https"
        frontend_port: 443
        backend_protocol: "https"
        backend_port: 443
    balancing_algorithm: "roundrobin"
    ssl_redirect: true
    http2: true
    http3: false
    nodes: 1
    timeout: 600
    health_check:
      protocol: "http"
      port: 80
      path: "/"
      check_interval: 15
      response_timeout: 5
      unhealthy_threshold: 3
      healthy_threshold: 2
    proxy_protocol: false
    sticky_session: {}
    instances: []
    vpc: null
    firewall_rules: []
    auto_ssl: {}
    global_regions: []
    state: present

- name: Delete a load balancer
  vultr.cloud.load_balancer:
    label: "example-lb"
    region: "ewr"
    state: absent

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

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

Ключ

Описание

vultr_api

dictionary

Ответ API Vultr с небольшими дополнениями и изменениями.

Возвращается: success

api_account

string

Учетная запись, указанная в ini-файле для выбора ключа.

Возвращается: success

Пример: "default"

api_endpoint

string

Конечная точка, используемая для запросов API.

Возвращается: success

Пример: "https://api.vultr.com/v2"

api_retries

integer

Максимальное количество повторных попыток выполнения запросов API.

Возвращается: success

Пример: 5

api_retry_max_delay

integer

Максимальная задержка в секундах при экспоненциальном увеличении интервала между повторными попытками.

Возвращается: success

Пример: 12

api_timeout

integer

Тайм-аут, используемый для запросов API.

Возвращается: success

Пример: 60

vultr_load_balancer

dictionary

Ответ API Vultr.

Возвращается: success

auto_ssl

dictionary

Конфигурация Auto SSL.

Возвращается: success

date_created

string

Дата и время создания балансировщика нагрузки.

Возвращается: success

Пример: "2020-10-10T01:56:20+00:00"

firewall_rules

list / elements=dictionary

Список правил брандмауэра.

Возвращается: success

forwarding_rules

list / elements=dictionary

Список правил перенаправления.

Возвращается: success

generic_info

dictionary

Дополнительная общая информация о балансировщике нагрузки.

Возвращается: success

global_regions

list / elements=string

Список глобальных регионов для балансировщика нагрузки.

Возвращается: success

has_ssl

boolean

Включен ли SSL.

Возвращается: success

Пример: false

health_check

dictionary

Конфигурация проверки работоспособности балансировщика нагрузки.

Возвращается: success

http2

boolean

Включен ли HTTP/2.

Возвращается: success

Пример: false

http3

boolean

Включен ли HTTP/3.

Возвращается: success

Пример: false

id

string

Уникальный идентификатор балансировщика нагрузки.

Возвращается: success

Пример: "cb676a46-66fd-4dfb-b839-443f2e6c0b60"

instances

list / elements=string

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

Возвращается: success

ipv4

string

Адрес IPv4, назначенный балансировщику нагрузки.

Возвращается: success

Пример: "192.0.2.123"

ipv6

string

Адрес IPv6, назначенный балансировщику нагрузки.

Возвращается: success

Пример: "2001:0db8:5:4973:ffff:ffff:ffff:ffff"

label

string

Имя или метка балансировщика нагрузки.

Возвращается: success

Пример: "Example Load Balancer"

node_ips

dictionary

IP-адреса узлов.

Возвращается: success

nodes

integer

Количество узлов в балансировщике нагрузки.

Возвращается: success

Пример: 1

region

string

Код региона, в котором развернут балансировщик нагрузки.

Возвращается: success

Пример: "ewr"

status

string

Текущий статус балансировщика нагрузки.

Возвращается: success

Пример: "active"

Авторы

  • Garrett Haughawout (@ghaughawout)

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

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

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

Spec-Zone.ru

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