Create resource decort_image, add a description
stSolo
194
07.7-Resource-функция-decort_image:-управление-образом..md
Normal file
194
07.7-Resource-функция-decort_image:-управление-образом..md
Normal file
@@ -0,0 +1,194 @@
|
||||
**Внимание:** необходимы права администратора.
|
||||
|
||||
_Resource_ функция **decort_image** служит для управления образом.
|
||||
|
||||
## Аргументы
|
||||
_Resource_ функция **decort_image** для создания образа принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| name | string | Обязательный параметр, имя образа<br/>При изменении - изменяет название образа|
|
||||
| url | string | Обязательный параметр, адрес образа |
|
||||
| gid | int | Обязательный параметр, grid id образа |
|
||||
| boot_type | string | Обязательный параметр, тип загрузки образа,<br/>возможные варианты: "bios" или "uefi"|
|
||||
| image_type | string | Обязательный параметр, тип образа,<br />возможные варианты - "linux", "windows"|
|
||||
| drivers | []string | Обязательный параметр, драйвера,<br/>возможные варианты - ["KVM_X86", "SVA_KVM_X86"], ["KVM_X86"], ["SVA_KVM_X86"] |
|
||||
| account_id | int | Опциональный параметр,<br/>id аккаунта владельца образа,<br/>может быть использован как при создании, так и редактировании образа |
|
||||
| username | string | Опциональный параметр, имя пользователя,<br/>может быть использован как при создании, так и редактировании образа |
|
||||
| password | string | Опциональный параметр, пароль пользователя,<br/>может быть использован как при создании, так и редактировании образа |
|
||||
| username_dl | string | Опциональный параметр,<br/>имя пользователя для загрузки бинарных данных,<br/>может быть использован как при создании, так и редактировании образа |
|
||||
| password_dl | string | Опциональный параметр,<br/>пароль пользователя для загрузки бинарных данных,<br/>может быть использован как при создании, так и редактировании образа |
|
||||
| sep_id | int | Опциональный параметр, id storage endpoint |
|
||||
| pool_name | string | Опциональный параметр, пул для создания образа |
|
||||
| architecture | string | Опциональный параметр, используется при создании, <br/>архитектура системы образа<br/>доступные значения: "X86_64"<br/>по-умолчанию "X86_64" |
|
||||
| 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_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 = "https://colba.decs.online/index.php/s/G3H7AREngzeKGw2/download"
|
||||
|
||||
#grid id образа
|
||||
#обязательный параметр
|
||||
#тип - число
|
||||
gid = 212
|
||||
|
||||
#тип загрузки образа
|
||||
#обязательный параметр
|
||||
#тип - строка
|
||||
#возможные варианты: "bios" или "uefi"
|
||||
boot_type = "bios"
|
||||
|
||||
#тип образа
|
||||
#обязательный параметр
|
||||
#тип - строка
|
||||
#возможные варианты - "linux", "windows"
|
||||
image_type = "linux"
|
||||
|
||||
#драйвера
|
||||
#обязательный параметр
|
||||
#тип - массив строк
|
||||
#возможные варианты - ["KVM_X86", "SVA_KVM_X86"], ["KVM_X86"], ["SVA_KVM_X86"]
|
||||
drivers = ["KVM_X86", "SVA_KVM_X86"]
|
||||
|
||||
#id аккаунта владельца образа
|
||||
#опциональный параметр
|
||||
#может быть использован как при создании,
|
||||
#так и при редактировании образа
|
||||
#тип данных - число
|
||||
#account_id = 57252
|
||||
|
||||
#имя пользователя и пароль
|
||||
#опциональные параметры,
|
||||
#могут быть использованы как при создании образа,
|
||||
#так и при его редактировании
|
||||
#тип - строка
|
||||
#username = "Valera"
|
||||
#password = "123"
|
||||
|
||||
#имя пользователя и пароль для загрузки бинарных данных
|
||||
#опциональные параметры,
|
||||
#могут быть использованы как при создании образа,
|
||||
#так и при его редактировании
|
||||
#тип - строка
|
||||
#username_dl = "Valera1"
|
||||
#password_dl = "1231"
|
||||
|
||||
#id storage endpoint
|
||||
#опциональный параметр, используется при создании
|
||||
#тип - число
|
||||
#sep_id = 1206
|
||||
|
||||
#пул для создания образа
|
||||
#опциональный тип, используется при создании образа
|
||||
#тип - строка
|
||||
#pool_name = "vmstor"
|
||||
|
||||
#архитектура системы образа
|
||||
#опциаональный параметр, используется при создании
|
||||
#тип - строка
|
||||
#доступные значения: "X86_64"
|
||||
#architecture = "X86_64"
|
||||
|
||||
#доступность образа
|
||||
#опциональный параметр, используется на уже созданном ресурсе
|
||||
#тип - булево значение
|
||||
#enabled = true
|
||||
|
||||
#настройка доступа образа аккаунтам
|
||||
#опциональный параметр, используется на уже созданном ресурсе
|
||||
#тип - массив чисел
|
||||
#пустой массив - удаление всех доступов, если они были
|
||||
#shared_with = [28096, 57121]
|
||||
|
||||
#установка computeci
|
||||
#опциональный параметр, используется на уже созданном ресурсе
|
||||
#тип - число
|
||||
#чтобы сбросить, необходимо передать 0
|
||||
#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` будут сохранены возвращаемые значения.
|
||||
Reference in New Issue
Block a user