BASIS/decort-ansible
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 16 Wiki Activity

Updated YY. Модуль decort_jwt (markdown)

svs1370
2020-07-07 23:27:49 +03:00
parent 1d7c2efe5c
commit a9a842be53
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
YY.-Модуль-decort_jwt.md → 09.-Модуль-decort_jwt.md

@@ -1,11 +1,11 @@
# Вспомогательный модуль для получения авторизационного JWT токена decort_jwt # Вспомогательный модуль для получения авторизационного JWT токена decort_jwt
## 11.1 Обзор модуля _decort_jwt_ ## 09.1 Обзор модуля _decort_jwt_
Модуль _decort_jwt_ предназначен для получения авторизационного токена JWT (JSON Web Token). Данный модуль может быть полезен при массовом создании виртуальных серверов на базе одного и того же образа, так как позволяет оптимизировать количество API вызовов, инициируемых в адрес контроллера облачной платформы. Модуль _decort_jwt_ предназначен для получения авторизационного токена JWT (JSON Web Token). Данный модуль может быть полезен при массовом создании виртуальных серверов на базе одного и того же образа, так как позволяет оптимизировать количество API вызовов, инициируемых в адрес контроллера облачной платформы.
По сути, данный модуль является провайдером информации и не управляет облачными ресурсами (всегда возвращает `changed: False`). По сути, данный модуль является провайдером информации и не управляет облачными ресурсами (всегда возвращает `changed: False`).
## 11.2 Параметры модуля _decort_jwt_ ## 09.2 Параметры модуля _decort_jwt_
Ниже в алфавитном порядке приведен полный список параметров для модуля _decort_jwt_. Актуальную информацию по параметрам, которые поддерживает версия модуля, установленного на вашем Ansible-сервере, можно получить командой: Ниже в алфавитном порядке приведен полный список параметров для модуля _decort_jwt_. Актуальную информацию по параметрам, которые поддерживает версия модуля, установленного на вашем Ansible-сервере, можно получить командой:
`ansible-doc -t module decort_jwt` `ansible-doc -t module decort_jwt`
@@ -20,14 +20,13 @@
| workflow_callback | (string) | URL, по которому вышестоящее приложение (например, пользовательский портал или оркестратор верхнего уровня, инициирующий запуск Ansible playbook) ожидает API вызова, в параметрах которого модуль будет оперативно передавать информацию о своем статусе и текущей фазе исполнения.<br/>Данный параметр является опциональным.<br/>Функциональность callbacks в текущей версии модуля не реализована.| | workflow_callback | (string) | URL, по которому вышестоящее приложение (например, пользовательский портал или оркестратор верхнего уровня, инициирующий запуск Ansible playbook) ожидает API вызова, в параметрах которого модуль будет оперативно передавать информацию о своем статусе и текущей фазе исполнения.<br/>Данный параметр является опциональным.<br/>Функциональность callbacks в текущей версии модуля не реализована.|
| workflow_context | (string) | Контекстная информация, которая будет содержаться в параметрах API вызова, адресованного к `workflow_callback` URL.<br>Данная информация призвана однозначно идентифицировать задачу, выполняемую модулем в настоящий момент, чтобы оркестратор верхнего уровня мог сопоставить получаемые через вызов `workflow_callback` данные со своим внутренним состоянием и отслеживать инициированные им задачи.<br/>Параметр является опциональным и имеет значение только при условии, что также задан `workflow_callback`.<br/>Функциональность callbacks в текущей версии модуля не реализована.| | workflow_context | (string) | Контекстная информация, которая будет содержаться в параметрах API вызова, адресованного к `workflow_callback` URL.<br>Данная информация призвана однозначно идентифицировать задачу, выполняемую модулем в настоящий момент, чтобы оркестратор верхнего уровня мог сопоставить получаемые через вызов `workflow_callback` данные со своим внутренним состоянием и отслеживать инициированные им задачи.<br/>Параметр является опциональным и имеет значение только при условии, что также задан `workflow_callback`.<br/>Функциональность callbacks в текущей версии модуля не реализована.|
## 11.3 Возвращаемые значения модуля _decort_jwt_ ## 09.3 Возвращаемые значения модуля _decort_jwt_
При успешном выполнении модуль _decort_jwt_ возвращает словарь, в котором по ключу `jwt` находится значение JWT-токена (тип _string_). При успешном выполнении модуль _decort_jwt_ возвращает словарь, в котором по ключу `jwt` находится значение JWT-токена (тип _string_).
## 11.4 Пример использования модуля _decort_jwt_ ## 09.4 Пример использования модуля _decort_jwt_
В данном примере сначала получается JWT со сроком действия 1200 сек., а затем этот JWT используется для создания виртуального сервера в режиме авторизации _jwt_ (подробнее о данном режиме см. в разделе [«Примеры различных режимов авторизации»]()). В данном примере сначала получается JWT со сроком действия 1200 сек., а затем этот JWT используется для создания виртуального сервера в режиме авторизации _jwt_ (подробнее о данном режиме см. в разделе [«Примеры различных режимов авторизации»]()).
``` ```
---
- hosts: ansible_master - hosts: ansible_master
tasks: tasks:
- name: obtain JWT with validity of 1200 sec from the OAuth2 provider - name: obtain JWT with validity of 1200 sec from the OAuth2 provider
@@ -49,11 +48,12 @@
cpu: 2 cpu: 2
ram: 4096 ram: 4096
<<<дальнейшие детали опущены>>> <<<дальнейшие детали опущены>>>
...
``` ```
Обратите внимание, как используется JWT при создании нового виртуального сервера (в предположении, что результат выполнения _task_ для модуля _decort_jwt_ был сохранен в переменной `my_token`): Обратите внимание, как используется JWT при создании нового виртуального сервера (в предположении, что результат выполнения _task_ для модуля _decort_jwt_ был сохранен в переменной `my_token`):
` jwt: "{{ my_token.jwt }}"` ```
jwt: "{{ my_token.jwt }}"
```