Быстрая установка серверной части системы Proceset

• Установка приложения Infomaximum на Windows
• Установка приложения Infomaximum на Linux
• Установка аналитической СУБД ClickHouse
• Подключение сервера Proceset к аналитической СУБД ClickHouse

Установка приложения Infomaximum на Windows

Для установки приложения Infomaximum может быть использован сервер под управлением ОС Windows Server 2012R2 (x64) или выше.

Выполните следующие шаги:

1. Запустите переданный вам exe-файл на сервере с правами локального администратора. Откроется окно установщика приложения.
2. Ознакомьтесь с условиями пользовательского соглашения и примите их, поставив галочку в строке Я согласен с Пользовательским соглашением.
3. Нажмите Установить.
4. В процессе установки может появиться запрос на создание разрешающего правила для «Брандмауэра Windows». Разрешите его создание.
5. После завершения процесса установки нажмите Готово.
6. В браузере, используемом по умолчанию, откроется страница для создания учетной записи администратора системы.
7. Заполните поля на странице и нажмите Применить и войти. Указанные данные будут использоваться для входа первого администратора системы в веб-интерфейс.
8. После успешного ввода данных откроется страница для ввода ключа активации системы. Введите переданный вам ключ лицензии и нажмите Активировать.
9. В случае успешной активации откроется веб-интерфейс системы. Приложение установлено и готово к дальнейшей настройке.

Настройка работы приложения Infomaximum на Windows по защищенному протоколу HTTPS

После установки приложения Infomaximum работа с веб-интерфейсом и передача данных от агентов мониторинга происходит по протоколу HTTP. Чтобы настроить передачу данных по защищенному протоколу HTTPS, выполните следующие действия:

1. Подготовьте SSL-сертификат и закрытый ключ для сервера, на котором установлено приложение, в виде pfx-файла (PKCS#12). Допустимо, чтобы в pfx-файл были также включены сертификаты центров сертификации. Важно, чтобы этот сертификат сервера был доверенным на компьютерах, где будут установлены агенты мониторинга и где будет происходить работа с веб-интерфейсом. Для получения сертификата рекомендуем обратиться к администраторам инфраструктуры открытых ключей (PKI) в вашей организации.
2. На сервере отключите службу Infomaximum: нажмите Win+R, откройте services.msc, в открывшемся окне кликните правой кнопкой мыши по Infomaximum и выберите Остановить.
3. Запустите текстовый редактор, например, «Блокнот», от имени администратора и отредактируйте файл конфигурации веб-сервера приложения C:\ProgramData\Infomaximum\config\com.infomaximum.subsystem.frontend.json. Рекомендуется сделать резервную копию файла перед редактированием.
4. Внесите в файл следующие изменения:
   • "protocol":"https" — использование HTTPS
   • "port":443 — укажите порт, на котором будет работать веб-сервер
   • "ssl_cert_store_password":"password" — пароль от pfx-файла. Если пароль пустой, укажите ""
   • "ssl_cert_store":"C:\\ProgramData\\Infomaximum\\certs\\file.pfx" — путь к pfx-файлу. Косую черту необходимо экранировать еще одной косой чертой
   • "url" — используется системой для формирования всех входящих ссылок. Например, на основе параметра создаются ссылки в рассылаемых почтовых сообщениях для сброса пароля и приглашения
5. Сохраните файл.
6. Запустите службу Infomaximum.
7. Проверьте доступность веб-сервера по протоколу HTTPS по указанному порту. Если после запуска возникают затруднения, обратитесь к логу C:\ProgramData\Infomaximum\logs\main.log.

Указание доступного приложению Infomaximum объема оперативной памяти на Windows

Максимальный объем оперативной памяти сервера (ОЗУ), который может использовать приложение Infomaximum, строго определен в параметрах запуска службы.

Чтобы изменить выделенный объем ОЗУ для службы Infomaximum выполните следующие шаги:

1. Откройте Редактор реестра с правами администратора.
2. В редакторе реестра откройте ветку Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Infomaximum.
3. Дважды кликните по ImagePath.
4. В поле Value Data измените параметр -Xmx2G на нужное значение в гигабайтах, например, на -Xmx8G, чтобы выделить 8 Гб памяти.
5. Сохраните изменения и перезапустите службу Infomaximum в оснастке службы или Диспетчере задач.

Установка приложения Infomaximum на Linux

Чтобы установить приложение Infomaximum на Linux выполните следующие действия:

1. Установите на сервер ПО Docker, следуя официальной документации https://docs.docker.com/engine/install/.
2. Загрузите предоставленный архив с Docker-образом на нужный сервер.
3. Распакуйте архив и загрузите его в локальное хранилище образов Docker.
   $ gunzip infomaximum_docker_app_d230809.tar.gz
   

   # docker load < infomaximum_docker_app_d230809.tar
   

   Обратите внимание, что имя образа может отличаться в зависимости от версии.
4. Создайте тома Docker (volume) для постоянного хранения данных работы программы.
   # docker volume create infomaximum-app-data
   

   # docker volume create infomaximum-app-log
   

Запуск приложения Infomaximum с HTTP

Чтобы запустить контейнер с приложением, которое будет работать по HTTP, выполните следующую команду:

# docker run -d --name infomaximum-app \
--mount source=infomaximum-app-data,target=/var/lib/infomaximum/data/ \
--mount source=infomaximum-app-log,target=/var/log/infomaximum/ \
-p 0.0.0.0:8010:8010 -d --restart=always \
dockerhub.office.infomaximum.com/infomaximum/infomaximum_app:d230809

Запуск приложения Infomaximum с HTTP (Swarm)

Чтобы запустить с помощью Swarm контейнер с приложением, которое будет работать по HTTP, выполните следующие действия:

1. Запустите локальный Docker Swarm.
   # docker swarm init --advertise-addr 127.0.0.1:2377 --listen-addr 127.0.0.1:2377
   

2. Создайте службу (service).
   # docker service create --name infomaximum-app \
   --mount type=volume,src=infomaximum-app-data,target=/var/lib/infomaximum/data/ \
   --mount type=volume,src=infomaximum-app-log,target=/var/log/infomaximum/ \
   -e JVM_MAX_MEMORY='4G' \
   --publish published=8010,target=8010,mode=host \
   --limit-memory 30G \
   --limit-cpu 2 \
   --restart-max-attempts 5 \
   --restart-condition "on-failure" \
   dockerhub.office.infomaximum.com/infomaximum/infomaximum_app:d230809
   

Запуск приложения Infomaximum с HTTPS (Swarm)

Чтобы запустить с помощью Swarm контейнер с приложением, которое будет работать по HTTPS, выполните следующие действия:

1. Запустите Docker Swarm.
   # docker swarm init --advertise-addr 127.0.0.1:2377 --listen-addr 127.0.0.1:2377
   

2. Создайте секреты (secrets).
   # docker secret create infomaximum_app_https_certificate ${PATH_FILE}
   

   # echo -n "${PASSWORD_CERTIFICATE}" | docker secret create infomaximum_app_https_certificate_password -
   

   где:
   • ${PATH_FILE} — полный путь к файлу с сертификатом и приватным ключом
   • ${PASSWORD_CERTIFICATE} — пароль к файлу с сертификатом
3. Создайте службу (service).
   # docker service create --name infomaximum-app \
   --secret infomaximum_app_https_certificate \
   --secret infomaximum_app_https_certificate_password \
   --mount type=volume,src=infomaximum-app-data,target=/var/lib/infomaximum/data/ \
   --mount type=volume,src=infomaximum-app-log,target=/var/log/infomaximum/ \
   --publish published=443,target=8010,mode=host \
   --restart-max-attempts 5 \
   --restart-condition "on-failure" \
   -e JVM_MAX_MEMORY='4G' \
   -e FE_URL="https://server-name.domain.com" \
   -e FE_CORS_POLICY="*" \
   infomaximum/infomaximum_app:d230809
   

   Рекомендуется указать порт для веб-интерфейса стандартный для HTTPS — 443. При необходимости можно указать другой порт.
4. В переменной JVM_MAX_MEMORY укажите максимальный объем ОЗУ в гигабайтах, который сможет использовать приложение Infomaximum. Рекомендуется указать значение в пределах 60-90 % от свободного объема ОЗУ на сервере. В переменной FE_URL укажите рабочий URL, который будет использоваться для входа в веб-интерфейс. В переменной FE_CORS_POLICY укажите значение *, чтобы настроить CORS для междоменного обмена данными с любыми сайтами. Для ограничения доступа перечислите через запятую список URL-адресов, с которыми необходим междоменный обмен данными, например, "https://infomaximum.com, https://infomaximum.ru".
5. Приложение запущено. В веб-браузере откройте страницу https://<fqdn-сервера>/ для создания учетной записи администратора системы.

Если страница не открывается:

• Проверьте, что контейнер работает, выполнив команду:
  # docker ps
  

• Обратитесь к логам приложения, выполнив команду:
  # docker service logs -f infomaximum-app
  

• Убедитесь, что с компьютера, где открыт браузер, есть возможность соединения с сервером Proceset, например при помощи telnet.

Установка аналитической СУБД ClickHouse

Для установки аналитической СУБД ClickHouse необходим сервер под управлением ОС семейства Linux с возможностью установки ПО Docker версии 17.06 или выше. Также у сервера (-ов) под управлением Linux, где будет установлена СУБД ClickHouse, должна быть версия ядра:

• 3.15 и выше при использовании файловой системы EXT4
• 4.0 и выше при использовании файловой системы XFS

Если версия ядра ОС не соответствует указанным требованиям, многие функции системы могут быть недоступны или работать нестабильно.

Подготовка сертификата и закрытого ключа для сервера с СУБД ClickHouse

Чтобы передача данных между приложением Proceset и СУБД ClickHouse происходила по защищенному протоколу HTTPS, подготовьте SSL-сертификат и закрытый ключ для сервера, где будет установлена СУБД. Файл сертификата должен быть с расширением .crt, ключ — файл с расширением .key. Формат PEM.

Для получения сертификата обратитесь к администраторам инфраструктуры открытых ключей (PKI) в вашей организации.

Вы также можете использовать самоподписанный сертификат. Ниже приведен пример команды для его генерации при помощи OpenSSL в ОС семейства Linux:

$ openssl req -x509 -nodes -newkey rsa:2048 -days 365 -keyout key.key -out cert.crt \
-subj "/C=RU/ST=./L=./O=./OU=./CN=server-name.domain.com/emailAddress=." \
-addext "subjectAltName = IP:1.1.1.1,DNS:server-name.domain.com"

Запуск Docker-службы СУБД ClickHouse

Дистрибутив СУБД ClickHouse предоставляется в виде Docker-образа. Для установки контейнера с СУБД на сервере Linux выполните следующие действия:

1. Установите на сервер ПО Docker, следуя официальной документации https://docs.docker.com/engine/install/.
2. Загрузите переданный архив с Docker-образом на сервер.
3. Распакуйте архив и загрузите образ в локальное хранилище Docker.
   # gunzip infomaximum_clickhouse-23.3.2.37.tar.gz
   

   # docker load < infomaximum_clickhouse-23.3.2.37.tar
   

4. Если Docker Swarm еще не был инициализирован на сервере, выполните команду запуска.
   # docker swarm init --advertise-addr 127.0.0.1:2377 --listen-addr 127.0.0.1:2377
   

5. Создайте секреты с учетными данными администратора СУБД ClickHouse.
   # echo -n "infomaximum_user" | docker secret create infomaximum_app_user - 
   

   # echo -n "b5w4GDSg36" | sha256sum | awk '{print $1}' | docker secret create infomaximum_app_user_password_hash - 
   

6. Создайте секреты с учетными данными пользователя СУБД ClickHouse с правами только на чтение.
   # echo -n "infomaximum_read_user" | docker secret create infomaximum_external_user -
   

   # echo -n "m26dhdhFdgj" | sha256sum | awk '{print $1}' | docker secret create infomaximum_external_user_password_hash - 
   

7. Создайте секреты с SSL-сертификатом и ключом.
   # docker secret create infomaximum_clickhouse.crt cert.crt 
   

   # docker secret create infomaximum_clickhouse.key key.key
   

   # openssl dhparam 4096 | docker secret create infomaximum_clickhouse_dhparam.pem - 
   

8. Создайте тома Docker (volume) для постоянного хранения данных работы контейнера.
   # docker volume create infomaximum-clickhouse
   

   # docker volume create infomaximum-clickhouse-log
   

9. Создайте службу (service).
   # docker service create --name infomaximum-clickhouse \
   --secret infomaximum_app_user \
   --secret infomaximum_app_user_password_hash \
   --secret infomaximum_external_user \
   --secret infomaximum_external_user_password_hash \
   --secret infomaximum_clickhouse_dhparam.pem \
   --secret infomaximum_clickhouse.crt \
   --secret infomaximum_clickhouse.key \
   --publish published=8123,target=8123,mode=host \
   --mount type=volume,src=infomaximum-clickhouse,target=/var/lib/clickhouse/ \
   --mount type=volume,src=infomaximum-clickhouse-log,target=/var/log/clickhouse-server \
   --restart-max-attempts 5 \
   --restart-condition "on-failure" \
   dockerhub.office.infomaximum.com/infomaximum/infomaximum-clickhouse:23.3.2.37
   

Если служба удачно запущена, результатом выполнения команды должно быть сообщение: verify: Service converged.

Чтобы убедиться, что СУБД работает стабильно, откройте в браузере страницу https://<адрес_сервера>:8123/ping или используйте команду curl https://<адрес сервера>:8123/ping. Если настройка выполнена верно, появится сообщение: ОК.

Если сообщение не появляется:

• Проверьте, что контейнер работает.
  # docker ps
  

• Обратитесь к логам приложения.
  # docker service logs -f infomaximum-clickhouse
  

• Убедитесь, что открыты сетевые проходы до сервера.

Проверьте, не была ли допущена ошибка в шагах запуска, и попробуйте повторить создание службы. Для удаления нерабочей службы используйте команду docker service rm infomaximum-clickhouse.

Подключение сервера Proceset к аналитической СУБД ClickHouse

После установки приложения Infomaximum и СУБД ClickHouse необходимо настроить их соединение. Для этого выполните следующие шаги:

1. Перейдите в Настройки системы и откройте раздел Хранилища данных.
2. На странице хранилищ данных выберите нужное подключение и кликните по нему. Откроется страница настройки подключения.
3. Укажите параметры подключения к СУБД ClickHouse в соответствии с настройками вашего сервера:
   • Название сервера — удобное имя для подключения
   • Хост — FQDN сервера ClickHouse
   • Порт — по умолчанию 8123
   • Имя пользователя — логин администратора СУБД
   • Пароль — администратора СУБД
   • SSL (Вкл/Выкл) — необходимо включить, если ClickHouse работает по HTTPS. При включении SSL вы можете загрузить корневой сертификат, которым подписан сертификат сервера ClickHouse (или самоподписанный, в случае использования)
   • Память на один запрос (МБ) – максимальный объем ОЗУ, выделяемый этим подключением ClickHouse на один SQL-запрос. Рекомендуется указать значение в пределах 40-60 % от общего объема ОЗУ
   • Количество одновременных подключений – допустимое количество открытых сессий сервера Proceset с данным подключением ClickHouse. Рекомендуется оставить значение по умолчанию
   • Размер очереди на выполнение – лимит количества SQL-запросов, ожидающих выполнения. Рекомендуется оставить значение по умолчанию
   • Время сессии (минуты) — указывается количество минут, отведенное на хранение сессии по отдельному SQL-запросу. Рекомендуется оставить значение по умолчанию
4. Нажмите Проверить соединение для тестирования корректности настроек.
5. Если тест соединения прошел успешно, нажмите Сохранить. Подключение выполнено.

Если тест соединения не проходит, обратитесь к логу приложения Infomaximum:

• На Windows: C:\ProgramData\Infomaximum\logs\main.log
• На Linux: var/lib/docker/volumes/infomaximum-app-log/_date/main.log или команда docker service logs infomaximum-app