Updated 06.6 Data функция decort_image: получение информации об образах. (markdown)

stSolo
2022-03-28 12:23:41 +03:00
parent 75ecdfab20
commit fabe720be4

@@ -9,33 +9,63 @@ _Data source_ функция **decort_image** принимает следующ
| Аргумент | Тип | Описание |
| --- | --- | --- |
| name | string | Имя образа, информацию по которому требуется получить.<br>Данный аргумент является обязательным.<br>Обратите внимание, что имя образа задается в точном соответствии с тем, как оно определено в облачной платформе, с соблюдением заглавных букв и пробелов. |
| account_id | int| Идентификатор подписчика (aka "account"), в пределах которой следует ограничить поиск и получение характеристик образа с именем `name`.<br>Данный аргумент является необязательным - не задавайте его, если не хотите ограничивать контекст поиска образа. |
| image_id | int | id образа, информацию по которому требуется получить.<br>Данный аргумент является обязательным. |
Образы в облачной платформе DECORT могут создаваться с ограниченным доступом - только для указанных подписчиков ("accounts"). Для уточнения контекста поиска образа помимо обязательного имени образа `name` можно дополнительно задавать `account_id`.
ID необходимо образа можно взять вызвав [decort_image](link here)
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_image** возвращает в указанную при вызове переменную следующие значения:
| Параметр | Тип | Описание |
| --- | --- | --- |
| arch | string | Аппаратная архитектура, для которой подготовлен данный образ.<br>Т.к. образ содержит бинарные данные, то важно понимать его совместимость с тем или иным типом _compute_. Данный параметр позволяет проверять эту совместимость. |
| id | int | Уникальный ненулевой идентификатор образа. |
| name | string | Имя образа. |
| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный образ. |
| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный образ. |
| size | int | Размер образа в ГБ. |
| 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 | версия
## Пример использования
Пример вызова _data source_ функции **decs_image**:
```
data "decort_image" "ubuntu_img" {
name = "Ubuntu 20.01 v1.2.3"
data "decort_image" "my_img" {
image_id = 1234
}
# once the above directive completes, image ID will be accessible
# as data.decort_image.ubuntu_img.id
# as data.decort_image.my_img.id
```
Данный пример подразумевает, что ранее по тексту 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** в переменной `data.decort_image.ubuntu_img` будут сохранены возвращаемые значения. В частности, для получения идентификатора образа следует использовать конструкцию `data.decort_image.ubuntu_img.id`
После успешного завершения такого вызова **decort_image** в переменной `data.decort_image.my_img` будут сохранены возвращаемые значения. В частности, для получения идентификатора образа следует использовать конструкцию `data.decort_image.my_img.id`