# Модуль decort_bservice

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

Базовая служба (Basic Service) это несколько групп виртуальных серверов (compute), создаваемых и управляемых как единое целое.

Все compute(s) в группе имеют одни и те же характеристики (cpu/ram/boot disk size/OS image + сетевые подключения). Для разных групп эти характеристики могут быть разными.

Группы в составе Basic Service могут иметь отношения parent-child с другими группами. Наличие таких отношений определяет последовательность запуска групп ("сначала parents").

На основе ресурсов, предоставляемых и управляемых через Basic Service, могут создаваться другие сервисы. 

`Для взаимодействия с группами виртуальных серверов используется модуль decort_group.`

Модуль decort_bservice предназначен для управления базовыми службами, в которых находятся группы виртуальных серверов.
Данный модуль позволяет:
- Создавать Basic Service
- Удалять Basic Service (безвозвратно).
- Включать/выключать/запускать/останавливать Basic Service
- Запускать Basic Service
- Изменять зону
- Запрашивать информацию о Basic Service.


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

| Параметр | Тип, допустимые значения | Описание |
| ------ | ------ | ------ |
| account_id | (int) | Уникальный целочисленный идентификатор аккаунта, которому принадлежит ресурсная группа. При идентификации базовой службы и ресурсной группы по именам (см. параметры `name` и `rg_name`) должен быть задан либо идентификатор, либо имя аккаунта (см. параметр `account_name`). Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется.|
|account_name | (string) | Имя аккаунта, которому принадлежит ресурсная группа. При идентификации базовой службы и ресурсной группы по именам (см. параметры `name` и `rg_name`) должен быть задан либо идентификатор (см. `account_id`), либо имя аккаунта. Если одновременно заданы и `account_id`, и `account_name`, то `account_name` игнорируется. |
| state | (str)<br>Значения:<br>`absent`<br>`disabled`<br>`enabled`<br>`present`<br>`started`<br>`stopped`| Целевое состояние базовой службы.<br>`absent` - безвозвратно удалена.<br>`disabled` - выключена. Если включена, то будет выключена. Если удалена в корзину, то будет восстановлена из корзины и выключена.<br>`enabled` - включена. Если выключена, то будет включена. Если удалена в корзину, то будет восстановлена из корзины и включена.<br>`present` - существует и не удалена. Если удалена в корзину, то будет восстановлена из корзины.<br>`started` - запущена. Если остановлена, то будет запущена. Если удалена в корзину, то будет восстановлена из корзины и запущена.<br>`stopped` - остановлена. Если запущена, то будет остановлена. Если удалена в корзину, то будет восстановлена из корзины и остановлена.<br>Значение по умолчанию, если объект не найден или безвозвратно удалён: <code>present</code>|
| name | (string) | Имя базовой службы. Данный параметр является обязательным при создании базовой службы и при изменении если не задан `id`. |
| sshuser | (string) | Имя пользователя, который будет создан на всех виртуальных серверах базовой службы. Используется в паре с `sshkey`. |
| sshkey | (string) | SSH ключ, который будет загружен на все виртуальные сервера базовой службы. Используется в паре с `sshuser`. |
| id | (int) | Уникальный целочисленный идентификатор базовой службы. Используется для поиска, изменения и удаления базовой службы. |
| rg_id | (int) | Уникальный целочисленный идентификатор ресурсной группы базовой службы. |
| rg_name | (string) | Имя ресурсной группы базовой службы. |
| zone_id | (int) | Идентификатор зоны. |

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

Модуль decort_bservice возвращает информацию о базовой службе в виде словаря 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">
      base_domain
    </td>
    <td>
      str
    </td>
    <td>
    </td>
  </tr>
  <tr>
    <td colspan="6">
      cpu_count_total
    </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">
      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">
      disk_size_total_gb
    </td>
    <td>
      int
    </td>
    <td>
      Объём дисков в ГБ.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      grid_id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор ЦОДа.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      groups
    </td>
    <td>
      list[dict[str, any]]
    </td>
    <td>
      Список словарей, описывающих группы базовой службы.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      id
    </td>
    <td>
      int
    </td>
    <td>
      Уникальный целочисленный идентификатор группы.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      name
    </td>
    <td>
      str
    </td>
    <td>
      Имя группы.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      status
    </td>
    <td>
      str
    </td>
    <td>
      Статус группы.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      tech_status
    </td>
    <td>
      str
    </td>
    <td>
      Технический статус группы.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      consistency
    </td>
    <td>
      bool
    </td>
    <td>
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      vm_count
    </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">
      milestones
    </td>
    <td>
      int
    </td>
    <td>
      Количество событий.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      name
    </td>
    <td>
      str
    </td>
    <td>
      Имя базовой службы.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      parent_service_id
    </td>
    <td>
      int
    </td>
    <td>
    </td>
  </tr>
  <tr>
    <td colspan="6">
      parent_service_type
    </td>
    <td>
      str
    </td>
    <td>
    </td>
  </tr>
  <tr>
    <td colspan="6">
      ram_size_total_mb
    </td>
    <td>
      int
    </td>
    <td>
      Объём оперативной памяти в МБ.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      rg_id
    </td>
    <td>
      int
    </td>
    <td>
      Уникальный целочисленный идентификатор ресурсной группы, в которой находится базовая служба
    </td>
  </tr>
  <tr>
    <td colspan="6">
      rg_name
    </td>
    <td>
      str
    </td>
    <td>
      Имя ресурсной группы.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      snapshots
    </td>
    <td>
      list[dict[str, any]]
    </td>
    <td>
      Снимки.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      timestamp
    </td>
    <td>
      int
    </td>
    <td>
      Unix-время создания.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      label
    </td>
    <td>
      str
    </td>
    <td>
      Имя снимка.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      valid
    </td>
    <td>
      bool
    </td>
    <td>
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      guid
    </td>
    <td>
      str
    </td>
    <td>
      Идентификатор снимка.
    </td>
  <tr>
    <td colspan="6">
      ssh_public_key
    </td>
    <td>
      str
    </td>
    <td>
      SSH ключ.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      ssh_user_name
    </td>
    <td>
      str
    </td>
    <td>
      SSH имя пользовотеля.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      status
    </td>
    <td>
      str
    </td>
    <td>
      Статус базовой службы.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      tech_status
    </td>
    <td>
      str
    </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">
      user_managed
    </td>
    <td>
      bool
    </td>
    <td>
      Управляется ли пользователем.
    </td>
  </tr>
  <tr>
    <td colspan="6">
      vms
    </td>
    <td>
      list[dict[str, any]]
    </td>
    <td>
      Список, описывающий ВМ, к которым подключена базовая служба.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор ВМ.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      name
    </td>
    <td>
      str
    </td>
    <td>
      Имя ВМ.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      bsgroup_id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор группы базовой службы.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      arch
    </td>
    <td>
      str
    </td>
    <td>
      Архитектура ВМ.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      account_id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор аккаунта.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      rg_id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор ресурсной группы.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      status
    </td>
    <td>
      str
    </td>
    <td>
      Статус ВМ.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      tech_status
    </td>
    <td>
      str
    </td>
    <td>
      Технический статус ВМ.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      node_id
    </td>
    <td>
      int | None
    </td>
    <td>
      Идентификатор физического узла.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      bsgroup_name
    </td>
    <td>
      str
    </td>
    <td>
      Имя группы базовой службы.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="5">
      bsgroup_role
    </td>
    <td>
      str
    </td>
    <td>
      Тег роли.
    </td>
  <tr>
    <td colspan="6">
      zone_id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор зоны.
    </td>
  </tr>
</table>


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

Данный пример создаёт базовую службу с именем databases.

```
  - name: Create Basic Service
    decort_bservice:
      authenticator: jwt
      controller_url: "{{ controller_url }}"
      jwt: "{{ auth_token }}"
      name: databases
      rg_id: "{{ rg_id }}"
    register: db_bservice
```

Данный пример удаляет базовую службу с названием databases.
```
  - name: Delete Basic Service
    decort_bservice:
      authenticator: jwt
      controller_url: "{{ controller_url }}"
      jwt: "{{ auth_token }}"
      state: absent
      name: databases
      rg_id: "{{ rg_id }}"
    register: db_bservice
```