From c1b1d83f9a18e4129ffc9c8d34948fec4fc38d0c Mon Sep 17 00:00:00 2001 From: svs1370 <34687689+svs1370@users.noreply.github.com> Date: Thu, 14 May 2020 09:42:05 +0300 Subject: [PATCH] =?UTF-8?q?Updated=20XX.=20=D0=9C=D0=BE=D0=B4=D1=83=D0=BB?= =?UTF-8?q?=D1=8C=20decort=5Fkvmvm=20(markdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- XX.-Модуль-decort_kvmvm.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/XX.-Модуль-decort_kvmvm.md b/XX.-Модуль-decort_kvmvm.md index cd4bfa4..88bdd66 100644 --- a/XX.-Модуль-decort_kvmvm.md +++ b/XX.-Модуль-decort_kvmvm.md @@ -19,6 +19,8 @@ | Параметр | Тип, допустимые значения | Описание | | --- | --- | --- | +| account_id | int | Уникальный цифровой идентификатор подписчика, владеющего данным виртуальным сервером.
Этот параметр является опциональным и используется в сценариях, когда уже существующая ресурсная группа задается комбинацией `account_id` и `rg_name`. | +| account_name | (string) | Имя подписчика, которому будет принадлежать новый виртуальный сервер (или уже принадлежит существующий).
Параметр должен задаваться в точном соответствии с тем, как назван нужный подписчик в облачной инфраструктуре (с соблюдением заглавных и строчных символов, а также пробелов).
Этот параметр является опциональным и используется в сценариях, когда уже существующая ресурсная группа задается комбинацией `account_name` и `rg_name`. | | annotation | (string) | Опциональное описание виртуального сервера. Этот параметр используется только в момент создания нового виртуального сервера и игнорируется при любых действиях над существующими серверами. | | app_id | (string) | Идентификатор приложения, использующийся для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима.
Если параметр не задан в _playbook_, модуль _decort_kvmvm_ будет использовать значение переменной окружения _DECS_APP_ID_. | | app_secret | (string) | Секретный ключ приложения, который используется для подключения к контроллеру облачной платформы DCORT в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима. Так как он содержит секретную информацию, то его не рекомендуется задавать непосредственно в _playbook_.
Если параметр не задан в _playbook_, то модуль _decort_kvmvm_ будет использовать значение переменной окружения _DECS_APP_SECRET_. | @@ -27,22 +29,20 @@ | boot_disk | (dict) | Конфигурация загрузочного диска виртуального сервера. Данный параметр является обязательным при создании нового виртуального сервера. Для существующих виртуальных серверов этот параметр является опциональным – с его помощью можно увеличить размер загрузочного диска. Параметр представляет собой словарь со следующими ключами:
* (int) `size` – размер диска в GB.
* (string) `pool` – пул дисковых ресурсов, из которого будет предоставлен данный загрузочный диск. Имена пулов могут меняться от одной модели СХД к другой. Если указанный пул не найден, модуль ожидает, что платформа создаст дисковый ресурс в “default” пуле, который всегда должен присутствовать.
Обратите внимание, что загрузочный диск будет создан на той же системе хранения, где размещён образ ОС (см. параметры `image_name` или `image_id`), на базе которого создаётся данный виртуальный сервер. | | controller_url | (string) | URL контроллера, соответствующего экземпляру облачной платформы DECORT, в рамках которого должен быть создан (или уже существует) данный виртуальный сервер.
Данный параметр является обязательным. | | cpu | (int) | Количество виртуальных CPU, выделенных виртуальному серверу.
Параметр является обязательным при создании нового сервера, во всех других случаях он опциональный. Если указать его для уже существующего сервера, то будет выполнена попытка изменить количество CPU.
Следует иметь ввиду, что _уменьшение_ количества CPU у работающего сервера, как правило, потребует его перезагрузки. | -| datacenter | (string) | Целевой _datacenter_ под управлением заданного DECORT контроллера, где размещается данный виртуальный сервер.
Этот параметр является обязательным при создании нового виртуального сервера, когда вместе с сервером также требуется создать виртуальный сетевой сегмент, в котором он будет расположен. При всех прочих операциях данный параметр игнорируется. | -| id | (int) | Уникальный цифровой идентификатор виртуального сервера внутри платформы.
Этот параметр используется как один из методов идентификации существующего сервера (альтернатива – по комбинации `name`, `vdc_name` и `tenant`) и игнорируется при создании нового сервера, так как для нового сервера облачная платформа назначает этот идентификатор автоматически.
Если при вызове модуля _decort_kvmvm_ существующий виртуальный сервер идентифицируется по своему `id`, то параметры `tenant`, `vdc_name` и `vdc_id` игнорируются. | +| id | (int) | Уникальный цифровой идентификатор виртуального сервера внутри платформы.
Этот параметр используется как один из методов идентификации существующего сервера (альтернатива – по комбинации `name`, `rg_name` и `account_name`) и игнорируется при создании нового сервера, так как для нового сервера облачная платформа назначает этот идентификатор автоматически.
Если при вызове модуля _decort_kvmvm_ существующий виртуальный сервер идентифицируется по своему `id`, то параметры `account`, `rg_name` и `rg_id` игнорируются. | | image_id | (int)| Уникальный цифровой идентификатор образа ОС, на базе которого следует создать виртуальный сервер.
При создании нового виртуального сервера требуется задать этот параметр или параметр `image_name`. При любых других операциях данные параметры игнорируются.
Если заданы оба этих параметра (`image_id` и `image_name`), то `image_name` игнорируется. Для получения `image_id` по `image_name` можно использовать модуль _decort_osimage_. | | image_name | (string) | Название образа ОС, на базе которого следует создать виртуальный сервер.
При создании нового виртуального сервера требуется задать этот параметр или параметр `image_id`. При любых других операциях данные параметры игнорируются.
Параметр `image_name` должен задаваться в точном соответствии с тем, как назван нужный образ ОС в облачной инфраструктуре (с соблюдением заглавных и строчных символов, а также пробелов). | | jwt | (string) | JSON Web Token (JWT), который будет использоваться для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: jwt`
Данный параметр является обязательным для указанного режима.
Так как он содержит потенциально секретную информацию, а сам JWT, как правило, имеет ограниченное время жизни, то его не рекомендуется задавать непосредственно в _playbook_.
Если этот параметр не определен в _playbook_, то модуль _decort_kvmvm_ будет использовать значение переменной окружения _DECS_JWT_. | -| name | (string) | Название виртуального сервера.
Чтобы модуль _decort_kvmvm_ мог управлять сервером по его названию, также необходимо задать комбинацию `tenant` и `rg_name` или идентификатор `rg_id`.
Параметр должен задаваться в точном соответствии с тем, как назван сервер в облачной инфраструктуре (с соблюдением заглавных и строчных символов, а также пробелов).
Если для существующего виртуального сервера указаны и `name`, и `id`, то параметр `name` игнорируется и идентификация сервера выполняется по его `id`. | +| name | (string) | Название виртуального сервера.
Чтобы модуль _decort_kvmvm_ мог управлять сервером по его названию, также необходимо задать комбинацию `account_name` и `rg_name` или идентификатор `rg_id`.
Параметр должен задаваться в точном соответствии с тем, как назван сервер в облачной инфраструктуре (с соблюдением заглавных и строчных символов, а также пробелов).
Если для существующего виртуального сервера указаны и `name`, и `id`, то параметр `name` игнорируется и идентификация сервера выполняется по его `id`. | | oauth2_url | (string) | URL авторизационного сервера, работающего по протоколу _Oauth2_, который должен использоваться в режиме `authenticator: oauth2`.
Данный параметр является обязательным для указанного режима.
Если параметр не задан в _playbook_, модуль _decort_kvmvm_ будет использовать значение переменной окружения _DECS_OAUTH2_URL_. | | password | (string) | Пароль для подключения к контроллеру облачной инфраструктуры DECORT в режиме `authenticator: legacy`.
Данный параметр является обязательным для указанного режима.
Так как он содержит секретную информацию, то его не рекомендуется задавать в _playbook_.
Если параметр не задан в _playbook_, то модуль _decort_kvmvm_ будет использовать значение переменной окружения _DECS_PASSWORD_. | | ram | (int) | Объем оперативной памяти (RAM) в MB, выделенной данному виртуальному серверу.
Параметр является обязательным при создании нового сервера. Если указать его для уже существующего сервера, то будет выполнена попытка изменить объем выделенной серверу памяти.
Следует иметь ввиду, что уменьшение объема памяти работающего сервера в большинстве случаев потребует его перезагрузки. | -| rg_id | (int) | Уникальный цифровой идентификатор уже существующей ресурсной группы (RG), в которой будет создан новый или находится уже существующий виртуальный сервер.
Данный параметр является одним из методов идентификации существующей RG (альтернативой является задание комбинации `tenant` и `rg_name`). | -| rg_name | (string) | Имя уже существующей ресурсной группы (RG), в которой будет создан новый или находится уже существующий виртуальный сервер.
Данный параметр является одним из методов идентификации существующей RG, когда задается пара `tenant` и `rg_name` (альтернативой является задание rg_id, однако такой метод применим только для уже существующих RG).
Параметр должен задаваться в точном соответствии с тем, как нужная ресурсная группа названа в облачной инфраструктуре (с соблюдением заглавных и строчных символов, а также пробелов).
Если заданы и `rg_id`, и `rg_name`, то параметр `rg_name` игнорируется. | +| rg_id | (int) | Уникальный цифровой идентификатор уже существующей ресурсной группы (RG), в которой будет создан новый или находится уже существующий виртуальный сервер.
Данный параметр является одним из методов идентификации существующей RG (альтернативой является задание комбинации `account_name` и `rg_name`). | +| rg_name | (string) | Имя уже существующей ресурсной группы (RG), в которой будет создан новый или находится уже существующий виртуальный сервер.
Данный параметр является одним из методов идентификации существующей RG, когда задается пара `account_name` и `rg_name` (альтернативой является задание `rg_id`, который можно получить с помощью модуля _decort_rg_).
Параметр должен задаваться в точном соответствии с тем, как нужная ресурсная группа названа в облачной инфраструктуре (с соблюдением заглавных и строчных символов, а также пробелов).
Если заданы и `rg_id`, и `rg_name`, то параметр `rg_name` игнорируется. | | ssh_key | (string) | Открытая часть SSH ключа, который необходимо авторизовать на создаваемом виртуальном сервере для пользователя, заданного параметром `ssh_key_user`.
Данный параметр применим только для Linux серверов, является опциональным, используется только при создании нового сервера и игнорируется при других операциях. | | ssh_key_user | (string) | Имя пользователя на уровне гостевой ОС (только для Linux серверов) для которого авторизуется SSH ключ, заданный параметром `ssh_key`.
Данный параметр является обязательным, если задан `ssh_key`, используется только при создании нового сервера и игнорируется при других операциях. | | state | Значения:
`present` <- default
`absent`
`poweredon`
`poweredoff`
`halted`
`paused`
`check` | Целевое состояние виртуального сервера на выходе из модуля _decort_kvmvm_.
Значение 'halted' - синоним к 'poweredoff'.
Значение 'check' вызывает модуль в _read-only_ режиме и считывает характеристики существующего виртуального сервера. | | tags | (string) | Строка, содержащая набор текстовых меток, которые надлежит присвоить данному виртуальному серверу.
Данные текстовые метки представляют собой произвольный текст, который можно использовать для группировки и индексирования виртуальных серверов во внешних приложениях.
Параметр является опциональным.| -| tenant | (string) | Имя подписчика, которому будет принадлежать новый виртуальный сервер (или уже принадлежит существующий).
Параметр должен задаваться в точном соответствии с тем, как назван нужный подписчик в облачной инфраструктуре (с соблюдением заглавных и строчных символов, а также пробелов).
Этот параметр является опциональным и используется в сценариях, когда вместе с новым виртуальным сервером создается новый виртуальный сетевой сегмент (_VDC_), в котором будет размещаться данный сервер, или когда уже существующий целевой сегмент задается комбинацией `tenant` и `vdc_name`. | | user | (string) | Имя пользователя, непосредственно зарегистрированного на контроллере облачной инфраструктуры DECORT, которое используется для подключения к контроллеру в режиме `authenticator: legacy`.
Данный параметр является обязательным для указанного режима.
Если параметр не задан в _playbook_, модуль _decort_kvmvm_ будет использовать значение переменной окружения _DECS_USER_.| | verify_ssl | (bool)
`True` <- default
`False` | Позволяет отключить проверку SSL сертификатов при выполнении API вызовов в адрес контроллера облачной инфраструктуры, например, при работе с изолированной облачной инфраструктурой, использующей самоподписанные сертификаты.
Применяйте данный параметр с осторожностью, предпочтительно в защищенных средах. | | workflow_callback | (string) | URL, по которому вышестоящее приложение (например, пользовательский портал или оркестратор верхнего уровня, инициирующий запуск Ansible playbook) ожидает API вызова, в параметрах которого модуль будет оперативно передавать информацию о своем статусе и текущей фазе исполнения.
Данный параметр является опциональным.
Функциональность callbacks в текущей версии модуля не реализована.| @@ -54,21 +54,23 @@ | Ключ | Тип данных | Описание | | --- | --- | --- | +| account_id | int| Цифровой идентификатор подписчика, владеющего данным виртуальным сервером. | +| account_name | string | Имя подписчика, владеющего данным виртуальным сервером. | | acrh | string | Аппаратная архитектура данного виртуального сервера. Возвращаемые значения: `KVM_X86` для Intel x86 и `KVM_PPC` для IBM PowerPC. | | ext_gateway | string | IP адрес шлюза по умолчанию (default gateway) для внешнего прямого IP адреса, назначенного данному серверу.
Если серверу не назначен прямой внешний IP адрес, по данному ключу возвращается пустая строка. | | ext_ip | string | Прямой внешний IP адрес, назначенный данному виртуальному серверу.
Если серверу не назначен прямой внешний IP адрес, по данному ключу возвращается пустая строка. | | ext_mac | string | MAC адрес виртуального сетевого интерфейса, подключенного к прямому внешнему (публичному) IP адресу.
Если серверу не назначен прямой внешний IP адрес, по данному ключу возвращается пустая строка. | | ext_netmask | int | Маска подсети для прямого внешнего IP адреса.
Если серверу не назначен прямой внешний IP адрес, по данному ключу возвращается пустая строка. | -| id | int | Уникальный цифровой идентификатор виртуального сервера в платформе DECORT. | +| id | int | Уникальный цифровой идентификатор данного виртуального сервера (экземпляра _compute_) в платформе DECORT. | | int_ip | string | IP адрес виртуального сервера внутри виртуального сетевого сегмента (`vdc_id`), в котором размещен данный сервер. | | name | string | Имя виртуального сервера.
Имя уникально только в рамках одного и того же виртуального сетевого сегмента. | | password | string | Пароль системного пользователя по умолчанию. | | state | string | Состояние виртуального сервера. | -| usrename | string | Имя системного пользователя по умолчанию. | +| username | string | Имя системного пользователя по умолчанию. | | rg_id | int | Уникальный цифровой идентификатор ресурсной группы (_RG_), к которой принадлежит данный сервер. | -| rg_name | string | Имя ресурсной группы , к которому принадлежит данный сервер.
Имя уникально только в рамках одного и того же подписчика (_tenant_). | -| tenant | string | Имя подписчика, владеющего данным виртуальным сервером. | -| tenant_id | int | Уникальный цифровой идентификатор подписчика, владеющего данным виртуальным сервером. | +| rg_name | string | Имя ресурсной группы , к которому принадлежит данный сервер.
Имя уникально только в рамках одного и того же подписчика (_account_). | + + ## XX.4 Пример использования модуля _decort_kvmvm_ В данном примере создается виртуальный сервер KVM VM с аппаратной архитектурой Intel x86.