update resource rg; add data sources for rg
93
06.02.58-Data-функция-decort_cb_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md
Normal file
93
06.02.58-Data-функция-decort_cb_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы.md
Normal file
@@ -0,0 +1,93 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_rg_list_computes** служит для получения информации о компьютах ресурсной группы.
|
||||||
|
|
||||||
|
Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS).
|
||||||
|
|
||||||
|
Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_rg_list_computes**.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_rg_list_computes** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы |
|
||||||
|
| compute_id | int | :x: | Фильтр по ID компьюта |
|
||||||
|
| name | string | :x: | Фильтр по имени компьюта |
|
||||||
|
| account_id | int | :x: | Фильтр по ID аккаунта |
|
||||||
|
| tech_status | string | :x: | Фильтр по тех. статусу |
|
||||||
|
| status | string | :x: | Фильтр по статусу |
|
||||||
|
| ip_address | string | :x: | Фильтр по IP адресу |
|
||||||
|
| extnet_name | string | :x: | Фильтр по имени extnet |
|
||||||
|
| extnet_id | int | :x: | Фильтр по ID extnet |
|
||||||
|
| page | int | :x: | Номер страницы |
|
||||||
|
| size | int | :x: | Размер страницы |
|
||||||
|
|
||||||
|
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
|
||||||
|
|
||||||
|
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_rg_list_computes** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|---------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------|
|
||||||
|
| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. |
|
||||||
|
| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. |
|
||||||
|
| affinity_label | string | Лейбл аффинити |
|
||||||
|
| affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила аффинити для компьютов |
|
||||||
|
| affinity_weight | int | weight аффинити |
|
||||||
|
| anti_affinity_rules | []Struct [см. ниже](#описание-структуры-affinity-rules) | Правила анти аффинити для компьютов |
|
||||||
|
| cpus | int | Количество виртуальных CPU, выделенных данному серверу. |
|
||||||
|
| created_by | string | Кем создан ресурс |
|
||||||
|
| created_time | int | Время создания ресурса |
|
||||||
|
| deleted_by | string | Кем удален ресурс |
|
||||||
|
| deleted_time | int | Время удаления ресурса |
|
||||||
|
| id | int | Идентификатор компьюта |
|
||||||
|
| name | string | Имя виртуального сервера |
|
||||||
|
| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. |
|
||||||
|
| registered | bool | Компьют зарегестрирован |
|
||||||
|
| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. |
|
||||||
|
| rg_id | int | ID ресурсной группы |
|
||||||
|
| status | string | Статус диска |
|
||||||
|
| tech_status | string | Технический статус диска |
|
||||||
|
| total_disk_size | int | Размер диска |
|
||||||
|
| updated_by | string | Кем обновлен ресурс |
|
||||||
|
| updated_time | int | Время обновления ресурса |
|
||||||
|
| user_managed | bool | User managed |
|
||||||
|
| vins_connected | int | Кол-во присоединенных винсов |
|
||||||
|
|
||||||
|
### Описание структуры affinity rules
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| guid | string | guid |
|
||||||
|
| key | string | Ключ |
|
||||||
|
| mode | string | Режим сравнения |
|
||||||
|
| policy | string | Степень "строгости" этого правила |
|
||||||
|
| topology | string | Топология |
|
||||||
|
| value | string | Значение |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_rg_list_computes**:
|
||||||
|
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_rg_list_computes" "list_computes" {
|
||||||
|
rg_id = 123
|
||||||
|
#compute_id = 100
|
||||||
|
#name = "test"
|
||||||
|
#account_id = 100
|
||||||
|
#tech_status = "STARTED"
|
||||||
|
#status = "ENABLED"
|
||||||
|
#ip_address = "1.1.1.1.1"
|
||||||
|
#extnet_name = "test"
|
||||||
|
#extnet_id = 100
|
||||||
|
#page = 1
|
||||||
|
#size = 1
|
||||||
|
}
|
||||||
|
# Once the above directive completes, resource group computes will be accessible as
|
||||||
|
# data.decort_cb_rg_list_computes.list_computes.items
|
||||||
|
```
|
||||||
|
|
||||||
|
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)).
|
||||||
|
|
||||||
|
После успешного завершения такого вызова **decort_cb_rg_list_computes** в переменной `data.decort_cb_rg_list_computes.list_computes.items` будут сохранены возвращаемые значения.
|
||||||
105
06.02.59-Data-функция-decort_cb_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md
Normal file
105
06.02.59-Data-функция-decort_cb_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп.md
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_rg_list_deleted** служит для получения информации о удаленных ресурсных группах.
|
||||||
|
|
||||||
|
Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS).
|
||||||
|
|
||||||
|
Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_rg_list_deleted**.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_rg_list_deleted** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| by_id | int | :x: | Фильтр по ID рес. группы |
|
||||||
|
| name | string | :x: | Фильтр по имени рес. группы |
|
||||||
|
| account_id | int | :x: | Фильтр по ID аккаунта |
|
||||||
|
| account_name | string | :x: | Фильтр по имени аккаунта |
|
||||||
|
| created_after | int | :x: | Фильтр рес. групп, созданных после опредленного момента во времени (unix timestamp) |
|
||||||
|
| created_before | int | :x: | Фильтр рес. групп, созданных перед опредленным моментом во времени (unix timestamp) |
|
||||||
|
| lock_status | string | :x: | Фильтр по lock статусу |
|
||||||
|
| page | int | :x: | Номер страницы |
|
||||||
|
| size | int | :x: | Размер страницы |
|
||||||
|
|
||||||
|
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
|
||||||
|
|
||||||
|
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_rg_list_deleted** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- |----------------------------------------------------------| --- |
|
||||||
|
| account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. |
|
||||||
|
| account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. |
|
||||||
|
| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control |
|
||||||
|
| cpu_allocation_parameter | string | Параметр выделения CPU |
|
||||||
|
| cpu_allocation_ratio | float | Отношение выделения CPU |
|
||||||
|
| created_by | string | Кем создан ресурс |
|
||||||
|
| created_time | int | Время создания ресурса |
|
||||||
|
| def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.<br/>Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. |
|
||||||
|
| def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:<br> * EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`<br> * PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`<br> * NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. |
|
||||||
|
| deleted_by | string | Кем удален ресурс |
|
||||||
|
| deleted_time | int | Время удаления ресурса |
|
||||||
|
| desc | string | Текстовое описание данной ресурсной группы. |
|
||||||
|
| dirty | bool | Dirty |
|
||||||
|
| gid | int | Идентификатор grid, которому будет принадлежать создаваемая ресурсная группа. |
|
||||||
|
| guid | int | GUID |
|
||||||
|
| rg_id | int | Идентификатор данной ресурсной группы. |
|
||||||
|
| lock_status | string | Lock статус |
|
||||||
|
| milestones | int | Milestones |
|
||||||
|
| name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). |
|
||||||
|
| register_computes | bool | Флаг отвечающий за то зарегестрированы ли компьюты |
|
||||||
|
| resource_limits | []Struct [см. ниже](#описание-структуры-resource-limits) | Лимиты ресурсов |
|
||||||
|
| secret | string | Секрет |
|
||||||
|
| status | string | Статус resgroup |
|
||||||
|
| updated_by | string | Кем был сделан апдейт |
|
||||||
|
| updated_time | int | Время апдейта |
|
||||||
|
| vins | []int | Список id виртуальных сетей |
|
||||||
|
| vms | []int | Список id компьютов |
|
||||||
|
| resource_types | []string | Res types |
|
||||||
|
| uniq_pools | []string | Uniq pools |
|
||||||
|
|
||||||
|
### Описание структуры acl
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| explicit | bool | Явно ли указан доступ |
|
||||||
|
| guid | string | guid Ресурса |
|
||||||
|
| right | string | Права на ресурс |
|
||||||
|
| status | string | Статус ресурса |
|
||||||
|
| type | string | Тип ресурса |
|
||||||
|
| user_group_id | string | ID user group |
|
||||||
|
|
||||||
|
### Описание структуры resources limits
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| cu_c | float | Количество ядер CPU |
|
||||||
|
| cu_d | float | Размер диска |
|
||||||
|
| cu_dm | float | Использованный размер хранилища виртуального диска |
|
||||||
|
| cu_i | float | Количество публичных IP адресов |
|
||||||
|
| cu_m | float | размер RAM |
|
||||||
|
| cu_np | float | Хранилище траффика |
|
||||||
|
| gpu_units | float | количество GPU ядер |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_rg_list_deleted**:
|
||||||
|
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_rg_list_deleted" "list_deleted" {
|
||||||
|
#by_id = 100
|
||||||
|
#name = "test"
|
||||||
|
#account_id = 11111
|
||||||
|
#account_name = "test"
|
||||||
|
#created_after = 123
|
||||||
|
#created_before = 123
|
||||||
|
#lock_status = "UNLOCKED"
|
||||||
|
#page = 1
|
||||||
|
#size = 2
|
||||||
|
}
|
||||||
|
# Once the above directive completes, resource group items will be accessible as
|
||||||
|
# data.decort_cb_rg_list_deleted.list_deleted.items
|
||||||
|
```
|
||||||
|
|
||||||
|
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)).
|
||||||
|
|
||||||
|
После успешного завершения такого вызова **decort_cb_rg_list_deleted** в переменной `data.decort_cb_rg_list_deleted.list_deleted.items` будут сохранены возвращаемые значения.
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_rg_list_lb** служит для получения информации о списке lb ресурсной группы.
|
||||||
|
|
||||||
|
Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS).
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_rg_list_lb** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
| --- |--------| --- | --- |
|
||||||
|
| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы |
|
||||||
|
| by_id | int | :x: | Фильтр по ID балансировщика |
|
||||||
|
| name | string | :x: | Фильтр по имени балансировщика |
|
||||||
|
| account_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: | Размер страницы |
|
||||||
|
|
||||||
|
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
|
||||||
|
|
||||||
|
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_rg_list_lb** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------------|---------------------------------------------------------|----------------------------------------------|
|
||||||
|
| ha_mode | bool | Флаг, показывающий, включен ли режим haproxy |
|
||||||
|
| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control |
|
||||||
|
| backends | []Struct{} [см. ниже](#описание-структуры-backends) | Список бекендов |
|
||||||
|
| created_by | string | Аккаунт, создавший балансировщик |
|
||||||
|
| created_time | int | Время создания |
|
||||||
|
| deleted_by | string | Кем балансировщик был удален |
|
||||||
|
| deleted_by | int | Время удаления |
|
||||||
|
| desc | string | Описание балансировщика |
|
||||||
|
| dp_api_user | string | Имя пользователя для работы |
|
||||||
|
| extnet_id | int | ID внешней сети |
|
||||||
|
| frontends | []Struct{} [см. ниже](#описание-структуры-frontends) | Список фронтендов |
|
||||||
|
| gid | int | Grid ID балансировщика |
|
||||||
|
| guid | int | ID балансировщика |
|
||||||
|
| id | int | ID балансировщика |
|
||||||
|
| image_id | int | ID образа |
|
||||||
|
| milestones | int | Вехи |
|
||||||
|
| name | string | Имя балансировщика |
|
||||||
|
| primary_node | Struct{} [см. ниже](#описание-структуры-primary_node) | Главный узел |
|
||||||
|
| rg_name | string | Название ресурсной группы |
|
||||||
|
| secondary_node | Struct{} [см. ниже](#описание-структуры-secondary_node) | Второй узел |
|
||||||
|
| status | string | Статус |
|
||||||
|
| tech_status | string | Технический статус |
|
||||||
|
| updated_by | string | Кем был обновлен балансировщик |
|
||||||
|
| updated_time | int | Время последнего обновления балансировщик |
|
||||||
|
| vins_id | int | 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 сети |
|
||||||
|
|
||||||
|
### Описание структуры frontends
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
|
||||||
|
| backend | string | Имя бекенда, к которому подключен фронтенд |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
| name | string | Имя фронтенда |
|
||||||
|
| bindings | []Struct{} [см. ниже](#описание-структуры-bindings) | Привязки фронтенда |
|
||||||
|
|
||||||
|
### Описание структуры bindings
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------|--------|-------------------------------------|
|
||||||
|
| address | string | Адрес, к которому привязан фронтенд |
|
||||||
|
| name | string | Имя привязки |
|
||||||
|
| port | int | Порт привязки |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
|
||||||
|
### Описание структуры acl
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| explicit | bool | Явно ли указан доступ |
|
||||||
|
| guid | string | guid Ресурса |
|
||||||
|
| right | string | Права на ресурс |
|
||||||
|
| status | string | Статус ресурса |
|
||||||
|
| type | string | Тип ресурса |
|
||||||
|
| user_group_id | string | ID user group |
|
||||||
|
|
||||||
|
### Описание структуры backends
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- |-----------------------------------------------------------------| --- |
|
||||||
|
| algorithm | string | Алгоритм работы бекенда |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
| name | string | Имя бекенда |
|
||||||
|
| server_default_settings | Struct{} [см. ниже](#описание-структуры-server_settings) | Описание настроек серверов бекенда по умолчанию |
|
||||||
|
| servers | []Struct{} [см. ниже](#описание-структуры-servers) | Список серверов |
|
||||||
|
|
||||||
|
### Описание структуры servers
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- |------------------------------------------------------------| --- |
|
||||||
|
| address | string | Адрес сервера |
|
||||||
|
| check | string | Включены ли проверки |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
| name | string | Имя сервера |
|
||||||
|
| port | int | Порт сервера |
|
||||||
|
| server_settings | []Struct{} [см. ниже](#описание-структуры-server_settings) | Настройки сервера |
|
||||||
|
|
||||||
|
### Описание структуры привязки фронтенда
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| address | string | Адрес, к которому привязан фронтенд |
|
||||||
|
| name | string | Имя привязки |
|
||||||
|
| port | int | Порт привязки |
|
||||||
|
|
||||||
|
### Описание структуры server_settings
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|------------| --- | --- |
|
||||||
|
| down_inter | int | Интервал между проверками на недоступность сервера |
|
||||||
|
| guid | string | ID ресурса |
|
||||||
|
| inter | int | Интервал между проверками на доступность сервера |
|
||||||
|
| rise | int | Кол-во попыток, после которых, сервер будет вновь включен в схему балансирования |
|
||||||
|
| fall | int | Кол-во неудачных попыток, после которых, сервер получит статус "unavailable" |
|
||||||
|
| slow_start | int | Интервал, в мс, в через который сервер получит статус "available" |
|
||||||
|
| max_conn | int | Кол-во соединений к северу, при достижении этого кол-ва, сервера выходит из схемы балансирования |
|
||||||
|
| max_queue | int | Кол-во соедений в очереди к серверу |
|
||||||
|
| weight | int | Вес сервера для работы алгоритма балансирования по весу |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_rg_list_lb**:
|
||||||
|
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_rg_list_lb" "list_lb" {
|
||||||
|
rg_id = 123
|
||||||
|
#by_id = 100
|
||||||
|
#тип - строка
|
||||||
|
#name = "test"
|
||||||
|
#account_id = 11111
|
||||||
|
#tech_status = "STOPPED"
|
||||||
|
#status = "ENABLED"
|
||||||
|
#front_ip = "ENABLED"
|
||||||
|
#back_ip = "ENABLED"
|
||||||
|
#page = 1
|
||||||
|
#size = 1
|
||||||
|
}
|
||||||
|
# Once the above directive completes, resource group list of load balancers will be accessible as
|
||||||
|
# data.decort_cb_rg_list_lb.list_lb.items
|
||||||
|
```
|
||||||
|
|
||||||
|
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)).
|
||||||
|
|
||||||
|
После успешного завершения такого вызова **decort_cb_rg_list_lb** в переменной `data.decort_cb_rg_list_lb.list_lb.items` будут сохранены возвращаемые значения.
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_rg_list_pfw** служит для получения информации о списке pfw ресурсной группы.
|
||||||
|
|
||||||
|
Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS).
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_rg_list_pfw** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
| --- |-----| --- | --- |
|
||||||
|
| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы |
|
||||||
|
|
||||||
|
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
|
||||||
|
|
||||||
|
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_rg_list_pfw** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| public_port_end | int | Конец диапазона внешних портов |
|
||||||
|
| public_port_start | int | Начало диапазона внешних портов |
|
||||||
|
| vm_id | int | ID компьюта|
|
||||||
|
| vm_ip | string | Локальный ip адрес vm |
|
||||||
|
| vm_name | string | Имя vm |
|
||||||
|
| vm_port | int | Порт vm |
|
||||||
|
| vins_id | int | Идентификатор vins |
|
||||||
|
| vins_name | string | Имя vins |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_rg_list_pfw**:
|
||||||
|
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_rg_list_pfw" "list_pfw" {
|
||||||
|
rg_id = 1234
|
||||||
|
}
|
||||||
|
# Once the above directive completes, resource group port forwarding rules will be accessible as
|
||||||
|
# data.decort_cb_rg_list_pfw.list_pfw.items
|
||||||
|
```
|
||||||
|
|
||||||
|
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)).
|
||||||
|
|
||||||
|
После успешного завершения такого вызова **decort_cb_rg_list_pfw** в переменной `data.decort_cb_rg_list_pfw.list_pfw.items` будут сохранены возвращаемые значения.
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
Функция доступна в провайдере версии 4.5.1 и выше.
|
||||||
|
|
||||||
|
_Data source_ функция **decort_cb_rg_list_vins** служит для получения информации о списке vins ресурсной группы.
|
||||||
|
|
||||||
|
Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS).
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Data source_ функция **decort_cb_rg_list_vins** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы |
|
||||||
|
| name | string | :x: | Фильтр по имени ViNS |
|
||||||
|
| account_id | int | :x: | Фильтр по ID аккаунта |
|
||||||
|
| ext_ip | string | :x: | Фильтр по внешнему IP |
|
||||||
|
| vins_id | int | :x: | Фильтр по ID ViNS |
|
||||||
|
| page | int | :x: | Номер страницы |
|
||||||
|
| size | int | :x: | Размер страницы |
|
||||||
|
|
||||||
|
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
|
||||||
|
|
||||||
|
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _data source_ функция **decort_cb_rg_list_vins** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|----------------|--------|--------------------------------------------------------|
|
||||||
|
| account_id | int | Уникальный идентификатор подписчика-владельца ViNS. |
|
||||||
|
| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. |
|
||||||
|
| computes | int | Кол-во компьютов |
|
||||||
|
| created_by | int | Кем создан ресурс |
|
||||||
|
| created_time | int | Время создания |
|
||||||
|
| deleted_by | string | Кем удален |
|
||||||
|
| deleted_time | int | Время удаления |
|
||||||
|
| external_ip | string | Внешний ip |
|
||||||
|
| id | int | идентификатор vins |
|
||||||
|
| name | string | Имя ресурса |
|
||||||
|
| network | string | Сеть |
|
||||||
|
| pri_vnf_dev_id | int | ID vnf dev |
|
||||||
|
| rg_id | int | ID ресурсной группы |
|
||||||
|
| rg_name | string | Имя ресурсной группы |
|
||||||
|
| status | string | Статус |
|
||||||
|
| updated_by | string | Кем обновлен ресрус |
|
||||||
|
| updated_time | int | Время обнавления ресурса |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
Пример вызова _data source_ функции **decort_cb_rg_list_vins**:
|
||||||
|
|
||||||
|
```terraform
|
||||||
|
data "decort_cb_rg_list_vins" "list_vins" {
|
||||||
|
rg_id = 123
|
||||||
|
# vins_id = 100
|
||||||
|
# name = "test"
|
||||||
|
# account_id = 11111
|
||||||
|
# ext_ip = "test"
|
||||||
|
# page = 2
|
||||||
|
# size = 3
|
||||||
|
}
|
||||||
|
# Once the above directive completes, resource group vins will be accessible as
|
||||||
|
# data.decort_cb_rg_list_vins.list_vins.items
|
||||||
|
```
|
||||||
|
|
||||||
|
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)).
|
||||||
|
|
||||||
|
После успешного завершения такого вызова **decort_cb_rg_list_vins** в переменной `data.decort_cb_rg_list_vins.list_vins.items` будут сохранены возвращаемые значения.
|
||||||
@@ -0,0 +1,150 @@
|
|||||||
|
_Resource_ функция **decort_cb_rg** служит для управления ресурсными группами в облачной платформе DECORT.
|
||||||
|
|
||||||
|
## Аргументы
|
||||||
|
_Resource_ функция **decort_cb_rg** принимает следующие аргументы:
|
||||||
|
|
||||||
|
| Аргумент | Тип | Обязательный | Описание |
|
||||||
|
|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| account_id | int | :heavy_check_mark: | Идентификатор подписчика (aka "account"), которому будет принадлежать создаваемая ресурсная группа. |
|
||||||
|
| rg_name | string | :heavy_check_mark: | Имя ресурсной группы. Должно быть уникальным в рамках одного и того же подписчика ("account"), не может быть пустым. |
|
||||||
|
| gid | int | :heavy_check_mark: | Идентификатор площадки (grid id) |
|
||||||
|
| owner | string | :x: | Имя пользователя – владелец этой РГ. Оставьте поле пустым, чтобы назначить текущего пользователя владельцем. |
|
||||||
|
| def_net_type | string | :x: | Тип сети по умолчанию для этой РГ. Виртуальные машины, созданные в этой РГ, будут по умолчанию подключены к этой сети. Допустимые значения: `PRIVATE`, `PUBLIC`, `NONE`. Значение по умолчанию: `PRIVATE`. |
|
||||||
|
| description | string | :x: | Текстовое описание данной ресурсной группы.<br/>Данный параметр не является обязательным, значение по умолчанию - пустая строка. |
|
||||||
|
| ext_ip | string | :x: | IP адрес из диапазона, принадлежащего внешней сети, который будет присвоен подключению ViNS во внешнюю сеть в случае, когда `def_net_type = "PRIVATE"` и ненулевом `ext_net_id`. При других значениях `def_net_type` данный параметр игнорируется.<br/>Если данный параметр не указан явно, то платформа автоматически выберет свободный IP адрес.<br/>Если заданный `ext_ip` уже используется, платформа вернёт ошибку. |
|
||||||
|
| ext_net_id | int | :x: | Идентификатор внешней сети, в которую будет подключён ViNS, автоматически создаваемый платформой для данной ресурсной группы в случае, когда `def_net_type = "PRIVATE"`. При других значениях `def_net_type` данный параметр игнорируется.<br/>Если данный параметр не задан явно при `def_net_type = "PRIVATE"`, то платформа выберет первую из доступных данному пользователю внешних сетей. |
|
||||||
|
| ipcidr | string | :x: | Адрес сети внутри ViNS для случая `def_net_type = "PRIVATE"`<br/>Если данный параметр явно не задан, то платформа назначит адрес сети автоматически. |
|
||||||
|
| resource_limits | []Struct{<br/>cu_c int;<br/> <br/>cu_dm int;<br/> <br/>cu_i int;<br/> <br/>cu_m int;<br/> <br/>cu_np int;<br/>} | :x: | Квоты на объем ресурсов, устанавливаемые для данной ресурсной группы:<br/> <br/>Максимальное количество ядер процессора;<br/> <br/>Максимальный размер агрегированных виртуальных дисков в ГБ;<br/> <br/>Максимальное количество назначенных публичных IP-адресов;<br/> <br/>Максимальный объем памяти в МБ;<br/> <br/>Максимальный отправленный / полученный пиринг сетевой передачи. |
|
||||||
|
| reason | string | :x: | Причина создания/изменения ресурсной группы. |
|
||||||
|
| register_computes | bool | :x: | Флаг регистрации ВМ во внешней системе |
|
||||||
|
| uniq_pools | []string | :x: | Список пулов. Например, ["sep1_poolName1", "sep2_poolName2"] |
|
||||||
|
| access | []Struct{<br/>user string;<br/> <br/>right string;<br/> <br/>reason string;<br/>} | :x: | Блок для предоставления пользователю или группе пользователей доступа к ресурсной группе:<br/> <br/>Имя пользователя или группы для предоставления доступа (обязательный параметр в блоке access);<br/> <br/>Права доступа: "R", "RCX" или "ARCXDU" (обязательный параметр в блоке access);<br/> <br/>Причина действия. |
|
||||||
|
| def_net | []Struct{<br/> <br/>net_type string;<br/> <br/>net_id int;<br/> <br/>reason string;<br/> <br/>} | :x: | Блок для установки сети по умолчанию для подключения связанных виртуальных машин:<br/> <br/>Тип сети: `PRIVATE` или `PUBLIC` (обязательный параметр в блоке def_net);<br/> <br/>ID сегмента сети. Если `net_type` равен `PUBLIC`, а `net_id` равен 0, то будет выбран сегмент внешней сети по умолчанию. Если `net_type` = `PRIVATE` и `net_id` = 0, будет выбран первый ViNS, определенный для этой РГ. В противном случае `net_id` определяет либо существующий сегмент внешней сети, либо ViNS. Значние по умолчанию 0;<br/> <br/>Причина действия. |
|
||||||
|
| cpu_allocation_parameter | string | :x: | Установить тип выделения ЦП:<br/>`strict` – ВМ не может быть запущена, если не хватает ресурсов ЦП;<br/>`loose` - можно запускать виртуальную машину, если не хватает ресурсов. |
|
||||||
|
| cpu_allocation_ratio | float | :x: | Установить коэффициент распределения ЦП для УЗ. Один pCPU = ratio*vCPU |
|
||||||
|
| enable | bool | :x: | Флаг доступности ресурсной группы |
|
||||||
|
| restore | bool | :x: | Флаг восстановления ресурсной группы<br/>Используется при редактировании |
|
||||||
|
| permanently | bool | :x: | Безвозвратное удаление ресурсной группы. Используется при удалении |
|
||||||
|
| force | bool | :x: | Удаление ресурсной группы, в случае если она к чему-то присоединена произойдет отсоединение от других ресурсов и удаление |
|
||||||
|
|
||||||
|
Для создания ресурсной группы пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь как минимум доступ на запись к указанному подписчику. В противном случае возникнет ошибка доступа.
|
||||||
|
|
||||||
|
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
|
||||||
|
|
||||||
|
## Возвращаемые значения
|
||||||
|
В случае успешного выполнения _resource_ функция **decort_cb_rg** возвращает в указанную при вызове переменную следующие значения:
|
||||||
|
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
|--------------------------|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. |
|
||||||
|
| account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. |
|
||||||
|
| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control |
|
||||||
|
| cpu_allocation_parameter | string | Параметр выделения CPU |
|
||||||
|
| cpu_allocation_ratio | float | Отношение выделения CPU |
|
||||||
|
| created_by | string | Пользователь - создатель ресурсной группы |
|
||||||
|
| created_time | int | Время создания ресурсной группы |
|
||||||
|
| def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.<br/>Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. |
|
||||||
|
| def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:<br> * EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`<br> * PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`<br> * NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. |
|
||||||
|
| deleted_by | string | Информация о том, кто удалил группу |
|
||||||
|
| deleted_time | int | Время удаления группы |
|
||||||
|
| description | string | Текстовое описание данной ресурсной группы. |
|
||||||
|
| gid | int | GRID ID |
|
||||||
|
| guid | int | ID ресурса |
|
||||||
|
| lock_status | string | Статус доступности |
|
||||||
|
| milestones | int | Вехи |
|
||||||
|
| rg_name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). |
|
||||||
|
| rg_id | int | Идентификатор данной ресурсной группы. |
|
||||||
|
| register_computes | bool | Флаг регистрации ВМ во внешней системе |
|
||||||
|
| resource_limits | []Struct [см. ниже](#описание-структуры-resource_limits) | Лимиты ресурсов |
|
||||||
|
| resource_types | []string | Типы ресурсов |
|
||||||
|
| secret | string | Секрет |
|
||||||
|
| status | string | Статус ресурсной группы |
|
||||||
|
| uniq_pools | []string | Список пулов. Например, ["sep1_poolName1", "sep2_poolName2"] |
|
||||||
|
| updated_by | string | Кем был обновлен ресурс |
|
||||||
|
| updated_time | int | Время последнего обновления ресурса |
|
||||||
|
| vins | []int | Список виртуальных сетей |
|
||||||
|
| vms | []int | Список id компьютов |
|
||||||
|
|
||||||
|
### Описание структуры acl
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| explicit | bool | Видимость аккаунта |
|
||||||
|
| guid | string | GUID |
|
||||||
|
| right | string | Права |
|
||||||
|
| status | string | Статус |
|
||||||
|
| type | string | Тип |
|
||||||
|
| user_group_id | string | ID группы юзеров |
|
||||||
|
|
||||||
|
### Описание структуры resource_limits
|
||||||
|
| Параметр | Тип | Описание |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| cu_c | float | Количество ядер CPU |
|
||||||
|
| cu_d | float | Размер диска |
|
||||||
|
| cu_dm | float | Использованный размер хранилища виртуального диска |
|
||||||
|
| cu_i | float | Количество публичных IP адресов |
|
||||||
|
| cu_m | float | размер RAM |
|
||||||
|
| cu_np | float | Хранилище траффика |
|
||||||
|
| gpu_units | float | количество GPU ядер |
|
||||||
|
|
||||||
|
## Пример использования
|
||||||
|
В нижеприведённом примере с помощью _resource_ функции **decort_cb_rg** создаётся ресурсная группа со следующими характеристиками:
|
||||||
|
* Имя создаваемой ресурсной группы - "testing_rg_1"
|
||||||
|
* Идентификатор подписчика-владельца ("account") - 123
|
||||||
|
* Gid площадки - 1234
|
||||||
|
* Квоты на объёмы ресурсов отсутствуют (нет ограничений).
|
||||||
|
|
||||||
|
```terraform
|
||||||
|
resource "decort_cb_rg" "my_new_rg" {
|
||||||
|
rg_name = "testing_rg_1"
|
||||||
|
account_id = 123
|
||||||
|
gid = 1234
|
||||||
|
|
||||||
|
/*
|
||||||
|
resource_limits {
|
||||||
|
#cu_c = 12
|
||||||
|
#cu_dm = 12
|
||||||
|
#cu_i = 12
|
||||||
|
#cu_m = 12
|
||||||
|
#cu_np = 12
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
|
#owner = "owner name"
|
||||||
|
#def_net_type = "NONE"
|
||||||
|
#ipcidr = "1.1.1.1"
|
||||||
|
#description = "qwerty"
|
||||||
|
#ext_net_id = 123
|
||||||
|
#ext_ip = "1.1.1.1"
|
||||||
|
#reason = "TEST"
|
||||||
|
#register_computes = true
|
||||||
|
#uniq_pools = ["sep1_poolName1", "sep2_poolName2"]
|
||||||
|
|
||||||
|
/*
|
||||||
|
access {
|
||||||
|
user = "kasim_baybikov_1@decs3o"
|
||||||
|
right = "RCX"
|
||||||
|
#reason = "test"
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
def_net {
|
||||||
|
net_type = "PUBLIC"
|
||||||
|
#net_id = 1234
|
||||||
|
#reason = "TEST"
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
|
#cpu_allocation_parameter = "loose"
|
||||||
|
#cpu_allocation_ratio = 1
|
||||||
|
|
||||||
|
#enable = true
|
||||||
|
#restore = false
|
||||||
|
#force = true
|
||||||
|
#permanently = true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
|
||||||
|
|
||||||
|
После успешного завершения такого вызова _resource_ функции **decort_cb_rg** в переменной `decort_cb_rg.my_new_rg` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `decort_resgroup.my_new_rg.rg_id`.
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
_Resource_ функция **decort_resgroup** служит для управления ресурсными группами в облачной платформе DECORT.
|
|
||||||
|
|
||||||
## Аргументы
|
|
||||||
_Resource_ функция **decort_resgroup** принимает следующие аргументы:
|
|
||||||
|
|
||||||
| Аргумент | Тип | Обязательный | Описание |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| account_id | int | :heavy_check_mark: | Идентификатор подписчика (aka "account"), которому будет принадлежать создаваемая ресурсная группа. |
|
|
||||||
| name | string | :heavy_check_mark: | Имя ресурсной группы. Должно быть уникальным в рамках одного и того же подписчика ("account"), не может быть пустым. |
|
|
||||||
| def_net_type | string | :x: | Тип сети, которая будет установлена по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:<br> * "PUBLIC" - создаваемые в данной ресурсной группе экземпляры _compute_ по умолчанию будут подключаться во внешнюю сеть с идентификатором, который задаётся параметром `ext_net_id`<br> * "PRIVATE" - экземпляры _compute_ по умолчанию будут подключаться в новый виртуальный сетевой сегмент (ViNS ), который платформа автоматически создаст для данной ресурсной группы.<br> * "NONE" - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. |
|
|
||||||
| description | string | :x: | Текстовое описание данной ресурсной группы.<br/>Данный параметр не является обязательным, значение по умолчанию - пустая строка. |
|
|
||||||
| ext_ip | string | :x: | IP адрес из диапазона, принадлежащего внешней сети, который будет присвоен подключению ViNS во внешнюю сеть в случае, когда `def_net_type = "PRIVATE"` и ненулевом `ext_net_id`. При других значениях `def_net_type` данный параметр игнорируется.<br/>Если данный параметр не указан явно, то платформа автоматически выберет свободный IP адрес.<br/>Если заданный `ext_ip` уже используется, платформа вернёт ошибку. |
|
|
||||||
| ext_net_id | int | :x: | Идентификатор внешней сети, в которую будет подключён ViNS, автоматически создаваемый платформой для данной ресурсной группы в случае, когда `def_net_type = "PRIVATE"`. При других значениях `def_net_type` данный параметр игнорируется.<br/>Если данный параметр не задан явно при `def_net_type = "PRIVATE"`, то платформа выберет первую из доступных данному пользователю внешних сетей. |
|
|
||||||
| ipcidr | string | :x: | Адрес сети внутри ViNS для случая `def_net_type = "PRIVATE"`<br/>Если данный параметр явно не задан, то платформа назначит адрес сети автоматически. |
|
|
||||||
| quota | dict | :x: | Квоты на объем ресурсов, устанавливаемые для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:<br> * (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;<br> * (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;<br> * (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;<br> * (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.<br> Значение -1 означает отсутствие ограничений по данному ресурсу.<br/>Данный параметр не является обязательным, значение по умолчанию - отсутствие лимитов на потребление ресурсов. |
|
|
||||||
|
|
||||||
Для создания ресурсной группы пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь как минимум доступ на запись к указанному подписчику. В противном случае возникнет ошибка доступа.
|
|
||||||
|
|
||||||
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
|
|
||||||
|
|
||||||
## Возвращаемые значения
|
|
||||||
В случае успешного выполнения _resource_ функция **decort_resgroup** возвращает в указанную при вызове переменную следующие значения:
|
|
||||||
|
|
||||||
| Параметр | Тип | Описание |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. |
|
|
||||||
| account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. |
|
|
||||||
| def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.<br/>Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. |
|
|
||||||
| def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:<br> * EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`<br> * PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`<br> * NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. |
|
|
||||||
| description | string | Текстовое описание данной ресурсной группы. |
|
|
||||||
| id | int | Идентификатор данной ресурсной группы. |
|
|
||||||
| name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). |
|
|
||||||
| rg_id | int | Идентификатор данной ресурсной группы. Дублирует значение параметра `id`. |
|
|
||||||
| quota | dict | Квоты на объем ресурсов, установленные для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:<br> * (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;<br> * (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;<br> * (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;<br> * (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.<br> Значение -1 означает отсутствие ограничений по данному ресурсу. |
|
|
||||||
|
|
||||||
## Пример использования
|
|
||||||
В нижеприведённом примере с помощью _resource_ функции **decort_resgroup** создаётся ресурсная группа со следующими характеристиками:
|
|
||||||
* Имя создаваемой ресурсной группы - "MyNewRG"
|
|
||||||
* Идентификатор подписчика-владельца ("account") - 100
|
|
||||||
* Квоты на объёмы ресурсов отсутствуют (нет ограничений).
|
|
||||||
|
|
||||||
```terraform
|
|
||||||
resource "decort_resgroup" "my_new_rg" {
|
|
||||||
name = "MyNewRG"
|
|
||||||
account_id = 100
|
|
||||||
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
|
|
||||||
|
|
||||||
После успешного завершения такого вызова _resource_ функции **decort_resgroup** в переменной `decort_resgroup.my_new_rg` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `decort_resgroup.my_new_rg.id`.
|
|
||||||
7
Home.md
7
Home.md
@@ -172,6 +172,11 @@ Terraform провайдер для платформы DECORT с API верси
|
|||||||
- [**decort_cb_rg_resource_consumption_get**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.55-Data-функция-decort_cb_rg_resource_consumption_get-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-по-конкретной-ресурсной-группе) - получение информации о количеств потребляемых и зарезервированных ресурсов по конкретной ресурсной группе
|
- [**decort_cb_rg_resource_consumption_get**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.55-Data-функция-decort_cb_rg_resource_consumption_get-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-по-конкретной-ресурсной-группе) - получение информации о количеств потребляемых и зарезервированных ресурсов по конкретной ресурсной группе
|
||||||
- [**decort_cb_rg_resource_consumption_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.56-Data-функция-decort_cb_rg_resource_consumption_list-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-доступных-ресурсной-группе) - получение информации о количестве потребляемых и зарезервированных ресурсов доступных ресурсной группе
|
- [**decort_cb_rg_resource_consumption_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.56-Data-функция-decort_cb_rg_resource_consumption_list-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-доступных-ресурсной-группе) - получение информации о количестве потребляемых и зарезервированных ресурсов доступных ресурсной группе
|
||||||
- [**decort_cb_rg_usage**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.57-Data-функция-decort_cb_rg_usage-информация-об-использовании-rg) - получение информации об использовании rg
|
- [**decort_cb_rg_usage**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.57-Data-функция-decort_cb_rg_usage-информация-об-использовании-rg) - получение информации об использовании rg
|
||||||
|
- [**decort_cb_rg_list_computes**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.58-Data-функция-decort_cb_rg_list_computes-получение-информации-о-компьютах-ресурсной-группы) - получение информации о компьютах ресурсной группы
|
||||||
|
- [**decort_cb_rg_list_deleted**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.59-Data-функция-decort_cb_rg_list_deleted-получение-информации-о-списке-удаленных-ресурсных-групп) - получение информации о списке удаленных ресурсных групп
|
||||||
|
- [**decort_cb_rg_list_lb**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.60-Data-функция-decort_cb_rg_list_lb-получение-информации-о-списке-lb) - получение информации о списке lb
|
||||||
|
- [**decort_cb_rg_list_pfw**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.61-Data-функция-decort_cb_rg_list_pfw-получение-информации-о-списке-pfw) - получение информации о списке pfw
|
||||||
|
- [**decort_cb_rg_list_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.62-Data-функция-decort_cb_rg_list_vins-получение-информации-о-списке-vins) - получение информации о списке vins
|
||||||
-->
|
-->
|
||||||
|
|
||||||
7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)
|
7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)
|
||||||
@@ -202,7 +207,7 @@ Terraform провайдер для платформы DECORT с API верси
|
|||||||
|
|
||||||
<!-- - [Административная группа API](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02-Административная-группа-API)
|
<!-- - [Административная группа API](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02-Административная-группа-API)
|
||||||
- [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.11-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM) - управление виртуальными серверами, создаваемыми на базе системы виртуализации KVM
|
- [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.11-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM) - управление виртуальными серверами, создаваемыми на базе системы виртуализации KVM
|
||||||
- [**decort_resgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.14-Resource-функция-decort_resgroup-управление-ресурсными-группами) - управление ресурсными группами
|
- [**decort_cb_rg**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.14-Resource-функция-decort_cb_rg-управление-ресурсными-группами) - управление ресурсными группами
|
||||||
- [**decort_cb_extnet**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями) - управление внешними сетями
|
- [**decort_cb_extnet**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями) - управление внешними сетями
|
||||||
- [**decort_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.13-Resource-функция-decort_disk-управление-дисковыми-ресурсами) - управление дисковыми ресурсами.
|
- [**decort_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.13-Resource-функция-decort_disk-управление-дисковыми-ресурсами) - управление дисковыми ресурсами.
|
||||||
- [**decort_cb_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.12-Resource-функция-decort_cb_vins-управление-виртуальными-сетевыми-сегментами) - управление виртуальными сетевыми сегментами.
|
- [**decort_cb_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.12-Resource-функция-decort_cb_vins-управление-виртуальными-сетевыми-сегментами) - управление виртуальными сетевыми сегментами.
|
||||||
|
|||||||
Reference in New Issue
Block a user