.. _counter_provider_install:

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

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

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

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

Предусловия выполнения первого запуска новой версии Counter-provider с персистентностью в Prostore 
####################################################################################################

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

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

1. Задать необходимые настройки в конфигурационном файле модуля новой версии.

- При кастомизации шага инкремента номеров счетчиков (``counter.increment-gap``), он устанавливается одинаковым для всех экземпляров модуля.
- При установке ``increment-gap >1`` возможны пропуски генерируемой последовательности значений после обновления или при перезапуске модуля Counter-provider.
2. Опционально - включить выполнение миграции счётчиков из Zookeeper (В конфигурационном файле нового Counter-provider задать настройки подключения к Zookeeper 
   и установить флаг выполнения миграции из Zookeeper).
3. Для обновления выбрать период минимальной прикладной активности.
4. Остановить Counter-provider.
5. Запустить новую версию Counter-provider в одном экземпляре (В случае запуска нескольких экземпляров возможны ошибки при выполнении миграции).

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

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

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

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

Пример файла ``application.yml`` и возможные настройки конфигурации модуля приведены в 
разделе :ref:`counter_provider_config` Руководства администратора Компонента «Витрина данных».

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

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

.. code-block:: bash
  
  scp file.jar user_name@IP:/home/dir

где, 

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