BASIS/wiki-terraform-provider-decort
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

4.9.5

Browse Source
This commit is contained in:
BASIS
2025-11-12 18:07:08 +03:00
committed by Ян Палис
commit 90dd7d4492
7776 changed files with 871610 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

168
4.5.3/07.01.02-Resource_decort_resgroup.md Normal file
View File

@@ -0,0 +1,168 @@
_Resource_ функция **decort_resgroup** служит для управления ресурсными группами в облачной платформе DECORT.
## Изменения в 3.5.2
- Добавлено поле register_computes, которое используется при создании rg
## Изменения в 3.5.0
- Обновлено поведение ресруса, в случае изменения блока quota – Если блок убирается, то значения Лимитов становяться дефолтными
- Добавлен опциональный блок access
- Добавлен опциональный блок def_net
- Добавлено опциональное поле enable
- Добавлена обработка входных идентификаторов значений при создании и обновлении ресурса
- В дальнейших версиях поля def_net_type, ext_ip, ext_net_id будут убраны и все взаисодействие с сетью ресурсной группы будет присходить с помощью блока def_net
## Изменения в 3.4.0
- В аргументы добавлено опциональное поле force
- В аргументы добавлено опциональное поле permanently
- В аргументы добавлено опциональное поле reason
- В аргументы добавлено обязательное поле gid
- В возвращаемые значения добавлено новое поле resources
- В возвращаемые значения добавлено новое поле status
- В возвращаемые значения добавлено новое поле vins
- В возвращаемые значения добавлено новое поле vms
## Аргументы
_Resource_ функция **decort_resgroup** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|-------------------|-------------------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| account_id | int | :heavy_check_mark: | Идентификатор подписчика (aka "account"), которому будет принадлежать создаваемая ресурсная группа. |
| gid | int | :heavy_check_mark: | Идентификатор grid, которому будет принадлежать создаваемая ресурсная группа. |
| 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/>Данный параметр не является обязательным, значение по умолчанию - пустая строка. |
| permanently | bool | :x: | Безвозвратное удаление ресурса. Используется при удалении |
| force | bool | :x: | Удаление ресурса, в случае если он к чему-то присоединен произойдет отсоединение его от других ресурсов и удаление |
| resaon | string | :x: | Причина по которой ресурс удаляется |
| enable | bool | :x: | Поле флаг, отвечающее за enable/disable ресурса |
| 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 | Struct [см. ниже](#описание-структуры-quota) | :x: | Квоты на объем ресурсов, устанавливаемые для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Максмальное количество: 1 |
| access | []Struct [см. ниже](#описание-структуры-access) | :x: | Юзеры которым выдется доступ к данной ресурсной группе |
| def_net | Struct [см. ниже](#описание-структуры-def_net) | :x: | Параметры сети ресурсной группы. Максмальное количество: 1 |
| register_computes | bool | :x: | Параметр используется при создании rg |
| owner | string | :x: | Имя пользователя – владелец этой РГ. Оставьте поле пустым, чтобы назначить текущего пользователя владельцем. |
| restore | bool | :x: | Восстановить ресурсную из корзины. |
### Описание структуры quota
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| cpu | int | :x: | лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы |
| ram | int | :x: | лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы |
| disk | int | :x: | лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы |
| ext_ips | int | :x: | лимит на суммарное количество внешних ip адресов в рамках данной ресрсной группы |
| ext_ips | int | :x: | лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы |
| gpu_units | int | :x: | лимит на суммарное количество GPU юнитов в рамках данной ресурсной группы |
### Описание структуры access
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| user | string | :heavy_check_mark: | Юзер которому предоставляется доступ |
| right | string | :heavy_check_mark: | Права, которые будут выдаваться данному юзеру. Возможные значения: "R", "RCX" или "ARCXDU"|
| reason | string | :x: | Причина |
### Описание структуры def_net
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| net_type | string | :heavy_check_mark: | Тип сети, которая будет присоединена к ресурсной группе. Возможные значения: "PRIVATE" - vins, "PUBLIC"- external network |
| net_id | int | :x: | Идентификатор сети. Если не указан, будет задан тот, к которому есть доступ по умолчанию |
| reason | string | :x: | Причина |
Для создания ресурсной группы пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь как минимум доступ на запись к указанному подписчику. В противном случае возникнет ошибка доступа.
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/wiki-terraform-provider-decort/src/branch/main/4.5.3/04.02-Инициализация-Terraform-провайдера-DECORT.md)).
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_resgroup** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| acl | Struct{} [см. ниже](#описание-структуры-acl) | Cписок Acces Control List |
| account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. |
| account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. |
| created_by | string | Кес создан ресурс |
| created_time | int | Время создания ресурса |
| deleted_by | string | Кем удален ресурс |
| deleted_time | int | Время удаления ресурса |
| resources | Struct{} [см. ниже](#описание-структуры-resources)| Информация о занимаемых ресурсах |
| 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 | Текстовое описание данной ресурсной группы. |
| gid | int | Идентификатор grid, которому будет принадлежать создаваемая ресурсная группа. |
| id | int | Идентификатор данной ресурсной группы. |
| name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). |
| quota | dict | Квоты на объем ресурсов, установленные для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:<br> * (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;<br> * (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;<br> * (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;<br> * (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.<br> Значение -1 означает отсутствие ограничений по данному ресурсу. |
| rg_id | int | Идентификатор данной ресурсной группы. Дублирует значение параметра `id`. |
| guid | int | GUID |
| dirty | bool | Dirty |
| lock_status | string | Lock статус |
| milestones | int | Milestones |
| secret | string | Секрет |
| status | string | Статус resgroup |
| updated_by | string | Кем был сделан апдейт |
| updated_time | int | Время апдейта |
| vins | []int | Список id виртуальных сетей |
| vms | []int | Список id виртуальных машин |
| res_types | []string | Resource Types |
| cpu_allocation_parameter | string | Параметр выделения CPU |
| cpu_allocation_ratio | float | Отношение выделения CPU |
| 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
| Параметр | Тип | Описание |
| --- | --- | --- |
| current | Struct{} [см. ниже](#описание-структуры-current-и-reserved) | Информация о текуших ресурсах |
| reserved | Struct{} [см. ниже](#описание-структуры-current-и-reserved) | Информация о зарезверированных аккаунтом ресурсах |
### Описание структуры current и reserved
| Параметр | Тип | Описание |
| --- | --- | --- |
| cpu | int | Количество CPU |
| disksize | int | Размер диска |
| extips | int | Внешние IPs |
| exttraffic | int | Внешний Traffic |
| gpu | int | Количество GPU |
| ram | int | Количество RAM |
| seps | []Struct{} [см . ниже](#описание-структуры-seps)| Информация о seps |
### Описание структуры seps
| Параметр | Тип | Описание |
| --- | --- | --- |
| sep_id | int | ID SEP |
| data_name | string | Имя пула информации внутри SEP'а |
| disk_size | int | Количество занятого места |
| disk_size_max | int | Размер диска |
## Пример использования
В нижеприведённом примере с помощью _resource_ функции **decort_resgroup** создаётся ресурсная группа со следующими характеристиками:
* Имя создаваемой ресурсной группы - "MyNewRG"
* Идентификатор подписчика-владельца ("account") - 100
* Квоты на объёмы ресурсов отсутствуют (нет ограничений).
```terraform
resource "decort_resgroup" "my_new_rg" {
name = "MyNewRG"
gid = 1010
account_id = 100
permanently = false
force = false
reason = "some reason"
#owner = "new_owner"
#restore=true
}
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/wiki-terraform-provider-decort/src/branch/main/4.5.3/04.02-Инициализация-Terraform-провайдера-DECORT.md)).
После успешного завершения такого вызова _resource_ функции **decort_resgroup** в переменной `decort_resgroup.my_new_rg` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `decort_resgroup.my_new_rg.id`.