Created ZZ. Модуль description template (markdown)

ZZ.-Модуль-description-template.md

@@ -0,0 +1,51 @@
+# Модуль decort_XXX
+## XX.1 Обзор модуля _decort_XXX_
+Модуль _decort_XXX_ предназначен для 
+1. text.
+2. text:
+    - text.
+    - text.
+3. text.
+
+## XX.2 Параметры модуля _decort_XXX_
+Ниже в алфавитном порядке приведен полный список параметров для модуля _decs_XXX_. Актуальную информацию по параметрам, которые поддерживает версия модуля, установленного на вашем Ansible-сервере, можно получить командой:
+
+`ansible-doc -t module decort_XXX`
+
+| Параметр | Тип, допустимые значения | Описание |
+| --- | --- | --- |
+| app_id | (string) | Идентификатор приложения, использующийся для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима.<br/> Если параметр не задан в _playbook_, модуль будет использовать значение переменной окружения _DECS_APP_ID_. |
+| app_secret | (string) | Секретный ключ приложения, который используется для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима. Так как он содержит секретную информацию, то его не рекомендуется задавать непосредственно в _playbook_.<br/> Если параметр не задан в _playbook_, то модуль будет использовать значение переменной окружения _DECS_APP_SECRET_. |
+| authenticator | Значения:<br/>`legacy`<br/>`oauth2`<br/>`jwt` <- default | Режим аутентификации при подключении к контроллеру облачной платформы DECORT. |
+| controller_url | (string) | URL контроллера, соответствующего экземпляру облачной платформы DECORT, в рамках которого должен быть создан (или уже существует) данный виртуальный сервер.<br/>Данный параметр является обязательным. |
+| jwt | (string) | JSON Web Token (JWT), который будет использоваться для подключения к контроллеру облачной платформы DECS в режиме `authenticator: jwt`<br/>Данный параметр является обязательным для указанного режима.<br/>Так как он содержит потенциально секретную информацию, а сам JWT, как правило, имеет ограниченное время жизни, то его не рекомендуется задавать непосредственно в _playbook_.<br/>Если этот параметр не определен в _playbook_, то модуль  будет использовать значение переменной окружения _DECS_JWT_. |
+| oauth2_url | (string) | URL авторизационного сервера, работающего по протоколу _Oauth2_, который должен использоваться в режиме `authenticator: oauth2`.<br/>Данный параметр является обязательным для указанного режима.<br/>Если параметр не задан в _playbook_, модуль будет использовать значение переменной окружения _DECS_OAUTH2_URL_. |
+| state | Значения:<br/>`present` <- default<br/>`absent`<br/> | Целевое состояние  . |
+| verify_ssl | (bool)<br/>`True` <- default<br/>`False` | Позволяет отключить проверку SSL сертификатов при выполнении API вызовов в адрес контроллера облачной инфраструктуры, например, при работе с изолированной облачной инфраструктурой, использующей самоподписанные сертификаты.<br/>Применяйте данный параметр с осторожностью, предпочтительно в защищенных средах. |
+| workflow_callback | (string) | URL, по которому вышестоящее приложение (например, пользовательский портал или оркестратор верхнего уровня, инициирующий запуск Ansible playbook) ожидает API вызова, в параметрах которого модуль _desc_vm_ будет оперативно передавать информацию о своем статусе и текущей фазе исполнения.<br/>Данный параметр является опциональным.<br/>Функциональность callbacks в текущей версии модуля не реализована.|
+| workflow_context | (string) | Контекстная информация, которая будет содержаться в параметрах API вызова, адресованного к `workflow_callback` URL.<br>Данная информация призвана однозначно идентифицировать задачу, выполняемую модулем в настоящий момент, чтобы оркестратор верхнего уровня мог сопоставить получаемые через вызов `workflow_callback` данные со своим внутренним состоянием и отслеживать инициированные им задачи.<br/>Параметр является опциональным и имеет значение только при условии, что также задан `workflow_callback`.<br/>Функциональность callbacks в текущей версии модуля не реализована.|
+
+
+## XX.3 Возвращаемые значения модуля _decort_XXX_
+Модуль _decort_XXX_ возвращает информацию о XXX в виде словаря `facts` со следующими ключами:
+
+| Ключ | Тип данных | Описание |
+| --- | --- | --- |
+| | | |
+
+
+## XX.4 Пример использования модуля _decort_XXX_
+В данном примере XXX.
+
+```
+- name: xxxx
+  decort_xxx:
+    authenticator: oauth2
+    app_id: "{{ my_app_id }}"
+    app_secret: "{{ my_app_secret }}"
+    oauth2_url: "https://sso.digitalenergy.online"
+    controller_url: "https://cloud.digitalenergy.online"
+    
+    delegate_to: localhost
+...
+```