diff --git a/XX.-Модуль-decort_osimage.md b/XX.-Модуль-decort_osimage.md index 734b392..9b22530 100644 --- a/XX.-Модуль-decort_osimage.md +++ b/XX.-Модуль-decort_osimage.md @@ -1,11 +1,12 @@ # Модуль decort_osimage + ## XX.1 Обзор модуля _decort_osimage_ -Модуль _decort_osimage_ предназначен для -1. text. -2. text: - - text. - - text. -3. text. + +Модуль _decort_osimage_ предназначен для получения информации об образе ОС (в первую очередь, его цифрового идентификатора) по имени образа. + +Данный модуль может быть полезен при массовом создании экземпляров _compute_ (напр., виртуальных серверов) на базе одного и того же образа, так как позволяет оптимизировать количество API вызовов, инициируемых в адрес контроллера облачной платформы. + +По сути, данный модуль является провайдером информации и не изменяет состояния облачных ресурсов (всегда возвращает `changed: False`). ## XX.2 Параметры модуля _decort_osimage_ Ниже в алфавитном порядке приведен полный список параметров для модуля _decort_osimage_. Актуальную информацию по параметрам, которые поддерживает версия модуля, установленного на вашем Ansible-сервере, можно получить командой: @@ -20,7 +21,6 @@ | controller_url | (string) | URL контроллера, соответствующего экземпляру облачной платформы DECORT, в рамках которого должен быть создан (или уже существует) данный виртуальный сервер.
Данный параметр является обязательным. | | jwt | (string) | JSON Web Token (JWT), который будет использоваться для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: jwt`
Данный параметр является обязательным для указанного режима.
Так как он содержит потенциально секретную информацию, а сам JWT, как правило, имеет ограниченное время жизни, то его не рекомендуется задавать непосредственно в _playbook_.
Если этот параметр не определен в _playbook_, то модуль будет использовать значение переменной окружения _DECS_JWT_. | | oauth2_url | (string) | URL авторизационного сервера, работающего по протоколу _Oauth2_, который должен использоваться в режиме `authenticator: oauth2`.
Данный параметр является обязательным для указанного режима.
Если параметр не задан в _playbook_, модуль будет использовать значение переменной окружения _DECS_OAUTH2_URL_. | -| state | Значения:
`present` <- default
`absent`
| Целевое состояние . | | verify_ssl | (bool)
`True` <- default
`False` | Позволяет отключить проверку SSL сертификатов при выполнении API вызовов в адрес контроллера облачной инфраструктуры, например, при работе с изолированной облачной инфраструктурой, использующей самоподписанные сертификаты.
Применяйте данный параметр с осторожностью, предпочтительно в защищенных средах. | | workflow_callback | (string) | URL, по которому вышестоящее приложение (например, пользовательский портал или оркестратор верхнего уровня, инициирующий запуск Ansible playbook) ожидает API вызова, в параметрах которого модуль будет оперативно передавать информацию о своем статусе и текущей фазе исполнения.
Данный параметр является опциональным.
Функциональность callbacks в текущей версии модуля не реализована.| | workflow_context | (string) | Контекстная информация, которая будет содержаться в параметрах API вызова, адресованного к `workflow_callback` URL.
Данная информация призвана однозначно идентифицировать задачу, выполняемую модулем в настоящий момент, чтобы оркестратор верхнего уровня мог сопоставить получаемые через вызов `workflow_callback` данные со своим внутренним состоянием и отслеживать инициированные им задачи.
Параметр является опциональным и имеет значение только при условии, что также задан `workflow_callback`.
Функциональность callbacks в текущей версии модуля не реализована.| @@ -31,7 +31,14 @@ | Ключ | Тип данных | Описание | | --- | --- | --- | -| | | | +| arch | string | Аппаратная архитектура, с которой совместим данный образ. Возможные значения: `X86_64` (Intel x86), `PPC64_LE` (IBM PowerPC). | +| id | int | Уникальный целочисленный идентификатор данного образа. | +| name | string | Имя образа. Обратите внимание, что имя образа может содержать пробелы. | +| pool | string | Пул на системе хранения данных, в котором находится данный образ. | +| sep_id | int | Идентификатор системы хранения (Storage Endpoint Provider), на которой хранится данный образ. | +| size | int | Размер образа в ГБ. Загрузочный диск экземпляра _compute_, создаваемого на базе данного образа, должен иметь как минимум такой же размер. | +| state | string | Текущий статус образа. Возможные значения: `CREATED`, `DISABLED`, `DESTROYED`.
Экземпляры _compute_ можно создавать только на базе образов, которые находятся в статусе `CREATED`. | +| type | string | Тип операционной системы внутри данного образа. Возможные значения: `Linux`, `Windows`. | ## XX.4 Пример использования модуля _decort_osimage_