diff --git a/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки.md b/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки.md new file mode 100644 index 0000000..a15a9ce --- /dev/null +++ b/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки.md @@ -0,0 +1,136 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_lb** служит для получения информации о балансировщике нагрузки (load balancer). Балансировщик нагрузки служит для равномерного распределения сетевой нагрузки на сервисы кубернетеса. + +## Аргументы +_Data source_ функция **decort_cb_lb** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| lb_id | int | :heavy_check_mark: | ID балансировщика | + + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_lb** возвращает следующие параметры: + +| Параметр | Тип | Описание | +|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| ha_mode | bool | Флаг, показывающий, включен ли режим haproxy | +| ckey | string | CKey | +| meta | []string | Мета информация | +| acl | string | Cписок Acces Control | +| backend_haip | string | Backend highly available ip | +| backends | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки#описание-структуры-backends) | Список бекендов | +| desc | string | Описание | +| dp_api_password | string | Пароль пользователя для работы | +| dp_api_user | string | Имя пользователя для работы | +| extnet_id | int | ID внешней сети | +| frontend_haip | string | Frontend highly available ip | +| frontends | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки#описание-структуры-frontends) | Список фронтендов | +| gid | int | Grid ID балансировщика | +| guid | int | ID балансировщика | +| lb_id | int | ID балансировщика | +| image_id | int | ID образа | +| milestones | int | Вехи | +| name | string | Имя балансировщика | +| part_k8s | bool | Является ли балансироващик частью кластера | +| primary_node | Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки#описание-структуры-primary_node) | Главный узел | +| rg_id | int | ID ресурсной группы | +| secondary_node | Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки#описание-структуры-secondary_node) | Второй узел | +| status | string | Статус | +| tech_status | string | Технический статус | +| vins_id | int | ID виртуальной сети | + +### Описание структуры backends +| Параметр | Тип | Описание | +|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| algorithm | string | Алгоритм работы бекенда | +| guid | string | ID ресурса | +| name | string | Имя бекенда | +| server_default_settings | Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки#описание-структуры-server_default_settings) | Описание настроек серверов бекенда по умолчанию | +| servers | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки#описание-структуры-servers) | Список серверов | + +### Описание структуры server_default_settings +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------------------------------------------------------------------------| +| downinter | int | Интервал между проверками на недоступность сервера | +| guid | string | ID ресурса | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +### Описание структуры servers +| Параметр | Тип | Описание | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| address | string | Адрес сервера | +| check | string | Включены ли проверки | +| guid | string | ID ресурса | +| name | string | Имя сервера | +| port | int | Порт сервера | +| server_settings | [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки#описание-структуры-server_settings) | Настройки сервера | + +### Описание структуры server_settings +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------------------------------------------------------------------------| +| downinter | int | Интервал между проверками на недоступность сервера | +| guid | string | ID ресурса | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +### Описание структуры frontends +| Параметр | Тип | Описание | +|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| backend | string | Имя бекенда, к которому подключен фронтенд | +| guid | string | ID ресурса | +| name | string | Имя фронтенда | +| bindings | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки#описание-структуры-bindings) | Привязки фронтенда | + +### Описание структуры bindings +| Параметр | Тип | Описание | +|----------|--------|-------------------------------------| +| address | string | Адрес, к которому привязан фронтенд | +| name | string | Имя привязки | +| port | int | Порт привязки | +| guid | string | ID ресурса | + +### Описание структуры primary_node +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| backend_ip | string | IP адрес бекенда | +| compute_id | int | ID виртуальной машины | +| frontend_ip | string | IP адрес фронтенда | +| guid | string | ID ресурса | +| mgmt_ip | string | IP адрес | +| network_id | int | ID сети | + +### Описание структуры secondary_node +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| backend_ip | string | IP адрес бекенда | +| compute_id | int | ID виртуальной машины | +| frontend_ip | string | IP адрес фронтенда | +| guid | string | ID ресурса | +| mgmt_ip | string | IP адрес | +| network_id | int | ID сети | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_lb**: +```terraform +data "decort_cb_lb" "lb" { + #id балансировщика нагрузок + #обязательный параметр + #тип - число + lb_id = 238 +} +``` + +После успешного завершения такого вызова **decort_cb_lb** в переменной `data.decort_cb_lb.lb` будут сохранены возвращаемые значения. diff --git a/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки.md b/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки.md new file mode 100644 index 0000000..19fb82b --- /dev/null +++ b/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки.md @@ -0,0 +1,156 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_lb_list** служит для получения информации об имеющихся в облачной платформе балансировщиках нагрузки. + +## Аргументы +_Data source_ функция **decort_cb_lb_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|----------------|--------|--------------|-----------------------------------------------| +| by_id | int | :x: | Фильтр по ID балансировщика | +| name | string | :x: | Фильтр по имени балансировщика | +| account_id | int | :x: | Фильтр по ID аккаунта | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| tech_status | string | :x: | Фильтр по тех. статусу | +| status | string | :x: | Фильтр по статусу | +| front_ip | string | :x: | Фильтр по IP фронтенда | +| back_ip | string | :x: | Фильтр по IP бэкенда | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | +| includedeleted | bool | :x: | Включить в результат удаленные балансировщики | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_lb_list** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| ha_mode | bool | Флаг, показывающий, включен ли режим haproxy | +| acl | string | Cписок Acces Control | +| backend_haip | string | Backend highly available ip | +| backends | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-backends) | Список бекендов | +| created_by | string | Аккаунт, создавший балансировщик | +| created_time | int | Время создания | +| deleted_by | string | Кем балансировщик был удален | +| deleted_time | int | Время удаления | +| desc | string | Описание | +| dp_api_user | string | Имя пользователя для работы | +| dp_api_password | string | Пароль пользователя | +| extnet_id | int | ID внешней сети | +| frontend_haip | string | Frontend highly available ip | +| frontends | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-frontends) | Список фронтендов | +| gid | int | Grid ID балансировщика | +| guid | int | ID балансировщика | +| lb_id | int | ID балансировщика | +| milestones | int | Вехи | +| name | string | Имя балансировщика | +| primary_node | Struct{} [см. описание узлов](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-primary_node) | Главный узел | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Имя ресурсной группы | +| secondary_node | Struct{} [см. описание узлов](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-secondary_node) | Второй узел | +| status | string | Статус | +| tech_status | string | Технический статус | +| updated_by | string | Кем балансировщик был обновлен | +| updated_time | string | Время последнего обновления | +| vins_id | int | ID виртуальной сети | + +### Описание структуры backends +| Параметр | Тип | Описание | +|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| algorithm | string | Алгоритм работы бекенда | +| guid | string | ID ресурса | +| name | string | Имя бекенда | +| server_default_settings | Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-server_default_settings) | Описание настроек серверов бекенда по умолчанию | +| servers | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-servers) | Список серверов | + +### Описание структуры server_default_settings +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------------------------------------------------------------------------| +| downinter | int | Интервал между проверками на недоступность сервера | +| guid | string | ID ресурса | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +### Описание структуры servers +| Параметр | Тип | Описание | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| address | string | Адрес сервера | +| check | string | Включены ли проверки | +| name | string | Имя сервера | +| port | int | Порт сервера | +| guid | string | ID ресурса | +| server_settings | [см. Описание структуры настроек](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-server_settings) | Настройки сервера | + +### Описание структуры server_settings +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------------------------------------------------------------------------| +| downinter | int | Интервал между проверками на недоступность сервера | +| guid | string | ID ресурса | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +### Описание структуры frontends +| Параметр | Тип | Описание | +|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| backend | string | Имя бекенда, к которому подключен фронтенд | +| guid | string | ID ресурса | +| name | string | Имя фронтенда | +| bindings | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки#Описание-структуры-bindings) | Привязки фронтенда | + +### Описание структуры bindings +| Параметр | Тип | Описание | +|----------|--------|-------------------------------------| +| address | string | Адрес, к которому привязан фронтенд | +| name | string | Имя привязки | +| port | int | Порт привязки | +| guid | string | ID ресурса | + +### Описание структуры primary_node +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| backend_ip | string | IP адрес бекенда | +| compute_id | int | ID виртуальной машины | +| frontend_ip | string | IP адрес фронтенда | +| guid | string | ID ресурса | +| mgmt_ip | string | IP адрес | +| network_id | int | ID сети | + +### Описание структуры secondary_node +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| backend_ip | string | IP адрес бекенда | +| compute_id | int | ID виртуальной машины | +| frontend_ip | string | IP адрес фронтенда | +| guid | string | ID ресурса | +| mgmt_ip | string | IP адрес | +| network_id | int | ID сети | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_lb_list**: + +```terraform +data "decort_cb_lb_list" "lbl" { + #by_id = 100 + #name = "test" + #account_id = 11111 + #rg_id = 100 + #tech_status = "STOPPED" + #status = "ENABLED" + #front_ip = "1.1.1.1." + #back_ip = "1.1.1.1" + #includedeleted = true + #page = 1 + #size = 1 +} +``` + +После успешного завершения такого вызова **decort_cb_lb_list** в переменной `data.decort_cb_lb_list.lbl` будут сохранены возвращаемые значения. diff --git a/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки.md b/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки.md new file mode 100644 index 0000000..5eefab9 --- /dev/null +++ b/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки.md @@ -0,0 +1,152 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_lb_list_deleted** служит для получения информации об удаленных балансировщиках нагрузки. + +## Аргументы +_Data source_ функция **decort_cb_lb_list_deleted** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|----------------|--------|--------------|-----------------------------------------------| +| by_id | int | :x: | Фильтр по ID балансировщика | +| name | string | :x: | Фильтр по имени балансировщика | +| account_id | int | :x: | Фильтр по ID аккаунта | +| rg_id | int | :x: | Фильтр по ID рес. группы | +| tech_status | string | :x: | Фильтр по тех. статусу | +| front_ip | string | :x: | Фильтр по IP фронтенда | +| back_ip | string | :x: | Фильтр по IP бэкенда | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_lb_list_deleted** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| ha_mode | bool | Флаг, показывающий, включен ли режим haproxy | +| acl | string | Cписок Acces Control | +| backend_haip | string | Backend highly available ip | +| backends | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки#Описание-структуры-backends) | Список бекендов | +| created_by | string | Аккаунт, создавший балансировщик | +| created_time | int | Время создания | +| deleted_by | string | Кем балансировщик был удален | +| deleted_time | int | Время удаления | +| desc | string | Описание | +| dp_api_user | string | Имя пользователя для работы | +| dp_api_password | string | Пароль пользователя | +| extnet_id | int | ID внешней сети | +| frontend_haip | string | Frontend highly available ip | +| frontends | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки#Описание-структуры-frontends) | Список фронтендов | +| gid | int | Grid ID балансировщика | +| guid | int | ID балансировщика | +| lb_id | int | ID балансировщика | +| milestones | int | Вехи | +| name | string | Имя балансировщика | +| primary_node | Struct{} [см. описание узлов](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки#Описание-структуры-primary_node) | Главный узел | +| rg_id | int | ID ресурсной группы | +| rg_name | string | Имя ресурсной группы | +| secondary_node | Struct{} [см. описание узлов](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки#Описание-структуры-secondary_node) | Второй узел | +| status | string | Статус | +| tech_status | string | Технический статус | +| updated_by | string | Кем балансировщик был обновлен | +| updated_time | string | Время последнего обновления | +| vins_id | int | ID виртуальной сети | + +### Описание структуры backends +| Параметр | Тип | Описание | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| algorithm | string | Алгоритм работы бекенда | +| guid | string | ID ресурса | +| name | string | Имя бекенда | +| server_default_settings | Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки#Описание-структуры-server_default_settings) | Описание настроек серверов бекенда по умолчанию | +| servers | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки#Описание-структуры-servers) | Список серверов | + +### Описание структуры server_default_settings +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------------------------------------------------------------------------| +| downinter | int | Интервал между проверками на недоступность сервера | +| guid | string | ID ресурса | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +### Описание структуры servers +| Параметр | Тип | Описание | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| address | string | Адрес сервера | +| check | string | Включены ли проверки | +| name | string | Имя сервера | +| port | int | Порт сервера | +| guid | string | ID ресурса | +| server_settings | [см. Описание структуры настроек](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки#Описание-структуры-server_settings) | Настройки сервера | + +### Описание структуры server_settings +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------------------------------------------------------------------------| +| downinter | int | Интервал между проверками на недоступность сервера | +| guid | string | ID ресурса | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +### Описание структуры frontends +| Параметр | Тип | Описание | +|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| backend | string | Имя бекенда, к которому подключен фронтенд | +| guid | string | ID ресурса | +| name | string | Имя фронтенда | +| bindings | []Struct{} [см. ниже](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки#Описание-структуры-bindings) | Привязки фронтенда | + +### Описание структуры bindings +| Параметр | Тип | Описание | +|----------|--------|-------------------------------------| +| address | string | Адрес, к которому привязан фронтенд | +| name | string | Имя привязки | +| port | int | Порт привязки | +| guid | string | ID ресурса | + +### Описание структуры primary_node +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| backend_ip | string | IP адрес бекенда | +| compute_id | int | ID виртуальной машины | +| frontend_ip | string | IP адрес фронтенда | +| guid | string | ID ресурса | +| mgmt_ip | string | IP адрес | +| network_id | int | ID сети | + +### Описание структуры secondary_node +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| backend_ip | string | IP адрес бекенда | +| compute_id | int | ID виртуальной машины | +| frontend_ip | string | IP адрес фронтенда | +| guid | string | ID ресурса | +| mgmt_ip | string | IP адрес | +| network_id | int | ID сети | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_lb_list_deleted**: + +```terraform +data "decort_cb_lb_list_deleted" "lbld" { + #by_id = 100 + #name = "test" + #account_id = 11111 + #rg_id = 100 + #tech_status = "STOPPED" + #front_ip = "1.1.1.1." + #back_ip = "1.1.1.1" + #page = 1 + #size = 1 +} +``` + +После успешного завершения такого вызова **decort_cb_lb_list_deleted** в переменной `data.decort_cb_lb_list_deleted.lbld` будут сохранены возвращаемые значения. diff --git a/07.01.16-Resource-функция-decort_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки.md b/07.01.16-Resource-функция-decort_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки.md index faf7dc7..b2ad158 100644 --- a/07.01.16-Resource-функция-decort_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки.md +++ b/07.01.16-Resource-функция-decort_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки.md @@ -11,7 +11,7 @@ _Resource_ функция **decort_lb_frontend_bind** принимает сле | name | string | :heavy_check_mark: | Название фронтенда | | frontend_name | string | :heavy_check_mark: | Название фронтенда балансировщика | | address | string | :heavy_check_mark: | IP адрес привязки | -| port | int | :heavy_check_mark: | Порт привязки +| port | int | :heavy_check_mark: | Порт привязки | ## Возвращаемые значения diff --git a/07.02.17-Resource-функция-decort_cb_lb-управление-балансировщиком-нагрузки.md b/07.02.17-Resource-функция-decort_cb_lb-управление-балансировщиком-нагрузки.md new file mode 100644 index 0000000..931396d --- /dev/null +++ b/07.02.17-Resource-функция-decort_cb_lb-управление-балансировщиком-нагрузки.md @@ -0,0 +1,160 @@ +Функция доступна в провайдере версии 3.1 и выше. + +_Resource_ функция **decort_cb_lb** служит для управления балансировщиком нагрузки (load balancer). Балансировщики нагрузки служат для равномерного распределения сетевой нагрузки между подключенными к ним сервисами. + +## Аргументы +_Resource_ функция **decort_cb_lb** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|--------------|--------|:------------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| rg_id | int | :heavy_check_mark: | ID ресурсной группы | +| name | string | :heavy_check_mark: | Название балансировщика | +| extnet_id | int | :heavy_check_mark: | ID внешней сети. extnet_id и vins_id не могут быть одновременно равны 0. | +| vins_id | int | :heavy_check_mark: | ID виртуальной сети. extnet_id и vins_id не могут быть одновременно равны 0. | +| start | bool | :heavy_check_mark: | Флаг запуска балансировщика. По умолчанию - true. Eсли load balancer был в статусе "stopped" (start = false), то для успешного старта, он должен быть доступен (enable = true) | +| desc | string | :x: | Описание балансировщика | +| enable | bool | :x: | Флаг доступности балансировщика | +| restart | bool | :x: | Флаг перезагрузки балансировщика. Можно использовать только на созданном ресурсе. По умолчанию - false. Перезагрузка происходит только при смене флага с false на true | +| config_reset | bool | :x: | Флаг сброса конфигурации балансировщика. По умолчанию - false. Сброс происходит только при изменении флага с false на true | +| ha_mode | bool | :x: | Использовать высокодоступную схему для развертывания LB | +| permanently | bool | :x: | Флаг моментального удаления балансировщика из платформы. По-умолчанию - false. При необходимости, после изменения значения флага, необходимо выполнить `terraform apply` для изменения значения флага в состоянии терраформа, а после этого - `terraform destroy` | +| restore | bool | :x: | Флаг восстановления балансировщика после удаления. Восстановить возможно только балансировщики, удаленные с флагом permanently равным false. Предварительно, необходимо импортировать удаленный ресурс и изменить значение флага. После этого - выполнить `terraform apply`. | + + +## Возвращаемые значения +В случае успешного выполнения _resource_ функция **decort_cb_lb** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров: + +| Параметр | Тип | Описание | +|-----------------|-------------------------------------------------------------------|----------------------------------------------| +| ha_mode | bool | Флаг, показывающий, включен ли режим haproxy | +| ckey | string | CKey | +| meta | []string | Мета информация | +| acl | string | Cписок Acces Control | +| backend_haip | string | Backend highly available ip | +| backends | []Struct{} [см. ниже](#Описание-структуры-backends) | Список бекендов | +| desc | string | Описание | +| dp_api_user | string | Имя пользователя для работы | +| dp_api_password | string | Пароль пользователя для работы | +| extnet_id | int | ID внешней сети | +| frontend_haip | string | Frontend highly available ip | +| frontends | []Struct{} [см. ниже](#Описание-структуры-frontends) | Список фронтендов | +| gid | int | Grid ID балансировщика | +| guid | int | ID балансировщика | +| lb_id | int | ID балансировщика | +| image_id | int | ID образа | +| milestones | int | Вехи | +| name | string | Имя балансировщика | +| part_k8s | bool | Является ли балансироващик частью кластера | +| primary_node | Struct{} [см. описание узлов](#Описание-структуры-primary_node) | Главный узел | +| rg_id | int | ID ресурсной группы | +| secondary_node | Struct{} [см. описание узлов](#Описание-структуры-secondary_node) | Второй узел | +| status | string | Статус | +| tech_status | string | Технический статус | +| vins_id | int | ID виртуальной сети | + +### Описание структуры backends +| Параметр | Тип | Описание | +|-------------------------|------------------------------------------------------------------|-------------------------------------------------| +| algorithm | string | Алгоритм работы бекенда | +| guid | string | ID ресурса | +| name | string | Имя бекенда | +| server_default_settings | Struct{} [см. ниже](#Описание-структуры-server_default_settings) | Описание настроек серверов бекенда по умолчанию | +| servers | []Struct{} [см. ниже](#Описание-структуры-servers) | Список серверов | + +### Описание структуры server_default_settings +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------------------------------------------------------------------------| +| guid | string | ID ресурса | +| downinter | int | Интервал между проверками на недоступность сервера | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +### Описание структуры servers +| Параметр | Тип | Описание | +|-----------------|-------------------------------------------------|----------------------| +| address | string | Адрес сервера | +| check | string | Включены ли проверки | +| name | string | Имя сервера | +| guid | string | ID ресурса | +| port | int | Порт сервера | +| server_settings | [см. ниже](#Описание-структуры-server_settings) | Настройки сервера | + +### Описание структуры server_settings +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------------------------------------------------------------------------| +| guid | string | ID ресурса | +| downinter | int | Интервал между проверками на недоступность сервера | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +### Описание структуры frontends +| Параметр | Тип | Описание | +|----------|-----------------------------------------------------|--------------------------------------------| +| backend | string | Имя бекенда, к которому подключен фронтенд | +| guid | string | ID ресурса | +| name | string | Имя фронтенда | +| bindings | []Struct{} [см. ниже](#Описание-структуры-bindings) | Привязки фронтенда | + +### Описание структуры bindings +| Параметр | Тип | Описание | +|----------|--------|-------------------------------------| +| address | string | Адрес, к которому привязан фронтенд | +| name | string | Имя привязки | +| guid | string | ID ресурса | +| port | int | Порт привязки | + +### Описание структуры primary_node +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| backend_ip | string | IP адрес бекенда | +| compute_id | int | ID виртуальной машины | +| frontend_ip | string | IP адрес фронтенда | +| guid | string | ID ресурса | +| mgmt_ip | string | IP адрес | +| network_id | int | ID сети | + +### Описание структуры secondary_node +| Параметр | Тип | Описание | +|-------------|--------|-----------------------| +| backend_ip | string | IP адрес бекенда | +| compute_id | int | ID виртуальной машины | +| frontend_ip | string | IP адрес фронтенда | +| guid | string | ID ресурса | +| mgmt_ip | string | IP адрес | +| network_id | int | ID сети | + +## Ограничение на наименование ресурса +Ресурс не должен содержать в названии символ `#` + + +## Пример использования +Пример вызова _resource_ функции **decort_cb_lb**: + +```terraform +resource "decort_cb_lb" "lb" { + rg_id = 1111 + name = "tf-test-lb" + extnet_id = 6 + vins_id = 758 + start = true + #ha_mode = true + #desc = "temp super lb for testing tf provider" + #enable = true + #restart = false + #config_reset = false + #permanently = false + #restore = true +} +``` + +После успешного завершения такого вызова **decort_cb_lb** в переменной `decort_cb_lb.lb` будут сохранены возвращаемые значения. diff --git a/07.02.18-Resource-функция-decort_cb_lb_backend-управление-бекендом-балансировщика-нагрузки.md b/07.02.18-Resource-функция-decort_cb_lb_backend-управление-бекендом-балансировщика-нагрузки.md new file mode 100644 index 0000000..b2c4bad --- /dev/null +++ b/07.02.18-Resource-функция-decort_cb_lb_backend-управление-бекендом-балансировщика-нагрузки.md @@ -0,0 +1,101 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Resource_ функция **decort_cb_lb_backend** служит для управления бекендом балансировщика нагрузки (load balancer). Балансировщики нагрузки служат для равномерного распределения сетевой нагрузки между подключенными к ним сервисами. + +## Аргументы +_Resource_ функция **decort_cb_lb_backend** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|-----------|--------|:------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lb_id | int | :heavy_check_mark: | ID балансировщика нагрузки | +| name | string | :heavy_check_mark: | Название бекенда | +| algorithm | string | :x: | Алгоритм работы бекенда. По умолчанию - "roundrobin". Доступные значения: "roundrobin", "static-rr", "leastconn" | +| inter | int | :x: | Интервал между проверками, в миллисекундах. Настройка севера по умолчанию. Значение по умолчанию - 5000. | +| downinter | int | :x: | Интервал между проверками доступности сервера после восстановления, в миллисекундах. Настройка севера по умолчанию. Значение по умолчанию - 1000. | +| rise | int | :x: | Кол-во проверок, которые сервер должен успешно пройти. Настройка севера по умолчанию. Значение по умолчанию - 2. | +| fall | int | :x: | Кол-во проверок, которые сервер может не пройти и после этого получить статус "unavailable". Настройка севера по умолчанию. Значение по умолчанию - 2. | +| slowstart | int | :x: | Кол-во миллисекунд - время между получением сервера статуса "available" и открытием соединений. Настройка севера по умолчанию. Значение по умолчанию - 60000. | +| maxconn | int | :x: | Максимальное кол-во соединений сервера, при достижении этого кол-ва, сервер выходит из схемы балансирования. Настройка севера по умолчанию. Значение по умолчанию - 250. | +| maxqueue | int | :x: | Максимальное кол-во соединений в очереди сервера, при достижении этого кол-ва, соединения будут перенаправлены на другой сервер. Настройка севера по умолчанию. Значение по умолчанию - 256. | +| weight | int | :x: | Вес сервера для балансировки. Диапазон от 0 до 255. Настройка севера по умолчанию. Значение по умолчанию - 100. | + +## Возвращаемые значения +В случае успешного выполнения _resource_ функция **decort_cb_lb_backend** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров: + +| Параметр | Тип | Описание | +|-----------|----------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lb_id | int | ID балансировщика нагрузки | +| name | string | Название бекенда | +| algorithm | string | Алгоритм работы бекенда. По умолчанию - "roundrobin". Доступные значения: "roundrobin", "static-rr", "leastconn" | +| inter | int | Интервал между проверками, в миллисекундах. Настройка севера по умолчанию. Значение по умолчанию - 5000. | +| downinter | int | Интервал между проверками доступности сервера после восстановления, в миллисекундах. Настройка севера по умолчанию. Значение по умолчанию - 1000. | +| rise | int | Кол-во проверок, которые сервер должен успешно пройти. Настройка севера по умолчанию. Значение по умолчанию - 2. | +| fall | int | Кол-во проверок, которые сервер может не пройти и после этого получить статус "unavailable". Настройка севера по умолчанию. Значение по умолчанию - 2. | +| slowstart | int | Кол-во миллисекунд - время между получением сервера статуса "available" и открытием соединений. Настройка севера по умолчанию. Значение по умолчанию - 60000. | +| maxconn | int | Максимальное кол-во соединений сервера, при достижении этого кол-ва, сервер выходит из схемы балансирования. Настройка севера по умолчанию. Значение по умолчанию - 250. | +| maxqueue | int | Максимальное кол-во соединений в очереди сервера, при достижении этого кол-ва, соединения будут перенаправлены на другой сервер. Настройка севера по умолчанию. Значение по умолчанию - 256. | +| weight | int | Вес сервера для балансировки. Диапазон от 0 до 255. Настройка севера по умолчанию. Значение по умолчанию - 100. | +| guid | string | ID ресурса | +| servers | []Struct{} [см. ниже](#Описание-структуры-servers) | Список серверов | + +### Описание структуры servers +| Параметр | Тип | Описание | +|-----------------|-------------------------------------------------|----------------------| +| address | string | Адрес сервера | +| check | string | Включены ли проверки | +| guid | string | ID ресурса | +| name | string | Имя сервера | +| port | int | Порт сервера | +| server_settings | [см. ниже](#Описание-структуры-server_settings) | Настройки сервера | + +### Описание структуры server_settings +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------------------------------------------------------------------------| +| downinter | int | Интервал между проверками на недоступность сервера | +| inter | int | Интервал между проверками на доступность сервера | +| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования | +| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" | +| guid | string | ID ресурса | +| slowstart | int | Интервал, в мс, в через который сервер получит статус "available" | +| maxconn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования | +| maxqueue | int | Кол-во соедений в очереди к серверу | +| weight | int | Вес сервера для работы алгоритма балансирования по весу | + +## Импортирование ресурса +Так как ресурс lb_backend является подресурсом lb, то для его импорта необходимо указать ID балансировщика, а так же само имя ресурса. +Общая схема: +```terraform +terraform import decort_cb_lb_backend. # +``` +Пример: +``` +terraform import decort_cb_lb_backend.lb 777#testBackend +``` + +## Ограничение на наименование ресурса +Ресурс не должен содержать в названии символ `#` + +## Пример использования +Пример вызова _resource_ функции **decort_cb_lb_backend**: +```terraform +resource "decort_cb_lb_backend" "lbb" { + lb_id = 777 + name = "testBackend" + #algorithm = "roundrobin" + + #------------------- + #настройки для серверов по умолчанию + #------------------- + + #inter = 5000 + #downinter = 1000 + #rise = 2 + #fall = 2 + #slowstart = 60000 + #maxconn = 250 + #maxqueue = 256 + #weight = 100 +} +``` + +После успешного завершения такого вызова **decort_cb_lb_backend** в переменной `decort_cb_lb_backend.lb` будут сохранены возвращаемые значения. diff --git a/07.02.19-Resource-функция-decort_cb_lb_backend_server-управление-сервером-бекендом-балансировщиком-нагрузки.md b/07.02.19-Resource-функция-decort_cb_lb_backend_server-управление-сервером-бекендом-балансировщиком-нагрузки.md new file mode 100644 index 0000000..3344507 --- /dev/null +++ b/07.02.19-Resource-функция-decort_cb_lb_backend_server-управление-сервером-бекендом-балансировщиком-нагрузки.md @@ -0,0 +1,87 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Resource_ функция **decort_cb_lb_backend_server** служит для управления сервером бекенда балансировщиком нагрузки (load balancer). Балансировщики нагрузки служат для равномерного распределения сетевой нагрузки между подключенными к ним сервисами. + +## Аргументы +_Resource_ функция **decort_cb_lb_backend_server** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|--------------|--------| :---: |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lb_id | int | :heavy_check_mark: | ID балансировщика нагрузки | +| backend_name | string | :heavy_check_mark: | Название бекенда | +| name | string | :heavy_check_mark: | Название сервера | +| address | string | :heavy_check_mark: | Адрес сервера | +| port | int | :heavy_check_mark: | Порт сервера | +| check | string | :x: | Проверка доступности сервера. По умолчанию - "enabled". Доступные значения: "disabled", "enabled" | +| inter | int | :x: | Интервал между проверками, в миллисекундах. Настройка севера по умолчанию. Значение по умолчанию - 5000. | +| downinter | int | :x: | Интервал между проверками доступности сервера после восстановления, в миллисекундах. Настройка севера по умолчанию. Значение по умолчанию - 1000. | +| rise | int | :x: | Кол-во проверок, которые сервер должен успешно пройти. Настройка севера по умолчанию. Значение по умолчанию - 2. | +| fall | int | :x: | Кол-во проверок, которые сервер может не пройти и после этого получить статус "unavailable". Настройка севера по умолчанию. Значение по умолчанию - 2. | +| slowstart | int | :x: | Кол-во миллисекунд - время между получением сервера статуса "available" и открытием соединений. Настройка севера по умолчанию. Значение по умолчанию - 60000. | +| maxconn | int | :x: | Максимальное кол-во соединений сервера, при достижении этого кол-ва, сервер выходит из схемы балансирования. Настройка севера по умолчанию. Значение по умолчанию - 250. | +| maxqueue | int | :x: | Максимальное кол-во соединений в очереди сервера, при достижении этого кол-ва, соединения будут перенаправлены на другой сервер. Настройка севера по умолчанию. Значение по умолчанию - 256. | +| weight | int | :x: | Вес сервера для балансировки. Диапазон от 0 до 255. Настройка севера по умолчанию. Значение по умолчанию - 100. | + +## Возвращаемые значения +В случае успешного выполнения _resource_ функция **decort_cb_lb_backend_server** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров: + +| Параметр | Тип | Описание | +|--------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lb_id | int | ID балансировщика нагрузки | +| backend_name | string | Название бекенда | +| name | string | Название сервера | +| address | string | Адрес сервера | +| port | int | Порт сервера | +| check | string | Проверка доступности сервера. По умолчанию - "enabled". Доступные значения: "disabled", "enabled" | +| inter | int | Интервал между проверками, в миллисекундах. Настройка севера по умолчанию. Значение по умолчанию - 5000. | +| downinter | int | Интервал между проверками доступности сервера после восстановления, в миллисекундах. Настройка севера по умолчанию. Значение по умолчанию - 1000. | +| rise | int | Кол-во проверок, которые сервер должен успешно пройти. Настройка севера по умолчанию. Значение по умолчанию - 2. | +| fall | int | Кол-во проверок, которые сервер может не пройти и после этого получить статус "unavailable". Настройка севера по умолчанию. Значение по умолчанию - 2. | +| slowstart | int | Кол-во миллисекунд - время между получением сервера статуса "available" и открытием соединений. Настройка севера по умолчанию. Значение по умолчанию - 60000. | +| maxconn | int | Максимальное кол-во соединений сервера, при достижении этого кол-ва, сервер выходит из схемы балансирования. Настройка севера по умолчанию. Значение по умолчанию - 250. | +| maxqueue | int | Максимальное кол-во соединений в очереди сервера, при достижении этого кол-ва, соединения будут перенаправлены на другой сервер. Настройка севера по умолчанию. Значение по умолчанию - 256. | +| weight | int | Вес сервера для балансировки. Диапазон от 0 до 255. Настройка севера по умолчанию. Значение по умолчанию - 100. | +| guid | string | ID ресурса | + + +## Импортирование ресурса +Так как ресурс lb_backend_server является подресурсом lb_backend, то для его импорта необходимо указать ID балансировщика, имя бекенда, а так же само имя ресурса. +Общая схема: +```terraform +terraform import decort_cb_lb_backend_server. ## +``` +Пример: +``` +terraform import decort_cb_lb_backend_server.lbbs 777#testBackend#testServer +``` +## Ограничение на наименование ресурса +Ресурс не должен содержать в названии символ `#` + + +## Пример использования +Пример вызова _resource_ функции **decort_cb_lb_backend_server**: +```terraform +resource "decort_cb_lb_backend_server" "lbbs" { + lb_id = 777 + backend_name = "testBackend" + name = "testServer" + address = "192.168.5.33" + port = 6553 + #check = "enabled" + + #------------------- + #настройки для сервера + #------------------- + + #inter = 5000 + #downinter = 1000 + #rise = 2 + #fall = 2 + #slowstart = 60000 + #maxconn = 250 + #maxqueue = 256 + #weight = 100 +} +``` + +После успешного завершения такого вызова **decort_cb_lb_backend_server** в переменной `decort_cb_lb_backend_server.lbbs` будут сохранены возвращаемые значения. diff --git a/07.02.20-Resource-функция-decort_cb_lb_frontend-управление-фронтендом-балансировщиком-нагрузки.md b/07.02.20-Resource-функция-decort_cb_lb_frontend-управление-фронтендом-балансировщиком-нагрузки.md new file mode 100644 index 0000000..1d70a3d --- /dev/null +++ b/07.02.20-Resource-функция-decort_cb_lb_frontend-управление-фронтендом-балансировщиком-нагрузки.md @@ -0,0 +1,58 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Resource_ функция **decort_cb_lb_frontend** служит для управления фронтендом балансировщиком нагрузки (load balancer). Балансировщики нагрузки служат для равномерного распределения сетевой нагрузки между подключенными к ним сервисами. + +## Аргументы +_Resource_ функция **decort_cb_lb_frontend** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|--------------|--------|:------------------:|---------------------------------| +| lb_id | int | :heavy_check_mark: | ID балансировщика нагрузки | +| name | string | :heavy_check_mark: | Название фронтенда | +| backend_name | string | :heavy_check_mark: | Название бекенда балансировщика | + + +## Возвращаемые значения +В случае успешного выполнения _resource_ функция **decort_cb_lb_frontend** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров: + +| Параметр | Тип | Описание | +|--------------|-----------------------------------------------------|--------------------------------------------| +| lb_id | int | ID балансировщика | +| backend_name | string | Имя бекенда, к которому подключен фронтенд | +| name | string | Имя фронтенда | +| bindings | []Struct{} [см. ниже](#Описание-структуры-bindings) | Привязки фронтенда | +| guid | string | ID ресурса | + +### Описание структуры bindings +| Параметр | Тип | Описание | +|----------|--------|-------------------------------------| +| address | string | Адрес, к которому привязан фронтенд | +| name | string | Имя привязки | +| guid | string | ID ресурса | +| port | int | Порт привязки | + +## Импортирование ресурса +Так как ресурс lb_frontend является подресурсом lb, то для его импорта необходимо указать ID балансировщика, а так же само имя ресурса. +Общая схема: +```terraform +terraform import decort_cb_lb_frontend. # +``` +Пример: +``` +terraform import decort_cb_lb_frontend.lb 777#testFrontend +``` + +## Ограничение на наименование ресурса +Ресурс не должен содержать в названии символ `#` + +## Пример использования +Пример вызова _resource_ функции **decort_cb_lb_frontend**: +```terraform +resource "decort_cb_lb_frontend" "lb" { + lb_id = 777 + backend_name = "testBackend" + name = "testFrontend" +} +``` + +После успешного завершения такого вызова **decort_cb_lb_frontend** в переменной `decort_cb_lb_frontend.lb` будут сохранены возвращаемые значения. diff --git a/07.02.21-Resource-функция-decort_cb_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки.md b/07.02.21-Resource-функция-decort_cb_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки.md new file mode 100644 index 0000000..c5df657 --- /dev/null +++ b/07.02.21-Resource-функция-decort_cb_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки.md @@ -0,0 +1,55 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Resource_ функция **decort_cb_lb_frontend_bind** служит для управления привязкой фронтенда балансировщиком нагрузки (load balancer). Балансировщики нагрузки служат для равномерного распределения сетевой нагрузки между подключенными к ним сервисами. + +## Аргументы +_Resource_ функция **decort_cb_lb_frontend_bind** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|---------------|--------|:------------------:| --- | +| lb_id | int | :heavy_check_mark: | ID балансировщика нагрузки | +| name | string | :heavy_check_mark: | Название фронтенда | +| frontend_name | string | :heavy_check_mark: | Название фронтенда балансировщика | +| address | string | :heavy_check_mark: | IP адрес привязки | +| port | int | :heavy_check_mark: | Порт привязки | + + +## Возвращаемые значения +В случае успешного выполнения _resource_ функция **decort_cb_lb_frontend_bind** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров: + +| Параметр | Тип | Описание | +|---------------|--------|-------------------------------------| +| address | string | Адрес, к которому привязан фронтенд | +| name | string | Имя привязки | +| frontend_name | string | Название фронтенда | +| lb_id | int | ID балансировщика | +| port | int | Порт привязки | +| guid | string | ID ресурса | + +## Импортирование ресурса +Так как ресурс lb_frontend_bind является подресурсом lb_frontend, то для его импорта необходимо указать ID балансировщика, имя фронтенда, а так же само имя ресурса. +Общая схема: +```terraform +terraform import decort_cb_lb_frontend_bind. ## +``` +Пример: +``` +terraform import decort_cb_lb_frontend_bind.lb 777#testFrontend#testBinding +``` + +## Ограничение на наименование ресурса +Ресурс не должен содержать в названии символ `#` + +## Пример использования +Пример вызова _resource_ функции **decort_cb_lb_frontend_bind**: +```terraform +resource "decort_cb_lb_frontend_bind" "lbfb" { + lb_id = 777 + frontend_name = "testFrontend" + name = "testBinding" + address = "111.111.111.111" + port = 1111 +} +``` + +После успешного завершения такого вызова **decort_cb_lb_frontend_bind** в переменной `decort_cb_lb_frontend_bind.lbfb` будут сохранены возвращаемые значения. diff --git a/Home.md b/Home.md index b64853e..c16267e 100644 --- a/Home.md +++ b/Home.md @@ -151,6 +151,9 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_cb_stack_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.34-Data-функция-decort_cb_stack_list-получение-информации-о-stack_list) - получение информации о списке вычислительных узлов (stack) - [**decort_cb_flipgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.35-Data-функция-decort_cb_flipgroup-получение-информации-о-группе-с-плавающим-ip-адресом) - получение информации о группе с плавающим ip-адресом - [**decort_cb_flipgroup_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.36-Data-функция-decort_cb_flipgroup_list-получение-информации-о-всех-группах-с-плавающим-ip-адресом) - получение информации о всех группах с плавающим ip-адресом + - [**decort_cb_lb**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.37-Data-функция-decort_cb_lb-получение-информации-о-балансировщике-нагрузки) - получение информации о балансировщике нагрузки + - [**decort_cb_lb_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.38-Data-функция-decort_cb_lb_list-получение-информации-о-балансировщиках-нагрузки) получение информации о балансировщиках нагрузки + - [**decort_cb_lb_list_deleted**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.39-Data-функция-decort_cb_lb_list_deleted-получение-информации-об-удаленных-балансировщиках-нагрузки) - получение информации об удаленных балансировщиках нагрузки --> 7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT) @@ -196,6 +199,11 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_cb_pcidevice**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.01-Resource-функция-decort_cb_pcidevice-управление-устройством) - управление pcidevice - [**decort_account**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.06-Resource-функция-decort_account-управление-аккаунтом) - управление аккаунтом - [**decort_cb_flipgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.16-Resource-функция-decort_cb_flipgroup-управление-плавающей-группой) - управление плавающей группой + - [**decort_cb_lb**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.17-Resource-функция-decort_cb_lb-управление-балансировщиком-нагрузки) - управление балансировщиком нагрузки + - [**decort_cb_lb_backend**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.18-Resource-функция-decort_cb_lb_backend-управление-бекендом-балансировщика-нагрузки) - управление бекендом балансировщика нагрузки + - [**decort_cb_lb_backend_server**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.19-Resource-функция-decort_cb_lb_backend_server-управление-сервером-бекендом-балансировщиком-нагрузки) управление сервером бекендом балансировщиком нагрузки + - [**decort_cb_lb_frontend**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.20-Resource-функция-decort_cb_lb_frontend-управление-фронтендом-балансировщиком-нагрузки) управление фронтендом балансировщиком нагрузки + - [**decort_cb_lb_frontend_bind**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.21-Resource-функция-decort_cb_lb_frontend_bind-управление-привязками-фронтенда-балансировщиком-нагрузки) - управление привязками фронтенда балансировщиком нагрузки --> 8. [Полезные советы](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы)