Интеграция с внешними системами

По желанию Заказчика возможна настройка интеграции Платформы с системами Заказчика.

Под интеграциями понимается синхронизация информации о пользовательских объектах Платформы с системами (например, CMDB, AD, DNS и прочими), развёрнутыми заказчиком самостоятельно.

Интеграция осуществляется со стороны Платформы посредством вызова REST API специальных сервисов. Специальные сервисы проксируют запросы в сторонние CMDB, AD, DNS соответственно.

Платформа обеспечивает доставку актуальной информации в специальные сервисы с возможной небольшой задержкой (позволяющей, например, без дискомфорта начать вручную использовать по DNS имени созданную вручную ВМ). Специальные сервисы разрабатываются под инфраструктуру Заказчика так, чтобы транслировать вызовы наших API в понятные системам Заказчика форматы и передавать их по корректным адресам.

Платформа выполняет логирование интеграции, логи доступны администраторам по общим правилам доступа к логам в Платформе.

Основные ограничения:

1. Для работы синхронизации CMDB требуется Consul (DCS KV, распределённое хранилище данных типа «ключ»-«значение»). Он используется при синхронизации отправки данных в соответствующий специальный сервис.

2. Для обновления информации в целевых системах в некоторых случаях недостаточно изменения синхронизируемых данных. К таким случаям относятся:

   • Изменение заголовка проекта в IAM.
   • Изменение метаданных корневого диска.
   • Изменение параметров сети (например, IP-адресов).

3. При недоступности специальных сервисов синхронизации или других проблемах обработки изменений синхронизация может не выполниться.

4. Интеграция Kubernetes Ingress с DNS не реализована.

Отправляет данные о ВМ, включающую информацию о дисках и сетях ВМ.

Структурно информация представляет собой один словарь. При создании ВМ словарь отправляется со всеми данными. При изменениях каких-либо объектов, влияющих на информацию о ВМ, посылаемый словарь может содержать только данные, связанные с изменившимися объектами. При удалении ВМ отправляется обновление информации о ВМ с соответствующим статусом.

На информацию о ВМ оказывают влияние следующие действия пользователей:

• Создание / удаление ВМ.
• Изменение объема ВМ.
• Включение / выключение ВМ.
• Подключение / отключение / замена диска.
• Изменение объема диска.
• Подключение / отключение сетевого интерфейса.
• Переименование сетевого интерфейса, в том числе приватного DNS-имени.
• Создание / изменение / масштабирование / удаление объектов PaaS.

Ниже в таблице 1 под настройками понимаются настройки системы синхронизации, доступные к конфигурированию на этапах развёртывания и сопровождения.

Статус ВМ определяется в зависимости от статуса объекта Nova instance (поле OS-EXT-STS:vm_state). Описание приведено ниже в таблице 3.

При любых других статусах выставляется статус «В работе». Все статусы и их соответствия, а также значение по умолчанию настраиваются в конфигурационном файле.

Тип запроса: POST, путь /devicesoftwarehostvms

Запрос посылается после создания ВМ, тело запроса имеет всю информацию о дисках и сетях созданной ВМ.

 
{  "devicesoftwarehostvm": {    "Status": "В работе",    "PlatformID": "1AAAAAA1-2222-BBBB-FFFF-999999999999",    "Project": "demo",    "Contact": "user@example.ru",    "Cluster": "nova",    "RAM": 1,    "CPUCores": 1,    "CPUSockets": 1,    "HDDCurrentValue": 1,    "SoftwareName": "Linux",    "j.network": [      {        "NetworkInterfaceIP": "10.0.0.7",        "NetworkInterfaceMAC": "fa:16:3e:1a:28:69",        "NetworkInterfaceName": "",        "NetworkInterfaceVLAN": "VLAN1085",        "NetworkInterfaceMask": "255.255.255.192"      }    ],    "NetworkName": "demo-test-insta.skf.",    "InstanceType": "TEST",    "ManagementIP": "10.0.0.7"  }}

Описание параметров тела запроса приведено ниже в таблице 4.

В ответе метода используются следующие HTTP-коды:

• 200 — данные успешно отправлены.

Тип запроса: PUT, путь /devicesoftwarehostvms/{platform_id}

Запрос отправляется при каких-либо изменениях в конфигурации ВМ, соответствующей platform_id. В том числе об удалении ВМ, в таком случае в теле запроса будут только PlatformID и Status, соответствующий удалению.

 
curl -X PUT "https://<hostname>/devicesoftwarehostvms/27f14fac-5952-48c1-8d5c-1545d4d2e6b2" -H "accept: application/json"

В методе используются параметры, перечисленные ниже в таблице 5.

В ответе метода используются следующие HTTP-коды:

• 200 — данные успешно отправлены.
• 404 — указанной ВМ не существует.

 
{  "devicesoftwarehostvm": {    "PlatformID": "1AAAAAA1-2222-BBBB-FFFF-999999999999",    "Status": "В работе",    "j.network": [      {        "NetworkInterfaceIP": "10.0.0.7",        "NetworkInterfaceMAC": "fa:16:3e:1a:28:69",        "NetworkInterfaceName": "",        "NetworkInterfaceVLAN": "VLAN1085",        "NetworkInterfaceMask": "255.255.255.192"      }    ],    "NetworkName": "demo-test-insta.skf.",    "InstanceType": "TEST",    "ManagementIP": "10.0.0.7"  }}

 
{  "devicesoftwarehostvm": {    "PlatformID": "27f14fac-5952-48c1-8d5c-1545d4d2e6b2",    "Status": "Остановлен"  }}

Синхронизирует информацию о ВМ в Active Directory (AD).

Структурно информация, передаваемая в AD, состоит из двух словарей с данными о группе (таблица 6) и сервере (таблица 7). При создании ВМ информация создается в AD, а при удалении — удаляется из AD. При изменении Доменного имени (FQDN) — удаляется старая информация и создается новая.

На информацию AD оказывают влияние следующие действия пользователя:

• Создание / удаление ВМ.
• Подключение / отключение сетевого интерфейса.
• Изменение приватного DNS-имени сетевого интерфейса.

Сервис предоставляет методы создания/удаления ВМ и групп AD:

• Создание хоста включает в себя создание группы AD и создание ВМ, которая будет входить в эту группу.
• Удаление хоста включает в себя удаление группы AD и удаление ВМ, которая входила в эту группу.

Все строки в телах запросов имеют формат Unicode.

Тип запроса: POST, путь /login

Авторизация для получения Bearer-токена, который нужен для авторизации остальных запросов.

 
{  "username": "login",  "password": "password"}

Описание параметров тела запроса приведено ниже в таблице 8.

В ответе метода используются следующие HTTP-коды:

• 200 — токен получен.
• 400 — некорректный запрос.
• 401 — отказано в доступе.

 
{  "token": "1mx6L2L7AMdEsyKy5LW9s8gt6mBxdICwosVn5sjhbwykOoQJFUru6752dwsj2THN"}

Тип запроса: POST, путь /api/v1/groups

Создать группу AD для ВМ. Для каждой ВМ создается своя собственная группа.

 
{  "hostname": "project-vm.example.",  "operating_system": "Linux",  "members": [    "member@example.ru"  ]}

Описание параметров тела запроса приведено ниже в таблице 9.

В ответе метода используются следующие HTTP-коды:

• 200 — группа создана.

Тип запроса: DELETE, путь /api/v1/groups/{hostname}

Удаление группы AD, за которым последует удаление ВМ, которая входила в эту группу.

 
curl -X DELETE "https://<hostname>/api/v1/groups/computer1" -H "accept: application/json"

В методе используются параметры, перечисленные ниже в таблице 10.

В ответе метода используются следующие HTTP-коды:

• 200 — удаление группы выполнено.
• 404 — указанной группы не существует.

Тип запроса: POST, путь /api/v1/computer

Создание ВМ, перед которым следовало создание группы AD для данной ВМ.

 
{  "hostname": "project-vm.example.",  "operating_system": "Linux"}

Описание параметров тела запроса приведено ниже в таблице 11.

В ответе метода используются следующие HTTP-коды:

• 200 — создание ВМ выполнено.

Тип запроса: DELETE, путь /api/v1/computer/{hostname}

 
curl -X DELETE "https://<hostname>/api/v1/computer/computer1" -H "accept: */*"

В методе используются параметры, перечисленные ниже в таблице 12.

В ответе метода используются следующие HTTP-коды:

• 200 — удаление ВМ выполнено.
• 404 — указанной ВМ не существует.

Синхронизирует информацию в целевом DNS о ВМ и балансировщиках нагрузки.

Структурно информация, передаваемая в целевые DNS, состоит из словаря (см. ниже таблицу 13). При создании объекта создается DNS-информация, при удалении — удаляется. При изменении — удаляется и создается новая.

Информация DNS синхронизируется:

• Для всех сетевых интерфейсов ВМ:

  • Не принадлежащих настраиваемому списку проектов.

• Для балансировщиков нагрузки LBaaS и Octavia:

  • Созданных на frontend (с заданным пользователем DNS-именем, отличным от стандартного host-<IP>).
  • Балансировщики нагрузки DBaaS.
  • Балансировщики нагрузки k8s API KaaS.

На передаваемую в целевые DNS информацию оказывают влияние следующие действия пользователя:

• Создание / удаление ВМ.
• Подключение / отключение сетевых интерфейсов.
• Изменение DNS-имени сетевых интерфейсов.
• Создание / удаление балансировщика нагрузки.
• Изменение DNS-имени VIP сетевого интерфейса балансировщика нагрузки.
• Создание / масштабирование / удаление PaaS объектов (например, кластеров/инстансов DBaaS, кластеров KaaS).

Тип запроса: POST, путь /login

Авторизация для получения Bearer-токена, который нужен для авторизации остальных запросов.

 
{  "username": "login",  "password": "password"}

Описание параметров тела запроса приведено ниже в таблице 14.

В ответе метода используются следующие HTTP-коды:

• 200 — токен получен.
• 400 — некорректный запрос.
• 401 — отказано в доступе.

 
{  "token": "1mx6L2L7AMdEsyKy5LW9s8gt6mBxdICwosVn5sjhbwykOoQJFUru6752dwsj2THN"}

Тип запроса: POST, путь /api/v1/rr/A/

Запрос для создания записи типа A. Для ВМ используется первый адрес первого сетевого интерфейса, для балансировщика нагрузки — первый адрес VIP порта балансировщика.

 
{  "name": "project-vm.example.",  "value": "192.168.193.7"}

Описание параметров тела запроса приведено ниже в таблице 15.

В ответе метода используются следующие HTTP-коды:

• 200 — запись типа A создана.
• 400 — запись уже существует.

Тип запроса: DELETE, путь /api/v1/rr/A/{fqdn}

Запрос для удаления записи типа A, соответствующей доменному имени fqdn.

 
curl -X DELETE "https://<hostname>/api/v1/rr/A/site1.example.ru." -H "accept: application/json"

В методе используются параметры, перечисленные ниже в linkto(#tab_del_rra_params)[text=таблице %number]}.

В ответе метода используются следующие HTTP-коды:

• 200 — удаление записи типа A выполнено.
• 404 — записи нет / уже удалена.