You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
22 KiB
22 KiB
Модуль decort_lb
Обзор модуля decort_lb
Модуль decort_lb предназначен для выполнения следующих действий над балансировщиками нагрузки:
- создать
- получить информацию
- отключить/включить/запустить/перезапустить
- изменить конфигурации backend и frontend
- удалить (в корзину или безвозвратно)
- восстановить из корзины
Параметры модуля decort_lb
Ниже приведен полный список параметров для модуля decort_lb:
| Параметр | Тип | Описание | ||
|---|---|---|---|---|
| account_id | (int) | Идентификатор аккаунта. | ||
| account_name | (str) |
Имя аккаунта.
Может быть альтернативой параметру account_id.
|
||
| annotation |
(str)
Default: Managed by Ansible module decort_lb
|
Описание балансировщика. | ||
| app_id | (str) |
Идентификатор приложения, использующийся для подключения к контроллеру
облачной платформы DECORT в режиме authenticator: oauth2.
Данный параметр является обязательным для указанного режима. Если
параметр не задан в playbook, модуль будет использовать значение
переменной окружения DECORT_APP_ID.
|
||
| app_secret | (str) |
Секретный ключ приложения, который используется для подключения к
контроллеру облачной платформы DECORT в режиме
authenticator: oauth2. Данный параметр является
обязательным для указанного режима. Так как он содержит секретную
информацию, то его не рекомендуется задавать непосредственно в
playbook. Если параметр не задан в playbook, то модуль будет
использовать значение переменной окружения
DECORT_APP_SECRET.
|
||
| authenticator |
(str)
Значения: oauth2
jwt
|
Режим аутентификации при подключении к контроллеру облачной платформы DECORT. Обязательный параметр. | ||
| backends | (list) | Список словарей, описывающих конфигурации backend. | ||
| algorithm |
(str)
Значения: leastconn
roundrobin
static-rr
Default: roundrobin
|
Используемый алгоритм. | ||
| default_settings | (dict) | Cловарь, описывающий параметры по умолчанию для backend-серверов. | ||
| downinter |
(int)
Default: 1000
|
Интервал в миллисекундах между двумя последовательными проверками доступности сервера, который считается недоступным. | ||
| fall |
(int)
Default: 2
|
Количество последовательных неудачных проверок доступности, после которых сервер, ранее считавшийся доступным, начинает считаться недоступным и временно исключается из схемы балансировки. | ||
| inter |
(int)
Default: 5000
|
Интервал в миллисекундах между двумя последовательными проверками доступности сервера, который считается доступным. | ||
| maxconn |
(int)
Default: 250
|
Лимит одновременных подключений к серверу. При достижении этого лимита сервер временно исключается из схемы балансировки. | ||
| maxqueue |
(int)
Default: 256
|
Лимит соединений, ожидающих в очереди. Когда этот предел будет достигнут, все последующие подключения будут перенаправлены на другие серверы. | ||
| rise |
(int)
Default: 2
|
Количество проверок, которые должен пройти сервер, считавшийся недоступным, чтобы начать считаться доступным и снова быть включенным в схему балансировки. | ||
| slowstart |
(int)
Default: 60000
|
Интервал в миллисекундах с момента когда сервер начинает считаться доступным, по истечении которого количество фактически разрешенных подключений к этому серверу будет возвращено до 100% от установленного лимита. | ||
| weight |
(int)
Default: 100
|
Вес сервера для использования в алгоритмах балансировки. | ||
| name | (str) | Название backend. Обязательный параметр. | ||
| controller_url | (str) | URL контроллера, соответствующего экземпляру облачной платформы DECORT. Данный параметр является обязательным. | ||
| ext_net_id | (int) |
Идентификатор внешней сети.
Может быть не задан, если задан vins_id -
в таком случае балансировщик будет подключён только к
внутренней сети.
|
||
| frontends | (list) | Список словарей, описывающих конфигурации frontend. | ||
| backend | (str) | Название используемого backend. Обязательный параметр. | ||
| bindings | (list) | Список словарей, описывающих конфигурации binding. | ||
| address | (str) |
IP-адрес.
Если не задан, то будет использоваться основной IP-адрес балансировщика во внешней сети или, если подключена только внутренняя сеть, основной IP-адрес балансировщика во внутренней сети. |
||
| name | (str) | Название. Обязательный параметр. | ||
| port |
(int)
Значения: 1-65535
|
Порт. Обязательный параметр. | ||
| ha_lb |
bool
Default: false
|
Использовать схему высокой доступности для создаваемого балансировщика. | ||
| jwt | (str) |
JSON Web Token (JWT), который будет использоваться для подключения
к контроллеру облачной платформы DECORT в режиме
authenticator: jwt. Данный параметр является
обязательным для указанного режима. Так как он содержит
потенциально секретную информацию, а сам JWT, как правило,
имеет ограниченное время жизни, то его не рекомендуется задавать
непосредственно в playbook. Если этот параметр не определен в
playbook, то модуль будет использовать значение переменной
окружения DECORT_JWT.
|
||
| lb_id | (int) | Идентификатор балансировщика нагрузки. | ||
| lb_name | (str) | Имя балансировщика. | ||
| oauth2_url | (str) |
URL авторизационного сервера, работающего по протоколу Oauth2,
который должен использоваться в режиме
authenticator: oauth2. Данный параметр является
обязательным для указанного режима. Если параметр не задан в
playbook, модуль будет использовать значение переменной
окружения DECORT_OAUTH2_URL.
|
||
| permanently |
(bool)
Default: false
|
Если выполняется удаление, то выполнить безвозвратное удаление (минуя корзину). | ||
| rg_id | (int) | Идентификатор ресурсной группы. | ||
| rg_name | (str) |
Имя ресурсной группы.
В комбинации с заданным аккаунтов может быть альтернативой параметру rg_id
|
||
| servers | (list) | Список словарей, описывающих конфигурации backend-серверов. | ||
| address | (str) | IP-адрес. Обязательный параметр. | ||
| backends | (list) |
Список словарей, описывающих параметры backend-сервера для разных
конфигураций backend.
Обязательный параметр. |
||
| check |
(str)
Значения: enabled
disabled
Default: enabled
|
Проверка доступности сервера. | ||
| name | (str) | Название конфигурации backend. Обязательный параметр. | ||
| port |
(int)
Значения: 1-65535
|
Порт. Обязательный параметр. | ||
| server_settings | (dict) |
Словарь, описывающий параметры backend-сервера.
Ключи данного словаря аналогичны ключам словаря default_settings . |
||
| name | (str) | Название. Обязательный параметр. | ||
| state |
(str)
Значения: present
absent
enabled
disabled
restart
Default: present
|
Целевое состояние балансировщика нагрузки.
Выполнение с state=restart позволяет выполнить
перезапуск балансировщика, соответственно, всегда возвращает
changed: true.
Значения present и enabled равнозначны
и соответствуют включённому и запущенному балансировщику.
|
||
| verify_ssl |
(bool)
Default: true
|
Позволяет отключить проверку SSL сертификатов при выполнении API вызовов в адрес контроллера облачной инфраструктуры, например, при работе с изолированной облачной инфраструктурой, использующей самоподписанные сертификаты. Применяйте данный параметр с осторожностью, предпочтительно в защищенных средах. | ||
| vins_id | (int) |
Идентификатор внутренней сети.
Может быть не задан, если задан ext_net_id -
в таком случае балансировщик будет подключён только к
внешней сети.
|
||
| vins_name | (str) |
Имя внутренней сети.
В комбинации с заданной РГ может быть альтернативой для параметра vins_id.
|
||
Возвращаемые значения модуля decort_lb
Модуль decort_lb возвращает информацию о балансировщике в виде словаря facts со следующими ключами:
| Ключ |
Тип
данных |
Описание | |||
|---|---|---|---|---|---|
| backends | list | Список словарей, описывающих конфигурации backend. | |||
| algorithm | str | Используемый алгоритм. | |||
| name | str | Название конфигурации backend. | |||
| serverDefaultSettings | dict |
Cловарь, описывающий параметры по умолчанию для backend-серверов.
Ключи данного словаря аналогичны ключам словаря default_settings . |
|||
| servers | list | Список словарей, описывающих конфигурации backend-серверов. | |||
| address | str | IP-адрес. | |||
| check | str | Проверка доступности сервера. | |||
| name | str | Название. | |||
| port | int | Порт. | |||
| serverSettings | dict |
Cловарь, описывающий параметры backend-сервера.
Ключи данного словаря аналогичны ключам словаря default_settings . |
|||
| frontends | list |
Список словарей, описывающих конфигурации frontend.
Ключи данного словаря аналогичны ключам словарей списка frontends . |
|||
| gid | int | Идентификатор физического кластера (Grid ID). | |||
| id | int | Идентификатор балансировщика. | |||
| name | str | Имя балансировщика. | |||
| rg_id | int | Идентификатор ресурсной группы. | |||
| state | str | Статус балансировщика. | |||