Create resource decort_virtual_image page, add a description

stSolo
2022-03-28 17:42:37 +03:00
parent 57d8cc37d5
commit bdac4c2b4f

@@ -0,0 +1,94 @@
**Внимание:** необходимы права администратора.
_Resource_ функция **decort_virtual_image** служит для управления виртуальным образом. Виртуальный образа создаются на основе уже созданных ранее образов, таким образом, они привязываются к уже созданным образам. Образ, на основе которого создан виртуальный диск, удалить невозможно - для этого необходимо удалить виртуальный образ, либо связать его с другим образом.
## Аргументы
_Resource_ функция **decort_virtual_image** для создания виртуального образа принимает следующие аргументы:
| Аргумент | Тип | Описание |
| --- | --- | --- |
| name | string | Обязательный параметр, имя виртуального образа |
| target_id | int | Обязательный параметр,<br/>id образа, на основе котрого будет создан виртуальный |
| link_to | int | Опциональный параметр,<br/>используется при редактировании ресурса<br/>изменение связи виртуального образа |
| account_id | int | Опциональный параметр,<br/>id аккаунта владельца образа<br/>может быть использован при редактировании образа|
| username | string | Опциональные параметры,<br/> имя пользователя,<br/>может быть использован при редактировании образа |
| password | string | Опциональные параметры,<br/> пароль пользователя,<br/>может быть использован при редактировании образа |
| enabled | bool | Опциональный параметр,<br/>доступность образа,<br/>используется при редактировании ресурса |
| shared_with | []int | Опциональный параметр,<br/>настройка доступа образа аккаунтам<br/>используется на уже созданном ресурсе,<br/>пустой маасив - удаление всех доступов, если они были |
| computeci_id | int | Опциональный параметр,<br/>установка computeci,<br/>используется на уже созданном ресурсе,<br/>чтобы сбросить, необходимо передать 0 |
| enabled_stacks | []string | Опциональный параметр,<br/>доступные стаки,<br/>используется на уже созданном ресурсе<br/>для удаления всех доступных стаков, необходимо передать пустой массив |
| permanently | bool | Опциональный параметр,<br/>мгновенное удаление<br/>можно использовать перед удалением |
| reason | string | Опциональный параметр,<br/>причина удаления<br/>можно использовать перед удалением |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_virtual_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_virtual_image**:
```terraform
resource "decort_virtual_image" "my_image" {
name = "test_vi_im_new_rename"
target_id = 6125
#link_to = 6062
#account_id = 57252
#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` будут сохранены возвращаемые значения.