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

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

svs1370
2020-07-07 23:26:14 +03:00
parent eb3523576e
commit 1d7c2efe5c
1 changed files with 21 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
XX.-Модуль-decort_rg.md → 08.-Модуль-decort_rg.md

@@ -1,10 +1,10 @@
# Модуль decort_rg
## XX.1 Обзор модуля _decort_rg_
## 08.1 Обзор модуля _decort_rg_
Модуль _decort_rg_ предназначен для создания, редактирования и удаления ресурсных групп (Resource Group, RG) в облачной платформе DECORT, а также для получения информации об уже существующей ресурсной группе.
## XX.2 Параметры модуля _decort_rg_
## 08.2 Параметры модуля _decort_rg_
Ниже в алфавитном порядке приведен полный список параметров для модуля _decort_rg_. Актуальную информацию по параметрам, которые поддерживает версия модуля, установленного на вашем Ansible-сервере, можно получить командой:
`ansible-doc -t module decort_rg`
@@ -28,7 +28,7 @@
| workflow_context | (string) | Контекстная информация, которая будет содержаться в параметрах API вызова, адресованного к `workflow_callback` URL.<br>Данная информация призвана однозначно идентифицировать задачу, выполняемую модулем в настоящий момент, чтобы оркестратор верхнего уровня мог сопоставить получаемые через вызов `workflow_callback` данные со своим внутренним состоянием и отслеживать инициированные им задачи.<br/>Параметр является опциональным и имеет значение только при условии, что также задан `workflow_callback`.<br/>Функциональность callbacks в текущей версии модуля не реализована.|
## XX.3 Возвращаемые значения модуля _decort_rg_
## 08.3 Возвращаемые значения модуля _decort_rg_
Модуль _decort_rg_ возвращает информацию о XXX в виде словаря `facts` со следующими ключами:
| Ключ | Тип данных | Описание |
@@ -40,18 +40,30 @@
| state | string | Текущее состояние ресурсной группы.<br/>Корректные состояния: `CREATED`, `DISABLED`, `DELETED`, `DESTROYED` |
## XX.4 Пример использования модуля _decort_rg_
В данном примере XXX.
## 08.4 Пример использования модуля _decort_rg_
В данном примере показано, как создать ресурсную группу по имени _MyRG_ в учётной записи _MyAccount_.
```
- name: xxxx
- name: manage resource group
decort_rg:
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
...
account_name: "MyAccount"
rg_name: "MyRG"
state: present
register: my_rg
delegate_to: localhost
```
В данном примере результат работы модуля _decort_rg_ записывается в переменную `my_rg`.
Модули DECORT, которым для работы требуется ресурсная группа, в качестве одного из параметров, как правило, принимают идентификатор `rg_id`. Так, например, используя модуль _decort_kvmvm_ для создания виртуального сервера необходимо указать ресурсную группу, к которой будет принадлежать этот виртуальный сервер. Сделать это можно следующим образом:
```
<прочие детали опущены>
rg_id: "{{ my_rg.facts.id }}"
```