diff --git a/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md b/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md index 7c36c53..2a12b3a 100644 --- a/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md +++ b/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами.md @@ -1,14 +1,28 @@ _Resource_ функция **decort_resgroup** служит для управления ресурсными группами в облачной платформе DECORT. +## Изменения в 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: | Тип сети, которая будет установлена по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* "PUBLIC" - создаваемые в данной ресурсной группе экземпляры _compute_ по умолчанию будут подключаться во внешнюю сеть с идентификатором, который задаётся параметром `ext_net_id`
* "PRIVATE" - экземпляры _compute_ по умолчанию будут подключаться в новый виртуальный сетевой сегмент (ViNS ), который платформа автоматически создаст для данной ресурсной группы.
* "NONE" - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | | description | string | :x: | Текстовое описание данной ресурсной группы.
Данный параметр не является обязательным, значение по умолчанию - пустая строка. | +| permanently | bool | :x: | Безвозвратное удаление ресурса. Используется при удалении| +| force | bool | :x: | Удаление ресурса, в случае если он к чему-то присоединен произойдет отсоединение его от других ресурсов и удаление| +| resaon | string | :x: | Причина по которой ресурс удаляется | | ext_ip | string | :x: | IP адрес из диапазона, принадлежащего внешней сети, который будет присвоен подключению ViNS во внешнюю сеть в случае, когда `def_net_type = "PRIVATE"` и ненулевом `ext_net_id`. При других значениях `def_net_type` данный параметр игнорируется.
Если данный параметр не указан явно, то платформа автоматически выберет свободный IP адрес.
Если заданный `ext_ip` уже используется, платформа вернёт ошибку. | | ext_net_id | int | :x: | Идентификатор внешней сети, в которую будет подключён ViNS, автоматически создаваемый платформой для данной ресурсной группы в случае, когда `def_net_type = "PRIVATE"`. При других значениях `def_net_type` данный параметр игнорируется.
Если данный параметр не задан явно при `def_net_type = "PRIVATE"`, то платформа выберет первую из доступных данному пользователю внешних сетей. | | ipcidr | string | :x: | Адрес сети внутри ViNS для случая `def_net_type = "PRIVATE"`
Если данный параметр явно не задан, то платформа назначит адрес сети автоматически. | @@ -28,10 +42,40 @@ _Resource_ функция **decort_resgroup** принимает следующ | def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.
Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. | | def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`
* PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`
* NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | | description | string | Текстовое описание данной ресурсной группы. | +| gid | int | Идентификатор grid, которому будет принадлежать создаваемая ресурсная группа. | | id | int | Идентификатор данной ресурсной группы. | | name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). | -| rg_id | int | Идентификатор данной ресурсной группы. Дублирует значение параметра `id`. | | quota | dict | Квоты на объем ресурсов, установленные для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:
* (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;
* (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;
* (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;
* (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.
Значение -1 означает отсутствие ограничений по данному ресурсу. | +| resources | Struct{} [см. ниже](#Описание-структуры-resources)| Информация о занимаемых ресурсах | +| rg_id | int | Идентификатор данной ресурсной группы. Дублирует значение параметра `id`. | +| status | string | Статус resgroup | +| vins | []int | Список id виртуальных сетей | +| vms | []int | Список id виртуальных машин | + +### Описание структуры resources +| Параметр | Тип | Описание | +| --- | --- | --- | +| current | Struct{} [см. ниже](#Описание-структуры-current-и-reserved) | Информация о текуших ресурсах | +| reserved | Struct{} [см. ниже](#Описание-структуры-current-и-reserved) | Информация о зарезверированных аккаунтом ресурсах | + +### Описание структуры current и reserved +| Параметр | Тип | Описание | +| --- | --- | --- | +| cpu | int | Количество CPU | +| disksize | int | Размер диска | +| extips | int | External IPs | +| exttraffic | int | External 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** создаётся ресурсная группа со следующими характеристиками: @@ -42,11 +86,14 @@ _Resource_ функция **decort_resgroup** принимает следующ ```terraform resource "decort_resgroup" "my_new_rg" { name = "MyNewRG" + gid = 1010 account_id = 100 - + permanently = false + force = false + reason = "some reason" } ``` Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)). -После успешного завершения такого вызова _resource_ функции **decort_resgroup** в переменной `decort_resgroup.my_new_rg` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `decort_resgroup.my_new_rg.id`. \ No newline at end of file +После успешного завершения такого вызова _resource_ функции **decort_resgroup** в переменной `decort_resgroup.my_new_rg` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `decort_resgroup.my_new_rg.id`.