Для запуска провайдера вам потребуется компьютер, на котором установлен Terraform. Провайдер тестировался вместе с Terraform 1.x на системах под управлением ОС семейства Linux и персональных компьютерах под управлением Windows 10.
Для запуска провайдера вам потребуется машина, на которой установлен Terraform.
Кроме того, в связи с тем, что начиная с версии 0.12 Terraform изменил алгоритм поиска и инициализации локальных провайдеров, настройка данного провайдера для работы с Terraform 0.12 или более новыми версиями потребует выполнения ряда дополнительных действий. Подробнее см. [8.3 Настройка локального провайдера для работы с новыми версиями Terraform](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы#user-content-8-3-настройка-локального-провайдера-для-работы-с-новыми-версиями-terraform).
## Установка
Terraform провайдер представляет собой бинарный исполняемый файл. Чтобы быстро начать пользоваться Terraform провайдером DECORT, поместите собранный для вашей целевой платформы исполняемый файл в ту же папку, где находится ваш файл _main.tf_.
Обычно, провайдер устанавливается автоматически из terraform registry.
Для этого достаточно в файл _main.tf_ добавить директивы определения провайдера.
При выполнении команды `terraform init` провайдер будет автоматически установлен.
После этого вы можете использовать стандартные команды Terraform-а для управления ресурсами в соответствии с декларациями, содержащимися в _main.tf_, а именно:
```
terraform init
terraform plan
terraform apply
```
## Установка из релизов
Terraform провайдер DECORT имеет скомпилированные релизные версии, которые расположены по адресу: [Релизы](https://github.com/rudecs/terraform-provider-decort/releases).
Установка из релизов позволяет вместо скачивания провайдера из хранилища HashiCorp Terraform, скачать провайдер со страницы, указанной выше и установить его в ручном режиме.
Чтобы выполнить установку из релиза, необходимо:
Начиная с версии провайдера `4.3.0` в релизном архиве находятся скрипты-инсталляторы.
Чтобы выполнить установку, необходимо:
1. Перейти по адресу: https://repository.basistech.ru/BASIS/terraform-provider-decort/releases
2. Выбрать необходимую версию провайдера подходящую под операционную систему.
3. Скачать архив.
4. Распаковать архив.
5. Полученный файл необходимо поместить:
Linux:
5. Выполнить скрипт установщика, `install.sh` или `install.bat` для Windows.<br/>
*Для запуска `install.sh` не забудьте изменить права доступа к файлу*
11. В случае успешной установки, Terraform инициализирует провайдер и будет готов к дальнейшей работе.
## Сборка из исходных кодов
1. Скачайте и установите Go по ссылке: [https://go.dev/dl/](https://go.dev/dl/)
2. Скачайте и установите terraform по ссылке: [https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/aws-get-started](https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/aws-get-started)
3. Склонируйте репозиторий с провайдером, выполнив команду:
4. Перейдите в скачанную папку с провайдером и выполните команду
```bash
go build -o terraform-provider-decort
```
Если вы знаете как устроен _makefile_, то можно изменить в файле `Makefile` параметры под вашу ОС и выполнить команду
```bash
make build
```
5. Полученный файл необходимо поместить:
## Установка из релизов
Terraform провайдер DECORT имеет скомпилированные релизные версии, которые расположены по адресу: [Релизы](https://repository.basistech.ru/BASIS/terraform-provider-decort/releases).
Чтобы выполнить установку из релиза, необходимо:
1. Перейти по адресу: https://repository.basistech.ru/BASIS/terraform-provider-decort/releases
2. Выбрать необходимую версию провайдера подходящую под операционную систему.
3. Скачать архив.
4. Распаковать архив.
5. Полученный файл (в директории `bin/`) необходимо поместить:
Более подробно о сборке провайдера можно найти по ссылке: [https://learn.hashicorp.com/tutorials/terraform/provider-use?in=terraform/providers](https://learn.hashicorp.com/tutorials/terraform/provider-use?in=terraform/providers)
10. В случае успешной установки, Terraform инициализирует провайдер и будет готов к дальнейшей работе.
_Data source_ функция **decort_kvmvm** служит для получения информации об уже существующей в облачной платформе виртуальной машине (Virtual Machine, VM), созданной на базе системы виртуализации KVM.
## Изменения в 3.5.0
- В возвращаемые значения добавлены поля, которые соответсвуют полям decort версии 3.8.5
- Убраны входные опциональные поля rg_id и name
## Изменения в 3.4.0
- В возвращаемые значения добавлено новое поле shareable
- В возвращаемые значения добавлено новое поле size_max в блоке disks
- В возвращаемые значения добавлено новое поле size_used в блоке disks
## Аргументы
_Data source_ функция **decort_kvmvm** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| compute_id | int | :heavy_check_mark: | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/03.-Обзор-облачной-платформы-DECORT)). Если задан этот параметр, то параметры `name` и `rg_id` игнорируются. |
| compute_id | int | :heavy_check_mark: | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/03.-Обзор-облачной-платформы-DECORT)). |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному виртуальному серверу и ресурсной группе. В противном случае возникнет ошибка доступа.
@ -191,6 +182,7 @@ _Data source_ функция **decort_kvmvm** принимает следующ
| label | string | Наименование снимка |
| res_id | string | Ссылка на снимок |
| snap_set_guid | string | Установленный id снимка |
| reference_id | int | Reference ID |
| snap_set_time | int | Установленное время снимка |
| sep_id | int | :x: | Фильтр результата по storage endpoint provider ID |
| shared_with | int | :x: |Фильтр результата по доступности образа различным аккаунтам |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_image_list** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
@ -63,10 +73,11 @@ _Data source_ функция **decort_image_list** принимает следу
Пример вызова _data source_ функции **decort_image_list**:
```terraform
data "decort_image_list" "il" {
#pool = "data03"
#bootable = true
#page = 2
#size = 3
#sep_id = 123
#shared_with = 123
}
# once the above directive completes, images will be accessible
_Data source_ функция **decort_disk_list** служит для получения информации об имеющихся дисках.
## Изменения в версии 3.4.0
- В возвращаемые значения добавлено поле shareable
- В возвращаемые значения добавлено поле present_to
- Убраны поля compute_id и compute_name и заменены на поле computes, которое представляет из себя список структур [см. ниже](#описание-структуры-computes)
## Аргументы
_Data source_ функция **decort_disk_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| by_id | int | :x: | Фильтр по ID диска |
| name | string | :x: | Фильтр по имени диска |
| account_name | string | :x: | Фильтр по имени аккаунта |
| disk_max_size | int | :x: | Фильтр по макс. размеру диска |
@ -17,7 +17,7 @@ _Data source_ функция **decort_extnet** принимает следующ
| meta | []string | Мета информация |
| check_ips | []string | Список ip адресов для проверки |
| default | bool | Является ли сеть сетью по-умолчанию |
| default_qos | Struct{<br/>e_rate int<br/>e_burst int<br/>guid string<br/>in_burst int<br/>in_rate int<br/>} | Quality of Service по-умолчанию<br/>Минимальное кол-во потерь<br/>id сервиса<br/>Потери в режиме burst<br/>Потери в режиме rate<br/> <br/> |
| default_qos | Struct{<br/>e_rate int<br/>guid string<br/>in_burst int<br/>in_rate int<br/>} | Quality of Service по-умолчанию<br/>Минимальное кол-во потерь<br/>id сервиса<br/>Потери в режиме burst<br/>Потери в режиме rate<br/> <br/> |
| desc | string | Описание |
| dns | []string | Список dns |
| excluded | []string | Список исключенных ip-адресов |
@ -37,7 +37,7 @@ _Data source_ функция **decort_extnet** принимает следующ
| shared_with | []int | Список ресурсов, имеющих доступ к сети |
| status | string | Статус сети |
| vlan_id | int | Идентификатор vlan |
| vnfs | Struct{<br/>dhcp int<br/>} | Информация о vnfs<br/>Информация о dhsp<br/> <br/> |
| vnfs | Struct{<br/>dhcp int<br/>} | Информация о vnfs<br/>Информация о dhcp<br/> <br/> |
## Пример использования
Пример вызова _data source_ функции **decort_extnet**:
@ -10,6 +10,12 @@ _Data source_ функция **decort_account_disks_list** принимает с
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| account_id | int | :heavy_check_mark: | ID аккаунта |
| disk_id | int | :x: | Фильтр по ID диска |
| name | string | :x: | Фильтр по имени диска |
| disk_max_size | int | :x: | Фильтр по макс. размеру диска |
| type | string | :x: | Фильтр по типу диска |
| page | int | :x: | Номер страницы |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_account_disks_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
@ -33,6 +39,10 @@ data "decort_account_disks_list" "adl" {
#тип - число
account_id = 11111
#Фильтр по максимальному размеру диска
#опциональный параметр
#тип - число
disk_max_size = 50
}
# once the above directive completes, account disks list will be accessible
@ -7,6 +7,14 @@ _Data source_ функция **decort_account_flipgroups_list** принимае
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| account_id | int | :heavy_check_mark: | ID аккаунта |
| name | string | :x: | Фильтр по имени флипгруппы |
| flipgroup_id | int | :x: | Фильтр по ID флипгруппы |
| vins_id | int | :x: | Фильтр по ID ViNS |
| vins_name | string | :x: | Фильтр по имени ViNS |
| extnet_id | int | :x: | Фильтр по ID extnet |
| by_ip | string | :x: | Фильтр по IP адресу |
| page | int | :x: | Номер страницы |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_account_flipgroups_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
@ -43,7 +51,13 @@ data "decort_account_flipgroups_list" "afgl" {
#обязательный параметр
#тип - число
account_id = 1111
#Фильтр по имени ViNS
#опциональный параметр
#тип - строка
vins_name = "vins1"
}
# once the above directive completes, account flipgroups list will be accessible
# as data.decort_account_flipgroups_list.afgl.items
В случае успешного выполнения _data source_ функция **decort_account_templates_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
@ -6,7 +6,15 @@ _Data source_ функция **decort_disk_list_unattached** служит для
_Data source_ функция **decort_disk_list_unattached** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| by_id | int | :x: | Фильтр по ID диска |
| name | string | :x: | Фильтр по имени диска |
| account_name | string | :x: | Фильтр по имени аккаунта |
| disk_max_size | int | :x: | Фильтр по макс. размеру диска |
| status | string | :x: | Фильтр по статусу |
| account_id | int | :x: | id аккаунта для получения списка дисков |
| type | string | :x: | Тип диска. Возможные типы: "b" - boot_disk, "d" - data_disk |
| page | int | :x: | Номер страниц |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_disk_list_unattached** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
@ -9,8 +9,17 @@ _Data source_ функция **decort_rg_list_computes** принимает сл
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы |
| reason | :x: | string | Причина вызова |
| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы |
| compute_id | int | :x: | Фильтр по ID компьюта |
| name | string | :x: | Фильтр по имени компьюта |
| account_id | int | :x: | Фильтр по ID аккаунта |
| tech_status | string | :x: | Фильтр по тех. статусу |
| status | string | :x: | Фильтр по статусу |
| ip_address | string | :x: | Фильтр по IP адресу |
| extnet_name | string | :x: | Фильтр по имени extnet |
| extnet_id | int | :x: | Фильтр по ID extnet |
| page | int | :x: | Номер страницы |
| size | int | :x: | Размер страницы |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
@ -9,7 +9,14 @@ _Data source_ функция **decort_rg_list_deleted** принимает сл
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| page | int | :x: | Номер страниц |
| by_id | int | :x: | Фильтр по ID рес. группы |
| name | string | :x: | Фильтр по имени рес. группы |
| account_id | int | :x: | Фильтр по ID аккаунта |
| account_name | string | :x: | Фильтр по имени аккаунта |
| created_after | int | :x: | Фильтр рес. групп, созданных после опредленного момента во времени (unix timestamp) |
| created_before | int | :x: | Фильтр рес. групп, созданных перед опредленным моментом во времени (unix timestamp) |
| lock_status | string | :x: | Фильтр по lock статусу |
| page | int | :x: | Номер страницы |
| size | int | :x: | Размер страницы |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
@ -10,6 +10,15 @@ _Data source_ функция **decort_rg_list_lb** принимает следу
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы |
| by_id | int | :x: | Фильтр по ID балансировщика |
| name | string | :x: | Фильтр по имени балансировщика |
| account_id | int | :x: | Фильтр по ID аккаунта |
| tech_status | string | :x: | Фильтр по тех. статусу |
| status | string | :x: | Фильтр по статусу |
| front_ip | string | :x: | Фильтр по IP фронтенда |
| back_ip | string | :x: | Фильтр по IP бэкенда |
| page | int | :x: | Номер страницы |
| size | int | :x: | Размер страницы |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
@ -9,8 +9,13 @@ _Data source_ функция **decort_rg_list_vins** принимает след
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| rg_id | :heavy_check_mark: | int | Идентификатор ресурсной группы |
| reason | :x: | string | Причина вызова |
| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы |
| name | string | :x: | Фильтр по имени ViNS |
| account_id | int | :x: | Фильтр по ID аккаунта |
| ext_ip | string | :x: | Фильтр по внешнему IP |
| vins_id | int | :x: | Фильтр по ID ViNS |
| page | int | :x: | Номер страницы |
| size | int | :x: | Размер страницы |
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
| client_ids | []int | Список ID подключенных к группе клиентов |
| client_names | []string | Список имен подключенных клиентов |
| client_type | string | Тип клиентов, подключаемых к группе |
| conn_id | int | ID подключения |
| net_mask | int | Маска сети |
| conn_type | string | Тип подключения |
| created_by | string | Кем создана группа |
| created_time | int | Время создания |
| default_gw | string | Шлюз по умолчанию |
| deleted_by | string | Кем удалена группа |
| deleted_time | int | Время удаления |
| desc | string | Описание группы |
| gid | int | Grid ID платформы |
| guid | int | ID флипгруппы на платформе (=flipgroup_id) |
@ -30,12 +32,7 @@ _Data source_ функция **decort_flipgroup_list** служит для по
| name | string | Наименование плавающей группы |
| net_id | int | ID сети |
| net_type | string | Тип сети (EXTNET/ViNS) |
| network | string | Сеть |
| rg_id | int | ID ресурсной группы |
| rg_name | string | Наименование ресурсной группы |
| status | string | Статус плавающей группы |
| updated_by | string | Кем обновлена группа |
| updated_time | int | Время обновления |
## Пример использования
@ -53,4 +50,4 @@ data "decort_flipgroup_list" "fg_list" {
}
```
После успешного завершения такого вызова **decort_flipgroup_list** в переменной `data.decort_flipgroup_list.fg` будут сохранены возвращаемые значения.
После успешного завершения такого вызова **decort_flipgroup_list** в переменной `data.decort_flipgroup_list.fg_list` будут сохранены возвращаемые значения.
_Data source_ функция **decort_cb_extnet_list** служит для получения информации о внешней сети.
**Для того чтобы использовать данную Resource функцию требуются права администратора!**
## Аргументы
_Data source_ функция **decort_cb_extnet_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| by_id | int | :x: | Фильтр по extnet ID |
| name | string | :x: | Фильтр по имени extnet |
| network | string | :x: | Фильтр по сети |
| vlan_id | int | :x: | Фильтр по VLAN ID |
| vnfdev_id | int | :x: | Фильтр по VnfDEV ID |
| status | string | :x: | Фильтр по статусу |
| account_id | int | :x: | ID аккаунта для фильтрации результата поиска |
| page | int | :x: | Номер страниц |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_cb_extnet_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| ckey | string | CKey |
| meta | []string | Meta |
| default | bool | Является ли внешняя сеть дефолтной |
| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS |
| desc | string | Описание внешней сети |
| free_ips | int | Кол-во свободных IP адресов |
| guid | int | ID внешней сети на платформе |
| ipcidr | string | IP CIDR |
| extnet_id | int | ID внешней сети |
| milestones | int | Вехи |
| network_id | int | ID сети |
| pri_vnfdev_id | int | Pri_VNFDev ID |
| pre_reservations_num | int | Кол-во резерваций |
| ovs_bridge | string | Наименование моста OpenvSwitch внешней сети |
| shared_with | []int | ID объектов, использующих сеть |
| status | string | Статус внешней сети |
| vlan_id | int | vLAN ID |
| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs |
### Описание блока default_qos
| Параметр | Тип | Описание |
| --- | --- | --- |
| e_rate | int | Egress Rate |
| guid | string | Grid Unique ID |
| in_rate | int | Ingress Rate |
| in_burst | int | Ingress Burst |
### Описание блока vnfs
| Параметр | Тип | Описание |
| --- | --- | --- |
| dhcp | int | ID DHCP |
## Пример использования
Пример вызова _data source_ функции **decort_cb_extnet_list**:
```terraform
data "decort_cb_extnet_list" "el" {
#id аккаунта для фильтрации результата
#необязательный параметр
#тип - число
account_id = 13
#Фильтр по имени extnet
#необязательный параметр
#тип - строка
name = "test"
#кол-во страниц для вывода
#опицональный параметр
#тип - число
page = 1
#размер страницы
#опицональный параметр
#тип - число
size = 1
}
# once the above directive completes, extnet list will be accessible
# as data.decort_extnet_list.el.items
```
После успешного завершения такого вызова **decort_cb_extnet_list** в переменной `data.decort_cb_extnet_list.el` будут сохранены возвращаемые значения.
_Resource_ функция **decort_kvmvm** служит для управления виртуальными машинами, создаваемыми в платформе DECORT на базе технологии виртуализации KVM.
## Изменения в версии 3.5.2
- Добавлен функционал, который позволяет изменять параметр size у диска в блоке disks и размер диска будет обновлен не только в стейте, но и на платформе
## Изменения в 3.5.0
- Обновлен блок disks, вывод в стейт сортируется
- Добавлен блок tags
- Добавлен блок port_forwarding
- Добавлен блок user_access
- Добавлен блок snapshot
- Добавлен блок rollback
- Добавлен блок cd
- Добавлено поле pin_to_stack
- Добавлено поле pause
- Добавлено поле reset
- Добавлена возможность сделать редеплой машины, при изменении поля image_id
- Добавлено поле data_disks, для редеплоя
- Добавлено поле auto_start, для редеплоя
- Добавлено поле force_stop, для редеплоя
- Добавлено возвращение не критичных ошибок при создании ресурса (warnings)
- Добавлена проверка на доступность входных параметров – rg_id, image_id, vins_id в блоке network. Проверка выполняется во время создания или обновления ресурса
## Изменения в 3.4.1
- Добавлено поле affinity_label
- Добавлены блоки affinity_rules
- Добавлены блоки anti_affinity_rules
## Изменения в 3.4.0
- В аргументы добавлено новое поле shareable
- В возвращаемые значения добавлено новое поле size_max в блок disks
- В возвращаемые значения добавлено новое поле size_used в блок disks
## Изменения в 3.2.2
Добавлена обработка статусов виртуальной машины.
Если статус __DELETED__, то при попытке изменения конфигурационного файла, машина будет автоматически восстановлена.
Если статус __DESTROYED__, то при попытке изменения конфигурационного файла, машина будет автоматически пересоздана.
Начиная с версии 3.2.2, в ресурсе kvmvm появляется опциональное поле `enabled`, которое принимает в себя булево значение. Поле отвечает за ручную регуляцию статуса доступности вычислительной машины, автоматическая регуляция так же имеется - восстановленная и вновь созданная виртуальная машине переводится в режим `enabled = true`.
## Изменения в 3.2.1
Начиная с версии 3.2.1, в ресурсе kvmvm имеется возможность задать конфигурацию сети, с которой будет происходить создание. Такой сетью является первый блок __network__ в конфигурационном файле, описывающем ресурс виртуальной машины. Все остальные блоки, если они были добавлены при создании ресурса, являются сетями, которые будут подключены с помощью вызова метода cloudapi/netAttach.
Если блоков __network__ не было задано при создании ресурса, то будет использован `net_type = NONE`
## Изменения в 3.2.0
Начиная с версии 3.2.0, в ресурсе kvmvm появился дополнительный блок - disks. Данный блок позволяет автоматически создавать диски и прикреплять их к виртуальной машине. Основные отличия от extra_disks заключаются в следующем:
- Диск автоматически создается, в extra_disks осуществляется присоединение уже созданных дисков.
- Диск позволяет использовать системный образ для создания.
Блоков disks может быть 0 и более.
### Возможные затруднения при работе с блоком disks.
По умолчанию, sep_id и pool в платформе выбираются те же, на которых размещается загрузочный диск (создается вместе с виртуальной машиной). Из-за этого, могут возникать ошибки следующего характера:
- `Cannot add disk to Compute ID XXX: Pool xxxx does not support disk type X ` - данная ошибка означает то, что выбранный пул не поддерживает выбранные тип диска
@ -55,20 +8,84 @@ _Resource_ функция **decort_kvmvm** служит для управлен
- Заполнить поля sep_id и pool подходящими полями для диска.
- При удалении не последнего блока в списке, перед подтверждением Terraform не правильно отображает диск, который будет удаляться. На самом деле из состояние будет удален тот диск, который был убран из файла. Также будет нужен дополнительное выполнение terraform apply для того чтобы все блоки сейта терраформа встали на свои места и не отличались от настоящего состояния ресурса
### Работа с cloud_init
Cloud Init позволяет запустить ВМс предустановленными настройками пользователя, группами и доступами. Подробнее про настройку cloud_init можно прочесть по [ссылке](#https://cloudinit.readthedocs.io/en/latest/reference/examples.html).
**Пароли, указанные в cloud_init не сохраняются на платформе и не отображаются в API!**
Для использования cloud_init конфигурации, следует:
1. Создать файл с расширением `.tftpl` в рабочей директории.
2. Описать в созданном файле конфигурацию cloud_init в формате JSON или YAML:
### initconfig.tftpl
```
{
"users": [
{
"groups": "users, wheel",
"name": "user",
"plain_text_passwd": "examplePassword",
"primary_group": "user",
"ssh_authorized_keys": [
"ssh-rsa EXAMPLE%id_rsa.pub"
],
"sudo": "ALL=(ALL) NOPASSWD:ALL"
}
]
}
```
3. Указать путь до файла `initconfig.tftpl` в качестве значения параметра `cloud_init` в ресурсе`decort_kvmvm`:
```terraform
resource "decort_kvmvm" "compute1" {
# ...
cloud_init = file("initconfig.tftpl")
# ...
}
```
4. Выполнить `terraform apply`
**Конфигурация cloud_init применяется только при создании компьюта, во всех остальных случаях - игнорируется**
### Работа с custom_fields
CustomFields - это новый метод работы с XML ВМ, пришедший на замену ComputeCI начиная с версии провайдера 4.3.0.
Для описания конфигурации используется файл в формате JSON, например:
customfields.json:
```
{
"title": "test",
"name": "basename",
"cpu": {
"mode": "host-model"
}
}
```
После этого, достаточно передать файл в качестве значения параметра:
```
custom_fields = file("customfields.json")
```
## Аргументы
_Resource_ функция **decort_kvmvm** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| driver | string | :heavy_check_mark: | Аппаратная архитектура виртуальной машины.<br/>Может принимать одно из следующих значений:<br/>* "KVM_X86" - виртуальная машина KVM на аппаратной платформе x86.<br/> * "KVM_PPC" - виртуальная машина KVM на аппаратной платформе IBM Power. |
| driver | string | :heavy_check_mark: | Аппаратная архитектура виртуальной машины.<br/>Может принимать одно из следующих значений:<br/>* "KVM_X86" - stateful виртуальная машина KVM на аппаратной платформе x86.<br/> * "SVA_KVM_X86" - stateless ВМ на аппаратной платформе 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: | Размер загрузочного диска виртуальной машины в ГБ. |
| custom_fields | string (json-encoded) | :x: | Управление XML виртуальной машины |
| extra_disks | []int | :x: | Список идентификаторов дополнительных дисков, которые требуется подключить к данной виртуальной машине помимо загрузочного диска. |
| cloud_init | string | :x: | Используется на этапе создания вм.<br/>Параметры для утилиты _cloud_init_, которая используется в платформе DECORT для первичного конфигурирования виртуальной машины после её создания. |
| with_default_vins | bool | :x: | При значении false ВМ создается без подключения стандартных ViNS ресурсной группы. При указании хотя бы одного блока network (см. ниже) данный параметр игнорируется. Дефолтное значение - true. |
| network | []Struct [см. ниже](#описание-блока-network) | :x: | Параметры сетевого подключения. Если нужно сконфигурировать несколько сетевых подключений, данный блок можно задавать многократно - по одному на каждое подключение.|
Данный пример подразумевает, что ранее по тексту tf-файла :
* выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
* создан ресурс типа decort_resgroup (см. _resource_ функцию [decort_resgroup](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.02-Resource-функция-decort_resgroup-управление-ресурсными-группами)) и результат записан в переменную _decort_resgroup.my_rg_
_Resource_ функция **decort_account** служит для управления аккаунтами. Аккаунты в платформе позволяют создавать ресурсные группы, вычислительные мощности (computes), виртуальные сети, управлять ресурсами и так далее. Аккаунты создают пользователи (user). Все административное взаимодействие внутри платформы строится на аккаунтах.
**Начиная с версии провайдера 4.3.0 аккаунты могут создавать только администраторы площадок.**<br/>
**Пользователи без административных прав могут только импортировать существующие аккаунты, используя следующую команду:**
@ -66,6 +66,7 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_k8s**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.45-Data-функция-decort_k8s-получение-информации-о-кластере-k8s) - получение информацуии о кластере k8s
- [**decort_k8s_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.46-Data-функция-decort_k8s_list-получение-информации-о-списке-кластеров-k8s) - получение информации о списке кластеров k8s
- [**decort_k8s_list_deleted**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.47-Data-функция-decort_k8s_list_deleted-получение-информации-о-списке-удаленных-кластеров-k8s) - получение информации о списке удаленных кластеров k8s
- [**decort_k8ci_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.76-Data-функция-decort_k8ci_list-получение-информации-о-k8ci) - получение информации о списке доступных K8CI
- [**decort_k8s_wg**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.48-Data-функция-decort_k8s_wg-получение-информации-о-группе-воркеров-кластера-k8s) - получение информации о группе воркеров кластера k8s
- [**decort_k8s_wg_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.49-Data-функция-decort_k8s_wg_list-получение-информации-о-списке-групп-воркеров-кластера-k8s) - получение информации о списке групп воркеров кластера k8s
- [**decort_k8s_computes**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.74-Data-функция-decort_k8s_computes-получение-информации-о-виртуальных-машинах-кластера) - получение информации о виртуальных машинах кластера
@ -96,11 +97,11 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_flipgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.75-Data-функция-decort_flipgroup-получение-информации-о-плавающей-группе) - получение информации о плавающей группе
- [**decort_flipgroup_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.01.75-Data-функция-decort_flipgroup_list-получение-информации-о-плавающих-группах) - получение информации о плавающих группах
- [Административная группа API](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02-Административная-группа-API)
- [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM) - получение информации о виртуальной машине, созданной на базе системы виртуализации KVM
<!-- - [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM) - получение информации о виртуальной машине, созданной на базе системы виртуализации KVM
- [**decort_resgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.02-Data-функция-decort_resgroup-получение-информации-о-ресурсной-группе) - получение информации о ресурсной группе
- [**decort_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.03-Data-функция-decort_disk-получение-информации-о-диске) - получение информации оресурсе хранения ("disk")
- [**decort_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.04-Data-функция-decort_vins-получение-информации-о-ViNS) - получение информации о виртуальном сетевом сегменте (Virtual Network Segment, "ViNS")
- [**decort_account**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.05-Data-функция-decort_account-получение-информации-об-аккаунте) - получение информации об аккаунте
- [**decort_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.04-Data-функция-decort_vins-получение-информации-о-ViNS) - получение информации о виртуальном сетевом сегменте (Virtual Network Segment, "ViNS") -->
<!-- - [**decort_account**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.05-Data-функция-decort_account-получение-информации-об-аккаунте) - получение информации об аккаунте
- [**decort_image_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.06-Data-функция-decort_image_list-получение-информации-об-образах) - получение информации об образах (_image_)
- [**decort_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.07-Data-функция-decort_image-получение-информации-об-образе) - получение информации об образе (_image_)
- [**decort_image_list_stacks**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.08-Data-функция-decort_image_list_stacks-получение-информации-о-доступных-для-образа-stacks) - получение информации о доступном stacks по id образа
@ -109,15 +110,15 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_pcidevice_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.11-Data-функция-decort_pcidevice_list-получение-информации-о-всех-pcidevice) - получение информации о всех доступных pcidevice
- [**decort_pcidevice**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.12-Data-функция-decort_pcidevice-получение-информации-о-pcidevice) - получение информации о pcidevice
- [**decort_vgpu**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.13-Data-функция-decort_vgpu-получение-информации-о-виртуальном-графическом-устройстве) - получение информации о виртуальном графическом устройстве
- [**decort_rg_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.14-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах) - получение информации о всех доступных ресурсных группах.
- [**decort_disk_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.15-Data-функция-decort_disk_list-получение-информации-о-всех-дисках) - получение информации о всех доступных дисках
- [**decort_rg_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.14-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах) - получение информации о всех доступных ресурсных группах. -->
<!-- - [**decort_disk_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.15-Data-функция-decort_disk_list-получение-информации-о-всех-дисках) - получение информации о всех доступных дисках
- [**decort_vins_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.16-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях) - получение информации о всех доступных виртуальных сетях
- [**decort_account_audits_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.17-Data-функция-decort_account_audits_list-получение-информации-о-запросах-аккаунта) - получение информации о запросах аккаунта
- [**decort_account_computes_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.18-Data-функция-decort_account_computes_list-получение-информации-об-используемых-аккаунтом-экземплярах-computes) - получение информации об используемых аккаунтом экземплярах computes
- [**decort_account_disks_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.19-Data-функция-decort_account_disks_list-получение-информации-об-используемых-аккаунтом-дисках) - получение информации об используемых аккаунтом дисках
- [**decort_account_flipgroups_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.20-Data-функция-decort_account_flipgroups_list-получение-информации-об-используемых-групп-с-плавающим-ip-адресом) - получение информации об используемых аккаунтом групп с плавающим ip-адресом
- [**decort_account_rg_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.21-Data-функция-decort_account_rg_list-получение-информации-о-ресурсных-группах-аккаунта) - получение информации о ресурсных группах аккаунта
- [**decort_account_vins_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.22-Data-функция-decort_account_vins_list-получение-информации-о-всех-сетях-аккаунта) - получение информации о виртуальных сетях аккаунта.
- [**decort_account_rg_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.21-Data-функция-decort_account_rg_list-получение-информации-о-ресурсных-группах-аккаунта) - получение информации о ресурсных группах аккаунта -->
<!-- - [**decort_account_vins_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.22-Data-функция-decort_account_vins_list-получение-информации-о-всех-сетях-аккаунта) - получение информации о виртуальных сетях аккаунта.
- [**decort_account_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.23-Data-функция-decort_account_list-получение-информации-о-всех-доступных-аккаунтах) - получение информации о всех доступных аккаунтах.
- [**decort_account_deleted_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.24-Data-функция-decort_account_deleted_list-получение-информации-об-удаленных-аккаунтах) - получение информации о всех удаленных аккаунтах
- [**decort_sep_config**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.25-Data-функция-decort_sep_config-получение-информации-о-конфигурации-sep) - получение информации о конфигурации sep
@ -125,7 +126,9 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_sep_disk_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.27-Data-функция-decort_sep_disk_list-получение-информации-о-дисках,-используемых-sep) - получение информации о дисках, используемых sep
- [**decort_sep_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.28-Data-функция-decort_sep_list-получение-информации-о-всех-sep) - получение информации обо всех доступных sep
- [**decort_sep_pool**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.29-Data-функция-decort_sep_pool-получение-информации-о-pool-sep) - получение информации о pool sep
- [**decort_sep**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.30-Data-функция-decort_sep-получение-информации-о-sep) - получение информации о sep
- [**decort_sep**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.30-Data-функция-decort_sep-получение-информации-о-sep) - получение информации о sep -->
- [**decort_cb_extnet**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети) - получение информации о внешней сети
- [**decort_cb_extnet_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях) - получение информации о списке внешних сетей
7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)
- [Пользовательская группа API](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01-Пользовательская-группа-API)
- [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.01-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM) - управление виртуальными серверами, создаваемыми на базе системы виртуализации KVM
@ -150,9 +153,10 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_disk_snapshot**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.19-Resource-функция-decort_disk_snapshot-управление-снимком-диска) - управление снимком диска
- [**decort_flipgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.20-Resource-функция-decort_flipgroup-управление-плавающей-группой) - управление плавающей группой
- [Административная группа API](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02-Административная-группа-API)
- [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.11-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM) - управление виртуальными серверами, создаваемыми на базе системы виртуализации KVM
- [**decort_resgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.14-Resource-функция-decort_resgroup-управление-ресурсными-группами) - управление ресурсными группами
- [**decort_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.13-Resource-функция-decort_disk-управление-дисковыми-ресурсами) - управление дисковыми ресурсами.
<!-- - [**decort_kvmvm**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.11-Resource-функция-decort_kvmvm-управление-виртуальными-машинами-на-базе-KVM) - управление виртуальными серверами, создаваемыми на базе системы виртуализации KVM
- [**decort_resgroup**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.14-Resource-функция-decort_resgroup-управление-ресурсными-группами) - управление ресурсными группами -->
- [**decort_cb_extnet**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями) - управление внешними сетями
<!-- - [**decort_disk**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.13-Resource-функция-decort_disk-управление-дисковыми-ресурсами) - управление дисковыми ресурсами.
- [**decort_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.12-Resource-функция-decort_vins-управление-виртуальными-сетевыми-сегментами) - управление виртуальными сетевыми сегментами.
- [**decort_k8s**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.10-Resource-функция-decort_k8s-управление-кластером-kubernetes) - управление кластером
- [**decort_k8s_wg**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.09-Resource-функция-decort_k8s_wg-управление-worker-groups-кластера) - управление worker group кластера
@ -163,7 +167,7 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_sep**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.03-Resource-функция-decort_sep-управление-sep) - управление sep
- [**decort_sep_config**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.02-Resource-функция-decort_sep_config-управление-конфигурацией-sep) - управление конфигурацией sep
- [**decort_pcidevice**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.01-Resource-функция-decort_pcidevice-управление-устройством) - управление pcidevice
- [**decort_account**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.06-Resource-функция-decort_account-управление-аккаунтом) - управление аккаунтом
- [**decort_account**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.06-Resource-функция-decort_account-управление-аккаунтом) - управление аккаунтом -->
- [Как хранить авторизационную информацию отдельно от tf-файла](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы#81-Как-хранить-авторизационную-информацию-отдельно-от-tf-файла)
- [Если Terraform провайдер DECORT жалуется на SSL сертификаты.](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/08.-Полезные-советы#82-Если-terraform-провайдер-жалуется-на-ssl-сертификаты)
