Remove doublicates

stSolo
2022-06-07 18:33:19 +03:00
parent 42fa5ecc5a
commit 674327081a
18 changed files with 0 additions and 1079 deletions

@@ -1,51 +0,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: | Имя ресурсной группы, по которой требуется получить информацию. Имя ресурсной группы не может быть пустым. Обратите внимание, что имя ресурсной группы должно быть уникальным только в рамках одного и того же подписчика.<br/>Ресурсная группа идентифицируется по комбинации ID подписчика-владельца (`account_id`) и имени самой группы или по её идентификатору (`rg_id`). <br>Вы можете задать или `rg_id`, или `name`. Если задан параметр `rg_id`, то параметр `name` игнорируся. |
| rg_id | int | :x: | Идентификатор ресурсной группы, по которой требуется получить информацию. Идентификатор не может быть нулевым.<br/>Вы можете задать или `rg_id`, или `name`. Если задан параметр `rg_id`, то параметр `name` игнорируся. |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `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.)).
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **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 означает отсутствие ограничений по данному ресурсу. |
## Пример использования
Пример вызова _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://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`

@@ -1,63 +0,0 @@
_Data source_ функция **decort_kvmvm** служит для получения информации об уже существующей в облачной платформе виртуальной машине (Virtual Machine, VM), созданной на базе системы виртуализации KVM.
## Аргументы
_Data source_ функция **decort_kvmvm** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| name | string | :x: | Имя виртуальной машины. Для идентификации виртуальной машины по её имени также необходимо указать идентификатор ресурсной группы, которой она принадлежит (`rg_id`).<br>Обратите внимание, что имя виртуальной машины уникально только в рамках одной и той же ресурсной группы и не может быть пустым.<br>Альтернативным способом идентификации виртуальной машины является задание параметра `compute_id`. |
| rg_id | int | :x: | Идентификатор ресурсной группы, которой принадлежит данный виртуальный сервер.<br/>Данный аргумент является обязательным, если идентификация виртуальной машины выполняется по её имени. |
| compute_id | int | :x: | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы 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.)). Если задан этот параметр, то параметры `name` и `rg_id` игнорируются. |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному виртуальному серверу и ресурсной группе. В противном случае возникнет ошибка доступа.
Пользователь облачной платформы задается на стадии инициализации 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.)).
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_kvmvm** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. |
| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. |
| boot_disk_id | int | Идентификатор загрузочного диска виртуальной машины. |
| boot_disk_size | int | Размер загрузочного диска в ГБ. |
| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. |
| cloud_init | string | Параметры cloud_init |
| cpu | int | Количество виртуальных CPU, выделенных данному серверу. |
| description | string | Текстовое описание виртуальной машины. |
| driver | string | Аппаратная архитектура данной виртуальной машины. |
| extra_disks | list of ints | Список идентификаторов дополнительных дисков, которые подключены к данной виртуальной машине помимо загрузочного диска. Если такие диски отсутствуют, то список будет пустым. |
| id | int | Уникальный идентификатор этой виртуальной машины в облачной платформе. Всегда совпадает с `compute_id`. |
| image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. |
| image_name | string | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. |
| name | string | Имя виртуального сервера.<br>Возвращаемое значение `name` совпадает со значением соответствующего аргумента, переданного при вызове функции. |
| network | list of dicts | Характеристики сетевых сегментов, к которым подключен данный сервер. Формат структуры:<br/>* (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.<br/>* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`<br/>* (string) `ip_address` - IP адрес, выделенный данному подключению.<br/>* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины. |
| os_users | list of dicts | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. Формат структуры:<br/>* (string) `login` - учётная запись в гостевой ОС.<br/>* (string) `password` - пароль к этой учётной записи. |
| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. |
| rg_id | int| Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. |
| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. |
## Пример использования
В нижеприведённом примере посредством вызова _data source_ функции **decort_kvmvm** извлекается информация об уже существующем в платформе виртуальном сервере со следующими характеристиками:
* Имя сервера _MyOldVM_;
* Идентификатор ресурсной группы, в которой находится данный сервер - 123.
```terraform
data "decort_kvmvm" "existing_vm" {
name = "MyOldVM" # this is the name of pre-existing virtual machine
rg_id = 123 # this is the ID of resource group, where VM named "MyOldVM" is found
}
# Once the above directive completes, VM ID will be accessible
# as data.decort_kvmvm.existing_vm.id
```
Данный пример подразумевает, что ранее по тексту 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.)).
Чтобы получить идентификатор ресурсной группы (аргумент `rg_id`), можно воспользоваться _data source_ функцией [decort_resgroup](https://github.com/rudecs/terraform-provider-decort/wiki/06.1-Data-%D1%84%D1%83%D0%BD%D0%BA%D1%86%D0%B8%D1%8F-decs_resgroup:-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D0%B8-%D0%BE-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BD%D0%BE%D0%B9-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D0%B5.).
После успешного завершения такого вызова **decort_kvmvm** в переменной `data.decort_kvmvm.existing_vm` будут сохранены возвращаемые значения. Так, например:
* пароль для доступа в гостевую ОС, назначенный по умолчанию при создании VM - `"data.decort_kvmvm.existing_vm.os_users.0.password`
* идентификатор образа ОС, на базе которого была создана данная VM - `data.decort_kvmvm.existing_vm.image_id`
* текущий объём ОЗУ - `data.decort_kvmvm.existing_vm.ram`

@@ -1,48 +0,0 @@
_Data source_ функция **decort_disk** служит для получения информации об уже существующем диске.
## Аргументы
_Data source_ функция **decort_disk** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| name | string | :x: | Имя диска, по которому требуется получить информацию. Имя диска не может быть пустым.<br>Диск идентифицируется по комбинации ID подписчика-владельца (`account_id`) и имени диска или по его идентификатору (`disk_id`). <br>Вы можете задать или `disk_id`, или `name`. Если задан параметр `disk_id`, то параметры `name` и `account_id` игнорируются.<br>Обратите внимание, что имя диска НЕ является уникальным, и если в рамках указанного подписчика есть несколько дисков с одним и тем же названием, то будет выдана информация по первому из них. |
| disk_id | int | :x: | Идентификатор диска, по которому требуется получить информацию. Идентификатор не может быть нулевым.<br>Вы можете задать или `disk_id`, или `name`. Если задан параметр `disk_id`, то параметры `name` и `account_id` игнорируются. |
| account_id | int | :x: | Идентификатор подписчика ("account"), которому принадлежит данный диск. Не может быть нулевым.<br>Данный параметр игнорируется, если задан `disk_id`. |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `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.)).
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_disk** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | Уникальный идентификатор подписчика-владельца диска. |
| account_name | string | Имя подписчика ("account"), которому принадлежит данный диск. |
| description | string | Текстовое описание диска. |
| disk_id | int | Идентификатор диска. Дублирует значение параметра `id`. |
| id | int | Идентификатор диска. |
| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа. |
| name | string | Имя диска. Обратите внимание, что имя диска НЕ является уникальным, и если в рамках одного и того же подписчика ("account") есть несколько дисков с одним и тем же названием, то используется первый из них. |
| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск. |
| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск. |
| sep_type | string | Тип SEP. Определяет тип системы хранения и содержит одно из заданных в облачной платформе значений. |
| size | int | Размер диска в ГБ. |
| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:<br/>"B" - признак загрузочного диска ("boot").<br/>"D" - признак дополнительного диска ("data"). |
## Пример использования
Пример вызова _data source_ функции **decort_disk**:
```terraform
data "decort_disk" "my_data_disk" {
name = "Data01" # this is the name of pre-existing disk
account_id = 100 # this is the ID of the account, where disk named "Data01" is found
}
# Once the above directive completes, disk ID will be accessible as
# data.decort_disk.my_data_disk.id
```
Данный пример подразумевает, что ранее по тексту 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_disk** в переменной `data.decort_disk.my_data_disk` будут сохранены возвращаемые значения. В частности, для получения идентификатора диска следует использовать конструкцию `data.decort_disk.my_data_disk.id`

@@ -1,46 +0,0 @@
_Data source_ функция **decort_vins** служит для получения информации об уже существующем виртуальном сетевом сегменте (Virtual Network Segment, ViNS).
## Аргументы
_Data source_ функция **decort_vins** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| name | string | :heavy_check_mark: | Имя виртуального сетевого сегмента (ViNS), по которому требуется получить информацию. Имя не может быть пустым.<br>ViNS идентифицируется по комбинации имени и идентификатора ресурсной группы (`rg_id`) или подписчика (`account_id`).<br>Обратите внимание, что имя ViNS является уникальным в рамках "account" и ресурсной группы. |
| account_id | int | :x: | Идентификатор подписчика ("account"), в котором находится данный ViNS.<br>Данный параметр игнорируется, если задан ненулевой `rg_id`, так как в этом случае подразумевается, что осуществляется поиск ViNS на уровне указанной ресурсной группы. |
| rg_id | int | :x: | Идентификатор ресурсной группы, в которой находится данный ViNS.<br>Если необходимо найти ViNS, созданный на уровне подписчика ("account"), то необходимо указать ненулевой `account_id`, а параметр `rg_id` не задавать. |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанной учётной записи ("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.)).
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_vins** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | Уникальный идентификатор подписчика-владельца ViNS. |
| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. |
| description | string | Текстовое описание ViNS. |
| ext_ip_addr | string | IP адрес подключения ViNS к внешней сети. Если ViNS не подключен к внешней сети, то данный параметр содержит пустую строку.<br/>Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. |
| ext_net_id | int | Идентификатор внешней сети, к которой подключен данный ViNS. Признаком подключения ViNS ко внешней сети является ненулевое значение этого параметра.<br/>Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. |
| id | int| Идентификатор ViNS. |
| ipcidr | string | IP CIDR, присвоенный внутреннему сегменту данного ViNS. |
| name | string | Имя ViNS. |
| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. |
## Пример использования
Пример вызова _data source_ функции **decort_vins**:
```terraform
data "decort_vins" "my_vins" {
name = "Vins01" # this is the name of pre-existing ViNS
rg_id = 500 # this is the ID of the resource group, where ViNS named "Vins01" is found
}
# Once the above directive completes, ViNS ID will be accessible as
# data.decort_vins.my_vins.id
```
Данный пример подразумевает, что ранее по тексту 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_vins** в переменной `data.decort_vins.my_vins` будут сохранены возвращаемые значения. В частности, для получения идентификатора ViNS следует использовать конструкцию `data.decort_vins.my_vins.id`

@@ -1,38 +0,0 @@
_Data source_ функция **decort_account** служит для получения информации о подписчике ("account"), к ресурсам которого имеет доступ данный пользователь. Основной сценарий применения данной функции - получить цифровой идентификатор подписчика по его имени, чтобы в дальнейшем использовать этот идентификатор для управления ресурсами.
## Аргументы
**Внимание:** в качестве параметра должен быть **обязательно** передан хотя бы один из аргументов.
_Data source_ функция **decort_account** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| name | string | :x: | Имя подписчика, по которому требуется получить информацию. Имя не может быть пустым.<br>Вы можете задать или `account_id`, или `name`. Если задан параметр `account_id`, то параметр `name` игнорируется. |
| account_id | int | :x: | Идентификатор подписчика, по которому требуется получить информацию. Не может быть нулевым.<br>Если задан данный параметр, то параметр `name` игнорируется. |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `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.)).
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_disk** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | Уникальный идентификатор подписчика. |
| account_name | string | Имя подписчика. |
| status | string | Текущий статус подписчика. |
## Пример использования
Пример вызова _data source_ функции **decort_account**:
```terraform
data "decort_account" "my_account" {
name = "MyAccount" # this is the name of the account, which ID we want to get
}
# Once the above directive completes, accountID will be accessible as
# data.decort_account.my_account.id
```
Данный пример подразумевает, что ранее по тексту 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_account** в переменной `data.decort_account.my_account` будут сохранены возвращаемые значения. В частности, для получения идентификатора подписчика следует использовать конструкцию `data.decort_account.my_account.id`

@@ -1,79 +0,0 @@
Функция доступна в провайдере версии 2.0 и выше.
**Внимание:** необходимы права администратора.
_Data source_ функция **decort_image_list** служит для получения информации об имеющихся в облачной платформе образах. Образы это дисковые ресурсы, уже содержащие некоторые данные, для которых реализован механизм быстрого клонирования/копирования в новый диск.
Основной сценарий использования таких ресурсов это создание каталогов образов операционных систем (ОС), на базе которых создаются загрузочные диски для _compute_. Также с их помощью можно хранить эталонную информацию, требующуюся для работы приложений, например, файлы баз данных.
Образ ОС является основной для создания новых виртуальных серверов, так как из него формируется загрузочный диск сервера. Как следствие, для создания виртуального сервера помимо других параметров требуется указать идентификатор нужного образа ОС. Для получения всех доступных идентификаторов можно воспользоваться _data source_ функцией **decort_image_list**.
## Аргументы
_Data source_ функция **decort_image_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| page | int | :x: | Номер страниц |
| size | int | :x: | Размер страницы |
| sep_id | int | :x: | Фильтр результата по storage endpoint provider ID |
| shared_with | int | :x: |Фильтр результата по доступности образа различным аккаунтам |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_image_list** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | accountId привязки образа |
| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE |
| boot_type | string | Тип запуска ОС - bios или uefi |
| bootable | bool | Является ли образ загрузочным |
| computeci_id | int | ID вычислительного ресурса |
| desc | string | Описание образа |
| drivers | []string | Список используемых драйверов |
| enabled | bool | Доступность образа |
| gid | int | ID платформы, где образ будет создан |
| guid | int | Внутренний id образа, совпадает с image_id |
| history | object{id: int, guid: int, timestamp: int} | История обновлений образа |
| hot_resize | bool | Использует ли машина горячее изменение размера образа |
| image_type | string | Тип образа: linux, windows или другой |
| last_modified | int | Дата последнего изменения |
| link_to | int | Привязка к образу, используется в виртуальных образах |
| meta | []string | Мета информация об образе |
| milestones | int | Вехи |
| name | string | Название образа |
| password | string | Пароль для образа |
| password_dl | string | Пароль для загрузки двоичных файлов |
| permanently | bool | Удаление образа: мгновенное или нет |
| pool_name | string | Пул, в котором был создан образ |
| provider_name | string | Наименование провайдера |
| purge_attempts | int | Попытки |
| reference_id | string | ID ссылки |
| res_id | string | ID ресурса |
| res_name | string | Наименование ресурса |
| rescuecd | bool | CD или нет |
| sep_id | int | storage endpoint provider ID |
| size | int | Размер образа |
| status | string | Статус образа |
| tech_status | string | Технический статус |
| unc_path | string | unc path |
| url | string | Адрес, которого осуществлялась загрузка образа |
| username | string | Имя пользователя образа |
| username_dl | string | Имя пользователя для загрузки двоичных файлов |
| version | string | Версия |
## Пример использования
Пример вызова _data source_ функции **decort_image_list**:
```terraform
data "decort_image_list" "il" {
#page = 2
#size = 3
#sep_id = 123
#shared_with = 123
}
# once the above directive completes, images will be accessible
# as data.decort_image_list.il.items
```
Данный пример подразумевает, что ранее по тексту 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.)).
После успешного завершения такого вызова **decort_image_list** в переменной `data.decort_image_list.il` будут сохранены возвращаемые значения.

@@ -1,75 +0,0 @@
Функция доступна в провайдере версии 2.0 и выше.
**Внимание:** необходимы права администратора.
_Data source_ функция **decort_image** служит для получения информации об имеющихся в облачной платформе образах. Образы это дисковые ресурсы, уже содержащие некоторые данные ("golden image"), для которых реализован механизм быстрого клонирования/копирования в новый диск.
Основной сценарий использования таких ресурсов это создание каталогов образов операционных систем (ОС), на базе которых создаются загрузочные диски для _compute_. Также с их помощью можно хранить эталонную информацию, требующуюся для работы приложений, например, файлы баз данных.
Образ ОС является основной для создания новых виртуальных серверов, так как из него формируется загрузочный диск сервера. Как следствие, для создания виртуального сервера помимо других параметров требуется указать идентификатор нужного образа ОС. Для получения такого идентификатора можно воспользоваться _data source_ функцией **decort_image**.
## Аргументы
_Data source_ функция **decort_image** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| image_id | int | :heavy_check_mark: | ID образа, информацию по которому требуется получить. |
ID необходимо образа можно взять вызвав [decort_image_list](https://github.com/rudecs/terraform-provider-decort/wiki/06.6-Data-функция-decort_image_list:-получение-информации-об-образах)
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_image** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | accountId привязки образа |
| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE |
| boot_type | string | Тип запуска ОС - bios или uefi |
| bootable | bool | Является ли образ загрузочным |
| computeci_id | int | ID вычислительного ресурса |
| desc | string | Описание образа |
| drivers | []string | Список используемых драйверов |
| enabled | bool | Доступность образа |
| gid | int | ID платформы, где образ будет создан |
| guid | int | Внутренний id образа, совпадает с image_id |
| history | object{id: int, guid: int, timestamp: int} | История обновлений образа |
| hot_resize | bool | Использует ли машина горячее изменение размера образа |
| image_type | string | Тип образа: linux, windows или другой |
| last_modified | int | Дата последнего изменения |
| link_to | int | Привязка к образу, используется в виртуальных образах |
| meta | []string | Мета информация об образе |
| milestones | int | Вехи |
| name | string | Название образа |
| password | string | Пароль для образа |
| password_dl | string | Пароль для загрузки двоичных файлов |
| permanently | bool | Удаление образа: мгновенное или нет |
| pool_name | string | Пул, в котором был создан образ |
| provider_name | string | Наименование провайдера |
| purge_attempts | int | Попытки |
| reference_id | string | ID ссылки |
| res_id | string | ID ресурса |
| res_name | string | Наименование ресурса |
| rescuecd | bool | CD или нет |
| sep_id | int | storage endpoint provider ID |
| size | int | Размер образа |
| status | string | Статус образа |
| tech_status | string | Технический статус |
| unc_path | string | unc path |
| url | string | Адрес, которого осуществлялась загрузка образа |
| username | string | Имя пользователя образа |
| username_dl | string | Имя пользователя для загрузки двоичных файлов |
| version | string | Версия |
## Пример использования
Пример вызова _data source_ функции **decort_image**:
```terraform
data "decort_image" "my_img" {
image_id = 1234
}
# once the above directive completes, image ID will be accessible
# as data.decort_image.my_img.id
```
Данный пример подразумевает, что ранее по тексту 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.)).
После успешного завершения такого вызова **decort_image** в переменной `data.decort_image.my_img` будут сохранены возвращаемые значения. В частности, для получения идентификатора образа следует использовать конструкцию `data.decort_image.my_img.id`

@@ -1,41 +0,0 @@
Функция доступна в провайдере версии 2.0 и выше.
**Внимание:** необходимы права администратора.
_Data source_ функция **decort_grid_list** служит для получения информации об имеющихся в облачной платформе grid. Grid это пространства, на которых возможно размещение виртуальных машин.
## Аргументы
_Data source_ функция **decort_grid_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| page | int | :x: | Номер страниц |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_grid_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| flag | string | Флаг |
| gid | int | ID grid |
| guid | int | Внутренний id |
| id | int | ID |
| location_code | string | Код расположения grid |
| name | string | Наименование grid |
## Пример использования
Пример вызова _data source_ функции **decort_grid_list**:
```terraform
data "decort_grid_list" "gl" {
#page = 2
#size = 3
}
# once the above directive completes, grid list will be accessible
# as data.decort_grid_list.gl.items
```
Данный пример подразумевает, что ранее по тексту 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.)).
После успешного завершения такого вызова **decort_grid_list** в переменной `data.decort_grid_list.gl` будут сохранены возвращаемые значения.

@@ -1,39 +0,0 @@
Функция доступна в провайдере версии 2.0 и выше.
**Внимание:** необходимы права администратора.
_Data source_ функция **decort_grid** служит для получения информации о grid. Grid это пространства, на которых возможно размещение виртуальных машин.
## Аргументы
_Data source_ функция **decort_grid** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| grid_id | int | :heavy_check_mark: | ID grid |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_grid** возвращает в указанную при вызове переменную, которая состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| flag | string | Флаг |
| gid | int | ID grid |
| guid | int | Внутренний id |
| id | int | ID |
| location_code | string | Код расположения grid |
| name | string | Наименование grid |
## Пример использования
Пример вызова _data source_ функции **decort_grid**:
```terraform
data "decort_grid" "my_grid" {
grid_id = 1234
}
# once the above directive completes, grid will be accessible
# as data.decort_grid.my_grid
```
Данный пример подразумевает, что ранее по тексту 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.)).
После успешного завершения такого вызова **decort_grid** в переменной `data.decort_grid.my_grid` будут сохранены возвращаемые значения.

@@ -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://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** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| 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://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`.

@@ -1,81 +0,0 @@
_Resource_ функция **decort_kvmvm** служит для управления виртуальными машинами, создаваемыми в платформе DECORT на базе технологии виртуализации KVM.
## Аргументы
_Resource_ функция **decort_kvmvm** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| driver | string | :heavy_check_mark: | Аппаратная архитектура виртуальной машины.<br/>Может принимать одно из следующих значений:<br/> * "KVM_X86" - виртуальная машина KVM на аппаратной платформе x86.<br/> * "KVM_PPC" - виртуальная машина KVM на аппаратной платформе IBM Power. |
| cpu | int | :heavy_check_mark: | Количество процессоров. |
| name | string | :heavy_check_mark: | Имя виртуальной машины. Обратите внимание, что имя должно быть уникальным в рамках ресурсной группы. |
| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы, которой принадлежит данная виртуальная машина. |
| ram | int | :heavy_check_mark: | Объём оперативной памяти в МБ.<br/> |
| image_id | int | :heavy_check_mark: | Идентификатор образа, на базе которого создаётся загрузочный диск виртуальной машины.<br/> |
| boot_disk_size | int | :heavy_check_mark: | Размер загрузочного диска виртуальной машины в ГБ. |
| extra_disks | []int | :x: | Список идентификаторов дополнительных дисков, которые требуется подключить к данной виртуальной машине помимо загрузочного диска. |
| cloud_init | string | :x: | Используется на этапе создания вм.<br/>Параметры для утилиты _cloud_init_, которая используется в платформе DECORT для первичного конфигурирования виртуальной машины после её создания. |
| network | dict | :x: | Параметры сетевого подключения. Структура словаря:<br/> * (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.<br/>* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`<br/>* (string) `ip_address` - IP адрес, выделенный данному подключению.<br/>* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины.<br/>Если нужно сконфигурировать несколько сетевых подключений, данный блок можно задавать многократно - по одному на каждое подключение. |
| description | string | :x: | Текстовое описание виртуальной машины. |
| started | bool | :x: | Флаг запуска машины,<br/>по-умолчанию - true.<br/>Если true - машина включена,<br/>если false - выключена. |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_kvmvm** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. |
| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. |
| driver | string | Аппаратная архитектура данной виртуальной машины. |
| boot_disk_id | int | Идентификатор загрузочного диска виртуальной машины. |
| boot_disk_size | int | Размер загрузочного диска в ГБ. |
| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. |
| cpu | int | Количество виртуальных CPU, выделенных данному серверу. |
| description | string | Текстовое описание виртуальной машины. |
| extra_disks | list of ints | Список идентификаторов дополнительных дисков, которые подключены к данной виртуальной машине помимо загрузочного диска. Если такие диски отсутствуют, то список будет пустым. |
| id | int | Уникальный идентификатор этой виртуальной машины в облачной платформе. Всегда совпадает с `compute_id`. |
| image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. |
| image_name | string | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. |
| name | string | Имя виртуального сервера.<br>Возвращаемое значение `name` совпадает со значением соответствующего аргумента, переданного при вызове функции. |
| network | list of dicts | Характеристики сетевых сегментов, к которым подключен данный сервер. Формат структуры:<br/>* (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.<br/>* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`<br/>* (string) `ip_address` - IP адрес, выделенный данному подключению.<br/>* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины. |
| os_users | list of dicts | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. Формат структуры:<br/>* (string) `login` - учётная запись в гостевой ОС.<br/>* (string) `password` - пароль к этой учётной записи. |
| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. |
| rg_id | int| Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. |
| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. |
| started | bool | Опциональный параметр, флаг запуска машины,<br/>по-умолчанию - true.<br/>Если true - машина включена,<br/>если false - выключена. |
## Пример использования
В нижеприведённом примере с помощью _resource_ функции **decort_kvmvm** создаётся виртуальная машина (экземпляр _compute_ в терминологии платформы DECORT) следующими характеристиками:
* Имя виртуальной машины - "tf-managed-vm"
* Характеристики виртуальной машины - 1 CPU, 1024Мб RAM, размер загрузочного диска 10Гб
* К виртуальной машине будет подключён один дополнительный диск с идентификатором 56789
* Идентификатор ресурсной группы, в которой создаётся виртуальная машина - поступает из переменной _decort_resgroup.my_rg.id_
* Идентификатор образа ОС, который будет установлен на загрузочный диск - поступает из переменной _data.decort_image.os_image.id_
* Виртуальная машина будет иметь одно сетевое подключение - во внешнюю сеть с идентификатором 12, IP адрес этого подключения платформа установит автоматически
```terraform
resource "decort_kvmvm" "my_new_vm" {
name = "tf-managed-vm"
rg_id = decort_resgroup.my_rg.id
driver = "KVM_X86" # "KVM_PPC" for IBM Power or "KVM_X86" for Intel
cpu = 1 # CPU count
ram = 1024 # RAM size in MB, must be even number, ideally a power of 2
boot_disk_size = 10 # Boot disk size in GB
extra_disks = [ 56789 ]
image_id = data.decort_image.os_image.id
description = "Test KVM VM Compute managed by Terraform"
network {
net_type = "EXTNET"
net_id = 12
}
#started = true
}
```
Данный пример подразумевает, что ранее по тексту 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.)).
* создан ресурс типа decort_resgroup (см. _resource_ функцию [decort_resgroup](https://github.com/rudecs/terraform-provider-decort/wiki/07.1-Resource-%D1%84%D1%83%D0%BD%D0%BA%D1%86%D0%B8%D1%8F-decort_resgroup:-%D1%83%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BD%D1%8B%D0%BC%D0%B8-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D0%B0%D0%BC%D0%B8.)) и результат записан в переменную _decort_resgroup.my_rg_
* считана информация об образе ОС(см. _data_ функцию [decort_image](https://github.com/rudecs/terraform-provider-decort/wiki/06.6-Data-%D1%84%D1%83%D0%BD%D0%BA%D1%86%D0%B8%D1%8F-decort_image:-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D0%B8-%D0%BE%D0%B1-%D0%BE%D0%B1%D1%80%D0%B0%D0%B7%D0%B0%D1%85.)) и результат записан в переменную _decort_resgroup.os_image_
После успешного завершения такого вызова _resource_ функции **decort_kvmvm** в переменной `decort_kvmvm.my_new_vm` будут сохранены возвращаемые значения. В частности, для получения идентификатора виртуальной машины следует использовать конструкцию `decort_kvmvm.my_new_vm.id`.

@@ -1,57 +0,0 @@
_Resource_ функция **decort_disk** служит для управления дисковыми ресурсами ("disk") в облачной платформе DECORT.
## Аргументы
_Resource_ функция **decort_disk** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| pool | string | :heavy_check_mark: | Имя пула в системе хранения, на ресурсах которой должен быть размещён данный диск. |
| sep_id | int | :heavy_check_mark: | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой должен быть размещён данный диск. |
| size | int | :heavy_check_mark: | Размер диска в ГБ. |
| account_id | int | :x: | Идентификатор подписчика (aka "account"), которому принадлежит данная ресурсная группа.<br/>Этот параметр является обязательным при идентификации уже имеющегося диска по его имени (`name`) или при создании нового диска. |
| description | string | :x: | Текстовое описание диска.<br/>Данный параметр не является обязательным. |
| disk_id | int | :x: | Идентификатор диска. Данный параметр может использоваться только при управлении уже существующим диском.<br/>Если этот параметр явно задан, то `name` и `account_id` игнорируются, а плагин считает, что диск с указанным `disk_id` уже существует. |
| name | string | :x: | Имя диска. Обратите внимание, что имя диска НЕ является уникальным в рамках одного и того же подписчика ("account").<br/>При создании нового диска этот параметр является обязательным и не может быть пустым. |
Для создания диска пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь как минимум доступ на запись к указанному подписчику. В противном случае возникнет ошибка доступа.
Пользователь облачной платформы задается на стадии инициализации 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.)).
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_disk** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | Уникальный идентификатор подписчика-владельца диска. |
| account_name | string | Имя подписчика ("account"), которому принадлежит данный диск. |
| description | string | Текстовое описание диска. |
| disk_id | int | Идентификатор диска. Дублирует значение параметра `id`. |
| id | int | Идентификатор диска. |
| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа. |
| name | string | Имя диска. Обратите внимание, что имя диска НЕ является уникальным, и если в рамках одного и того же подписчика ("account") есть несколько дисков с одним и тем же названием, то используется первый из них. |
| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск. |
| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск. |
| sep_type | string | Тип SEP. Определяет тип системы хранения и содержит одно из заданных в облачной платформе значений. |
| size | int | Размер диска в ГБ. |
| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:<br/>"B" - признак загрузочного диска ("boot").<br/>"D" - признак дополнительного диска ("data"). |
## Пример использования
В нижеприведённом примере с помощью _resource_ функции **decort_disk** создаётся новый диск со следующими характеристиками:
* Имя диска- "MyDisk01"
* Идентификатор подпичсика-владельца ("account") - 100
* Размер диска - 10 ГБ.
* Система хранения, на которой будет размещён ноый диск, идентифицируется как SEP ID = 5
* Пул на указанной системе хранения, где будет размещён диск, называется "data"
```terraform
resource "decort_disk" "my_disk01" {
name = "MyDisk01"
account_id = 100
sep_id = 5
pool = "data"
}
```
Данный пример подразумевает, что ранее по тексту 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_disk** в переменной `decort_disk.my_disk01` будут сохранены возвращаемые значения. В частности, для получения идентификатора диска следует использовать конструкцию `"${decort_disk.my_disk01.id}"`.

@@ -1,52 +0,0 @@
_Resource_ функция **decort_vins** служит для управления виртуальными сетевыми сегментами (Virtual Network Segment) в платформе DECORT.
## Аргументы
_Resource_ функция **decort_vins** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| name | string | :heavy_check_mark: | Имя виртуального сетевого сегмента (ViNS), по которому требуется получить информацию. Имя не может быть пустым.<br/>ViNS идентифицируется по комбинации имени и идентификатора ресурсной группы (`rg_id`) или подписчика (`account_id`).<br>Обратите внимание, что имя ViNS является уникальным в рамках "account" и ресурсной группы. |
| account_id | int | :heavy_check_mark: | Данный параметр является обязательным независимо от того, создаётся ли ViNS на уровне подписчика или на уровне ресурсной группы.<br/> Идентификатор подписчика ("account"), в котором должен находиться данный ViNS.<br/>Обратите внимание, что попытка изменить `account_id` у существующего ресурса приведёт к его пересозданию. |
| ext_net_id | int | :heavy_check_mark: | Идентификатор внешней сети, в которую должен быть подключён ViNS. Если подключение во внешнюю сеть не требуется, то необходимо задать `ext_net_id = 0`.<br/>Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. |
| description | string | :x: | Текстовое описание данного ViNS.<br/>Данный параметр не является обязательным, значение по умолчанию - пустая строка. |
| ipcidr | string | :x: | IP CIDR, который требуется присвоить внутреннему сегменту данного ViNS. <br/>Данный параметр не является обязательным и принимается во внимание только на стадии создания нового ViNS. Если он не задан, то платформа установит значение самостоятельно. |
| rg_id | int | :x: | Идентификатор ресурсной группы, в которой должен находиться данный ViNS.<br>Если требуется создать ViNS на уровне подписчика ("account"), то необходимо указать `rg_id = 0`.<br/>Обратите внимание, что попытка изменить `rg_id` у существующего ресурса приведёт к его пересозданию.|
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанной учётной записи ("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.)).
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_vins** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | Уникальный идентификатор подписчика-владельца ViNS. |
| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. |
| description | string | Текстовое описание ViNS. |
| ext_ip_addr | string | IP адрес подключения ViNS к внешней сети. Если ViNS не подключен к внешней сети, то данный параметр содержит пустую строку.<br/>Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. |
| ext_net_id | int | Идентификатор внешней сети, к которой подключен данный ViNS. Признаком подключения ViNS ко внешней сети является ненулевое значение этого параметра.<br/>Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. |
| id | int | Идентификатор ViNS. |
| ipcidr | string | IP CIDR, присвоенный внутреннему сегменту данного ViNS. |
| name | string | Имя ViNS. |
| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. |
## Пример использования
Пример вызова _data source_ функции **decort_vins**:
```terraform
resource "decort_vins "my_vins" {
name = "Vins01" # this is the name of the ViNS to create
rg_id = 500 # this is the ID of the resource group, where ViNS is created
account_id = 100 # this is the ID of the account, where the resource group is located and ViNS is created
ext_net_id = 0 # no connection to external network for this ViNS
}
# Once the above directive completes, ViNS ID will be accessible as
# decort_vins.my_vins.id
```
Данный пример подразумевает, что ранее по тексту 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_vins** в переменной `data.decort_vins.my_vins` будут сохранены возвращаемые значения. В частности, для получения идентификатора ViNS следует использовать конструкцию `data.decort_vins.my_vins.id`

@@ -1,39 +0,0 @@
Функция доступна в провайдере версии 2.1 и выше.
_Resource_ функция **decort_snapshot** служит для управления снапшотами. Снапшот позволяет делать снимки данных с диска, а после этого их восстанавливать. Для успешного восстановления данных через снапшот, необходимо убедиться, что [compute](link will available soon) (вычислительные мощности) остановлен.
## Аргументы
_Resource_ функция **decort_snapshot** для создания снапшота принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| compute_id | int | :heavy_check_mark: | ID вычислительной мощности |
| label | string | :heavy_check_mark: | Наименование снапшота |
| rollback | bool | :x: | Флаг отката<br/>по-умолчанию - false<br/>если флаг был изменен с false на true,<br/>то произойдет восстановление данных из снапшота<br/>Флаг используется после создания ресурса. |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_snapshot** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| guid | string | Guid снапшота |
| label | string | Наименование снапшота |
| timestamp | int | Время создания снапшота |
| disks | []int | Диски снапшота |
## Пример использования
Пример вызова _resource_ функции **decort_snapshot**:
```terraform
resource "decort_snapshot" "s" {
compute_id = 11111
label = "test_ssht_3"
#rollback = false
}
# once the above directive completes, cdrom image will be accessible
# as decort_snapshot.s
```
Данный пример подразумевает, что ранее по тексту 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.)).
После успешного завершения такого вызова **decort_snapshot** в переменной `decort_snapshot.s` будут сохранены возвращаемые значения.

@@ -1,69 +0,0 @@
Функция доступна в провайдере версии 2.0 и выше.
_Resource_ функция **decort_k8s** служит для управления кластером.
## Аргументы
_Resource_ функция **decort_k8s** для создания кластера принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| name | string | :heavy_check_mark: | Наименование кластера, <br/>при изменении - изменяет наименование кластера |
| rg_id | int | :heavy_check_mark: | ID ресурсной группы |
| k8sci_id | int | :heavy_check_mark: | ID catalogue item |
| wg_name | string | :heavy_check_mark: | Имя для первой worker group, <br/> созданной в кластере |
| masters | object{<br/>num: int, <br/>cpu: int,<br/>ram: int,<br/>disk: int} | :x: | Настройка мастер node или nodes<br/>Обязательный параметр, кол-во nodes<br/>Обязательный параметр, количество cpu<br/>Обязательный параметр, кол-во RAM в Mбайтах<br/>Обязательный параметр, размер диска в Гбайтах |
| workers | object{<br/>num: int, <br/>cpu: int,<br/>ram: int,<br/>disk: int} | :x: | Настройка worker node или nodes<br/>Обязательный параметр, кол-во nodes<br/>Обязательный параметр, количество cpu<br/>Обязательный параметр, кол-во RAM в Mбайтах<br/>Обязательный параметр, размер диска в Гбайтах |
| extnet_id | int | :x: | ID внешней сети для соединения workers.<br/>Если не задано,<br/>то сеть будет выбрана платформой. |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_k8s** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| default_wg_id | int | ID рабочей группы (worker group) для этого экземпляра кластера. |
| kubeconfig | string | Kubeconfig для доступа к кластеру. |
| lb_ip | string | IP адрес балансировщика нагрузки (load balancer) по-умолчанию. |
| name | string | Наименование кластера |
| rg_id | int | ID ресурсной группы |
| k8sci_id | int | ID catalogue item |
| wg_name | string | Имя для первой worker group, <br/> созданной в кластере |
| masters | object{<br/>num: int, <br/>cpu: int,<br/>ram: int,<br/>disk: int} | Настройка мастер node или nodes<br/>Кол-во nodes<br/>Количество cpu<br/>Кол-во RAM в Mбайтах<br/>Размер диска в Гбайтах |
| workers | object{<br/>num: int, <br/>cpu: int,<br/>ram: int,<br/>disk: int} | Настройка worker node или nodes<br/>Кол-во nodes<br/>Количество cpu<br/>Кол-во RAM в Mбайтах<br/>Размер диска в Гбайтах |
| extnet_id | int | ID внешней сети для соединения workers |
## Пример использования
Пример вызова _resource_ функции **decort_k8s**:
```terraform
resource "decort_k8s" "cluster" {
name = "tftest"
rg_id = 123
k8sci_id = 9
wg_name = "workers"
#extnet_id = 11111
/*
masters {
num = 1
cpu = 2
ram = 2048
disk = 10
}
*/
/*
workers {
num = 1
cpu = 2
ram = 2048
disk = 10
}
*/
}
# once the above directive completes, will be accessible
# as decort_k8s.cluster
```
Данный пример подразумевает, что ранее по тексту 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.)).
После успешного завершения такого вызова **decort_k8s** в переменной `decort_k8s` будут сохранены возвращаемые значения.

@@ -1,45 +0,0 @@
Функция доступна в провайдере версии 2.0 и выше.
_Resource_ функция **decort_k8s_wg** служит для управления worker groups (рабочики группами, wg) кластера.
## Аргументы
_Resource_ функция **decort_k8s_wg** для создания worker group принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| k8s_id | int | :heavy_check_mark: | ID экземпляра k8s |
| name | string | :heavy_check_mark: | Наименование worker group |
| num | int | :x: | Количество worker node для создания |
| cpu | int | :x: | Количество cpu для 1 worker node<br/>по - умолчанию - 1|
| ram | int | :x: | Количество RAM для одной worker node в Мбайтах, <br/>по-умолчанию - 1024|
| disk | int | :x: | Размер загрузочного диска для worker node, в Гбайтах<br/>по - умолчанию - 0<br/>если установлен параметр 0, то размер диска будет равен размеру образа |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_k8s_wg** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| k8s_id | int | ID экземпляра k8s |
| name | string | Наименование worker group |
| num | int | Количество worker node для создания |
| cpu | int | Количество cpu для 1 worker node |
| ram | int | Количество RAM для одной worker node в Мбайтах |
| disk | int | Размер загрузочного диска для worker node, в Гбайтах |
## Пример использования
Пример вызова _resource_ функции **decort_k8s_wg**:
```terraform
resource "decort_k8s_wg" "wg" {
k8s_id = 1234 //это значение должно быть результатом вызова decort_k8s.cluster.id
name = "workers-2"
num = 2
cpu = 1
ram = 1024
disk = 10
}
# once the above directive completes, will be accessible
# as decort_k8s_wg.wg
```
Данный пример подразумевает, что ранее по тексту 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.)).

@@ -1,113 +0,0 @@
Функция доступна в провайдере версии 2.0 и выше.
**Внимание:** необходимы права администратора.
_Resource_ функция **decort_image** служит для управления образом.
## Аргументы
_Resource_ функция **decort_image** для создания образа принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| name | string | :heavy_check_mark: | Имя образа<br/>При изменении - изменяет название образа|
| url | string | :heavy_check_mark: | Адрес образа |
| gid | int | :heavy_check_mark: | Grid id образа |
| boot_type | string | :heavy_check_mark: | Тип загрузки образа,<br/>возможные варианты: "bios" или "uefi"|
| image_type | string | :heavy_check_mark: | Тип образа,<br />возможные варианты - "linux", "windows"|
| drivers | []string | :heavy_check_mark: | Драйвера,<br/>возможные варианты - ["KVM_X86", "SVA_KVM_X86"], ["KVM_X86"], ["SVA_KVM_X86"] |
| account_id | int | :x: |ID аккаунта владельца образа,<br/>может быть использован как при создании, так и редактировании образа |
| username | string | :x: | Имя пользователя,<br/>может быть использован как при создании, так и редактировании образа |
| password | string | :x: | Пароль пользователя,<br/>может быть использован как при создании, так и редактировании образа |
| username_dl | string | :x: | Имя пользователя для загрузки бинарных данных,<br/>может быть использован как при создании, так и редактировании образа |
| password_dl | string | :x: | Пароль пользователя для загрузки бинарных данных,<br/>может быть использован как при создании, так и редактировании образа |
| sync | bool | :x: | Синхронное создание образа, используется при создании |
| sep_id | int | :x: | ID storage endpoint |
| pool_name | string | :x: | Пул для создания образа |
| architecture | string | :x: | Используется при создании, <br/>архитектура системы образа<br/>доступные значения: "X86_64"<br/>по-умолчанию "X86_64" |
| enabled | bool | :x: | Доступность образа,<br/>используется при редактировании ресурса |
| shared_with | []int | :x: | Настройка доступа образа аккаунтам<br/>используется на уже созданном ресурсе,<br/>пустой маасив - удаление всех доступов, если они были |
| computeci_id | int | :x: | Установка computeci,<br/>используется на уже созданном ресурсе,<br/>чтобы сбросить, необходимо передать 0 |
| enabled_stacks | []string | :x: | Доступные стаки,<br/>используется на уже созданном ресурсе<br/>для удаления всех доступных стаков, необходимо передать пустой массив |
| permanently | bool | :x: | Мгновенное удаление<br/>можно использовать перед удалением |
| reason | string | :x: | Причина удаления<br/>можно использовать перед удалением |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_image** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | accountId привязки образа |
| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE |
| boot_type | string | Тип запуска ОС - bios или uefi |
| bootable | bool | Является ли образ загрузочным |
| computeci_id | int | ID вычислительного ресурса |
| desc | string | Описание образа |
| drivers | []string | Список используемых драйверов |
| enabled | bool | Доступность образа |
| gid | int | ID платформы, где образ будет создан |
| guid | int | Внутренний id образа, совпадает с image_id |
| history | object{id: int, guid: int, timestamp: int} | История обновлений образа |
| hot_resize | bool | Использует ли машина горячее изменение размера образа |
| image_type | string | Тип образа: linux, windows или другой |
| last_modified | int | Дата последнего изменения |
| link_to | int | Привязка к образу, используется в виртуальных образах |
| meta | []string | Мета информация об образе |
| milestones | int | Вехи |
| name | string | Название образа |
| password | string | Пароль для образа |
| password_dl | string | Пароль для загрузки двоичных файлов |
| permanently | bool | Удаление образа: мгновенное или нет |
| pool_name | string | Пул, в котором был создан образ |
| provider_name | string | Наименование провайдера |
| purge_attempts | int | Попытки |
| reference_id | string | ID ссылки |
| res_id | string | ID ресурса |
| res_name | string | Наименование ресурса |
| rescuecd | bool | cd или нет |
| sep_id | int | storage endpoint provider ID |
| size | int | Размер образа |
| status | string | Статус образа |
| tech_status | string | Технический статус |
| unc_path | string | unc path |
| url | string | Адрес, которого осуществлялась загрузка образа |
| username | string | Имя пользователя образа |
| username_dl | string | Имя пользователя для загрузки двоичных файлов |
| version | string | Версия |
## Пример использования
Пример вызова _resource_ функции **decort_image**:
```terraform
resource "decort_image" "my_image" {
name = "test_image_rename"
url = <IMAGE_URL>
gid = 212
boot_type = "bios"
image_type = "linux"
drivers = ["KVM_X86", "SVA_KVM_X86"]
#account_id = 5725
#username = "Valera"
#password = "123"
#username_dl = "Valera1"
#password_dl = "1231"
#sep_id = 1206
#pool_name = "vmstor"
#architecture = "X86_64"
#enabled = true
#shared_with = [28096, 57121]
#computeci_id = 1
#enabled_stacks = ["9"]
#permanently = true
#reason = "test"
}
# once the above directive completes, will be accessible
# as decort_image.my_image
```
Данный пример подразумевает, что ранее по тексту 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.)).
После успешного завершения такого вызова **decort_image** в переменной `decort_image.my_image` будут сохранены возвращаемые значения.

@@ -1,91 +0,0 @@
Функция доступна в провайдере версии 2.0 и выше.
**Внимание:** необходимы права администратора.
_Resource_ функция **decort_virtual_image** служит для управления виртуальным образом. Виртуальный образа создаются на основе уже созданных ранее образов, таким образом, они привязываются к уже созданным образам. Образ, на основе которого создан виртуальный диск, удалить невозможно - для этого необходимо удалить виртуальный образ, либо связать его с другим образом.
## Аргументы
_Resource_ функция **decort_virtual_image** для создания виртуального образа принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| name | string | :heavy_check_mark: | Имя виртуального образа |
| target_id | int | :heavy_check_mark: | ID образа, на основе котрого будет создан виртуальный |
| link_to | int | :x: | Используется при редактировании ресурса<br/>изменение связи виртуального образа |
| account_id | int | :x: | ID аккаунта владельца образа<br/>может быть использован при редактировании образа|
| username | string | :x: | Имя пользователя,<br/>может быть использован при редактировании образа |
| password | string | :x: | Пароль пользователя,<br/>может быть использован при редактировании образа |
| enabled | bool | :x: | Доступность образа,<br/>используется при редактировании ресурса |
| shared_with | []int | :x: | Настройка доступа образа аккаунтам<br/>используется на уже созданном ресурсе,<br/>пустой маасив - удаление всех доступов, если они были |
| computeci_id | int | :x: | Установка computeci,<br/>используется на уже созданном ресурсе,<br/>чтобы сбросить, необходимо передать 0 |
| enabled_stacks | []string | :x: | Доступные стаки,<br/>используется на уже созданном ресурсе<br/>для удаления всех доступных стаков, необходимо передать пустой массив |
| permanently | bool | :x: | Мгновенное удаление<br/>можно использовать перед удалением |
| reason | string | :x: | Причина удаления<br/>можно использовать перед удалением |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_virtual_image** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| account_id | int | accountId привязки образа |
| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE |
| computeci_id | int | ID вычислительного ресурса |
| desc | string | Описание образа |
| drivers | []string | Cписок используемых драйверов |
| enabled | bool | Доступность образа |
| gid | int | ID платформы, где образ будет создан |
| guid | int | Внутренний id образа, совпадает с image_id |
| history | object{id: int, guid: int, timestamp: int} | История обновлений образа |
| hot_resize | bool | Использует ли машина горячее изменение размера образа |
| image_type | string | Тип образа: linux, windows или другой |
| last_modified | int | Дата последнего изменения |
| link_to | int | Привязка к образу, используется в виртуальных образах |
| meta | []string | Мета информация об образе |
| milestones | int | Вехи |
| name | string | Название образа |
| password | string | Пароль для образа |
| permanently | bool | Удаление образа: мгновенное или нет |
| pool_name | string | Пул, в котором был создан образ |
| provider_name | string | Наименование провайдера |
| purge_attempts | int | Попытки |
| reference_id | string | ID ссылки |
| res_id | string | ID ресурса |
| res_name | string | Наименование ресурса |
| sep_id | int | storage endpoint provider ID |
| size | int | Размер образа |
| status | string | Статус образа |
| tech_status | string | Технический статус |
| unc_path | string | unc path |
| url | string | Адрес, которого осуществлялась загрузка образа |
| username | string | Имя пользователя образа |
| version | string | Версия |
## Пример использования
Пример вызова _resource_ функции **decort_virtual_image**:
```terraform
resource "decort_virtual_image" "my_image" {
name = "test_vi_im_new_rename"
target_id = 2222
#link_to = 3333
#account_id = 78765
#username = "Valera"
#password = "123"
#enabled = false
#shared_with = [111222, 222333]
#computeci_id = 1
#enabled_stacks = ["9"]
#permanently = true
#reason = "test"
}
# once the above directive completes, will be accessible
# as decort_virtual_image.my_image
```
Данный пример подразумевает, что ранее по тексту 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.)).
После успешного завершения такого вызова **decort_virtual_image** в переменной `decort_virtual_image.my_image` будут сохранены возвращаемые значения.