# Модуль decort_rg

## Обзор модуля decort_rg

Модуль decort_rg предназначен для создания, редактирования и удаления ресурсных групп (Resource Group, RG) в облачной платформе DECORT, а также для получения информации об уже существующей ресурсной группе. Модуль decort_rg позволяет:

- создавать ресурсные группы
- удалять ресурсные группы (в корзину или безвозвратно, с удалением содержимого или без)
- восстанавливать ресурсные группы из корзины
- включать/отключать ресурсные группы
- запрашивать информацию об уже существующих ресурсных группах
- изменять ресурсные группы:
  - переименовывать
  - настраивать квоты
  - задавать стандартную сеть
  - настраивать права доступа для пользователей
  - изменять доступные пулы СХД
  - изменять описание

## Параметры модуля decort_rg
Ниже приведен список параметров для модуля **decort_rg** (за исключением [общих параметров](./введение.md#общие-параметры-модулей)):

| Параметр | Тип, допустимые значения | Описание |
|----------|--------------------------|----------|
| account_id | (int) | Уникальный целочисленный идентификатор аккаунта, в рамках которого создаётся или уже существует данная ресурсная группа. Должен быть задан либо идентификатор, либо имя аккаунта (см. параметр `account_name`). Если одновременно заданы и `account_id`, и `account_name`, то account_name игнорируется. |
| account_name | (string) | Имя аккаунта, в рамках которого создаётся или уже существует данная ресурсная группа. Должно быть задано либо имя, либо идентификатор учётной записи (см. параметр `account_id`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. |
| access | (dict) | Параметр, позволяющий выдать, забрать или изменить права у пользователя в ресурсной группе.<br>Ключи словаря:<br>&bull; `action` (str) - режим изменения прав доступа для указанного пользователя. Обязательный параметр. Значения: `grant`, `revoke` <br>&bull; `user` (str) - имя пользователя. Обязательный параметр.<br>&bull; `right` (str) - права доступа. Обязателен при `action: grant`. Значения: `R`, `RCX`, `ARCXDU`. |
| description | (string) | Текстовое описание ресурсной группы. |
| def_netId | (int) | Уникальный целочисленный идентификатор внутренней или внешней сети. Используется для изменения сети по умолчанию в ресурсной группе. |
| def_netType | (string) <br>Значения:<br>`PRIVATE`<br>`PUBLIC`<br>`NONE`<br>Default: `PRIVATE` | Тип сети по умолчанию в ресурсной группе. Используется при создании ресурсной группы, а также при изменении. |
| extNetId | (int) | Уникальный целочисленный идентификатор внешней сети.<br>Если `def_netType: PRIVATE`, то указывает какую внешнюю сеть подключить к создаваемой внутренней сети, которая будет задана как сеть по умолчанию для создаваемой РГ.<br>Если `def_netType: PUBLIC`, то указывает какую внешнюю сеть задать как сеть по умолчанию для создаваемой РГ. |
| extNetIp | (string) | IP-адрес для внешней сети, которая задана в параметре `extNetId`. |
| ipcidr | (string) | IP-адрес внутренней сети. Используется при создании ресурсной группы, чтобы задать IP-адрес сети для создаваемой внутренней сети, которая создастся вместе с ресурсной группой. Используется при параметре `def_netType` в значении `PRIVATE`. |
| owner | (string) | Владелец ресурсной группы. Задаётся при создании ресурсной группы, не обязателен. Если оставить пустое значение - владельцем ресурсной группы будет пользователь, создавший ресурсную группу. |
| permanently | (bool)<br>Default: `false` | Параметр, использующийся при удалении ресурсной группы. При значении `true` - ресурсная группа удалится безвозвратно, а при `false` - попадёт в корзину. |
| quotas | (dict) | Предназначено для задания или изменения квоты на ресурсы в составе данной ресурсной группы.<br>Ключи словаря:<br>&bull; `cpu` (int) - количество виртуальных процессоров<br>&bull; `disk` (int) - объём дисков в ГБ<br>&bull; `ext_ips` (int) - количество внешних IP-адресов<br>&bull; `ram` (int) - объём оперативной памяти в МБ<br>&bull; `storage_policies` (list) - список словарей, описывающих квоты по политикам хранения. Ключи словаря: `id` (int)  - идентификатор политики хранения; `storage_size_gb` (int) - объём дисков.|
| recursive_deletion | (bool)<br>Default: `false` | Рекурсивное удаление.<br>Если `true`, то при удалении РГ будет удалено всё её содержимое.<br>Если `false`, то при удалении непустой РГ работа модуля завершится ошибкой. |
| rename | (string) | Новое имя ресурсной группы.<br>Возможно переименование только включенной ресурсной группы. |
| rg_id | (int) | Уникальный целочисленный идентификатор ресурсной группы. Является обязательным при изменении РГ если не заданы `rg_name` и `account_id`/`account_name` |
| rg_name | (string) | Имя ресурсной группы. Данный параметр является обязательным при создании. |
| sdn_access_group_id | (string) | Идентификатор группы доступа SDN. |
| sep_pools| (list) | Список словарей, описывающих доступные пулы СХД.<br>Ключи словаря:<br>&bull; `sep_id` (int) - идентификатор системы хранения данных.<br>&bull; `pool_names` (list) - список названий пулов системы хранения данных.<br>Чтобы очистить список доступных пулов, нужно указать пустой список `[]`.|
| state | Значения:<br>`present`<br>`absent`<br>`enabled`<br>`disabled`<br>Default: `present` | Целевое состояние ресурсной группы. |

## Возвращаемые значения модуля decort_rg

Модуль **decort_rg** возвращает информацию о ресурсной группе в виде словаря `facts` со следующими ключами:

<table>
  <tr>
    <th colspan="6">
      Ключ
    </th>
    <th>
      Тип
      <br>данных
    </th>
    <th>
      Описание
    </th>
  </tr>
  <tr>
    <td colspan="6">
      account_id
    </td>
    <td>
      int
    </td>
    <td>
      Уникальный целочисленный идентификатор аккаунта, которому принадлежит данная ресурсная группа.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      account_name
    </td>
    <td>
      str
    </td>
    <td>
      Имя аккаунта, которому принадлежит данная ресурсная группа.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      acl
    </td>
    <td>
      list[str, any]
    </td>
    <td>
      Список словарей, описывающих доступы пользователей.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      access_type
    </td>
    <td>
      str
    </td>
    <td>
      Тип доступа.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      can_be_deleted
    </td>
    <td>
      bool | null
    </td>
    <td>
      Может ли быть удалён.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      explicit
    </td>
    <td>
      bool
    </td>
    <td>
      Видимость ресурсной группы.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      guid
    </td>
    <td>
      str | null
    </td>
    <td>
      Идентификатор.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      status
    </td>
    <td>
      str
    </td>
    <td>
      Статус.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      type
    </td>
    <td>
      str
    </td>
    <td>
      Тип.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      user_emails
    </td>
    <td>
      list[str] | null
    </td>
    <td>
      Список адресов электронной почты.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      user_name
    </td>
    <td>
      str
    </td>
    <td>
      Имя пользователя.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      cpu_allocation_parameter
    </td>
    <td>
      str
    </td>
    <td>
      Режим выделения ЦП.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      cpu_allocation_ratio
    </td>
    <td>
      int
    </td>
    <td>
      Коэффициент для режима выделения ЦП.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      created_by
    </td>
    <td>
      str
    </td>
    <td>
      Имя пользователя, создавшего ресурсную группу.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      created_timestamp
    </td>
    <td>
      int
    </td>
    <td>
      Unix-время создания.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      created_datetime
    </td>
    <td>
      str
    </td>
    <td>
      Дата и время создания.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      default_net_id
    </td>
    <td>
      int
    </td>
    <td>
      Уникальный целочисленный идентификатор сети по умолчанию в данной ресурсной группе.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      default_net_type
    </td>
    <td>
      str
    </td>
    <td>
      Тип сети по умолчанию в данной ресурсной группе.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      deleted_by
    </td>
    <td>
      str
    </td>
    <td>
      Имя пользователя, удалившего ресурсную группу.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      deleted_timestamp
    </td>
    <td>
      int
    </td>
    <td>
      Unix-время удаления.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      deleted_datetime
    </td>
    <td>
      str
    </td>
    <td>
      Дата и время удаления.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      description
    </td>
    <td>
      str
    </td>
    <td>
      Текстовое описание ресурсной группы.
    </td>
  </tr>
    <tr>
    <td colspan="6">
      dirty
    </td>
    <td>
      bool
    </td>
    <td>
    </td>
  </tr>
  <tr>
    <td colspan="6">
      grid_id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор ЦОДа.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      guid
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      lock_status
    </td>
    <td>
      str
    </td>
    <td>
      Статус блокировки.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      milestones
    </td>
    <td>
      int
    </td>
    <td>
      Количество событий.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      name
    </td>
    <td>
      str
    </td>
    <td>
      Имя ресурсной группы. Обратите внимание, что это имя уникально только в рамках аккаунта, которому принадлежит данная ресурсная группа.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      quotas
    </td>
    <td>
      dict[str, any]
    </td>
    <td>
      Словарь, описывающий квоты.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      cpu_count
    </td>
    <td>
      int
    </td>
    <td>
      Количество виртуальных процессоров.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      disk_size_gb
    </td>
    <td>
      int
    </td>
    <td>
      Объём дисков в ГБ.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      gpu_count
    </td>
    <td>
      int
    </td>
    <td>
      Количество графических процессоров.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      ext_ip_count
    </td>
    <td>
      int
    </td>
    <td>
      Количество внешних IP-адресов.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      ram_size_mb
    </td>
    <td>
      float | int
    </td>
    <td>
      Объём оперативной памяти в МБ.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      storage_size_gb
    </td>
    <td>
      int
    </td>
    <td>
      Объём дисков.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      storage_policies
    </td>
    <td>
      list[dict[str, int]]
    </td>
    <td>
      Список словарей, описывающий квоты по политикам хранения.
    </td>
  </tr>
  <tr>
    <td></td>
    <td></td>
    <td colspan="4">
      id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор политики хранения.
    </td>
  </tr>
  <tr>
    <td></td>
    <td></td>
    <td colspan="4">
      storage_size_gb
    </td>
    <td>
      int
    </td>
    <td>
      Объём дисков.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      resource_types
    </td>
    <td>
      list[str]
    </td>
    <td>
      Список разрешённых типов ресурсов.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      sdn_access_group_id
    </td>
    <td>
      str
    </td>
    <td>
      Идентификатор группы доступа SDN.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      secret
    </td>
    <td>
      str
    </td>
    <td>
    </td>
  </tr>
  <tr>
    <td colspan="6">
      sep_pools
    </td>
    <td>
      list[str]
    </td>
    <td>
      Список доступных пулов СХД.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      status
    </td>
    <td>
      str
    </td>
    <td>
      Статус.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      storage_policy_ids
    </td>
    <td>
      list[int]
    </td>
    <td>
      Идентификаторы политик хранения.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      updated_by
    </td>
    <td>
      str
    </td>
    <td>
      Имя пользователя, обновившего ресурсную группу.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      updated_timestamp
    </td>
    <td>
      int
    </td>
    <td>
      Unix-время обновления.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      updated_datetime
    </td>
    <td>
      str
    </td>
    <td>
      Дата и время обновления.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      vins_ids
    </td>
    <td>
      list[int]
    </td>
    <td>
      Список идентификаторов внутренних сетей ресурсной группы.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      vm_features
    </td>
    <td>
      list[str]
    </td>
    <td>
      Список дополнительных возможностей гипервизора, доступных ВМ.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      vm_ids
    </td>
    <td>
      list[int]
    </td>
    <td>
      Список идентификаторов виртуальных машин ресурсной группы.
    </td>
  </tr>
</table>

## Пример использования модуля decort_rg

В данном примере показано, как создать ресурсную группу по имени MyRG в аккаунте MyAccount.

```
- 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"
    account_name: "MyAccount"
    rg_name: "MyRG"
    state: present
  register: my_rg
  delegate_to: localhost
```

В данном примере показано, как создать ресурсную группу по имени MyRG в аккаунте MyAccount, также задать квоты и выдать права на чтение пользователю MyUser.

```
- 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"
    account_name: "MyAccount"
    rg_name: "MyRG"
    access:
      action: "grant"
      user: "MyUser"
      right: "R"
    quotas:
      cpu: 16
      ram: 16384
      disk: 100
      ext_ips: 20
      storage_policies:
        - id: "{{ storage_policy_id }}"
          storage_size_gb: "{{ storage_size_gb }}"
    state: present
  register: my_rg
  delegate_to: localhost
```

В данном примере показано, как выдать доступ на чтение и запись пользователю MyUser в ресурсной группе по имени MyRG в аккаунте MyAccount.

```
- 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"
    account_name: "MyAccount"
    rg_name: "MyRG"
    access:
      action: "grant"
      user: "MyUser"
      right: "RCX"
    state: present
  register: my_rg
  delegate_to: localhost
```

В данном примере показано, как сменить квоту в ресурсной группе по имени MyRG в аккаунте MyAccount.

```
- 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"
    account_name: "MyAccount"
    rg_name: "MyRG"
    quotas:
      cpu: 16
      ram: 16384
      disk: 100
      ext_ips: 20
      storage_policies:
        - id: "{{ storage_policy_id }}"
          storage_size_gb: "{{ storage_size_gb }}"
    state: present
  register: my_rg
  delegate_to: localhost
```

В данном примере показано, как изменить сеть по умолчанию в ресурсной группе по имени MyRG в аккаунте MyAccount.

```
- 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"
    account_name: "MyAccount"
    rg_name: "MyRG"
    def_netType: "PRIVATE"
    def_netId: 99
    state: present
  register: my_rg
  delegate_to: localhost
```

В данном примере показано, как переименовать ресурсную группу по имени MyRG на новое имя "NewRg" в аккаунте MyAccount.

```
- 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"
    account_name: "MyAccount"
    rg_name: "MyRG"
    rename: "NewRg"
    rg_id: 27
    state: present
  register: my_rg
  delegate_to: localhost
```

В данном примере результат работы модуля decort_rg записывается в переменную my_rg.

Модули DECORT, которым для работы требуется ресурсная группа, в качестве одного из параметров, как правило, принимают идентификатор `rg_id`. Так, например, используя модуль `decort_vm` для создания виртуального сервера необходимо указать ресурсную группу, к которой будет принадлежать этот виртуальный сервер. Сделать это можно следующим образом:

```
   <прочие детали опущены>
   rg_id: "{{ my_rg.facts.id }}"
```

В данном примере показано, как изменить доступные пулы СХД в ресурсной группе по имени MyRG в аккаунте MyAccount.

```
- name: change available sep pools
  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"
    account_name: "MyAccount"
    rg_name: "MyRG"
    sep_pools:
      - sep_id: 1
        pool_names:
          - sep1_pool1
          - sep1_pool2
      - sep_id: 2
        pool_names:
          - sep2_pool1
    state: present
  register: my_rg
  delegate_to: localhost
```