12 KiB
12 KiB
Функция доступна в провайдере версии 4.6.0 и выше.
Resource функция decort_cb_image_from_blank_compute служит для управления образом, созданным из пустого компьюта.
Аргументы
Resource функция decort_cb_image_from_blank_compute для создания образа принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|---|---|---|---|
| compute_id | int | ✔️ | ID ВМ, которая была создана как blank |
| name | string | ✔️ | Имя образа При изменении - изменяет название образа |
| boot_type | string | ✔️ | Тип загрузки образа, возможные варианты: "bios" или "uefi" |
| image_type | string | ✔️ | Тип образа, возможные варианты - "linux", "windows" |
| account_id | int | ❌ | ID аккаунта владельца образа |
| username | string | ❌ | Имя пользователя |
| password | string | ❌ | Пароль пользователя |
| sep_id | int | ❌ | ID storage endpoint |
| pool_name | string | ❌ | Пул для создания образа |
| hot_resize | bool | ❌ | Использует ли машина горячее изменение размера образа |
| async_mode | bool | ❌ | Синхронное создание образа, используется при создании. Значение по умолчанию: false. |
| permanently | bool | ❌ | Мгновенное удаление можно использовать перед удалением |
| bootable | bool | ❌ | Фильтр загрузочных образов |
| enabled | bool | ❌ | Доступность образа, используется при редактировании ресурса |
| computeci_id | int | ❌ | Установка computeci, используется на уже созданном ресурсе, чтобы сбросить, необходимо передать 0 |
| enabled_stacks | []int | ❌ | Доступные стаки, используется на уже созданном ресурсе для удаления всех доступных стаков, необходимо передать пустой массив |
| shared_with | []int | ❌ | Настройка доступа образа аккаунтам используется на уже созданном ресурсе, пустой массив - удаление всех доступов, если они были |
| reason | string | ❌ | Причина удаления можно использовать перед удалением |
| accounts | []int | ❌ | Список аккаунтов, которым будет предоставлен доступ к образу |
| network_interface_naming | string | ❌ | Наименование сетевого интерфейса для вашего компьютера с Linux, eth - встроенный, ens - pci слот |
Возвращаемые значения
В случае успешного выполнения resource функция decort_cb_image_from_blank_compute возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
|---|---|---|
| account_id | int | accountId привязки образа |
| acl | []Struct см. ниже | Cписок Acces Control |
| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE |
| boot_type | string | Тип запуска ОС - bios или uefi |
| bootable | bool | Является ли образ загрузочным |
| compute_ci_id | int | ID вычислительного ресурса |
| cd_presented_to | string | Подключение образа |
| deleted_time | int | Время удаления ресурса |
| 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 | Привязка к образу, используется в виртуальных образах |
| milestones | int | Вехи |
| name | string | Название образа |
| network_interface_naming | string | Название сетевого интерфейса |
| permanently | bool | Удаление образа: мгновенное или нет |
| pool_name | string | Пул, в котором был создан образ |
| provider_name | string | Наименование провайдера |
| purge_attempts | int | Попытки |
| present_to | []int | Список ID ресурсов для который предоставлен образ |
| reference_id | string | ID референса |
| res_id | string | ID ресурса |
| res_name | string | Название ресурса |
| rescuecd | bool | cd или нет |
| sep_id | int | storage endpoint provider ID |
| shared_with | []int | Список ресурсов, имеющих доступ к образу |
| size | int | Размер образа |
| status | string | Статус образа |
| tech_status | string | Технический статус |
| unc_path | string | unc path |
| url | string | Адрес, которого осуществлялась загрузка образа |
| version | string | Версия |
Описание структуры acl
| Параметр | Тип | Описание |
|---|---|---|
| explicit | bool | Явно ли указан доступ |
| guid | string | guid Ресурса |
| right | string | Права на ресурс |
| status | string | Статус ресурса |
| type | string | Тип ресурса |
| user_group_id | string | ID user group |
Пример использования
Пример вызова resource функции decort_cb_image_from_blank_compute:
resource "decort_cb_image_from_blank_compute" "my_image" {
#id виртуальной машины, созданной как blank
#используется для создания образа
#обязательный параметр
#тип - целое число
compute_id = 1234
#имя образа
#используется для обновления и создания образа
#обязательный параметр
#тип - строка
#при изменении - изменяет название созданного образа
name = "test_image_rename"
#тип загрузки образа
#используется для создания образа
#обязательный параметр
#тип - строка
#возможные варианты: "bios" или "uefi"
boot_type = "bios"
#тип образа
#используется для создания образа
#обязательный параметр
#тип - строка
#возможные варианты - "linux", "windows"
image_type = "linux"
#имя пользователя для образа
#используется для обновления и создания образа
#опциональный параметр
#тип - строка
#username = "userx"
#пароль для образа
#используется для обновления и создания образа
#опциональный параметр
#тип - строка
#password = "passx"
#ID аккаунта
#используется для обновления и создания образа
#опциональный параметр
#тип - целое число
#account_id = 138
#sep id
#используется для создания образа
#опциональный параметр
#тип - целое число
#sep_id = 1
#название pool
#используется для создания образа
#опциональный параметр
#тип - строка
#pool_name = "pool"
#поддержка hot resize
#используется для обновления и создания образа
#опциональный параметр
#тип - булев
#hot_resize = true
#флаг для создания образа в асинхронном режиме
#опциональный параметр
#по умолчанию - false
#тип - булев
#async_mode = true
#доступность образа
#опциональный параметр, используется на уже созданном ресурсе
#тип - булев
#enabled = true
#является ли образ загрузочным
#опциональный параметр, используется на уже созданном ресурсе
#тип - булев
#bootable = true
#настройка доступа образа аккаунтам
#опциональный параметр, используется на уже созданном ресурсе
#тип - массив целых чисел
#пустой массив - удаление всех доступов, если они были
#shared_with = [28096, 57121]
#установка computeci
#опциональный параметр, используется на уже созданном ресурсе
#тип - целое число
#чтобы сбросить, необходимо передать 0
#computeci_id = 1
#доступные стаки
#опциональный параметр, используется на уже созданном ресурсе
#тип - массив целых чисел
#для удаления всех доступных стаков, необходимо передать пустой массив
#enabled_stacks = [9]
#аккаунты, которым предоставляется доступ к образу
#Используется для обновления и создания образа
#опциональный параметр
#тип - массив целых чисел
#для удаления всех доступных аккаунтов, необходимо передать пустой массив
#accounts = [9, 5]
#мгновенное удаление
#опциональный параметр, можно использовать перед удалением
#тип - булев
#permanently = true
#причина удаления
#опциональный параметр, можно использовать перед удалением
#тип - строка
#reason = "test"
#наименование сетевого интерфейса для вашего компьютера с Linux, eth - встроенный, ens - pci слот
#используется для обновления образа
#опциональный параметр
#тип - строка
#network_interface_naming = "ens"
}
После успешного завершения такого вызова decort_cb_image_from_blank_compute в переменной decort_cb_image_from_blank_compute.my_image будут сохранены возвращаемые значения.