.. _smev_ql_install:

Процесс установки
^^^^^^^^^^^^^^^^^^^^

Действия по установке выполняются через SSH консоль технологического пользователя.

Общий процесс установки состоит из следующих действий:

1. Выполнить предусловия для запуска новой версии модуля.
2. Настроить конфигурацию модуля.
3. Создать на сервере директорию для загрузки файлов модуля.
4. Загрузить файлы модуля в созданную директорию.
5. Запустить модуль (Описание процесса запуска приведено в разделе :ref:`quick_start` Руководства администратора Компонента «Витрина данных»).
6. Проверить работу модуля.

.. _smevql_migration:

Предусловия выполнения первого запуска новой версии SMEVQL 
###########################################################

Начиная с версии 2.6.0 хранение данных персистентности модуля осуществляется в снапшот-таблицах Prostore. 
Пересоздание таблиц и миграция данных выполняется автоматически при старте модуля. 


1. Проверить версию Prostore (для работы новой версии SMEVQL (с хранением данных персистентности в Prostore) требуется Prostore версии 7.6 и выше).
2. Проверить тип подключенных датасорсов Prostore (в Prostore данные персистентности хранятся в snapshot-таблицах, которые поддерживаются только типом ADP):

- если все имеющиеся датасорсы с типом ADP, перейти к следующему шагу;
- если нет ни одного ADP-датасорса, то необходимо развернуть СУБД PostgreSQL и настроить подключение к Prostore (при отсутствии ADP использование новой версии SMEVQL невозможно);
- если имеются и ADP, и датасорсы других типов, необходимо в конфигурационном файле SMEVQL задать перечень наименований ADP-датасорсов, используемых для обеспечения персистентности;

3. Для обновления выбрать период минимальной прикладной активности (асинхронные ответы при обновлении витрины не сохраняются).
4. Остановить изменения в витрине - отключить доступ клиентов к загрузчикам /выключить загрузчики данных, чтобы остановить формирование новых пуш-уведомлений.
5. Проверить состав очередей пуш-уведомлений в таблице ``smevqlqueue.reestr_queue``:

- по имеющимся записям проверить отсутствие записей в таблицах ``queue_$agent_target_$resource``;
- дождаться пока очереди будут пустые (очереди пуш-уведомлений при обновлении не сохраняются).
  
6. Остановить SMEVQL.
7. (опционально) в конфигурации новой версии SMEVQL задать настройки подключения к Postgres для выполнения миграции данных таблицы ``push_consumers``.

8. Запустить новую версию SMEVQL в одном экземпляре. В случае запуска в нескольких экземпляров возможны ошибки при выполнении миграции.

После успешного выполнения миграции (модуль запущен, в логах отсутствуют ошибки миграции) выполнить запуск других экземпляров при необходимости.

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

Настройка конфигурации
########################

Настройка конфигурации выполняется путем редактирования параметров файлов:

- ``application.yaml`` - конфигурирует поведение сервера;
- ``credentials.yaml`` - конфигурирует представление сервера.
  
Пример файлов конфигурации и возможные настройки модуля приведены в разделе :ref:`smev_ql_config` Руководства администратора.


Загрузка JAR-файла на сервер
################################

Для загрузки файла на сервер выполните команду::

  scp file.jar user_name@IP:/home/dir

где, 

- ``file.jar`` - название JAR-файла;
- ``user_name`` - имя пользователя, например, ``sudo`` или ``root``;
- ``IP`` - адрес сервера;
- ``/home/dir`` - директория на сервере, в которую будет загружен файл.