diff --git a/06.01.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md b/06.01.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md index a80d322..d220e42 100644 --- a/06.01.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md +++ b/06.01.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md @@ -4,16 +4,23 @@ _Data source_ функция **decort_resgroup** служит для получ Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_resgroup**. +## Изменения в 3.4.0 +- Добавлено поле gid +- Добавлено новое поле resources +- Добавлено новое поле status +- Добавлено новое поле vins +- Добавлено новое поле vms +- Обязательное поле account_id изменено на опциональное + ## Аргументы _Data source_ функция **decort_resgroup** принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | | --- | --- | --- | --- | -| account_id | int | :heavy_check_mark: | Идентификатор подписчика (aka "account"), которому принадлежит данная ресурсная группа. | +| account_id | int | :x: | Идентификатор подписчика (aka "account"), которому принадлежит данная ресурсная группа. | | name | string | :x: | Имя ресурсной группы, по которой требуется получить информацию. Имя ресурсной группы не может быть пустым. Обратите внимание, что имя ресурсной группы должно быть уникальным только в рамках одного и того же подписчика.
Ресурсная группа идентифицируется по комбинации ID подписчика-владельца (`account_id`) и имени самой группы или по её идентификатору (`rg_id`).
Вы можете задать или `rg_id`, или `name`. Если задан параметр `rg_id`, то параметр `name` игнорируeтся. | | rg_id | int | :x: | Идентификатор ресурсной группы, по которой требуется получить информацию. Идентификатор не может быть нулевым.
Вы можете задать или `rg_id`, или `name`. Если задан параметр `rg_id`, то параметр `name` игнорируeтся. | - Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). @@ -28,10 +35,40 @@ _Data source_ функция **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 | Текстовое описание данной ресурсной группы. | -| id | int| Идентификатор данной ресурсной группы. | +| 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 | Размер диска | ## Пример использования @@ -41,6 +78,7 @@ _Data source_ функция **decort_resgroup** принимает следую data "decort_resgroup" "target_rg" { name = "test" # this is the name of pre-existing resource group account_id = 100 # this is the ID of the account, where resource group named "test" is found + rg_id = 123 } # Once the above directive completes, resource group ID will be accessible as # data.decort_resgroup.target_rg.id @@ -48,4 +86,4 @@ data "decort_resgroup" "target_rg" { Данный пример подразумевает, что ранее по тексту 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.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)). -После успешного завершения такого вызова **decort_resgroup** в переменной `data.decort_resgroup.target_rg` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_resgroup.target_rg.id` \ No newline at end of file +После успешного завершения такого вызова **decort_resgroup** в переменной `data.decort_resgroup.target_rg` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_resgroup.target_rg.id`