Updated XX. Модуль decort_kvmvm (markdown)

master
svs1370 5 years ago
parent 3ea8d80cee
commit d50918dbcd

@ -1,6 +1,6 @@
# Модуль decort_kvmvm
## XX.1 Обзор модуля _decort_kvmvm_
Модуль _decs_osimage_ предназначен для предназначен для выполнения следующих действий над виртуальными серверами, созданными на базе технологии виртуализации KVM, в облачной платформе DECORT:
Модуль _decort_kvmvm_ предназначен для предназначен для выполнения следующих действий над виртуальными серверами, созданными на базе технологии виртуализации KVM, в облачной платформе DECORT:
1. Создание нового виртуального сервера указанной аппаратной архитектуры. Платформа поддерживает виртуальные сервера архитектуры Intel x86 и IBM PowerPC.
2. Изменение конфигурации существующего виртуального сервера:
- Изменение количества выделенных CPU и виртуальной ОЗУ. Следует иметь ввиду, что изменение этих параметров в меньшую сторону может потребовать перезагрузки гостевой ОС.
@ -22,6 +22,7 @@
| annotation | (string) | Опциональное описание виртуального сервера. Этот параметр используется только в момент создания нового виртуального сервера и игнорируется при любых действиях над существующими серверами. |
| app_id | (string) | Идентификатор приложения, использующийся для подключения к контроллеру облачной платформы DECS в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима.<br/> Если параметр не задан в _playbook_, модуль _decort_kvmvm_ будет использовать значение переменной окружения _DECS_APP_ID_. |
| app_secret | (string) | Секретный ключ приложения, который используется для подключения к контроллеру облачной платформы DECS в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима. Так как он содержит секретную информацию, то его не рекомендуется задавать непосредственно в _playbook_.<br/> Если параметр не задан в _playbook_, то модуль _decort_kvmvm_ будет использовать значение переменной окружения _DECS_APP_SECRET_. |
| arch| Значения:<br/>`KVM_X86` <- default <br/>`KVM_PPC`<br/> | Аппаратная архитектура виртуального сервера. Данный параметр является обязательным при создании нового вирутального сервера и игнорируется для уже существующего сервера.<br/>Платформа DECORT поддерживает виртуальные серверы KVM аппаратных архитектур Intel x86 и IBM PowerPC. |
| authenticator | Значения:<br/>`legacy`<br/>`oauth2`<br/>`jwt` <- default | Режим аутентификации при подключении к контроллеру облачной платформы DECS. |
| boot_disk | (dict) | Конфигурация загрузочного диска виртуального сервера. Данный параметр является обязательным при создании нового виртуального сервера. Для существующих виртуальных серверов этот параметр является опциональным с его помощью можно увеличить размер загрузочного диска. Параметр представляет собой словарь со следующими ключами:<br/>* (int) `size` размер диска в GB.<br/>* (string) `pool` пул дисковых ресурсов, из которого будет предоставлен данный загрузочный диск. Имена пулов могут меняться от одной модели СХД к другой. Если указанный пул не найден, модуль ожидает, что платформа создаст дисковый ресурс в “default” пуле, который всегда должен присутствовать.<br/>Обратите внимание, что загрузочный диск будет создан на той же системе хранения, где размещён образ ОС (см. параметры `image_name` или `image_id`), на базе которого создаётся данный виртуальный сервер. |
| controller_url | (string) | URL контроллера, соответствующего экземпляру облачной платформы DECS, в рамках которого должен быть создан (или уже существует) данный виртуальный сервер.<br/>Данный параметр является обязательным. |
@ -49,18 +50,28 @@
## XX.3 Возвращаемые значения модуля _decort_kvmvm_
При успешном выполнении модуль _decs_osimage_ возвращает словарь `osimage_facts` со следующими ключами:
Модуль _decort_kvmvm_ возвращает информацию о виртуальном сервере в виде словаря `facts` со следующими ключами:
| Ключ | Тип данных | Описание |
| --- | --- | --- |
| id | int | Уникальный цифровой идентификатор образа ОС в платформе DECS. |
| name | string | Имя образа ОС. |
| size | int | Размер образа ОС в ГБ. |
| type | string | Тип образа ОС. Доступные типы: `Linux`, `Windows`, `Other`. |
| state | string | Текущее состояние образа ОС. Доступные статусы: `CREATED`, `DISABLED`. |
| acrh | string | Аппаратная архитектура данного виртуального сервера. Возвращаемые значения: `KVM_X86` для Intel x86 и `KVM_PPC` для IBM PowerPC. |
| ext_gateway | string | IP адрес шлюза по умолчанию (default gateway) для внешнего прямого IP адреса, назначенного данному серверу.<br/>Если серверу не назначен прямой внешний IP адрес, по данному ключу возвращается пустая строка. |
| ext_ip | string | Прямой внешний IP адрес, назначенный данному виртуальному серверу.<br/>Если серверу не назначен прямой внешний IP адрес, по данному ключу возвращается пустая строка. |
| ext_mac | string | MAC адрес виртуального сетевого интерфейса, подключенного к прямому внешнему (публичному) IP адресу.<br/>Если серверу не назначен прямой внешний IP адрес, по данному ключу возвращается пустая строка. |
| ext_netmask | int | Маска подсети для прямого внешнего IP адреса.<br/>Если серверу не назначен прямой внешний IP адрес, по данному ключу возвращается пустая строка. |
| id | int | Уникальный цифровой идентификатор виртуального сервера в платформе DECS. |
| int_ip | string | IP адрес виртуального сервера внутри виртуального сетевого сегмента (`vdc_id`), в котором размещен данный сервер. |
| name | string | Имя виртуального сервера.<br/>Имя уникально только в рамках одного и того же виртуального сетевого сегмента. |
| password | string | Пароль системного пользователя по умолчанию. |
| state | string | Состояние виртуального сервера. |
| usrename | string | Имя системного пользователя по умолчанию. |
| rg_id | int | Уникальный цифровой идентификатор ресурсной группы (_RG_), к которой принадлежит данный сервер. |
| rg_name | string | Имя ресурсной группы , к которому принадлежит данный сервер.<br/>Имя уникально только в рамках одного и того же подписчика (_tenant_). |
| tenant | string | Имя подписчика, владеющего данным виртуальным сервером. |
| tenant_id | int | Уникальный цифровой идентификатор подписчика, владеющего данным виртуальным сервером. |
## 12.4 Пример использования модуля _decort_kvmvm_
В данном примере сначала извлекается идентификатор образа ОС, а затем на базе этого образа создается виртуальный сервер.
## XX.4 Пример использования модуля _decort_kvmvm_
В данном примере создается виртуальный сервер KVM VM с аппаратной архитектурой Intel x86.
```

Loading…
Cancel
Save