Установка Компонента
======================

.. note:: Установка витрины данных производится без необходимости доступа к сети Интернет.

.. _install_guide_standart:

Установка Компонента «Витрина данных» конфигурации Стандарт
--------------------------------------------------------------

Порядок установки
~~~~~~~~~~~~~~~~~~~~~

1. Проверить соответствие серверов техническим характеристикам (см. раздел :ref:`hard_soft_ware`).
2. Выполнить предварительные действия перед установкой Компонента (см. раздел :ref:`preactions`).
3. Установить на серверы, в соответствующем порядке, следующее программное обеспечение:

 - Prostore (dtm-query-execution-core);
 - СМЭВ QL Сервер;
 - СМЭВ3-адаптер;
 - BLOB-адаптер;
 - Сервис формирования документов;
 - Стандартный загрузчик;
 - ETL;
 - CSV-Uploader;
 - DATA-Uploader;
 - REST-Uploader;
 - Сервис генерации уникального номера (Counter-Provider);
 - Агент проверок.

4. Проверить работу всех модулей Компонента (см. раздел :ref:`system_check`).

Версии модулей Компонента приведены в :ref:`distr_components` документа «Техническое описание Компонента «Витрина данных»».

Описание настроек модулей приведено в документе «Руководство администратора Компонента «Витрина данных».

.. _prostore_install:

Установка Prostore (dtm-query-execution-core)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Установка Prostore должна осуществляться после установки СУБД.

Prostore поставляется в виде дистрибутива с модулями в jar-файлах (dtm-query-execution-core).

Процесс установки состоит из следующих действий приведен в разделе `Сборка и развертывание <https://prostore.datamart.ru/docs_prostore/getting_started/getting_started.html>`_ 
документации Prostore.

.. note:: Перед установкой Prostore необходимо сверить версию модуля, включенного в дистрибутив, 
               (см. раздел :ref:`distr_components` в документе «Техническое описание Компонента «Витрина данных»») и открыть 
               соответствующую версию документации Prostore для установки соответствующего окружения.

`JDBC-driver <https://prostore.datamart.ru/docs_prostore/connection/connection_via_code/connection_via_code.html>`_ (dtm-jdbc-driver) поставляется совместно с Prostore в релизе Компонента «Витрина данных.

Для переноса системных данных (сервисной БД) из ZooKeeper в Postgres-совместимые СУБД при обновлении кластера Prostore используется
`команда ZK2PG утилиты DTM Tools <https://prostore.datamart.ru/docs_prostore/utility/zk2pg/zk2pg.html>`_.


Установка СМЭВ QL Сервера
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка СМЭВ QL Сервера
.. Подключаем файл с установкой СМЭВ QL Сервера

.. include:: ../../modules/smev-ql/doc/smev_ql_install.rst

Установка СМЭВ3-адаптера
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка СМЭВ-адаптер
.. Подключаем файл с установкой СМЭВ-адаптер

.. include:: ../../modules/smev3-adapter/doc/smev3_adapter_install.rst

Установка BLOB-адаптера
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка BLOB-адаптер
.. Подключаем файл с установкой BLOB-адаптер

.. include:: ../../modules/blob-adapter/doc/blob_adapter_install.rst

Установка сервиса формирования документов
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка Сервис формирования документов
.. Подключаем файл с установкой Сервис формирования документов

.. include:: ../../modules/printable-form-service/doc/printable_form_service_install.rst

Установка стандартного загрузчика
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка стандартного загрузчика
.. Подключаем файл с установкой стандартного загрузчика

.. include:: ../../modules/standard-loader/doc/standard_loader_install.rst

.. Установка утилиты Back Manager
.. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка утилиты Back Manager
.. Подключаем файл с установкой утилиты Back Manager

.. .. include:: ../../modules/backup-manager/doc/backup_manager_install.rst

Установка CSV-Uploader
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка CSV-uploader
.. Подключаем файл с установкой CSV-uploader

.. include:: ../../modules/csv-uploader/doc/csv_uploader_install.rst

Установка DATA-uploder – Модуля исполнения асинхронных заданий
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка Data-uploder – Модуль исполнения асинхронных заданий
.. Подключаем файл с установкой Data-uploder – Модуль исполнения асинхронных заданий

.. include:: ../../modules/data-uploader/doc/data_uploader_install.rst


Установка REST-uploader – Модуля асинхронной загрузки данных из сторонних источников
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка REST-uploader – Модуль асинхронной загрузки данных из сторонних источников
.. Подключаем REST-uploader – Модуль асинхронной загрузки данных из сторонних источников

.. include:: ../../modules/rest-uploader/doc/rest_uploader_install.rst

.. Установка СМЭВ4-адаптера – Модуля подписки
.. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка СМЭВ4-адаптер – Модуль подписки
.. Подключаем файл с установкой СМЭВ4-адаптер – Модуль подписки

.. .. include:: ../../modules/podd-adapter-replicator/doc/podd_adapter_replicator_install.rst

Установка сервиса генерации уникального номера (Counter-Provider)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка Counter-provider
.. Подключаем файл с установкой Counter-provider

.. include:: ../../modules/counter-provider/doc/counter_provider_install.rst

Установка Агента проверок
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. Установка Агента проверок
.. Подключаем файл с установкой Агента проверок

.. include:: ../../modules/check-adapter/doc/check_adapter_install.rst

Установка коннектора Kafka-Postgres
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Из полученного дистрибутива компонента скопируйте и загрузите в папку **kafka-postgres-connector** архив ``kafka-postgres-writer-1.5.0.jar``

2. Скопируйте конфигурационный файл **KAFKA-POSTGRES-WRITER** ``application.yaml`` в папку **kafka-postgres-connector/config**.

.. Dropdown:: Конфигурационный файл **KAFKA-POSTGRES-WRITER**

   .. code-block:: yaml
   
       logging:
       level:
           ru.datamart.kafka: ${LOG_LEVEL:DEBUG}
           org.apache.kafka: ${KAFKA_LOG_LEVEL:INFO}
   
       http:
       port: ${SERVER_PORT:8096}
   
       vertx:
       pools:
           eventLoopPoolSize: ${VERTX_EVENT_LOOP_SIZE:12}
           workersPoolSize: ${VERTX_WORKERS_POOL_SIZE:32}
       verticle:
           query:
           instances: ${QUERY_VERTICLE_INSTANCES:12}
           insert:
           poolSize: ${INSERT_WORKER_POOL_SIZE:32}
           insertPeriodMs: ${INSERT_PERIOD_MS:1000}
           batchSize: ${INSERT_BATCH_SIZE:500}
           consumer:
           poolSize: ${KAFKA_CONSUMER_WORKER_POOL_SIZE:32}
           maxFetchSize: ${KAFKA_CONSUMER_MAX_FETCH_SIZE:10000}
           commit:
           poolSize: ${KAFKA_COMMIT_WORKER_POOL_SIZE:1}
           commitPeriodMs: ${KAFKA_COMMIT_WORKER_COMMIT_PERIOD_MS:1000}
   
       client:
       kafka:
           consumer:
           checkingTimeoutMs: ${KAFKA_CHECKING_TIMEOUT_MS:10000}
           responseTimeoutMs: ${KAFKA_RESPONSE_TIMEOUT_MS:10000}
           consumerSize: ${KAFKA_CONSUMER_SIZE:10}
           closeConsumersTimeout: ${KAFKA_CLOSE_CONSUMER_TIMEOUT:15000}
           property:
               bootstrap.servers: ${KAFKA_BOOTSTRAP_SERVERS:kafka.host:9092}
               group.id: ${KAFKA_CONSUMER_GROUP_ID:postgres-query-execution}
               auto.offset.reset: ${KAFKA_AUTO_OFFSET_RESET:earliest}
               enable.auto.commit: ${KAFKA_AUTO_COMMIT:false}
               auto.commit.interval.ms: ${KAFKA_AUTO_INTERVAL_MS:1000}
   
       datasource:
       postgres:
           database: ${POSTGRES_DB_NAME:test}
           user: ${POSTGRES_USERNAME:dtm}
           password: ${POSTGRES_PASS:dtm}
           hosts: ${POSTGRES_HOSTS:localhost:5432}
           poolSize: ${POSTGRES_POOLSIZE:10}
           preparedStatementsCacheMaxSize: ${POSTGRES_CACHE_MAX_SIZE:256}
           preparedStatementsCacheSqlLimit: ${POSTGRES_CACHE_SQL_LIMIT:2048}
           preparedStatementsCache: ${POSTGRES_CACHE:true}

.. _datacollect:


Установка и настройка сервиса сбора данных запросов и ответов Витрины данных
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Сервис сбора данных запросов и ответов Витрины данных реализован с целью проведения бизнес-мониторинга ИЭП процессов обработки запросов 
Компонентом «Витрина данных», как в целом, так и в части функционирования отдельных витрин для последующей передачи данных в СЦЛ.

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

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

1. Настройка логирования модулей.
2. Установка и настройка Vector.
3. Установка и настройка HaProxy.
4. Установка и настройка fluentbit.
5. Установка ClickHouse.


Настройка логирования модулей
################################

Необходимо настроить формирование логов в формате JSON на стороне модулей:

- BLOB-адаптер;
- СМЭВ3-адаптер;
- Сервис формирования документов.

Для этого необоходимо в файле ``logback.xml`` включить ``net.logstash.logback.encoder.LogstashEncoder``.

.. Dropdown:: Пример logback.xml

   .. code-block:: xml
   
       <?xml version="1.0" encoding="UTF-8"?>
           <configuration>
           <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
               <file>logs/application.log</file>
               <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                   <!-- daily rollover -->
                   <fileNamePattern>logs/application.%d{yyyy-MM-dd}.log</fileNamePattern>
                   <!-- keep 30 days' worth of history capped at 3GB total size -->
                   <maxHistory>30</maxHistory>
                   <totalSizeCap>3GB</totalSizeCap>
               </rollingPolicy>
               <encoder class="net.logstash.logback.encoder.LogstashEncoder" />
           </appender>
   
           <root level="INFO">
               <appender-ref ref="FILE" />
           </root>
       </configuration>
    
`Подробная информация об encoder <https://github.com/logfellow/logstash-logback-encoder>`_

Установка и настройка Vector
################################

Установка производится по `официальной документации Vector <https://vector.dev/docs/setup/installation/>`_

Настройка Vector:

Пример настройки source:

.. code-block:: yaml

    json_source:
        type: fluent
        address: 0.0.0.0:24226

Пример фильтрации сообщений, имеющих флаг ``scl``:

.. code-block:: yaml

    scl_tags_filter:
    type: filter
    inputs:
      - json_source
    condition:
      type: "vrl"
      source: |-
        exists(.tags) && includes(array!(.tags), "TYPE_SCL")

Пример парсинга scl-сообщений:

.. code-block:: yaml

    scl_message_remap:
        type: remap
        inputs:
        - scl_tags_filter
        source: |-
        . = parse_json!(.message)

Пример отправки scl-сообщений в **Kafka**:

.. code-block:: yaml

    podd_agent_sink:
        type: kafka
        inputs:
          - scl_message_remap
        bootstrap_servers: kafka:9092
        topic: "<префикс>.scl.signal"
        acknowledgements: true
        compression: "gzip"
        encoding:
          codec: json
        healthcheck: true


Установка и настройка HaProxy
##################################

Установка производится по `официальной документации HaProxy <http://docs.haproxy.org>`_

Для настройки HaProxy в секции ``backend`` нужно перечислить список установленных инстансов **Vector**.

Пример файла ``haproxy.cfg``:

.. code-block:: bash

    global
        log 127.0.0.1 local2

        chroot /var/lib/haproxy
        pidfile /var/run/haproxy.pid
        maxconn 4000
        user haproxy
        group haproxy
        daemon

        stats socket /var/lib/haproxy/stats

    defaults
        mode tcp
        log global
        retries 3

        maxconn 3000

    listen stats
        bind                 0.0.0.0:1936
        mode                 http
        stats                enable
        stats                uri /

    frontend services
        bind 0.0.0.0:24226
        default_backend services
        mode tcp

    backend services
        balance roundrobin
        mode tcp
        server vector01 vector-01:24226
        server vector02 vector-02:24226


Установка и настройка FluentBit
#####################################
 
Установка производится по `официальной документации FluentBit <https://docs.fluentbit.io/manual/installation/getting-started-with-fluent-bit>`_.

Далее необходимо настроить FluentBit на чтение файлов с логами приложений.

Пример файла конфигурации ``fluent-bit.conf``:

.. code-block:: bash

    [SERVICE]
        flush        5
        daemon       off
        log_level    info
        parsers_file parsers.conf
    [INPUT]
        name tail
        path <путь до лог файла приложения>
        tag *
        parser json
    [OUTPUT]
        name forward
        match *
        host haproxy
        port 24226

Пример файла ``parsers.conf``:

.. code-block:: bash

    [PARSER]
        Name        json
        Format      json

На этом настройка fluentbit завершена.


Включение / выключение отправки сообщений в СЦЛ 
**************************************************

Отправка логов в СЦЛ осуществляется автоматически после корректной настройки сервиса.

Для выключения отправки логов можно закомментировать блок ``podd_agent_sink`` отправки сообщений в Kafka в настройках Vector.    


Установка и настройка ClickHouse
######################################

Установка производится по `официальной документации ClickHouse <https://clickhouse.com/docs/ru/getting-started/install/>`_

Пример задания конфигурационных настроек:

.. code-block:: yaml

   clickhouse_default_config:
   clickhouse:
      logger:
         level: trace
         log: /var/log/clickhouse-server/clickhouse-server.log
         errorlog: /var/log/clickhouse-server/clickhouse-server.err.log
         size: 1000M
         count: 10
      http_port: 8123
      tcp_port: 9000
      listen_host: 0.0.0.0
      max_connections: 4096
      keep_alive_timeout: 3
      user_directories:
         users_xml:
         path: users.xml
         local_directory:
         path: "{{ clickhouse_root_data_folder }}/access/"
      path: "{{ clickhouse_root_data_folder | add_slash }}"   


.. _install_guide_lite:

Установка Компонента «Витрина данных» конфигурации лайт
--------------------------------------------------------------

.. note:: Перед установкой Компонента необходимо обязательно выполнить предварительные действия по настройке (см. раздел :ref:`preactions`). 

Состав модулей дистрибутива и номер версии Компонента приведены в разделе :ref:`distr_components` документа «Техническое описание 
Компонента «Витрина данных».

Требования к серверному оборудованию, телекоммуникационному оборудованию и каналам связи приведены в :numref:`common_info_gd` документа «Техническое описание 
Компонента «Витрина данных»».

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

Чтобы запустить процесс установки Компонента с помощью Ansible, необходимо настроить конфигурационный файл. Для этого выполните следующие действия:

1. Переименовать файл ``custom.example.yml`` расположенный в папке *ansible/group_vars/* в ``custom.yml``. Для этого выполните команду:

.. code-block:: bash 

   cp -n ansible/group_vars/custom.example.yml ansible/group_vars/custom.yml

2. В файле ``custom.yml`` указать корректные значения для следующих переменных:

- ``server_ip`` - адреса сервера. Укажите IP-адрес сервера, на который будет установлено обновление Компонента, например:

.. code-block:: bash 

   server_ip: "172.16.10.59"

Если установка производится локально, то нужно выставить ``server_ip: "localhost"``.

- ``server_user_name`` - имя пользователя операционной системы. Укажите имя пользователя операционной системы сервера, под которым 
  будет производиться установка Компонента (см. раздел :ref:`datamart_user`), например:

.. code-block:: bash 

   server_user_name: datamart

.. _install_lite:

Установка Компонента
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Для установки Компонента выполните команду:

.. code-block:: bash 

   docker-ansible-cmd ansible-playbook -i hosts install.yml


Начнется процесс установки Компонента (см. :numref:`img_progress_install`):

.. _img_progress_install:
.. figure:: img/progress_install_lig.png
         :align: center
         :alt: Процесс установки

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


Установка Компонента завершена. При успешной установке параметр ``failed`` должен иметь значение - ``0`` (см. :numref:`img_progress_install`). 

Это значит, что все компоненты Компонента установлены, а необходимые взаимосвязи между ними настроены корректно.

После установки Компонента следует провести ее проверку.

.. _monitoring_install:

Установка системы мониторинга
--------------------------------

Для мониторинга состояния работы Компонента «Витрина данных» используется связка Grafana + Prometheus.

Prometheus — система мониторинга, обладающая возможностями тонкой настройки метрик. Prometheus используется для отслеживания состояния 
работы компонентов системы на низком уровне.

Grafana — инструмент с открытым исходным кодом для визуализации данных из различных систем сбора статистики. Grafana используется для 
представления в графическом виде временных рядов и текстовых данных.

Для Grafana и Prometheus доступны установки как на Bare metal, так и под Docker.

.. note:: Описание настроек системы мониторинга приведено в разделе :ref:`monitoringset` документа «Руководство администратора Типового ПО «Витрина данных»».

Установка Prometheus на Bare metal
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Подготовка сервера
^^^^^^^^^^^^^^^^^^^^

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

1. Установите пакеты, нужные для работы:

- **wget** - для загрузки файлов;
- **tar** - для распаковки архивов.

В зависимости от системы, команды будут отличаться.


.. tab-set::

   .. tab-item:: на РЕД ОС

      .. code-block:: bash

         yum updateinfo
         yum install wget tar

   .. tab-item:: на Ubuntu

      .. code-block:: bash

         apt update
         apt install wget tar


2. Проверьте, что установлен нужный часовой пояс (описание настройки часового пояса приведено в разделе :ref:`timezoneset`).

3. На фаерволе, при его использовании, откройте порт TCP 9090 — HTTP для сервера Prometheus.

   Используя IPtables откройте порт командой:

.. code-block:: bash

    iptables -I INPUT -p tcp --match multiport --dports 9090 -j ACCEPT

Сохраните правила с помощью iptables-persistent:

.. tab-set::

   .. tab-item:: на РЕД ОС

      .. code-block:: bash

         service iptables save

   .. tab-item:: на Ubuntu

      .. code-block:: bash

        apt install iptables-persistent
        netfilter-persistent save

Установка Prometheus
^^^^^^^^^^^^^^^^^^^^^^

Prometheus не устанавливается из репозитория и имеет не простой процесс установки. 

Необходимо скачать исходник, создать пользователя, вручную скопировать нужные файлы, назначить права и создать юнит для автозапуска.

Загрузка
##############

Для загрузки нужно перейдите на `официальную страницу загрузки <https://prometheus.io/download/>`_, скопируйте ссылку на пакет для 
Linux (желательно, использовать версию LTS) и загрузите пакет командой:

.. code-block:: bash

    wget https://github.com/prometheus/prometheus/releases/download/v2.45.0/prometheus-2.45.0.linux-amd64.tar.gz

.. note:: Если система вернет ошибку, необходимо установить пакет wget.

Установка (копирование файлов)
#################################

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

1. Создайте каталоги, в которые нужно скопировать файлы для Prometheus командой:

.. code-block:: bash

    mkdir /etc/prometheus /var/lib/prometheus

2. Распакуйте архив командой:

.. code-block:: bash

    tar -zxf prometheus-*.linux-amd64.tar.gz

3. Перейдите в каталог с распакованными файлами:

.. code-block:: bash

    cd prometheus-*.linux-amd64

4. Распределите файлы по каталогам:

.. code-block:: bash

    cp prometheus promtool /usr/local/bin/
    cp -r console_libraries consoles prometheus.yml /etc/prometheus

5. Выйдите из каталога и удалите исходник:

.. code-block:: bash

    cd .. && rm -rf prometheus-*.linux-amd64/ && rm -f prometheus-*.linux-amd64.tar.gz

Назначение прав
####################

1. Создайте пользователя, который будет запускать систему мониторинга:

.. code-block:: bash

    useradd --no-create-home --shell /bin/false prometheus

.. note:: Данная команда создает пользователя Prometheus без домашней директории и без возможности входа в консоль сервера.

2. Задайте владельца для каталогов, которые были созданы ранее:

.. code-block:: bash

    chown -R prometheus:prometheus /etc/prometheus /var/lib/prometheus

3. Задайте владельца для скопированных файлов:

.. code-block:: bash

    chown prometheus:prometheus /usr/local/bin/{prometheus,promtool}

Запуск и проверка
######################

1. Запусите Prometheus от одноименного пользователя командой:

.. code-block:: bash

    sudo -u prometheus /usr/local/bin/prometheus --config.file /etc/prometheus/prometheus.yml --storage.tsdb.path /var/lib/prometheus/ --web.console.templates=/etc/prometheus/consoles --web.console.libraries=/etc/prometheus/console_libraries

Система выведет в консоль лог запуска с сообщением в конце:

.. code-block:: bash

    level=info ts=2019-08-07T07:39:06.849Z caller=main.go:621 msg="Server is ready to receive web requests."

2. В браузере введите адрес: ``http://<IP-адрес сервера>:9090`` — в случае успешной установки загрузится консоль Prometheus.

Автозапуск
##############

Для настройки автоматического старта Prometheus нужно создать новый юнит в systemd.

1. Откройте консоль сервера, прервать работу Prometheus с помощью комбинации Ctrl + C и создать файл ``prometheus.service``:

.. code-block:: bash

    vi /etc/systemd/system/prometheus.service

    [Unit]
    Description=Prometheus Service
    Documentation=https://prometheus.io/docs/introduction/overview/
    After=network.target

    [Service]
    User=prometheus
    Group=prometheus
    Type=simple
    ExecStart=/usr/local/bin/prometheus \
    --config.file /etc/prometheus/prometheus.yml \
    --storage.tsdb.path /var/lib/prometheus/ \
    --web.console.templates=/etc/prometheus/consoles \
    --web.console.libraries=/etc/prometheus/console_libraries
    ExecReload=/bin/kill -HUP $MAINPID
    Restart=on-failure

    [Install]
    WantedBy=multi-user.target

2. Разрешите автозапуск:

.. code-block:: bash

    systemctl enable prometheus

3. Запустите службу:

.. code-block:: bash

    systemctl start prometheus

4. Проверьте корректность запуска:

.. code-block:: bash

    systemctl status prometheus


Установка Grafana на Bare metal 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. tab-set::

   .. tab-item:: Установка на РЕД ОС

      1. Создайте файл конфигурации репозитория:

      .. code-block:: bash

         vi /etc/yum.repos.d/grafana.repo

         [grafana]
         name=grafana
         baseurl=https://packages.grafana.com/oss/rpm
         repo_gpgcheck=1
         enabled=1
         gpgcheck=1
         gpgkey=https://packages.grafana.com/gpg.key
         sslverify=1
         sslcacert=/etc/pki/tls/certs/ca-bundle.crt

      2. Установите Grafana командой:

      .. code-block:: bash

         yum install grafana

      3. На вопросы системы, задаваемые в процессе установки выберите ответ: **Y**.

   .. tab-item:: Установка на Ubuntu

      1. Добавьте репозиторий командой:

      .. code-block:: bash

         add-apt-repository "deb https://packages.grafana.com/oss/deb stable main"

      2. Установите ключ для проверки подлинности репозитория Grafana:

      .. code-block:: bash

         wget -q -O - https://packages.grafana.com/gpg.key | apt-key add -

      3. Обновите список портов:

      .. code-block:: bash

         apt update

      4. Установите Grafana:

      .. code-block:: bash

         apt install grafana

      5. На вопросы системы, задаваемые в процессе установки выберите ответ: **Y**.


Настройка брэндмауэра
^^^^^^^^^^^^^^^^^^^^^^^

По умолчанию, Grafana работает на порту 3000. 

 Для возможности подключиться к серверу откройте данный порт командой: 

.. code-block:: bash

    iptables -A INPUT -p tcp --dport 3000 -j ACCEPT


Сохраните правила с помощью iptables-persistent:

.. tab-set::

   .. tab-item:: на РЕД ОС

      .. code-block:: bash

         service iptables save

   .. tab-item:: на Ubuntu

      .. code-block:: bash

        netfilter-persistent save

      .. note:: Eсли при вводе второй команды система выдаст ошибку, нужно установить пакет командой ``apt install iptables-persistent``.

Запуск Grafana
^^^^^^^^^^^^^^^^^

Разрешите автозапуск командой:

.. code-block:: bash

    systemctl enable grafana-server

Запустите сервис:

.. code-block:: bash

    systemctl start grafana-server


Установка Prometheus и Grafana в Docker
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Для этого варианта установки необходимо установить Docker. 

Описание установки Docker приведено в разделе :ref:`docker_install`.

Для того чтобы установить Prometheus и Grafana создайте файл ``docker-compose.yml`` со следующим содержимым:

.. code-block:: bash

  version: '3.3'

  networks:
    monitoring:
      driver: bridge
        
  volumes:
    prometheus_data: {}

  services:
    grafana:
      image: grafana/grafana-enterprise
      container_name: grafana
      restart: unless-stopped
      ports:
        - 3000:3000
    prometheus:
      image: prom/prometheus:latest
      container_name: prometheus
      restart: unless-stopped
      volumes:
        - ./prometheus.yml:/etc/prometheus/prometheus.yml
        - prometheus_data:/prometheus
      command:
        - '--config.file=/etc/prometheus/prometheus.yml'
        - '--storage.tsdb.path=/prometheus'
        - '--web.console.libraries=/etc/prometheus/console_libraries'
        - '--web.console.templates=/etc/prometheus/consoles'
        - '--web.enable-lifecycle'
      ports:
        - 9090:9090
      networks:
        - monitoring

В примере выше указан путь к корневой папке с которой будет запущен docker-compose файл.

Для Prometheus укажите папку в которой будет располагаться файл конфигурации ``prometheus.yml``. 
Пример файла приведен в разделе :ref:`prometheus_config`.

После этого вернитесь на уровень выше, где находится файл ``docker-compose.yml`` и выполнить установку командой:

.. code-block:: bash

    docker-compose up -d

После установки Prometheus будет доступен по адресу http://ip:9090

.. _prometheus_access:
.. figure:: img/prometheus_access.jpg
         :align: center
         :alt: Доступ Prometheus

         Доступ Prometheus

Веб-интерфейс Grafana будет доступен по адресу http://ip:3000. 

Для авторизации введите логин ``viewer`` и пароль ``viewer``.

.. _grafana_auth:
.. figure:: img/grafana_auth.jpg
         :align: center
         :alt: Авторизация в Grafana

         Авторизация в Grafana

Подключение к Агенту СМЭВ4
------------------------------

Установка и настройка Агента СМЭВ4 осуществляется согласно документу «Руководство администратора Агента СМЭВ4».

.. note:: Для сопряжения Компонента «Витрина данных» и ИС УВ с Ядром СМЭВ4 необходимо использовать Агент СМЭВ4 версии не ниже 3.23.0.

Настройка взаимодействия Агента СМЭВ4 с Prostore на стороне Витрины по протоколу HTTP осуществляется в соответствии с разделом 
«Взаимодействие с Витринами данных по HTTP (версия Витрины 2.x)» Руководства администратора Агента СМЭВ4.