Использование ИИ-агентов для администрирования¶

Для установки, настройки и обслуживания Compass On-premise можно использовать ИИ-агента. Его можно запустить на вашем компьютере с SSH-доступом к серверу или непосредственно на сервере Compass. Вы описываете задачу, а агент читает документацию, выполняет необходимые команды и проверяет результат.

Администрирование с помощью ИИ-агентов доступно начиная с версии Compass On-premise 6.9.4.

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

Возможности¶

С помощью агента можно:

Подготовить сервер и установить Compass по инструкции по развертыванию.
Выполнить обновление серверной части, в том числе в режиме отказоустойчивости.
Настроить сервисы авторизации, например отправку кодов по почте или вход через корпоративную учетную запись.
Настроить SSL-сертификаты.
Настроить собственный TURN-сервер на базе Coturn для аудио- и видеозвонков.
Организовать резервное копирование приложения и баз данных.
Подключить DLP-интеграцию или интеграцию с SIEM-системами.
Настроить автоматическую очистку чатов и ограничение доступа к файлам.
Собрать логи и сведения о состоянии сервисов для обращения в поддержку.

Подготовка к работе¶

Выберите удобный вариант запуска агента. В обоих случаях он должен уметь выполнять команды в терминале и иметь доступ к документации Compass On-premise.

На компьютере¶

Установите и запустите агента на своем компьютере. Для выполнения задач на сервере ему потребуется SSH-доступ.

Заранее создайте на сервере отдельного пользователя для работы агента и задайте ему пароль. У пользователя должен быть доступ к директории установщика и права на выполнение необходимых административных команд через sudo.
Проверьте SSH-подключение с вашего компьютера:
```
ssh <пользователь>@<адрес_сервера>
```
Замените <пользователь> на имя созданного пользователя, а <адрес_сервера> — на IP-адрес или доменное имя сервера. Пароль вводите при подключении, не включайте его в текст задачи.

На сервере¶

Установите CLI-версию агента на сервере Compass. После загрузки установщика подключитесь к серверу по SSH из терминала на своем компьютере, перейдите в директорию установщика и запустите CLI-агента.

Процесс агента работает на сервере, а вы взаимодействуете с ним в терминале на своем компьютере через SSH-сессию. Используйте пользователя с доступом к директории установщика и правами на выполнение необходимых команд через sudo.

Если приложение развернуто в режиме отказоустойчивости, обеспечьте агенту доступ к обоим серверам.

Получение установщика¶

Следующие команды выполняются на сервере Compass. Если вы работаете с компьютера, сначала подключитесь к серверу по SSH. Будет загружен установщик с инструкциями для агента.

Новая установка¶

Загрузите установщик в рекомендуемую директорию /opt от имени пользователя с правом записи в нее:

cd /opt
git clone https://github.com/getCompass/onpremise-installer

Установщик будет находиться в /opt/onpremise-installer.

Если установщик уже загружен¶

Если у вас установлена версия Compass On-premise ниже 6.9.4, выполните команду git pull в директории установщика, чтобы обновить его и получить инструкции для агента.

git pull

Начало работы¶

Если агент запущен на вашем компьютере, укажите сервер, SSH-пользователя и попросите прочитать инструкции:

Подключись к серверу <пользователь>@<адрес_сервера>
и прочитай /opt/onpremise-installer/

Если установщик находится в другой директории, укажите путь к ней. В режиме отказоустойчивости укажите оба сервера.

Если агент работает непосредственно на сервере, запускайте его из директории установщика.

Опишите задачу обычным сообщением. Если для ее выполнения не хватает данных, агент запросит их в ходе работы.

Примеры использования агента¶

Установка Compass¶

Рассмотрим установку серверной части на одном сервере. Установщик уже загружен, а у агента есть SSH-доступ и права на выполнение команд через sudo.

После начала работы с агентом достаточно описать задачу:

Установи Compass On-premise на этом сервере.

Агент сам запросит недостающие данные, например домен и email администратора. После уточнения параметров он выполнит установку по документации:

Проверит параметры установки и подготовит сервер к развертыванию.
Создаст конфигурационные файлы, укажет домен и данные администратора, настроит способ авторизации.
Настроит HTTPS с действующим SSL-сертификатом для указанного домена.
Запустит установку серверной части и выполнит активацию сервера.
Проверит состояние сервисов и доступность страницы авторизации Compass по HTTPS.

В результате на сервере развернута и активирована серверная часть Compass, а по указанному домену открывается страница авторизации. В отчете агента будут перечислены выполненные действия и результаты проверок.

Настройка Coturn¶

Если Compass уже установлен, агенту можно поручить настройку собственного TURN-сервера для аудио- и видеозвонков:

Установи и настрой Coturn для Compass.

Агент сам уточнит недостающие данные и проверит текущие настройки. Если TURN-сервер размещается вместе с Compass, он выберет свободные порты, чтобы сервисы не мешали друг другу.

Сохранит резервные копии конфигурационных файлов.
Установит Coturn по инструкции и настроит его запуск как системного сервиса.
Укажет домен, SSL-сертификат и порты TURN-сервера, создаст секретный ключ авторизации.
Настроит доступ к необходимым портам и укажет параметры TURN-сервера в конфигурации Compass.
Применит настройки и проверит состояние Coturn, сертификат и параметры подключения сервиса звонков.

В результате Coturn запущен, а сервис звонков Compass настроен на его использование. После настройки выполните тестовый аудио- или видеозвонок между двумя участниками и проверьте звук и видео.

Границы возможностей¶

Агент должен выполнять только порученную задачу по опубликованным инструкциям Compass. Изменение внутреннего кода приложения и операции, не описанные в документации или инструкциях агента, в его задачи не входят.

Сбор логов не включает автоматическое исправление проблемы или перезапуск сервисов. Если проблема описана в разделе решения проблем, вы можете отдельно попросить агента выполнить действия из соответствующей инструкции.

Если инструкция не описывает дальнейшие действия или во время работы возникает неожиданная ошибка, агент должен остановить изменения и рекомендовать обратиться в поддержку Compass.

Проверка результата¶

После выполнения задачи ознакомьтесь с отчетом агента и проверьте результат в приложении.

Напишите нам в пространстве поддержки On-premise, Telegram или на почту support@getcompass.ru, чтобы получить индивидуальную демонстрацию функционала и помощь по вопросам интеграции мессенджера в вашей компании.