diff --git a/07.01.08-Resource-функция-decort_virtual_image-управление-виртуальным-образом.md b/07.01.08-Resource-функция-decort_virtual_image-управление-виртуальным-образом.md deleted file mode 100644 index 1e2096f..0000000 --- a/07.01.08-Resource-функция-decort_virtual_image-управление-виртуальным-образом.md +++ /dev/null @@ -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: | Используется при редактировании ресурса
изменение связи виртуального образа | -| account_id | int | :x: | ID аккаунта владельца образа
может быть использован при редактировании образа| -| username | string | :x: | Имя пользователя,
может быть использован при редактировании образа | -| password | string | :x: | Пароль пользователя,
может быть использован при редактировании образа | -| enabled | bool | :x: | Доступность образа,
используется при редактировании ресурса | -| shared_with | []int | :x: | Настройка доступа образа аккаунтам
используется на уже созданном ресурсе,
пустой маасив - удаление всех доступов, если они были | -| computeci_id | int | :x: | Установка computeci,
используется на уже созданном ресурсе,
чтобы сбросить, необходимо передать 0 | -| enabled_stacks | []string | :x: | Доступные стаки,
используется на уже созданном ресурсе
для удаления всех доступных стаков, необходимо передать пустой массив | -| permanently | bool | :x: | Мгновенное удаление
можно использовать перед удалением | -| reason | string | :x: | Причина удаления
можно использовать перед удалением | - - -## Возвращаемые значения -В случае успешного выполнения _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://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). - -После успешного завершения такого вызова **decort_virtual_image** в переменной `decort_virtual_image.my_image` будут сохранены возвращаемые значения. diff --git a/07.01.08-Resource-функция-decortl_image_virtual-управление-виртуальным-образом.md b/07.01.08-Resource-функция-decortl_image_virtual-управление-виртуальным-образом.md new file mode 100644 index 0000000..7ead289 --- /dev/null +++ b/07.01.08-Resource-функция-decortl_image_virtual-управление-виртуальным-образом.md @@ -0,0 +1,87 @@ +Функция доступна в провайдере версии 4.4.1 и выше. + +**Внимание:** необходимы права администратора. + +_Resource_ функция **decort_image_virtual** служит для управления виртуальным образом. Виртуальный образа создаются на основе уже созданных ранее образов, таким образом, они привязываются к уже созданным образам. Образ, на основе которого создан виртуальный диск, удалить невозможно - для этого необходимо удалить виртуальный образ, либо связать его с другим образом. + +## Аргументы +_Resource_ функция **decort_image_virtual** для создания виртуального образа принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +|-------------|--------|--------------------|-------------------------------------------------------------| +| name | string | :heavy_check_mark: | Имя виртуального образа | +| link_to | int | :heavy_check_mark: | ID реального образа, на который будет ссылаться виртуальный | +| permanently | bool | :x: | Флаг для удаления диска | + + +## Возвращаемые значения +В случае успешного выполнения _resource_ функция **decort_image_virtual** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +|----------------|--------------------------------------------|----------------------------------------------------------| +| unc_path | string | unc path | +| ckey | string | ckey | +| account_id | int | accountId привязки образа | +| acl | string | access control list | +| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE | +| boot_type | string | Тип запуска ОС - bios или uefi | +| bootable | bool | Является ли образ загрузочным | +| compute_ci_id | int | ID вычислительного ресурса | +| deleted_time | int | Время удаления | +| 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 | Использует ли машина горячее изменение размера образа | +| last_modified | int | Дата последнего изменения | +| link_to | int | Привязка к образу, используется в виртуальных образах | +| milestones | int | Вехи | +| image_name | string | Название образа | +| password | string | Пароль для образа | +| pool_name | string | Пул, в котором был создан образ | +| provider_name | string | Наименование провайдера | +| purge_attempts | int | Попытки | +| present_to | []int | Список ID ресурсов, которым предоставлен образ | +| res_id | string | ID ресурса | +| rescuecd | bool | CD или нет | +| sep_id | int | storage endpoint provider ID | +| shared_with | bool | Список ресурсов, имеющих доступ к образу | +| size | int | Размер образа | +| status | string | Статус образа | +| tech_status | string | Технический статус | +| type | string | Тип образа: linux, windows или другой | +| username | string | Имя пользователя образа | +| version | string | Версия | + + +## Пример использования +Пример вызова _resource_ функции **decort_image_virtual**: +```terraform +resource "decort_image_virtual" "my_image" { + #имя виртуального образа + #обязательный параметр + #при изменении - обновляет имя виртуального образа + #тип - строка + name = "iv-name" + + #ID реального образа, на который будет ссылаться виртуальный + #обязательный параметр + #при изменении - ссылается на другой реальный образ + #тип - число + link_to = 123 + + #Флаг для удаления диска + #опциональный параметр + #тип - bool + #permanently = false +} + +# once the above directive completes, will be accessible +# as decort_image_virtual.my_image +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова **decort_image_virtual** в переменной `decort_image_virtual.my_image` будут сохранены возвращаемые значения. diff --git a/Home.md b/Home.md index 20c76f7..b6db651 100644 --- a/Home.md +++ b/Home.md @@ -153,7 +153,7 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_k8s**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.06-Resource-функция-decort_k8s-управление-кластером-kubernetes) - управление кластером - [**decort_k8s_cp**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.21-Resource-функция-decort_k8s_cp-управление-control-plane-кластера) - управление control plane - [**decort_k8s_wg**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.07-Resource-функция-decort_k8s_wg-управление-worker-groups-кластера) - управление worker group кластера - - [**decort_virtual_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.08-Resource-функция-decort_virtual_image-управление-виртуальным-образом) - управление виртуальным образом + - [**decort_image_virtual**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.08-Resource-функция-decort_image_virtual-управление-виртуальным-образом) - управление виртуальным образом - [**decort_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.09-Resource-функция-decort_image-управление-образом) - управление образом - [**decort_pfw**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.10-Resource-функция-decort_pfw-управление-правилами-трансляции-сетевых-портов-для-виртуальных-серверов) - управление правилами трансляции сетевых портов для виртуальных серверов. - [**decort_account**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.01.11-Resource-функция-decort_account-управление-аккаунтом) - управление аккаунтом