diff --git a/06.02.02-Data-функция-decort_cb_rg-получение-информации-о-ресурсной-группе.md b/06.02.02-Data-функция-decort_cb_rg-получение-информации-о-ресурсной-группе.md new file mode 100644 index 0000000..aa08943 --- /dev/null +++ b/06.02.02-Data-функция-decort_cb_rg-получение-информации-о-ресурсной-группе.md @@ -0,0 +1,87 @@ +Функция доступна в провайдере версии 3.0 и выше. + +_Data source_ функция **decort_cb_rg** служит для получения информации об уже существующей ресурсной группе. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_rg**. + +## Аргументы +_Data source_ функция **decort_cb_rg** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- |------------------------------------------------------------------------------------------------------------------| +| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы, по которой требуется получить информацию. Идентификатор не может быть нулевым. | +| reason | string | :x: | Причина запроса | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **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_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.
Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. | +| def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`
* PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`
* NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | +| deleted_by | string | Информация о том, кто удалил группу | +| deleted_time | int | Время удаления группы | +| desc | string | Текстовое описание данной ресурсной группы. | +| dirty | bool | Dirty | +| gid | int | GRID ID | +| guid | int | ID ресурса | +| lock_status | string | Статус доступности | +| milestones | int | Вехи | +| 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 | Список виртуальных сетей | +| computes | []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 ядер | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_rg**: + +```terraform +data "decort_cb_rg" "target_rg" { + rg_id = 1022 + #reason = "TEST" +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_cb_rg.target_rg.rg_id +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/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://repository.basistech.ru/BASIS/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_cb_rg** в переменной `data.decort_cb_rg.target_rg` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_cb_rg.target_rg.rg_id` diff --git a/06.02.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md b/06.02.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md deleted file mode 100644 index 05fc6be..0000000 --- a/06.02.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе.md +++ /dev/null @@ -1,53 +0,0 @@ -Функция доступна в провайдере версии 3.0 и выше. - -_Data source_ функция **decort_resgroup** служит для получения информации об уже существующей ресурсной группе. - -Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). - -Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_resgroup**. - -## Аргументы -_Data source_ функция **decort_resgroup** принимает следующие аргументы: - -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| account_id | int | :heavy_check_mark: | Идентификатор подписчика (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://repository.basistech.ru/BASIS/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.)). - -## Возвращаемые значения -В случае успешного выполнения _data source_ функция **decort_resgroup** возвращает в указанную при вызове переменную следующие значения: - -| Параметр | Тип | Описание | -| --- | --- | --- | -| account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. | -| account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. | -| 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| Идентификатор данной ресурсной группы. | -| name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). | -| rg_id | int| Идентификатор данной ресурсной группы. Дублирует значение параметра `id`. | -| quota | dict | Квоты на объем ресурсов, установленные для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:
* (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;
* (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;
* (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;
* (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.
Значение -1 означает отсутствие ограничений по данному ресурсу. | - - -## Пример использования -Пример вызова _data source_ функции **decort_resgroup**: - -```terraform -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 -} -# Once the above directive completes, resource group ID will be accessible as -# data.decort_resgroup.target_rg.id -``` - -Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/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://repository.basistech.ru/BASIS/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` diff --git a/06.02.14-Data-функция-decort_cb_rg_list-получение-информации-о-всех-ресурсных-группах.md b/06.02.14-Data-функция-decort_cb_rg_list-получение-информации-о-всех-ресурсных-группах.md new file mode 100644 index 0000000..21723bc --- /dev/null +++ b/06.02.14-Data-функция-decort_cb_rg_list-получение-информации-о-всех-ресурсных-группах.md @@ -0,0 +1,99 @@ +Функция доступна в провайдере версии 3.0 и выше. + +_Data source_ функция **decort_cb_rg_list** служит для получения информации об имеющихся ресурсных группах. + +## Аргументы +_Data source_ функция **decort_cb_rg_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| by_id | int | :x: | Фильтр по ID ресурсной группы | +| name | string | :x: | Фильтр по имени ресурсной группы | +| account_id | int | :x: | Фильтр поID аккаунта | +| account_name | string | :x: | Фильтр по названию аккаунта | +| created_after | int | :x: | Отдает все рес. группы созданные после определенного времени (unix timstamp) | +| created_before | int | :x: | Отдает все рес. группы созданные до определенного времени (unix timstamp) | +| status | string | :x: | Фильтр по статусу | +| lock_status | string | :x: | Фильтр по локстатусу | +| includedeleted | bool | :x: | Включение удаленных rg в результат поиска | +| page | int | :x: | Номер страниц | +| size | int | :x: | Размер страницы | + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_rg_list** возвращает в указанную при вызове переменную, в поле _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_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.
Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. | +| def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:
* EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`
* PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`
* NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. | +| deleted_by | string | Информация о том, кто удалил группу | +| deleted_time | int | Время удаления группы | +| desc | string | Текстовое описание данной ресурсной группы. | +| dirty | bool | Dirty | +| gid | int | GRID ID | +| guid | int | ID ресурса | +| lock_status | string | Статус доступности | +| milestones | int | Вехи | +| 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 ядер | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_rg_list**: +```terraform +data "decort_cb_rg_list" "rl" { + #by_id = 100 + #name = "test" + #account_id = 11111 + #account_name = "test" + #created_after = 123 + #created_before = 123 + #status = "ENABLED" + #includedeleted = false + #page = 1 + #size = 2 +} +# once the above directive completes, rg list will be accessible +# as data.decort_cb_rg_list.rl.items +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/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.)). + +После успешного завершения такого вызова **decort_cb_rg_list** в переменной `data.decort_cb_rg_list.rl` будут сохранены возвращаемые значения. diff --git a/06.02.14-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md b/06.02.14-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md deleted file mode 100644 index 5805a40..0000000 --- a/06.02.14-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md +++ /dev/null @@ -1,70 +0,0 @@ -Функция доступна в провайдере версии 3.0 и выше. - -_Data source_ функция **decort_rg_list** служит для получения информации об имеющихся ресурсных группах. - -## Аргументы -_Data source_ функция **decort_rg_list** принимает следующие аргументы: -| Аргумент | Тип | Обязательный | Описание | -| --- | --- | --- | --- | -| includedeleted | bool | :x: | Включение удаленных rg в результат поиска | -| page | int | :x: | Номер страниц | -| size | int | :x: | Размер страницы | - - -## Возвращаемые значения -В случае успешного выполнения _data source_ функция **decort_rg_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: - -| Параметр | Тип | Описание | -| --- | --- | --- | -| account_id | int | ID аккаунта - владельца ресурсной группы | -| account_name | string | Имя аккаунта - владельца ресурсной группы | -| acl | []Struct{
explicit bool
guid string
right string
status string
type string
user_group_id string
} | Более подробная информация об аккаунтах, имеющих доступ к ресурсной группе
Явно ли указан доступ
guid аккаунта
Права доступа
Статус аккаунта
Тип аккаунта
Идентификатор пользователя-владельца аккаунта
 
| -| created_by | string | Информация о создателе группы | -| created_time | int | Время создания группы | -| def_net_id | int | id сети по-умолчанию | -| def_net_type | string | Тип сети по-умолчанию | -| deleted_by | string | Информация о том, кто удалил группу | -| deleted_time | int | Время удаления группы | -| desc | string | Описание группы | -| gid | int | Grid id | -| guid | int | Внутренний идентификатор ресурсной группы | -| rg_id | int | Идентификатор ресурсной группы | -| lock_status | string | Статус блокировки ресурсной группы | -| name | string | Название ресурсной группы | -| register_computes | bool | Имеются ли зарезервированные выч. мощности | -| resource_limits | Struct{
cu_c float
cu_d float
cu_i float
cu_m float
cu_np float
gpu_units float
} | Ограничения ресурсов
Кол-во ядер
Размер диска, ГБ
Число публичных ip адресов
Размер RAM, МБ
Объем трафика, ГБ
Кол-вол графических ядер
 
| -| secret | string | Секрет группы | -| status | string | Статус группы | -| updated_by | string | Кем группа была обновлена в последний раз | -| updated_time | int | Время последнего обновления | -| vins | []int | Список идентификаторов виртуальных сетей | -| vms | []int | Список идентификаторов виртуальных машин (устаревшее) | - -## Пример использования -Пример вызова _data source_ функции **decort_rg_list**: -```terraform -data "decort_rg_list" "rl" { - #включение удаленных rg в результат поиска - #опциональный параметр - #тип - булев тип - #по-умолчанию - false - #includedeleted = true - - #номер страницы для отображения - #опциональный параметр, тип - число - #если не задан - выводятся все доступные данные - #page = 2 - - #размер страницы - #опциональный параметр, тип - число - #если не задан - выводятся все доступные данные - #size = 3 - -} -# once the above directive completes, rg list will be accessible -# as data.decort_rg_list.rl.items -``` - -Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/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.)). - -После успешного завершения такого вызова **decort_rg_list** в переменной `data.decort_rg_list.rl` будут сохранены возвращаемые значения. diff --git a/06.02.51-Data-функция-decort_cb_rg_affinity_group_computes-получение-информации-о-компьютах-аффинити-группы.md b/06.02.51-Data-функция-decort_cb_rg_affinity_group_computes-получение-информации-о-компьютах-аффинити-группы.md new file mode 100644 index 0000000..22aec67 --- /dev/null +++ b/06.02.51-Data-функция-decort_cb_rg_affinity_group_computes-получение-информации-о-компьютах-аффинити-группы.md @@ -0,0 +1,48 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_rg_affinity_group_computes** служит для получения информации о компьютах аффинити группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_rg_affinity_group_computes**. + +## Аргументы +_Data source_ функция **decort_cb_rg_affinity_group_computes** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- | --- | --- | --- | +| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы | +| affinity_group | :heavy_check_mark: | string | Аффинити группа | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_rg_affinity_group_computes** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| compute_id | int | Идентификатор компьюта | +| other_node | []int | Спсиок other node | +| other_node_indirect | []int | Список other node indirect | +| other_node_indirect_soft | []int | Список other node indirect soft | +| other_node_soft | []int | Список other node soft| +| same_node | []int | Список same node| +| same_node_soft | []int | Список same node soft| + +## Пример использования +Пример вызова _data source_ функции **decort_cb_rg_affinity_group_computes**: + +```terraform +data "decort_cb_rg_affinity_group_computes" "rg_affinity_group_computes" { + rg_id = 123 + affinity_group = "TEST" +} +# Once the above directive completes, resource group affinity group computes will be accessible as +# data.decort_cb_rg_affinity_group_computes.rg_affinity_group_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_affinity_group_computes** в переменной `data.decort_cb_rg_affinity_group_computes.rg_affinity_group_computes.items` будут сохранены возвращаемые значения. diff --git a/06.02.52-Data-функция-decort_cb_rg_affinity_groups_get-получение-информации-о-аффинити-группе.md b/06.02.52-Data-функция-decort_cb_rg_affinity_groups_get-получение-информации-о-аффинити-группе.md new file mode 100644 index 0000000..a89cf4a --- /dev/null +++ b/06.02.52-Data-функция-decort_cb_rg_affinity_groups_get-получение-информации-о-аффинити-группе.md @@ -0,0 +1,42 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_rg_affinity_groups_get** служит для получения информации о аффинити группе ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_rg_affinity_groups_get**. + +## Аргументы +_Data source_ функция **decort_cb_rg_affinity_groups_get** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |--------| --- | --- | +| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы | +| affinity_group | string | :heavy_check_mark: | Аффинити группа | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_rg_affinity_groups_get** возвращает следующие параметры: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| ids | []int | Список ID виртуальных машин в указанной affinity группе. | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_rg_affinity_groups_get**: + +```terraform +data "decort_cb_rg_affinity_groups_get" "rg_affinity_groups_get" { + rg_id = 1234 + affinity_group = "TEST" +} +# Once the above directive completes, resource group affinity groups ids will be accessible as +# data.decort_cb_rg_affinity_groups_get.rg_affinity_groups_get.ids +``` + +Данный пример подразумевает, что ранее по тексту 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_affinity_groups_get** в переменной `data.decort_cb_rg_affinity_groups_get.rg_affinity_groups_get` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_cb_rg_affinity_groups_get.rg_affinity_groups_get.ids` diff --git a/06.02.53-Data-функция-decort_cb_rg_affinity_groups_list-получение-информации-о-аффинити-группах.md b/06.02.53-Data-функция-decort_cb_rg_affinity_groups_list-получение-информации-о-аффинити-группах.md new file mode 100644 index 0000000..c7c9836 --- /dev/null +++ b/06.02.53-Data-функция-decort_cb_rg_affinity_groups_list-получение-информации-о-аффинити-группах.md @@ -0,0 +1,46 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_rg_affinity_groups_list** служит для получения информации о списке аффинити групп ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_rg_affinity_groups_list**. + +## Аргументы +_Data source_ функция **decort_cb_rg_affinity_groups_list** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |-----| --- | --- | +| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы | +| 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_affinity_groups_list** возвращает в указанную при вызове переменную, в поле _affinity_groups_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| -- |--------|-----------------------| +| label | string | Лейбл аффинити группы | +| id | int | ID виртуальной машины | +|node_id| int | ID ВМ (узла worker) | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_rg_affinity_groups_list**: + +```terraform +data "decort_cb_rg_affinity_groups_list" "rg_affinity_groups_list" { + rg_id = 1234 + #page = 1 + #size = 1 +} +# Once the above directive completes, resource group ID will be accessible as +# data.decort_cb_rg_affinity_groups_list.rg_affinity_groups_list.id +``` + +Данный пример подразумевает, что ранее по тексту 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_affinity_groups_list** в переменной `data.decort_cb_rg_affinity_groups_list.rg_affinity_groups_list` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_cb_rg_affinity_groups_list.rg_affinity_groups_list.id` diff --git a/06.02.54-Data-функция-decort_cb_rg_audits-получение-информации-о-аудитах-ресурсной-группы.md b/06.02.54-Data-функция-decort_cb_rg_audits-получение-информации-о-аудитах-ресурсной-группы.md new file mode 100644 index 0000000..c4153a0 --- /dev/null +++ b/06.02.54-Data-функция-decort_cb_rg_audits-получение-информации-о-аудитах-ресурсной-группы.md @@ -0,0 +1,44 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_rg_audits** служит для получения информации о аудитах ресурсной группы. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_rg_audits**. + +## Аргументы +_Data source_ функция **decort_cb_rg_audits** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |-----| --- | --- | +| 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_audits** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- | --- | +| call | string | Какая команда была выполнена | +| responsetime | float | Время выполнения | +| statuscode | int | Статус выполнения | +| timestamp | float | Точное время исполнения | +| user | string | Кем была выполнена команда | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_rg_audits**: + +```terraform +data "decort_cb_rg_audits" "rg_audits" { + rg_id = 1234 +} +# Once the above directive completes, resource group audits will be accessible as +# data.decort_cb_rg_audits.rg_audits.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_audits** в переменной `data.decort_cb_rg_audits.rg_audits.items` будут сохранены возвращаемые значения. diff --git a/06.02.55-Data-функция-decort_cb_rg_resource_consumption_get-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-по-конкретной-ресурсной-группе.md b/06.02.55-Data-функция-decort_cb_rg_resource_consumption_get-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-по-конкретной-ресурсной-группе.md new file mode 100644 index 0000000..7d0a9aa --- /dev/null +++ b/06.02.55-Data-функция-decort_cb_rg_resource_consumption_get-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-по-конкретной-ресурсной-группе.md @@ -0,0 +1,69 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_rg_resource_consumption_get** служит для получения информации о количестве потребляемых и зарезервированных ресурсов (процессор, оперативная память, диск) по конкретной ресурсной группе. + +## Аргументы + +_Data source_ функция **decort_cb_rg_resource_consumption_get** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| -------- | --- | ------------------ | ------------------- | +| rg_id | int | :heavy_check_mark: | ID ресурсной группы | + +## Возвращаемые значения + +В случае успешного выполнения _data source_ функция **decort_cb_rg_resource_consumption_get** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров: + +| Параметр | Тип | Описание | +| ---------- | ------- | ----------------------------------------------- | +| rg_id | int | id ресурсной группы | +| consumed | Struct{} [см. ниже](#описание-структуры-consumed-и-reserved) | Информация о текуших ресурсах | +| reserved | Struct{} [см. ниже](#описание-структуры-consumed-и-reserved) | Информация о зарезервированных ресурсной группой ресурсах | +| resource_limits | Struct{} [см. ниже](#описание-структуры-resource-limits) | Лимиты ресурсов | + +### Описание структуры consumed и reserved +| Параметр | Тип | Описание | +| --- | --- | --- | +| cpu | int | Количество CPU | +| disk_size | float | Размер диска | +| disk_size_max | float | Максимальный размер диск | +| extips | int | Внешние IPs | +| exttraffic | int | Внешний Traffic | +| gpu | int | Количество GPU | +| ram | int | Количество RAM | +| seps | []Struct{} [см . ниже](#описание-структуры-seps)| Информация о seps | + +### Описание структуры seps +| Параметр | Тип | Описание | +| --- | --- | --- | +| sep_id | string | ID SEP. SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск| +| data_name | string | Имя пула информации внутри SEP'а | +| disk_size | float | Количество занятого места | +| disk_size_max | float | Размер диска | + +### Описание структуры 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_resource_consumption_get**: + +```terraform +data "decort_cb_rg_resource_consumption_get" "rc_get" { + rg_id = 111 +} +# once the above directive completes, resource group consumption will be accessible +# as data.decort_cb_rg_resource_consumption_get.rc_get +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/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.)). + +После успешного завершения такого вызова **decort_cb_rg_resource_consumption_get** в переменной `data.decort_cb_rg_resource_consumption_get.rc_get` будут сохранены возвращаемые значения. diff --git a/06.02.56-Data-функция-decort_cb_rg_resource_consumption_list-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-доступных-ресурсной-группе.md b/06.02.56-Data-функция-decort_cb_rg_resource_consumption_list-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-доступных-ресурсной-группе.md new file mode 100644 index 0000000..6a3cdeb --- /dev/null +++ b/06.02.56-Data-функция-decort_cb_rg_resource_consumption_list-получение-информации-о-количестве-потребляемых-и-зарезервированных-ресурсов-доступных-ресурсной-группе.md @@ -0,0 +1,65 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_rg_resource_consumption_list** служит для получения информации о количестве потребляемых и зарезервированных ресурсов (процессор, оперативная память, диск) доступных ресурсной группе + +## Аргументы + +_Data source_ функция **decort_cb_rg_resource_consumption_list** не принимает аргументы. + +## Возвращаемые значения + +В случае успешного выполнения _data source_ функция **decort_cb_rg_resource_consumption_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| ---------- | ------- | ----------------------------------------------- | +| rg_id | int | id ресурсной группы | +| consumed | Struct{} [см. ниже](#описание-структуры-consumed-и-reserved) | Информация о текуших ресурсах | +| reserved | Struct{} [см. ниже](#описание-структуры-consumed-и-reserved) | Информация о зарезервированных ресурсной группой ресурсах | +| resource_limits | Struct{} [см. ниже](#описание-структуры-resource-limits) | Лимиты ресурсов | + +### Описание структуры consumed и reserved +| Параметр | Тип | Описание | +| --- | --- | --- | +| cpu | int | Количество CPU | +| disk_size | float | Размер диска | +| disk_size_max | float | Максимальный размер диск | +| extips | int | Внешние IPs | +| exttraffic | int | Внешний Traffic | +| gpu | int | Количество GPU | +| ram | int | Количество RAM | +| seps | []Struct{} [см . ниже](#описание-структуры-seps)| Информация о seps | + +### Описание структуры seps +| Параметр | Тип | Описание | +| --- |--------| --- | +| sep_id | string | ID SEP. SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск| +| data_name | string | Имя пула информации внутри SEP'а | +| disk_size | float | Количество занятого места | +| disk_size_max | float | Размер диска | + +### Описание структуры 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 ядер | + +## Пример использования + +Пример вызова _data source_ функции **decort_cb_rg_resource_consumption_list**: + +```terraform +data "decort_cb_rg_resource_consumption_list" "rc_list" { + #Нет входных параметров +} +# once the above directive completes, resource group consumption will be accessible +# as data.decort_cb_rg_resource_consumption_list.rc_list.items +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/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.)). + +После успешного завершения такого вызова **decort_cb_rg_resource_consumption_list** в переменной `data.decort_cb_rg_resource_consumption_list.rc_list.items` будут сохранены возвращаемые значения. diff --git a/06.02.57-Data-функция-decort_cb_rg_usage-информация-об-использовании-rg.md b/06.02.57-Data-функция-decort_cb_rg_usage-информация-об-использовании-rg.md new file mode 100644 index 0000000..1b746ba --- /dev/null +++ b/06.02.57-Data-функция-decort_cb_rg_usage-информация-об-использовании-rg.md @@ -0,0 +1,58 @@ +Функция доступна в провайдере версии 4.5.1 и выше. + +_Data source_ функция **decort_cb_rg_usage** служит для получения информации о использовании ресурсов rg. + +Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS). + +Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_cb_rg_usage**. + +## Аргументы +_Data source_ функция **decort_cb_rg_usage** принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |--------| --- | --- | +| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы | +| reason | string | :x: | Причина вызова | + +Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа. + +Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +## Возвращаемые значения +В случае успешного выполнения _data source_ функция **decort_cb_rg_usage** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров: + +| Параметр | Тип | Описание | +| --- | --- |----------------------------------| +| rg_id | int | Идентификатор ресурсной группы | +| cpu | int | Количество виртуальных CPU, выделенных данному серверу. | +| disk_size | int | Размер диска | +| disk_size_max | int | Максимальный размер диска | +| extips | int | Extips | +| exttraffic | int | Exttraffic| +| gpu | int | Количество GPU | +| ram | int | Количество RAM | +| seps | []Struct [см. ниже](#описание-структуры-seps) | Информация о сепах | + +### Описание структуры seps +| Параметр | Тип | Описание | +| --- |--------| --- | +| sep_id | string | Идентификатор сепа | +| data_name | string | Имя пула информации внутри SEP'а | +| disk_size | float | Количество занятого места | +| disk_size_max | float | Размер диска | + +## Пример использования +Пример вызова _data source_ функции **decort_cb_rg_usage**: + +```terraform +data "decort_cb_rg_usage" "rg_usage" { + rg_id = 1234 + #reason = "TEST" +} +# Once the above directive completes, resource group resource usage will be accessible as +# data.decort_cb_rg_usage.rg_usage +``` + +Данный пример подразумевает, что ранее по тексту 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_usage** в переменной `data.decort_cb_rg_usage.rg_usage` будут сохранены возвращаемые значения. diff --git a/Home.md b/Home.md index a5c6262..86e974c 100644 --- a/Home.md +++ b/Home.md @@ -116,7 +116,7 @@ Terraform провайдер для платформы DECORT с API верси 7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)