From 4a06ace898a29734f2180f509596405f6242650f Mon Sep 17 00:00:00 2001 From: loskutovanl Date: Fri, 24 Nov 2023 15:29:15 +0300 Subject: [PATCH] update image resources --- ...правление-cdrom-образом.md | 119 +++++++++++++++++ ...правление-cdrom-образом.md | 104 --------------- ...-виртуальным-образом.md | 108 +++++++++++++++ ...-виртуальным-образом.md | 89 ------------- ...age-управление-образом.md | 126 ++++++++++-------- Home.md | 6 +- 6 files changed, 300 insertions(+), 252 deletions(-) create mode 100644 07.02.04-Resource-функция-decort_cb_cdrom_image-управление-cdrom-образом.md delete mode 100644 07.02.04-Resource-функция-decort_cdrom_image-управление-cdrom-образом.md create mode 100644 07.02.07-Resource-функция-decort_cb_virtual_image-управление-виртуальным-образом.md delete mode 100644 07.02.07-Resource-функция-decort_virtual_image-управление-виртуальным-образом.md rename 07.02.08-Resource-функция-decort_image-управление-образом.md => 07.02.08-Resource-функция-decort_cb_image-управление-образом.md (50%) diff --git a/07.02.04-Resource-функция-decort_cb_cdrom_image-управление-cdrom-образом.md b/07.02.04-Resource-функция-decort_cb_cdrom_image-управление-cdrom-образом.md new file mode 100644 index 0000000..781a18c --- /dev/null +++ b/07.02.04-Resource-функция-decort_cb_cdrom_image-управление-cdrom-образом.md @@ -0,0 +1,119 @@ +Функция доступна в провайдере версии 2.0 и выше. + +_Resource_ функция **decort_cb_cdrom_image** служит для управления cdrom - образом. + +## Аргументы + +_Resource_ функция **decort_cb_cdrom_image** для создания cdrom - образа принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| -------------- |----------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| name | string | :heavy_check_mark: | Имя образа
При изменении - изменяет название образа | +| url | string | :heavy_check_mark: | Адрес образа | +| gid | int | :heavy_check_mark: | Grid id образа | +| drivers | []string | :heavy_check_mark: | Драйвера,
возможные варианты - ["KVM_X86", "SVA_KVM_X86"], ["KVM_X86"], ["SVA_KVM_X86"] | +| hot_resize | bool | :x: | Использует ли машина горячее изменение размера образа | +| account_id | int | :x: | ID аккаунта владельца образа,
может быть использован как при создании, так и редактировании образа | +| username_dl | string | :x: | Имя пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | +| password_dl | string | :x: | Пароль пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | +| sep_id | int | :x: | ID storage endpoint | +| pool_name | string | :x: | Пул для создания образа | +| architecture | string | :x: | Используется при создании,
архитектура системы образа
доступные значения: "X86_64"
по-умолчанию "X86_64" | +| permanently | bool | :x: | Мгновенное удаление
можно использовать перед удалением | +| bootable | bool | :x: | Является ли образ загрузочным | +| enabled | bool | :x: | Доступность образа,
используется при редактировании ресурса | +| computeci_id | int | :x: | Установка computeci,
используется на уже созданном ресурсе,
чтобы сбросить, необходимо передать 0 | +| shared_with | []int | :x: | Настройка доступа образа аккаунтам
используется на уже созданном ресурсе,
пустой маасив - удаление всех доступов, если они были | +| enabled_stacks | []int | :x: | Доступные стаки,
используется на уже созданном ресурсе
для удаления всех доступных стаков, необходимо передать пустой массив | + +## Возвращаемые значения + +В случае успешного выполнения _resource_ функция **decort_cb_cdrom_image** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +| --- |-----------------------------------------------|----------------------------------------------------------| +| unc_path | string | unc path | +| ckey | string | CKey | +| meta | []string | Мета информация об образе | +| account_id | int | accountId привязки образа | +| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control | +| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE | +| boot_type | string | Тип запуска ОС - bios или uefi | +| bootable | bool | Является ли образ загрузочным | +| drivers | []string | Список используемых драйверов | +| enabled | bool | Доступность образа | +| gid | int | ID платформы, где образ будет создан | +| guid | int | Внутренний id образа, совпадает с image_id | +| history | object{id: int, guid: string, timestamp: int} | История обновлений образа | +| hot_resize | bool | Использует ли машина горячее изменение размера образа | +| image_id | int | ID образа | +| link_to | int | Привязка к образу, используется в виртуальных образах | +| milestones | int | Вехи | +| name | string | Название образа | +| password | string | Пароль для образа | +| pool_name | string | Пул, в котором был создан образ | +| provider_name | string | Наименование провайдера | +| purge_attempts | int | Попытки | +| reference_id | string | ID ссылки | +| res_id | string | ID ресурса | +| res_name | string | Наименование ресурса | +| rescuecd | bool | CD или нет | +| last_modified | int | Дата последнего изменения | +| deleted_time | int | Время удаления | +| desc | string | Описание образа | +| present_to | []int | Список ID ресурсов для который предоставлен образ | +| sep_id | int | storage endpoint provider ID | +| shared_with | []int | Список ресурсов, имеющих доступ к образу | +| size | int | Размер образа | +| status | string | Статус образа | +| tech_status | string | Технический статус | +| 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_cdrom_image**: + +```terraform +resource "decort_cb_cdrom_image" "my_image" { + name = "test_image_rename" + url = "" + gid = 212 + drivers = ["KVM_X86", "SVA_KVM_X86"] + + #hot_resize = true + #account_id = 57252 + + #username_dl = "Valera1" + #password_dl = "1231" + + #sep_id = 1206 + #pool_name = "vmstor" + + #architecture = "X86_64" + #enabled = true + #shared_with = [28096, 57121] + + #computeci_id = 1 + #enabled_stacks = [9] + #bootable = true + #permanently = true +} + +# once the above directive completes, cdrom image will be accessible +# as decort_cb_cdrom_image.my_image +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова **decort_cb_cdrom_image** в переменной `decort_cb_cdrom_image.my_image` будут сохранены возвращаемые значения. diff --git a/07.02.04-Resource-функция-decort_cdrom_image-управление-cdrom-образом.md b/07.02.04-Resource-функция-decort_cdrom_image-управление-cdrom-образом.md deleted file mode 100644 index 15e4b1e..0000000 --- a/07.02.04-Resource-функция-decort_cdrom_image-управление-cdrom-образом.md +++ /dev/null @@ -1,104 +0,0 @@ -Функция доступна в провайдере версии 2.0 и выше. - -_Resource_ функция **decort_cdrom_image** служит для управления cdrom - образом. - -## Аргументы - -_Resource_ функция **decort_cdrom_image** для создания cdrom - образа принимает следующие аргументы: - -| Аргумент | Тип | Обязательный | Описание | -| -------------- | -------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | -| name | string | :heavy_check_mark: | Имя образа
При изменении - изменяет название образа | -| url | string | :heavy_check_mark: | Адрес образа | -| gid | int | :heavy_check_mark: | Grid id образа | -| drivers | []string | :heavy_check_mark: | Драйвера,
возможные варианты - ["KVM_X86", "SVA_KVM_X86"], ["KVM_X86"], ["SVA_KVM_X86"] | -| account_id | int | :x: | ID аккаунта владельца образа,
может быть использован как при создании, так и редактировании образа | -| username | string | :x: | Имя пользователя,
может быть использован как при создании, так и редактировании образа | -| password | string | :x: | Пароль пользователя,
может быть использован как при создании, так и редактировании образа | -| username_dl | string | :x: | Имя пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | -| password_dl | string | :x: | Пароль пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | -| sep_id | int | :x: | ID storage endpoint | -| pool_name | string | :x: | Пул для создания образа | -| architecture | string | :x: | Используется при создании,
архитектура системы образа
доступные значения: "X86_64"
по-умолчанию "X86_64" | -| enabled | bool | :x: | Доступность образа,
используется при редактировании ресурса | -| shared_with | []int | :x: | Настройка доступа образа аккаунтам
используется на уже созданном ресурсе,
пустой маасив - удаление всех доступов, если они были | -| computeci_id | int | :x: | Установка computeci,
используется на уже созданном ресурсе,
чтобы сбросить, необходимо передать 0 | -| enabled_stacks | []string | :x: | Доступные стаки,
используется на уже созданном ресурсе
для удаления всех доступных стаков, необходимо передать пустой массив | -| permanently | bool | :x: | Мгновенное удаление
можно использовать перед удалением | - -## Возвращаемые значения - -В случае успешного выполнения _resource_ функция **decort_cdrom_image** возвращает в указанную при вызове переменную следующие значения: - -| Параметр | Тип | Описание | -| -------------- | ------------------------------------------ | -------------------------------------------------------- | -| account_id | int | accountId привязки образа | -| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE | -| 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_cdrom_image**: - -```terraform -resource "decort_cdrom_image" "my_image" { - name = "test_image_rename" - url = - gid = 212 - drivers = ["KVM_X86", "SVA_KVM_X86"] - #account_id = 57252 - - #username = "Valera" - #password = "123" - #username_dl = "Valera1" - #password_dl = "1231" - #sep_id = 1206 - #pool_name = "vmstor" - #architecture = "X86_64" - #enabled = true - #shared_with = [28096, 57121] - #computeci_id = 1 - #enabled_stacks = ["9"] - #permanently = true - -} - -# once the above directive completes, cdrom image will be accessible -# as decort_cdrom_image.my_image -``` - -Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). - -После успешного завершения такого вызова **decort_cdrom_image** в переменной `decort_cdrom_image.my_image` будут сохранены возвращаемые значения. diff --git a/07.02.07-Resource-функция-decort_cb_virtual_image-управление-виртуальным-образом.md b/07.02.07-Resource-функция-decort_cb_virtual_image-управление-виртуальным-образом.md new file mode 100644 index 0000000..80930a7 --- /dev/null +++ b/07.02.07-Resource-функция-decort_cb_virtual_image-управление-виртуальным-образом.md @@ -0,0 +1,108 @@ +Функция доступна в провайдере версии 2.0 и выше. + +_Resource_ функция **decort_cb_virtual_image** служит для управления виртуальным образом. Виртуальный образа создаются на основе уже созданных ранее образов, таким образом, они привязываются к уже созданным образам. Образ, на основе которого создан виртуальный диск, удалить невозможно - для этого необходимо удалить виртуальный образ, либо связать его с другим образом. + +## Аргументы +_Resource_ функция **decort_cb_virtual_image** для создания виртуального образа принимает следующие аргументы: + +| Аргумент | Тип | Обязательный | Описание | +| --- |--------|------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| name | string | :heavy_check_mark: | Имя виртуального образа | +| link_to | int | :heavy_check_mark: | Используется при редактировании ресурса
изменение связи виртуального образа | +| account_id | int | :x: | ID аккаунта владельца образа
может быть использован при редактировании образа | +| bootable | bool | :x: | Является ли образ загрузочным | +| computeci_id | int | :x: | Установка computeci,
используется на уже созданном ресурсе,
чтобы сбросить, необходимо передать 0 | +| enabled | bool | :x: | Доступность образа,
используется при редактировании ресурса | +| hot_resize | bool | :x: | Использует ли машина горячее изменение размера образа | +| username | string | :x: | Имя пользователя,
может быть использован при редактировании образа | +| password | string | :x: | Пароль пользователя,
может быть использован при редактировании образа | +| shared_with | []int | :x: | Настройка доступа образа аккаунтам
используется на уже созданном ресурсе,
пустой маасив - удаление всех доступов, если они были | +| enabled_stacks | []int | :x: | Доступные стаки,
используется на уже созданном ресурсе
для удаления всех доступных стаков, необходимо передать пустой массив | +| permanently | bool | :x: | Мгновенное удаление
можно использовать перед удалением | +| reason | string | :x: | Причина удаления
можно использовать перед удалением | + +## Возвращаемые значения +В случае успешного выполнения _resource_ функция **decort_cb_virtual_image** возвращает в указанную при вызове переменную следующие значения: + +| Параметр | Тип | Описание | +| --- |-----------------------------------------------|----------------------------------------------------------| +| unc_path | string | unc path | +| ckey | string | CKey | +| meta | []string | Мета информация об образе | +| account_id | int | accountId привязки образа | +| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control | +| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE | +| boot_type | string | Тип запуска ОС - bios или uefi | +| bootable | bool | Является ли образ загрузочным | +| drivers | []string | Список используемых драйверов | +| enabled | bool | Доступность образа | +| gid | int | ID платформы, где образ будет создан | +| guid | int | Внутренний id образа, совпадает с image_id | +| history | object{id: int, guid: string, timestamp: int} | История обновлений образа | +| hot_resize | bool | Использует ли машина горячее изменение размера образа | +| image_id | int | ID образа | +| link_to | int | Привязка к образу, используется в виртуальных образах | +| milestones | int | Вехи | +| name | string | Название образа | +| password | string | Пароль для образа | +| pool_name | string | Пул, в котором был создан образ | +| provider_name | string | Наименование провайдера | +| purge_attempts | int | Попытки | +| reference_id | string | ID ссылки | +| res_id | string | ID ресурса | +| res_name | string | Наименование ресурса | +| rescuecd | bool | CD или нет | +| last_modified | int | Дата последнего изменения | +| deleted_time | int | Время удаления | +| desc | string | Описание образа | +| present_to | []int | Список ID ресурсов для который предоставлен образ | +| sep_id | int | storage endpoint provider ID | +| shared_with | []int | Список ресурсов, имеющих доступ к образу | +| size | int | Размер образа | +| status | string | Статус образа | +| tech_status | string | Технический статус | +| image_type | string | Тип образа: linux, windows или другой | +| url | string | Адрес, которого осуществлялась загрузка образа | +| username | 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_virtual_image**: +```terraform +resource "decort_cb_virtual_image" "my_image" { + name = "test_vi_im_new_rename" + link_to = 6125 + + #account_id = 78765 + #bootable = true + #hot_resize = true + + #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, virtual image will be accessible +# as decort_cb_virtual_image.my_image +``` + +Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). + +После успешного завершения такого вызова **decort_cb_virtual_image** в переменной `decort_cb_virtual_image.my_image` будут сохранены возвращаемые значения. diff --git a/07.02.07-Resource-функция-decort_virtual_image-управление-виртуальным-образом.md b/07.02.07-Resource-функция-decort_virtual_image-управление-виртуальным-образом.md deleted file mode 100644 index 44e3945..0000000 --- a/07.02.07-Resource-функция-decort_virtual_image-управление-виртуальным-образом.md +++ /dev/null @@ -1,89 +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.02.08-Resource-функция-decort_image-управление-образом.md b/07.02.08-Resource-функция-decort_cb_image-управление-образом.md similarity index 50% rename from 07.02.08-Resource-функция-decort_image-управление-образом.md rename to 07.02.08-Resource-функция-decort_cb_image-управление-образом.md index 352fea6..c3cb774 100644 --- a/07.02.08-Resource-функция-decort_image-управление-образом.md +++ b/07.02.08-Resource-функция-decort_cb_image-управление-образом.md @@ -1,94 +1,108 @@ Функция доступна в провайдере версии 2.0 и выше. -_Resource_ функция **decort_image** служит для управления образом. +_Resource_ функция **decort_cb_image** служит для управления образом. ## Аргументы -_Resource_ функция **decort_image** для создания образа принимает следующие аргументы: +_Resource_ функция **decort_cb_image** для создания образа принимает следующие аргументы: | Аргумент | Тип | Обязательный | Описание | -| -------------- | -------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | +| -------------- |----------| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | | name | string | :heavy_check_mark: | Имя образа
При изменении - изменяет название образа | | url | string | :heavy_check_mark: | Адрес образа | | gid | int | :heavy_check_mark: | Grid id образа | | boot_type | string | :heavy_check_mark: | Тип загрузки образа,
возможные варианты: "bios" или "uefi" | | image_type | string | :heavy_check_mark: | Тип образа,
возможные варианты - "linux", "windows" | | drivers | []string | :heavy_check_mark: | Драйвера,
возможные варианты - ["KVM_X86", "SVA_KVM_X86"], ["KVM_X86"], ["SVA_KVM_X86"] | -| account_id | int | :x: | ID аккаунта владельца образа,
может быть использован как при создании, так и редактировании образа | +| hot_resize | bool | :x: | Фильтр образов, разрешающих hot resize | | username | string | :x: | Имя пользователя,
может быть использован как при создании, так и редактировании образа | | password | string | :x: | Пароль пользователя,
может быть использован как при создании, так и редактировании образа | +| account_id | int | :x: | ID аккаунта владельца образа,
может быть использован как при создании, так и редактировании образа | | username_dl | string | :x: | Имя пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | | password_dl | string | :x: | Пароль пользователя для загрузки бинарных данных,
может быть использован как при создании, так и редактировании образа | -| sync | bool | :x: | Синхронное создание образа, используется при создании | | sep_id | int | :x: | ID storage endpoint | | pool_name | string | :x: | Пул для создания образа | | architecture | string | :x: | Используется при создании,
архитектура системы образа
доступные значения: "X86_64"
по-умолчанию "X86_64" | +| permanently | bool | :x: | Мгновенное удаление
можно использовать перед удалением | +| bootable | bool | :x: | Фильтр загрузочных образов | | enabled | bool | :x: | Доступность образа,
используется при редактировании ресурса | -| shared_with | []int | :x: | Настройка доступа образа аккаунтам
используется на уже созданном ресурсе,
пустой маасив - удаление всех доступов, если они были | | computeci_id | int | :x: | Установка computeci,
используется на уже созданном ресурсе,
чтобы сбросить, необходимо передать 0 | -| enabled_stacks | []string | :x: | Доступные стаки,
используется на уже созданном ресурсе
для удаления всех доступных стаков, необходимо передать пустой массив | -| permanently | bool | :x: | Мгновенное удаление
можно использовать перед удалением | +| sync_mode | bool | :x: | Синхронное создание образа, используется при создании | +| enabled_stacks | []int | :x: | Доступные стаки,
используется на уже созданном ресурсе
для удаления всех доступных стаков, необходимо передать пустой массив | +| shared_with | []int | :x: | Настройка доступа образа аккаунтам
используется на уже созданном ресурсе,
пустой маасив - удаление всех доступов, если они были | | reason | string | :x: | Причина удаления
можно использовать перед удалением | ## Возвращаемые значения -В случае успешного выполнения _resource_ функция **decort_image** возвращает в указанную при вызове переменную следующие значения: +В случае успешного выполнения _resource_ функция **decort_cb_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 или другой | +| Параметр | Тип | Описание | +| --- |-----------------------------------------------|----------------------------------------------------------| +| ckey | string | CKey | +| meta | []string | Мета информация об образе | +| account_id | int | accountId привязки образа | +| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control | +| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE | +| boot_type | string | Тип запуска ОС - bios или uefi | +| bootable | bool | Является ли образ загрузочным | +| drivers | []string | Список используемых драйверов | +| enabled | bool | Доступность образа | +| gid | int | ID платформы, где образ будет создан | +| guid | int | Внутренний id образа, совпадает с image_id | +| history | object{id: int, guid: string, timestamp: int} | История обновлений образа | +| hot_resize | bool | Использует ли машина горячее изменение размера образа | +| image_id | int | ID образа | +| link_to | int | Привязка к образу, используется в виртуальных образах | +| milestones | int | Вехи | +| name | string | Название образа | +| password | string | Пароль для образа | +| pool_name | string | Пул, в котором был создан образ | +| provider_name | string | Наименование провайдера | +| purge_attempts | int | Попытки | +| reference_id | string | ID ссылки | +| res_id | string | ID ресурса | +| res_name | string | Наименование ресурса | +| rescuecd | bool | CD или нет | | 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 | Технический статус | +| deleted_time | int | Время удаления | +| desc | string | Описание образа | +| present_to | []int | Список ID ресурсов для который предоставлен образ | +| sep_id | int | storage endpoint provider ID | +| shared_with | []int | Список ресурсов, имеющих доступ к образу | +| size | int | Размер образа | +| status | string | Статус образа | +| tech_status | string | Технический статус | +| image_type | string | Тип образа: linux, windows или другой | +| url | string | Адрес, которого осуществлялась загрузка образа | +| username | string | Имя пользователя образа | +| version | string | Версия | | unc_path | string | unc path | -| url | string | Адрес, которого осуществлялась загрузка образа | -| username | string | Имя пользователя образа | -| username_dl | string | Имя пользователя для загрузки двоичных файлов | -| version | string | Версия | + +### Описание структуры acl +| Параметр | Тип | Описание | +| --- | --- | --- | +| explicit | bool | Явно ли указан доступ | +| guid | string | guid Ресурса | +| right | string | Права на ресурс | +| status | string | Статус ресурса | +| type | string | Тип ресурса | +| user_group_id | string | ID user group | ## Пример использования -Пример вызова _resource_ функции **decort_image**: +Пример вызова _resource_ функции **decort_cb_image**: ```terraform -resource "decort_image" "my_image" { +resource "decort_cb_image" "my_image" { name = "test_image_rename" - url = + url = "" gid = 212 boot_type = "bios" image_type = "linux" drivers = ["KVM_X86", "SVA_KVM_X86"] + #hot_resize = true #account_id = 5725 - #username = "Valera" #password = "123" #username_dl = "Valera1" #password_dl = "1231" @@ -96,18 +110,18 @@ resource "decort_image" "my_image" { #pool_name = "vmstor" #architecture = "X86_64" #enabled = true + #bootable = true + #sync_mode = true #shared_with = [28096, 57121] #computeci_id = 1 - #enabled_stacks = ["9"] + #enabled_stacks = [9] #permanently = true #reason = "test" - } - -# once the above directive completes, will be accessible -# as decort_image.my_image +# once the above directive completes, image id will be accessible +# as decort_cb_image.my_image.image_id ``` Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)). -После успешного завершения такого вызова **decort_image** в переменной `decort_image.my_image` будут сохранены возвращаемые значения. +После успешного завершения такого вызова **decort_cb_image** в переменной `decort_cb_image.my_image` будут сохранены возвращаемые значения. diff --git a/Home.md b/Home.md index f6bd8ff..66d6d81 100644 --- a/Home.md +++ b/Home.md @@ -222,9 +222,9 @@ Terraform провайдер для платформы DECORT с API верси - [**decort_cb_vins**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.12-Resource-функция-decort_cb_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 кластера - - [**decort_virtual_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.07-Resource-функция-decort_virtual_image-управление-виртуальным-образом) - управление виртуальным образом - - [**decort_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.08-Resource-функция-decort_image-управление-образом) - управление образом - - [**decort_cdrom_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.04-Resource-функция-decort_cdrom_image-управление-cdrom-образом) - управление cdrom образом + - [**decort_cb_virtual_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.07-Resource-функция-decort_cb_virtual_image-управление-виртуальным-образом) - управление виртуальным образом + - [**decort_cb_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.08-Resource-функция-decort_cb_image-управление-образом) - управление образом + - [**decort_cb_cdrom_image**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.04-Resource-функция-decort_cb_cdrom_image-управление-cdrom-образом) - управление cdrom образом - [**decort_delete_images**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.05-Resource-функция-decort_delete_images-удаление-нескольких-образов) - удаление образов - [**decort_cb_sep**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.03-Resource-функция-decort_cb_sep-управление-sep) - управление sep - [**decort_cb_sep_config**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.02.02-Resource-функция-decort_cb_sep_config-управление-конфигурацией-sep) - управление конфигурацией sep