From 3e0b6dedaf5abcb8215eacf5c8d5f448344188ec Mon Sep 17 00:00:00 2001 From: svs1370 <34687689+svs1370@users.noreply.github.com> Date: Wed, 13 May 2020 18:07:10 +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=5Frg=20(markdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- XX.-Модуль-decort_rg.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/XX.-Модуль-decort_rg.md b/XX.-Модуль-decort_rg.md index 5b56304..955ff3c 100644 --- a/XX.-Модуль-decort_rg.md +++ b/XX.-Модуль-decort_rg.md @@ -1,45 +1,45 @@ -# Модуль decort_XXX -## XX.1 Обзор модуля _decort_XXX_ -Модуль _decort_XXX_ предназначен для +# Модуль decort_rg +## XX.1 Обзор модуля _decort_rg_ +Модуль _decort_rg_ предназначен для 1. text. 2. text: - text. - text. 3. text. -## XX.2 Параметры модуля _decort_XXX_ -Ниже в алфавитном порядке приведен полный список параметров для модуля _decs_XXX_. Актуальную информацию по параметрам, которые поддерживает версия модуля, установленного на вашем Ansible-сервере, можно получить командой: +## XX.2 Параметры модуля _decort_rg_ +Ниже в алфавитном порядке приведен полный список параметров для модуля _decs_rg_. Актуальную информацию по параметрам, которые поддерживает версия модуля, установленного на вашем Ansible-сервере, можно получить командой: -`ansible-doc -t module decort_XXX` +`ansible-doc -t module decort_rg` | Параметр | Тип, допустимые значения | Описание | | --- | --- | --- | -| app_id | (string) | Идентификатор приложения, использующийся для подключения к контроллеру облачной платформы DECS в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима.
Если параметр не задан в _playbook_, модуль будет использовать значение переменной окружения _DECS_APP_ID_. | -| app_secret | (string) | Секретный ключ приложения, который используется для подключения к контроллеру облачной платформы DECS в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима. Так как он содержит секретную информацию, то его не рекомендуется задавать непосредственно в _playbook_.
Если параметр не задан в _playbook_, то модуль будет использовать значение переменной окружения _DECS_APP_SECRET_. | +| app_id | (string) | Идентификатор приложения, использующийся для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима.
Если параметр не задан в _playbook_, модуль будет использовать значение переменной окружения _DECS_APP_ID_. | +| app_secret | (string) | Секретный ключ приложения, который используется для подключения к контроллеру облачной платформы DECORT в режиме `authenticator: oauth2`. Данный параметр является обязательным для указанного режима. Так как он содержит секретную информацию, то его не рекомендуется задавать непосредственно в _playbook_.
Если параметр не задан в _playbook_, то модуль будет использовать значение переменной окружения _DECS_APP_SECRET_. | | authenticator | Значения:
`legacy`
`oauth2`
`jwt` <- default | Режим аутентификации при подключении к контроллеру облачной платформы DECS. | -| controller_url | (string) | URL контроллера, соответствующего экземпляру облачной платформы DECS, в рамках которого должен быть создан (или уже существует) данный виртуальный сервер.
Данный параметр является обязательным. | +| controller_url | (string) | URL контроллера, соответствующего экземпляру облачной платформы DECORT, в рамках которого должен быть создан (или уже существует) данный виртуальный сервер.
Данный параметр является обязательным. | | jwt | (string) | JSON Web Token (JWT), который будет использоваться для подключения к контроллеру облачной платформы DECS в режиме `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 вызова, в параметрах которого модуль _desc_vm_ будет оперативно передавать информацию о своем статусе и текущей фазе исполнения.
Данный параметр является опциональным.
Функциональность callbacks в текущей версии модуля не реализована.| +| workflow_callback | (string) | URL, по которому вышестоящее приложение (например, пользовательский портал или оркестратор верхнего уровня, инициирующий запуск Ansible playbook) ожидает API вызова, в параметрах которого модуль будет оперативно передавать информацию о своем статусе и текущей фазе исполнения.
Данный параметр является опциональным.
Функциональность callbacks в текущей версии модуля не реализована.| | workflow_context | (string) | Контекстная информация, которая будет содержаться в параметрах API вызова, адресованного к `workflow_callback` URL.
Данная информация призвана однозначно идентифицировать задачу, выполняемую модулем в настоящий момент, чтобы оркестратор верхнего уровня мог сопоставить получаемые через вызов `workflow_callback` данные со своим внутренним состоянием и отслеживать инициированные им задачи.
Параметр является опциональным и имеет значение только при условии, что также задан `workflow_callback`.
Функциональность callbacks в текущей версии модуля не реализована.| -## XX.3 Возвращаемые значения модуля _decort_XXX_ -Модуль _decort_XXX_ возвращает информацию о XXX в виде словаря `facts` со следующими ключами: +## XX.3 Возвращаемые значения модуля _decort_rg_ +Модуль _decort_rg_ возвращает информацию о XXX в виде словаря `facts` со следующими ключами: | Ключ | Тип данных | Описание | | --- | --- | --- | | | | | -## XX.4 Пример использования модуля _decort_XXX_ +## XX.4 Пример использования модуля _decort_rg_ В данном примере XXX. ``` - name: xxxx - decort_xxx: + decort_rg: authenticator: oauth2 app_id: "{{ my_app_id }}" app_secret: "{{ my_app_secret }}"