ВЫПОЛНЕНИЕ ПРОГРАММЫ ==================== Подготовка к работе ------------------- Запуск "Витрины данных НСУД" осуществляется в автоматическом режиме при запуске операционной системы и от оператора дополнительных действий не требуется. Перед началом работы необходимо выполнить следующие действия: - Получить у системного администратора логин и пароль для подключения к серверу. - Получить у системного администратора учетные записи для подключения к БД. - Получить SSH-ключи. - Установить клиентское приложение для управления базами данных – DBeaver (версия 7.3.4 и выше). - Установить :term:`JDBC-драйвер`. - Установить ftp-клиент :term:`FileZilla`. - Проверить подключение к базам данных сервера. - Проверить подключение к серверу по протоколу :term:`SSH`. Настройка подключения к базам данных ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Для подключения к базам данных сервера необходимо выполнить следующие действия: - получить у системного программиста учетные записи для доступа к базам данных; - установить и настроить программу :term:`DBeaver` (менеджер баз данных); - установить и настроить :term:`JDBC-драйвер` для работы с базами данных «Витрины данных НСУД»; - выполнить проверку подключения к базам данных. Установка программы DBeaver ^^^^^^^^^^^^^^^^^^^^^^^^^^^ :term:`DBeaver` — это бесплатное программное обеспечение с открытым исходным кодом для управления базами данных (БД). Для взаимодействия с реляционными БД в программе используется программный интерфейс :term:`JDBC` (через :term:`JDBC-драйвер`). С помощью программы :term:`DBeaver` оператор может выполнить следующие действия: - настроить доступ и подключится к БД; - проверить работоспособность БД. Для установки :term:`DBeaver` скачайте дистрибутив программы с официального сайта https://dbeaver.io/download/. .. attention:: Необходимо выбрать дистрибутив программы для операционной системы, которая установлена на вашем компьютере. Установка DBeaver для ОС Linux ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ (В данном разделе описан процесс установки DBeaver, в операционную систему Linux Ubuntu, версия 20.04). 1. В строке поиска *Ubuntu Software* введите название программы *DBeaver* (см. рис. ниже). .. figure:: img/image1.png :align: center :alt: Поиск DBeaver Поиск DBeaver 2. В предложенном списке (см.рис. выше) выберите программу DBeaver. 3. В следующем окне запустите установку программы, для этого нажмите кнопку *Install* (см. рис. ниже). .. figure:: img/image2.png :align: center :alt: Установка DBeaver Установка DBeaver 1. Дождитесь окончания процесса копирования файлов (см. рис. ниже). .. figure:: img/image3.png :align: center :alt: Процесс копирования файлов программы Процесс копирования файлов программы 2. После завершения копирования файлов на экране монитора отобразится окно об успешной установке программы (см. рис. ниже). .. figure:: img/image4.png :align: center :alt: Завершение установки программы Завершение установки программы Установка DBeaver для ОС Windows ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1. Запустите установочный файл от имени администратора (см. рис. ниже). .. figure:: img/image5.png :align: center :alt: Запуск установочного файла от имени администратора Запуск установочного файла от имени администратора 3. В открывшемся окне (см. рис. ниже) выберите язык установки: .. figure:: img/image6.png :align: center :alt: Выбор языка установки Выбор языка установки 4. В окне «Мастер установки DBeaver Community» нажмите кнопку **Далее** (см. рис. ниже). .. figure:: img/image7.png :align: center :alt: Окно «Мастер установки DBeaver Community» Окно «Мастер установки DBeaver Community» 5. В открывшемся окне «Лицензионное соглашение» нажмите кнопку **Принимаю** (см. рис. ниже). .. figure:: img/image8.png :align: center :alt: Лицензионное соглашение Лицензионное соглашение 6. В окне «Выбор пользователя» выберите пользователей компьютера, которым будет доступна программа и нажмите кнопку **Далее** (см. рис. ниже). .. figure:: img/image9.png :align: center :alt: Выбор пользователя Выбор пользователя 7. В окне «Компоненты устанавливаемой программы» выберите компоненты программы, которые требуется установить (см. рис. ниже) и нажмите кнопку **Далее**. .. figure:: img/image10.png :align: center :alt: Выбор компонентов программы для установки Выбор компонентов программы для установки 8. В открывшемся окне «Выбор папки установки» вы можете выбрать папку установки или оставить путь к папке установки по умолчанию. Чтобы изменить папку установки нажмите кнопку **Обзор** и выберите требуемую папку. Для продолжения установки нажмите кнопку **Далее** (см. рис. ниже). .. figure:: img/image11.png :align: center :alt: Выбор папки установки Выбор папки установки 9. В окне «Папка в меню «Пуск» выберите папку в меню «Пуск», в которую будет помещен ярлык программы или установите маркер в поле «Не создавать ярлыки», в этом случае ярлык программы не будет создан (см. рис. ниже). Нажмите кнопку **Установить** для продолжения процесса установки. .. figure:: img/image12.png :align: center :alt: Выбор папки в меню «Пуск» Выбор папки в меню «Пуск» 10. В окне «Копирование файлов» можно просмотреть процесс установки программы (см. рис. ниже). .. figure:: img/image13.png :align: center :alt: Копирование файлов программы Копирование файлов программы 11. Дождитесь окончания процесса копирования файлов. После завершения процесса установки на экране монитора отобразится окно «Завершение работы мастера установки» (см. рис. ниже). Нажмите кнопку **Готово**. .. figure:: img/image14.png :align: center :alt: Завершение работы мастера установки Завершение работы мастера установки Установка и настройка JDBC-драйвера ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Для дальнейшей работы c программой оператору необходимо настроить подключение к базам данных ПО «Витрина данных НСУД». Для этого необходимо установить и настроить :term:`JDBC-драйвер` Дистрибутив с актуальной версией :term:`JDBC-драйвер` следует запросить у системного программиста. Установка и настройка JDBC-драйвера для ОС Windows ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Чтобы установить :term:`JDBC-драйвер` и настроить подключение к базам данных в программе :term:`Dbeaver`, работающей под операционной системой Windows, выполните следующие действия: 1. Откройте программу :term:`Dbeaver`. 2. В главном меню программы выберите «Базы данных» и нажмите пункт **Управление драйверами** (см. рис. ниже). .. figure:: img/image15.png :align: center :alt: Управление драйверами Управление драйверами 3. В открывшемся окне «Менеджер драйверов» нажмите кнопку **Новый** (см. рис. ниже). .. figure:: img/image16.png :align: center :alt: Окно «Менеджер драйверов» Окно «Менеджер драйверов» 4. В открывшемся окне «Создать драйвер» (см. рис. ниже) заполните следующую информацию: - Имя драйвера: ``DtmDriver``; - Имя класса: ``ru.datamart.prostore.jdbc.Driver``; - Шаблон URL: ``jdbc:prostore://{host}:{port}``. .. figure:: img/image17.png :align: center :alt: Окно «Создать драйвер» Окно «Создать драйвер» 5. Установите маркер в поле «Без авторизации» и «Пустой пароль». 6. Во вкладке «Библиотеки» укажите путь к jar-файлу с :term:`JDBC-драйвер`. .. figure:: img/image17_1.png :align: center :alt: Окно «Библиотека» Окно «Библиотека» 7. Нажмите кнопку «Ок». 8. Проверьте, что драйвер был добавлен в программу. Для этого в окне «Менеджер драйверов» в поисковой строке введите название драйвера – ``DtmDriver`` (см. рис. ниже). .. figure:: img/image18.png :align: center :alt: Поиск DtmDriver в Менеджере драйверов Поиск DtmDriver в Менеджере драйверов Для подключения к базам данных через :term:`JDBC-драйвер`, выполните следующие действия: 1. Откройте :term:`Dbeaver`. 2. В главном меню программы выберите пункт *База данных > Новое соединение*. 3. В окне «Создать соединение» в поисковой строке введите ``dtmjdbc`` (см. рис. ниже). .. figure:: img/image19.png :align: center :alt: Установка нового соединения с базой данных Установка нового соединения с базой данных 4. Нажмите кнопку **Далее** В окне «Настройка базового соединения» (см. рис. ниже) заполните следующие поля: 1. Хост: DNS-name или IP адрес Prostore (172.16.0.17:9090 (имя сервера ``t2-core-service-01.ru-central1.internal``) .. figure:: img/image20.png :align: center :alt: Настройка подключения Настройка подключения 2. Нажмите кнопку **Тест соединения** для проверки подключения. В случае успешного подключение отобразится сообщение о корректном подключении (см. рис. ниже). .. figure:: img/image21.png :align: center :alt: Сообщение об успешном подключении к БД Сообщение об успешном подключении к БД 3. Нажмите кнопку **Готово** Установка и настройка драйвера JDBC-драйвер для Linux ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ (В данном разделе описан процесс установки драйвера в :term:`Dbeaver`, работающий под управлением операционной системы Linux Ubuntu, версия 20.04). Чтобы установить драйвер и настроить подключение к базам данных, выполните следующие действия: 1. Откройте программу :term:`Dbeaver`. 2. В главном меню программы выберите «Database» и нажмите пункт **Driver Manager** (см. рис. ниже). .. figure:: img/image22.png :align: center :alt: Управление драйверами Управление драйверами 3. В открывшемся окне «Driver Manager» нажмите кнопку **New** (см. рис. ниже). .. figure:: img/image23.png :align: center :alt: Окно «Driver Manager» Окно «Driver Manager» 4. В открывшемся окне «Create new driver» (см. рис. ниже) заполните следующую информацию: - Driver Name: ``DtmDriver``; - Class Name: ``ru.datamart.prostore.jdbc.Driver``; - URL Template: ``jdbc:prostore://{host}:{port}``. .. figure:: img/image24.png :align: center :alt: Окно «Create new driver» Окно «Create new driver» 5. Установите маркер в поле «No authentication» и «Allow Empty Password». 6. Во вкладке «Libraries» укажите путь к jar-файлу с :term:`JDBC-драйвер`. 7. Нажмите кнопку **Ок**. 8. Проверьте, что драйвер был добавлен в программу. Для этого в окне «Driver Manager» в поисковой строке введите название драйвера – DtmDriver (см. рис. ниже). .. figure:: img/image25.png :align: center :alt: Окно «Поиск DtmDriver в Driver Manager» Окно «Поиск DtmDriver в Driver Manager» Для подключения к базам данных через :term:`JDBC-драйвер`, выполните следующие действия: 1. Откройте программу :term:`Dbeaver`. 2. В главном меню программы выберите пункт *Database > Connect to a Database*. 3. В окне «Connect to a Database» в поисковой строке введите ``dtmdriver`` (см. рис. ниже). .. figure:: img/image26.png :align: center :alt: Поиск DtmDriver при создании нового подключения Окно Поиск DtmDriver при создании нового подключения 4. Выберите DtmDriver (см. рис. ниже). .. figure:: img/image27.png :align: center :alt: Установка нового соединения с базой данных Установка нового соединения с базой данных 5. В окне «Connection Settings» (см. рис. ниже) заполните следующие поля: - Host: - DNS-name или IP адрес ядра DTM (172.16.0.17:9090 (имя сервера t2-core-service-01.ru-central1.internal) .. figure:: img/image28.png :align: center :alt: Настройка базового подключения Настройка базового подключения 6. Нажмите кнопку «Connection test» для проверки подключения. 7. В случае успешного подключение отобразится сообщение об успешном подключении (см. рис. ниже). .. figure:: img/image29.png :align: center :alt: Сообщение об успешном подключении к БД Сообщение об успешном подключении к БД 8. Нажмите кнопку **Ok**. Настройка подключения к серверу ETL ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Для выполнения работ на сервере, например, для загрузки данных или просмотра log-файлов, необходимо: - установить рекомендуемое программное обеспечение (ftp-клиент) или использовать для подключения режим терминального клиента; - получить SSH-ключи; - получить у системного программиста логин пользователя; - настроить подключение к серверу по протоколу SSH; - выполнить проверку подключения к серверу. Установка и настройка программы FileZilla ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :term:`FileZilla`– ftp-клиент для подключения к серверу. С помощью FileZilla оператор может выполнять следующие действия: - настроить подключение к серверу по протоколу :term:`SSH`; - загружать и просматривать файлы сервера, в соответствии cо своими должностными обязанностями и предоставленными правами; - проверить работоспособность сервера. .. attention:: Перед началом установки программы FileZilla уточните у системного программиста рекомендуемый в вашем ведомстве ftp-клиент. Для установки FileZilla скачайте дистрибутив с официального сайта: https://filezilla.ru/. Необходимо выбрать дистрибутив программы для операционной системы, которая установлена на вашем компьютере. Установка FileZilla для ОС Windows ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1. Запустите установочный файл от имени администратора (см. рис. ниже). .. figure:: img/image30.png :align: center :alt: Запуск установочного файла от имени администратора Запуск установочного файла от имени администратора 2. В открывшемся окне «Лицензионное соглашение» нажмите кнопку **I Agree** (см. рис. ниже). .. figure:: img/image31.png :align: center :alt: Лицензионное соглашение Лицензионное соглашение 1. В окне «Выбор пользователя» выберите пользователей компьютера, которым будет доступна программа и нажмите кнопку **Next** (см. рис. ниже). .. figure:: img/image32.png :align: center :alt: Выбор пользователя Выбор пользователя 4. В окне «Компоненты устанавливаемой программы» выберите компоненты программы, которые требуется установить (см. рис. ниже) и нажмите кнопку **Далее**. .. figure:: img/image33.png :align: center :alt: Выбор компонентов программы FileZilla для установки Выбор компонентов программы FileZilla для установки 5. В открывшемся окне «Выбор папки установки» вы можете изменить папку установки, для этого нажмите кнопку **Browse** и выберите требуемую папку или оставьте путь к папке установки по умолчанию. Для продолжения установки нажмите кнопку **Next** (см. рис. ниже). .. figure:: img/image34.png :align: center :alt: Выбор папки установки FileZilla Выбор папки установки FileZilla 6. В окне «Choose Install Location» выберите папку в меню **Пуск**, в которую будет помещен ярлык программы или установите маркер в поле «Do not create shortcuts», в этом случае ярлык программы не будет создан (см. рис. ниже). Нажмите кнопку **Install** для продолжения процесса установки. .. figure:: img/image35.png :align: center :alt: Выбор папки в меню «Пуск» Выбор папки в меню «Пуск» 7. Дождитесь окончания процесса копирования файлов. После завершения копирования файлов на экране монитора отобразится окно об успешной установке программы (см. рис. ниже). Нажмите кнопку «Finish». .. figure:: img/image36.png :align: center :alt: Завершение работы мастера установки Завершение работы мастера установки Установка FileZilla для ОС Linux ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ (В данном разделе описан процесс установки FileZilla, в операционную систему Linux Ubuntu, версия 20.04). 1. В строке поиска Ubuntu Software введите название программы Filezilla (см. рис. ниже). .. figure:: img/image37.png :align: center :alt: Поиск Filezilla Поиск Filezilla 2. В предложенном списке (см. рис. выше) выберите программу FileZilla. 4. В следующем окне запустите установку программы, для этого нажмите кнопку **Install** (см. рис. ниже). .. figure:: img/image38.png :align: center :alt: Установка программы Установка программы 5. Дождитесь окончания процесса копирования файлов. После завершения копирования файлов на экране монитора отобразится окно об успешной установке программы (см. рис. ниже). .. figure:: img/image39.png :align: center :alt: Завершение установки программы Завершение установки программы Создание SSH-ключей ^^^^^^^^^^^^^^^^^^^ Для подключения к серверу по протоколу SSH оператору необходимо создать SSH-ключи. Для аутентификации пользователя на сервере используются два ключа: приватный и публичный. Публичный ключ хранится на сервере в корневом каталоге, а приватный ключ остаётся на локальном компьютере оператора в зашифрованном виде. После того как оператор создаст пару SSH-ключей (приватный и публичный), публичный ключ следует передать системному программисту. Создание SSH-ключей для ОС Linux ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Чтобы сгенерировать SSH-ключи для операционной системы Linux, выполните следующие действия: 1. Откройте терминал на вашем компьютере и выполните команду: .. code-block:: bash ssh-keygen .. note:: Если команда ssh-keygen не найдена, установите пакет openssh. 1. После выполнения команды вам будет предложено указать имена файлов, в которые будут сохранены ключи и ввести пароль для закрытого ключа. По умолчанию используется имя ``id_rsa``, ключи создаются в директории ``~./ssh``. Публичная часть ключа будет сохранена в файле с названием <имя_ключа>.pub. 2. В окне терминала будет выведено следующее сообщение:: Generating public/private rsa key pair. Enter file in which to save the key (/home/user/.ssh/id_rsa). 3. Нажмите клавишу **Enter** - ключ будет сохранен в указанную директорию по умолчанию. Далее вам будет предложено ввести кодовое слово для дополнительной защиты ключа. Вы можете пропустить данный шаг и нажать **Enter**. 4. Если вы укажете кодовое слово, то при обращении на сервер вам потребуется его вводить. Данный способ позволяет дополнительно защитить ваш приватный ключ. Процедура создания ключей завершена, ключи сохранены в директории ~/.ssh/ в файлах ``id_rsa`` и ``id_rsa.pub``. Приватный ключ (id_rsa) должен храниться на компьютере оператора. Публичный ключ (id_rsa.pub) необходимо передать системному программисту для размещения на том сервере, к которому будет настроен доступ. Создание SSH-ключей для ОС Windows ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Для создания ключей в ОС Windows необходимо установить SSH-клиент :term:`PuTTY`. Для этого выполните следующие действия: 1. Скачайте дистрибутив программы с официального сайта https://www.putty.org/ (ссылка актуальна на момент написания данного документа). 2. Запустите установочный файл. 3. В открывшемся окне нажмите кнопку **Next** (см. рис. ниже). .. figure:: img/image40.png :align: center :alt: Установка программы PuTTY Установка программы PuTTY 4. Выберите папку, в которую будет установлена программа. .. figure:: img/image41.png :align: center :alt: Выбор папки установки программы PuTTY Выбор папки установки программы PuTTY 5. В следующем окне (см. рис. ниже) нажмите кнопку **Install**. .. figure:: img/image42.png :align: center :alt: Выбор пути установки Выбор пути установки 6. Дождитесь окончания процесса копирования файлов. После завершения копирования файлов на экран монитора будет выведено окно об успешной установке программы (см. рис. ниже). .. figure:: img/image43.png :align: center :alt: Окно завершения установки Окно завершения установки 7. Нажмите кнопку **Finish**. 8. Откройте программу для генерации ключа PuTTYgen, которая входит в состав программы :term:`PuTTY`. 9. В открывшемся окне (см. рис. ниже) нажмите кнопку **Generate**. .. figure:: img/image44.png :align: center :alt: Генерация ssh-ключей Генерация ssh-ключей 10. Установите курсор мыши в область для сбора случайных данных (см. рис. ниже). Выполняйте произвольные движения курсором мыши. Индикатор загрузки (зеленая полоса) информирует о процессе формирования ключа. 11. После того как ключ будет создан, программа отобразит информацию о публичном и приватном ключе (см. рис. ниже). .. figure:: img/image45.png :align: center :alt: Окно с информацией о ssh-ключах Окно с информацией о ssh-ключах 12. Скопируйте публичный ключ из области «Key» (см. рис. ниже) и сохраните его на локальном компьютере. 13. Для сохранения приватного ключа нажмите кнопку **Save private key**. .. attention:: Публичный ключ в формате openSSH можно сохранить, только скопировав его вручную. Ключ, сохранённый с помощью кнопки **Save private key**, система Linux не распознаёт. Подключение к серверу через SSH-клиент PuTTY ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SSH-клиент :term:`PuTTY` применяется для удаленного администрирования Linux серверов и подключения к виртуальным серверам по протоколу :term:`SSH`. Перед настройкой программы оператору необходимо: - получить приватный и публичный ключ SSH (см. п. `Создание SSH-ключей`_ ). - передать публичный ключ системному программисту. - получить у системного программиста учетные данные для подключения к серверу. Чтобы настроить подключение к серверу по протоколу SSH выполните следующие действия: 1. Откройте программу :term:`PuTTY`. 2. В поле «Host Name (or IP address)» введите IP-адрес сервера, например:: 172.16.0.11. 3. Во левом меню программы выберите вкладку *Connection > SSH > Auth*. 4. В поле «Private key file for authentication» укажите путь к закрытому ключу. Для этого нажмите кнопку **Browse** и выберите файл с ключом. 5. Нажмите кнопку **Open** (см. рис. ниже). .. figure:: img/image46.png :align: center :alt: Настройка пути к закрытому ключу в программе PuTTY Настройка пути к закрытому ключу в программе PuTTY 6. В открывшемся окне SSH-консоли в поле «login as» введите свой логин, который вам выдал системный программист (см. рис. ниже). .. figure:: img/image47.png :align: center :alt: Окно SSH-консоли программы PuTTY Окно SSH-консоли программы PuTTY 7. Нажмите клавишу **Enter**. Если вы подключаетесь к узлу в первый раз, может появиться предупреждение о неизвестном хосте:: The authenticity of host '130.193.40.101 (130.193.40.101)' can't be established. ECDSA key fingerprint is SHA256:PoaSwqxRc8g6iOXtiH7ayGHpSN0MXwUfWHkGgpLELJ8. Are you sure you want to continue connecting (yes/no)? 8. Введите в терминале слово «yes» и нажмите клавишу **Enter**. Подключение к серверу с помощью программы FileZilla ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Перед настройкой программы оператору необходимо: - получить приватный и публичный ключ SSH (см. п. `Создание SSH-ключей`_ ). - передать публичный ключ системному программисту. - получить у системного программиста учетные данные пользователя для подключения к серверу. Чтобы настроить подключение к серверу по протоколу SSH выполните следующие действия: 1. Откройте программу :term:`FileZilla`. 2. Выберите в главном меню программы пункт *Редактирование > Настройки*. 3. В окне «Настройки», в левом меню выберите «SFTP» и нажмите кнопку **Добавить файл с ключом** (см. рис. ниже). .. figure:: img/image48.png :align: center :alt: Окно «Настройки» Окно «Настройки» 4. В открывшемся окне укажите путь к папке, в которой расположен ваш приватный ключ (файл с расширением **.ppk**). Выберите ключ и нажмите кнопку **Открыть**. 2. При успешной загрузке приватный ключ отобразится в поле «Личные ключи» (см. рис. ниже). .. figure:: img/image49.png :align: center :alt: Добавление личного (приватного) ключа Добавление личного (приватного) ключа Проверка подключения к серверу ETL в программе FileZilla ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Для подключения к серверу выполните следующие действия: 1. Откройте программу :term:`FileZilla`. 2. В главном окне программы, в панели быстрого подключения (см. рис. ниже) введите следующие данные: - **Хост** – введите IP-адрес сервера; - **Имя пользователя** – введите имя пользователя; - **Пароль** – введите пароль пользователя; - **Порт** – укажите порт подключения или оставьте пустым. .. figure:: img/image50.png :align: center :alt: Панель быстрого подключения к серверу Панель быстрого подключения к серверу 3. Нажмите кнопку **Быстрое соединение**. Если подключение произошло без ошибок, в правой области окна будет отображен список файлов и директорий сервера. В случае ошибки подключения, в правой области окна будет отображено сообщение "Не подключен к серверу" (см. рис. ниже). Рекомендуется проверить настройки подключения и повторить попытку. .. figure:: img/image51.png :align: center :alt: Ошибка подключения к серверу Ошибка подключения к серверу Выполнение запросов к базам данных ---------------------------------- Для выполнения запросов к базе данных необходимо выполнить следующие действия: 1. Откройте программу :term:`Dbeaver`. 2. Выполните подключение к базе данных (см. п. `Настройка подключения к базам данных`_ ). 3. В главном окне программы выберите пункт «Редактор SQL > Выполнить SQL-выражение». 4. В открывшемся окне введите :term:`SQL-запрос` к базе данных (см. рис. ниже). .. figure:: img/image52.png :align: center :alt: Выполнение SQL-запросов к базе данных Выполнение SQL-запросов к базе данных 5. В нижней области окна (см. рис. выше) просмотрите результат запроса. Работа с файлами ---------------- Загрузка csv-файлов на сервер ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Для передачи сsv-файла на сервер выполните следующие действия: 1. Откройте программу :term:`FileZilla`. 2. Подключитесь к серверу (см. п. `Проверка подключения к серверу ETL в программе FileZilla`_ ). 3. В левой области окна (локальный сайт) отображаются файлы и директории, на котором запущен клиент :term:`FileZilla` (компьютер оператора). В правой колонке (удаленный сайт) отображаются файлы и директории сервера, к которому вы подключены. 4. В локальной панели (левая область окна) перейдите в директорию, в которой расположен csv-файл. 5. В серверной панели (правая область окна) выберите директорию на сервере, в которую требуется загрузить csv-файл. 6. Подведите курсор мыши к файлу и нажмите правую кнопку мыши и в контекстном меню выберите «Закачать на сервер» (см. рис. ниже). Файл будет загружен на сервер в ту директорию, которая открыта в серверной панели. .. figure:: img/image53.png :align: center :alt: Загрузка файла на сервер Загрузка файла на сервер 7. Убедитесь, что файл был загружен на сервер см. рис. ниже). .. figure:: img/image54.png :align: center :alt: Проверка загрузки файла на сервер Проверка загрузки файла на сервер Скачивание файлов с сервера ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Для скачивания файлов с сервера выполните следующие действия: 1. Откройте программу :term:`FileZilla`. 2. Подключитесь к серверу (см. п. `Проверка подключения к серверу ETL в программе FileZilla`_ ). 3. В левой области окна (локальный сайт) отображаются файлы и директории, на котором запущен клиент :term:`FileZilla` (компьютер оператора). В правой колонке (удаленный сайт) отображаются файлы и директории сервера, к которому вы подключены. 4. В серверной панели (правая область окна) выберите директорию на сервере, в которой расположен файл. 5. В локальной панели (левая область окна) перейдите в директорию, в которую требуется скачать файл. 6. Подведите курсор мыши к файлу на сервере и нажмите правую кнопку мыши. В контекстном меню выберите «Скачать (см. рис. ниже). Файл будет загружен на локальный компьютер в ту директорию, которая открыта в левой (локальной) панели. .. figure:: img/image55.png :align: center :alt: Скачивание файла с сервера Скачивание файла с сервера 7. Убедитесь, что файл был скачен на локальный компьютер (см. рис. ниже). .. figure:: img/image56.png :align: center :alt: Проверка загрузки файла на локальный компьютер Проверка загрузки файла на локальный компьютер Работа в Airflow ~~~~~~~~~~~~~~~~ :term:`Apache Airflow` предназначен для создания, планирования и мониторинга рабочих процессов. Для запуска процесса на сервере, необходимо выполнить следующие действия: - авторизоваться в Apache Airflow; - загрузить dag-файл с описанием процесса; - запустить процесс. После запуска процесса оператор может проверить статус выполнения задачи, перезапустить или удалить процесс (список возможных действий оператора зависит от установленных системным программистом пользовательских прав). Авторизация в Airflow ^^^^^^^^^^^^^^^^^^^^^ Для авторизации в :term:`Apache Airflow` выполните следующие действия: 1. Откройте страницу авторизации < сервер Spark/AirFlow>/login/. 2. В окне авторизации введите свои учетные данные (см. рис. ниже). .. figure:: img/image57.png :align: center :alt: Окно авторизации Окно авторизации 2. Нажмите кнопку **Sign In** При успешной авторизации отобразится главное окно программы (см. рис. ниже). .. figure:: img/image58.png :align: center :alt: Главное окно Spark/Airflow Главное окно Spark/Airflow Загрузка DAG-файла ^^^^^^^^^^^^^^^^^^ dag-файл это файл с задачами, которые требуются выполнить в процессе эксплуатации программы. Выполнять загрузку dag-файл следует в папку:: <сервер_Spark/AirFlow>/airflow/dags Действия оператора по загрузке dag-файл аналогичны действиям описанным в п. `Загрузка csv-файлов на сервер`_ настоящего документа за исключением пути к папке загрузки. .. attention:: Перед началом выполнения операции по загрузке файлов уточните адрес сервера – <сервер_Spark/AirFlow>, у системного программиста. Перезапуск процесса ^^^^^^^^^^^^^^^^^^^ Для перезапуска процесса выполните следующие действия: 1. В главном окне программы выберите в столбце «Dag» процесс, который требуется перезапустить. Для поиска процесса введите его название в строке «Поиск» (см. рис. ниже). .. figure:: img/image59.png :align: center :alt: Поиск в списке процессов Поиск в списке процессов 2. Нажмите кнопку **Обновление**. <<<<<<< HEAD:project_dtm/gost/userguide/chapter_3.rst .. figure:: img/image60.png ======= .. figure:: img/image60.png >>>>>>> 5b4361758de01dc8faf434e1867a3790e6c5ea88:project_dtm/gost/userguide/ug_chapter_3.rst :align: center :alt: кнопка Обновление Кнопка **Обновление** В результате выполненных действий процесс будет перезапущен. Мониторинг статуса выполнения процесса ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Для просмотра статуса обработки активных процессов, выполните следующие действия: 1. В главном окне программы нажмите кнопку **Active** (см. рис. ниже). .. figure:: img/image59.png :align: center :alt: Мониторинг статуса выполнения активных процессов Мониторинг статуса выполнения активных процессов 2. Просмотрите информацию в столбцах: - **Runs** – статус выполненных задач: - **Success** – задача выполнена. - **Running** – задача выполняется. - **Failed** – задача завершена с ошибкой. - **Shedule** – расписание задач. - **Last Run** – время выполнения последней задачи. - **Recent Task** – недавно выполненные задачи. Мониторинг и статистика работоспособности ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Описание возможностей ^^^^^^^^^^^^^^^^^^^^^ Мониторинг и сбор статистических данных о работоспособности компонентов программы «Витрина данных НСУД» позволяет оператору отслеживать потенциальные проблемы до их возникновения. Выбор способов и объектов мониторинга программы определяется на этапе внедрения для каждого ведомства и зависит от конфигурации сети, серверов и других параметров IT-инфраструктуры. Мониторинг информации происходит на основании собранных в лог-файлы данных о занятости вычислительных ресурсов по каждому серверу и их последующему анализу. Рекомендуемые для отслеживания метрики контроля работоспособности программы приведены ниже: - Сеть - Переданные пакеты/байты - Ошибочные/отброшенные пакеты - Коллизии - CPU - Load average (усредненная загрузка) - Простой/использование CPU - Данные утилизации CPU по отдельным процессам - Память - Свободная/использованная память - Утилизация swap/файла подкачки - Диск - Свободное/занятое дисковое пространство - I/O чтения и записи - Служба - Состояние процесса - Использование памяти процессом - Состояние службы (ssh, ntp, ldap, smtp, ftp, http, pop, nntp, imap) - Разрешение DNS - Работоспособность TCP - Время ответа TCP - Файл - Размер/время файла - Существование файла - Контрольная сумма - MD5 хеш - Поиск по регулярному выражению - Журнал - Текстовый журнал - Другое - Время работы системы - Системное время - Подключенные пользователи Периодичность обновления значений метрик и их пороговые значения определяются при внедрении и корректируется в процессе последующей эксплуатации программы, в соответствии с пороговыми значениями нагрузки. Детализация событий в лог-файле ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Обращение к лог-файлу обеспечивает оператора полной информацией о происшедших в системе событиях и позволяет в любой момент времени получить достоверную информацию о конкретном событии и времени, когда оно произошло. События подразделяются на следующие типы: - отладочные; - информационные; - предупреждающие - иные ошибки (в соответствии с классификатором ошибок). Возможные варианты детализации событий устанавливаются системным программистом. В зависимости от установленной детализации оператор может просматривать следующую информацию в лог-файле: - ``ALL`` – вывод всех сообщений. - ``DEBUG`` – отладочная информация. - ``ERROR`` – вывод сообщений об ошибках. - ``FATAL`` – вывод сообщений о критических ошибках, которые приводят к остановке работы приложения. - ``INFO`` – информационные сообщения. - ``TRACE`` – трассировочные сообщения. - ``WARN`` – сообщения-предупреждения в случае возникновения потенциально опасных ситуаций. Скачивание лог-файла с сервера ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Разрешение на скачивание и просмотр лог-файлов программы определяется внутренними регламентами ведомства. В случае, если оператору разрешено просматривать лог-файлы, необходимо выполнить следующие действия: - получить у системного программиста права на доступ к папке с лог-файлами. - скачать лог-файл с сервера. Общий процесс скачивания файлов описан в настоящем документе в разделе 3.3.2. Место хранения. Просмотр информации в лог-файле ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Запись информации в лог-файлы осуществляется в формате .csv. Для просмотра информации откройте файл в тестовом редакторе (например, Блокнот или Notepad++). Для просмотра информации с помощью текстового редактора Notepad++, выполните следующие действия: 1. Скачайте лог-файл на локальный компьютер см. п.3.3.5.3. 2. Запустите программу Notepad++. 3. В главном меню программы выберите пункт *Файл > Открыть*. 4. Выберите файл и нажмите кнопку **Открыть**. 5. Файл будет открыт в отдельной вкладке текстового редактора (см. рис. ниже). .. figure:: img/image62.png :align: center :alt: Просмотр лог-файла в текстовом редакторе Notepad++ Просмотр лог-файла в текстовом редакторе Notepad++ Поиск информации в лог-файле ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Поиск информации в лог-файле позволяет проводить всесторонний анализ происходящих событий в системе, используя различные параметры поиска: время выполнения, имя сервера, тип события и т. д. Оператор имеет возможность осуществлять поиск событий в лог-файле используя встроенные функции текстового редактора. Для поиска информации в лог-файле с помощью программы Notepad++, выполните следующие действия: 1. Откройте лог-файл в программе Notepad++. 2. В главном меню программы выберите пункт *Поиск > Найти*. 3. В открывшемся окне, в поисковой строке введите поисковый запрос, например, введите тип события - «Debug» (Рисунок 62). .. figure:: img/image63.png :align: center :alt: Поиск информации в текстовом редакторе Notepad++ Поиск информации в текстовом редакторе Notepad++ 4. Нажмите кнопку **Найти Далее** Записи, удовлетворяющие условиям поиска, будут выделены зеленым цветом (задать стиль отображения найденных записей можно в настройках программы). Оператор может изменять настройки параметров поиска, например, выполнять поиск с учетом регистра или задавать направление поиска. Проверка работоспособности кластера ETL ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Для проверки работоспособности кластера ETL, требуется выполнить следующие действия: - авторизоваться в Apache Spark; - просмотреть статус работы сервера. Для проверки работоспособности сервера выполните следующие действия: 1. Откройте страницу авторизации <сервер Spark >/login/. 2. В окне авторизации введите свои учетные данные (Рисунок 63). .. image:: img/image64.png Рисунок 63. Окно авторизации в Apache Spark  3. Нажмите кнопку «Log In» При успешной авторизации отобразится главное окно программы (Рисунок 58). .. image:: img/image65.png Рисунок 64. Главное окно Apache Spark 1) В поле «Status» просмотрите статус работы сервера: ALIVE –работает. DEAD – не работает. DECOMISSIONED – отключен. UNKNOWN – состояние неизвестно. Во всех случаях, кроме статуса работы кластера «ALIVE», обратитесь к системному программисту. Контроль результатов резервного копирования ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Контроль результатов выполнения процедур резервного копирования осуществляется оператором в срок до 12:00 рабочего дня, следующего за установленной датой выполнения этих процедур. Контроль результатов резервного копирования производится путем просмотра log-файла и специализированного программного обеспечения. В случае обнаружения сбоя планового резервного копирования оператор должен сообщить об этом системному программисту. Завершение работы с программой ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Завершение работы с программой "Витрина данных НСУД" осуществляется в автоматическом режиме при выключении компьютера и от оператора дополнительных действий не требуется.