community.general.oneandone_load_balancer – Настройка балансировщика нагрузки 1&1.

Примечание

Этот плагин входит в коллекцию community.general (версия 2.0.1).

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

Для использования в книге задач укажите: community.general.oneandone_load_balancer.

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

Обзор

Создание, удаление, обновление балансировщиков нагрузки. Данный модуль зависит от 1and1 >= 1.0

Требования

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

1and1
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
add_rules список / элементы=строка		Список правил, которые будут добавлены к существующему балансировщику нагрузки. Его синтаксис аналогичен синтаксису параметра rules. Используется в сочетании с состоянием update.
add_server_ips список / элементы=строка		Список идентификаторов серверов (id или имя), которые будут назначены балансировщику нагрузки. Используется в сочетании с состоянием update.
api_url строка		Пользовательский URL API. Переопределяет переменную среды ONEANDONE_API_URL.
auth_token строка		Аутентификационный токен API, предоставленный 1&1.
datacenter строка	Варианты: US ES DE GB	Идентификатор или код страны дата-центра, где будет создан балансировщик нагрузки. Если не указано, используется значение по умолчанию US.
description строка		Описание балансировщика нагрузки. maxLength=256
health_check_interval строка		Период проверки работоспособности в секундах. minimum=5, maximum=300, multipleOf=1
health_check_parse строка		Регулярное выражение для проверки. Требуется для проверки работоспособности HTTP. maxLength=64
health_check_path строка		URL для вызова при проверке работоспособности. Требуется для проверки работоспособности HTTP. maxLength=1000
health_check_test строка	Варианты: NONE TCP HTTP ICMP	Тип проверки работоспособности. В настоящее время HTTP не поддерживается.
load_balancer строка		Идентификатор (id или имя) балансировщика нагрузки, используемый с состоянием update.
method строка	Варианты: ROUND_ROBIN LEAST_CONNECTIONS	Процедура балансировки.
name строка		Имя балансировщика нагрузки, используемое с состоянием present. Используется в качестве идентификатора (id или имя) при использовании состояния absent. maxLength=128
persistence логическое значение	Варианты: нет да	Поддержка сохранения состояния.
persistence_time строка		Время сохранения состояния в секундах. Требуется при включении сохранения состояния. minimum=30, maximum=1200, multipleOf=1
remove_rules список / элементы=строка		Список идентификаторов правил, которые будут удалены из существующего балансировщика нагрузки. Используется в сочетании с состоянием update.
remove_server_ips список / элементы=строка		Список идентификаторов IP-адресов серверов, которые будут удалены из балансировщика нагрузки. Используется в сочетании с состоянием update.
rules список / элементы=строка		Список объектов правил, которые будут установлены для балансировщика нагрузки. Каждое правило должно содержать параметры protocol, port_balancer и port_server, а также необязательный параметр source.
state строка	Варианты: present ← absent update	Определите состояние балансировщика нагрузки для создания, удаления или обновления.
wait логическое значение	Варианты: нет да ←	подождите, пока экземпляр не перейдет в состояние 'running', прежде чем возвращать результат
wait_interval целое число	Значение по умолчанию: 5	Определяет количество секунд ожидания при использовании методов _wait_for
wait_timeout целое число	Значение по умолчанию: 600	время ожидания до сброса ожидания в секундах

Примеры

- name: Create a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    name: ansible load balancer
    description: Testing creation of load balancer with ansible
    health_check_test: TCP
    health_check_interval: 40
    persistence: true
    persistence_time: 1200
    method: ROUND_ROBIN
    datacenter: US
    rules:
     -
       protocol: TCP
       port_balancer: 80
       port_server: 80
       source: 0.0.0.0
    wait: true
    wait_timeout: 500

- name: Destroy a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    name: ansible load balancer
    wait: true
    wait_timeout: 500
    state: absent

- name: Update a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer
    name: ansible load balancer updated
    description: Testing the update of a load balancer with ansible
    wait: true
    wait_timeout: 500
    state: update

- name: Add server to a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer updated
    description: Adding server to a load balancer with ansible
    add_server_ips:
     - server identifier (id or name)
    wait: true
    wait_timeout: 500
    state: update

- name: Remove server from a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer updated
    description: Removing server from a load balancer with ansible
    remove_server_ips:
     - B2504878540DBC5F7634EB00A07C1EBD (server's ip id)
    wait: true
    wait_timeout: 500
    state: update

- name: Add rules to a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer updated
    description: Adding rules to a load balancer with ansible
    add_rules:
     -
       protocol: TCP
       port_balancer: 70
       port_server: 70
       source: 0.0.0.0
     -
       protocol: TCP
       port_balancer: 60
       port_server: 60
       source: 0.0.0.0
    wait: true
    wait_timeout: 500
    state: update

- name: Remove rules from a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer updated
    description: Adding rules to a load balancer with ansible
    remove_rules:
     - rule_id #1
     - rule_id #2
     - ...
    wait: true
    wait_timeout: 500
    state: update

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

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

Ключ	Возвращаемое значение	Описание
load_balancer словарь	всегда	Информация о обработанном балансировщике нагрузки Пример: {"id": "92B74394A397ECC3359825C1656D67A6", "name": "Балансировщик по умолчанию"}

Авторы

Amel Ajdinovic (@aajdinov)
Ethan Devenport (@edevenport)

© 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/community/general/oneandone_load_balancer_module.html