Техническое описание программы

Содержание

• 1. Общие сведения
  • 1.1. Обозначение и наименование программы
  • 1.2. Назначение программы
  • 1.3. Возможности программы
  • 1.4. Рекомендуемые технические и программные средства
    • 1.4.1. Серверное оборудование
    • 1.4.2. Программное обеспечение
    • 1.4.3. Требования к каналам связи
  • 1.5. Режим работы программы
    • 1.5.1. Штатный режим
    • 1.5.2. Сервисный режим
    • 1.5.3. Аварийный режим
    • 1.5.4. Остановка
  • 1.6. Используемые языки программирования
  • 1.7. Требования к персоналу
    • 1.7.1. Требования к системному администратору
    • 1.7.2. Требования к программисту
• 2. Структура Витрины данных
  • 2.1. Составные части Витрины данных
    • 2.1.1. Основные компоненты
    • 2.1.2. Дополнительные компоненты
    • 2.1.3. Операционная система
  • 2.2. Модули Витрины данных
    • 2.2.1. ПОДД-адаптер — Модуль исполнения запросов
      • 2.2.1.1. Общее описание
        • 2.2.1.1.1. Общая схема взаимодействия через ПОДД-адаптер- Модуль исполнения запросов
        • 2.2.1.1.2. Процесс обработки запроса через ПОДД-адаптер- Модуль исполнения запросов
    • 2.2.2. ПОДД-адаптер — Модуль MPPR
      • 2.2.2.1. Общее описание
        • 2.2.2.1.1. Общая схема взаимодействия
        • 2.2.2.1.2. Процесс обработки запроса через Модуль MPPR
    • 2.2.3. Модуль подписок
      • 2.2.3.1. Общее описание
    • 2.2.4. CSV-uploader
      • 2.2.4.1. Общее описание
        • 2.2.4.1.1. Общая схема взаимодействия через CSV-uploader
  • 2.3. Состав компонентов в дистрибутиве
  • 2.4. Cвязи между составными частями
  • 2.5. Связи с другими программами
  • 2.6. Карта портов
• 3. Архитектура Витрины данных
  • 3.1. Общая архитектурная схема
  • 3.2. Общая компонентная схема
  • 3.3. Схема развертывания
  • 3.4. Описание логической структуры
• 4. Описание технических решений
  • 4.1. Задачи реализованных технических решений
    • 4.1.1. Задача «Упрощение процесса установки»
    • 4.1.2. Задача «Создание структуры таблиц витрины»
    • 4.1.3. Задача «Выгрузка шаблона»
    • 4.1.4. Задача «Загрузка данных в витрину»
      • 4.1.4.1. Загрузка данных через графический интерфейс (CSV-файлы)
      • 4.1.4.2. Загрузка данных через REST API
      • 4.1.4.3. Загрузка данных через файловый обмен
    • 4.1.5. Настройка параметров работы витрины через графический интерфейс
    • 4.1.6. Задача «Журналирование событий функциональных блоков»
    • 4.1.7. Задача «Мониторинг информации о работоспособности экземпляра программы»
    • 4.1.8. Задача «Совместимость Типового ПО Витрина данных конфигурации Лайт с РЕД ОС версии 7.2»
    • 4.1.9. Задача «Совместимость Типового ПО Витрина данных конфигурации Лайт с АЛЬТ Сервер 8 СП»
    • 4.1.10. Задача «Совместимость Типового ПО Витрина данных конфигурации Лайт с Astra Linux 1.7»
      • 4.1.10.1. Описание тестирования процесса развертывания витрины данных на серверах с предустановленной операционной системой Astra Linux
      • 4.1.10.2. Описание регрессионного тестирования функционирования витрины данных без подключения к ПОДД на серверах с предустановленной операционной системой Astra Linux
      • 4.1.10.3. Описание подготовки отчетов о регрессионном тестировании витрины данных на серверах с предустановленной операционной системой Astra Linux
      • 4.1.10.4. Описание выполнения необходимых доработок Типового ПО Витрина данных по итогам регрессионного тестирования для обеспечения совместимости с операционными системами Astra Linux
      • 4.1.10.5. Описание подготовки скриптов и проведения нагрузочного тестирования
      • 4.1.10.6. Описание подготовки отчета о результатах нагрузочного тестирования
    • 4.1.11. Выполнение запросов с системными параметрами
      • 4.1.11.1. Общее описание
      • 4.1.11.2. Обработка системных параметров
      • 4.1.11.3. Примеры преобразования запросов
• 5. Вызов и загрузка
• 6. Входные и выходные данные
  • 6.1. Входные данные
  • 6.2. Выходные данные

Руководство по установке

Содержание

• 1. Общие сведения о программе
  • 1.1. Обозначение и наименование программы
  • 1.2. Назначение программы
  • 1.3. Возможности программы
• 2. Подготовка к установке
  • 2.1. Требования к серверу
  • 2.2. Предварительные действия
    • 2.2.1. Установка операционной системы
    • 2.2.2. Создание пользователя
    • 2.2.3. Отключение межсетевого экрана
    • 2.2.4. Отключение SELinux
    • 2.2.5. Выбор часового пояса
    • 2.2.6. Подключение к серверу через SSH-клиент PuTTY
    • 2.2.7. Создание SSH-ключей
    • 2.2.8. Копирование ssh-ключей на сервер
    • 2.2.9. Копирование архива программы
    • 2.2.10. Распаковка архива
    • 2.2.11. Установка Docker
    • 2.2.12. Установка библиотеки python-docker-py
    • 2.2.13. Настройка логирования в Docker
    • 2.2.14. Перезапуск Docker
    • 2.2.15. Добавление пользователя в группу docker
    • 2.2.16. Настройка Ansible
• 3. Установка программы
  • 3.1. Настройка конфигурационного файла
  • 3.2. Установка программы
• 4. Проверка программы
• 5. Обновление программы
  • 5.1. Обновление с версии 1.0.0 до версии 1.0.1
    • 5.1.1. Резервное копирование
    • 5.1.2. Копирование архива с обновлением программы на сервер
    • 5.1.3. Распаковка архива с обновлением
    • 5.1.4. Процесс обновления программы
    • 5.1.5. Проверка обновления программы до версии 1.0.1
  • 5.2. Обновление с версии 1.0.1 до версии выше
    • 5.2.1. Резервное копирование
    • 5.2.2. Копирование архива с обновлением программы на сервер
    • 5.2.3. Распаковка архива с обновлением
    • 5.2.4. Процесс обновления программы
    • 5.2.5. Проверка обновления программы
• 6. Приложение
  • 6.1. Настройка firewall (Iptables)
  • 6.2. Просмотр выполнения загрузки данных в программу
    • 6.2.1. Настройка подключения к базе данных
    • 6.2.2. Проверка загрузки данных в БД

Руководство администратора

Содержание

• 1. Общие сведения о программе
  • 1.1. Обозначение и наименование программы
  • 1.2. Назначение программы
  • 1.3. Возможности программы
  • 1.4. Обеспечивающие технические и программные средства
• 2. Настройка программы
  • 2.1. Настройка на состав технических средств
  • 2.2. Настройка на состав программных средств
    • 2.2.1. Настройка ProStore
    • 2.2.2. Настройка ПОДД-адаптера - Модуль исполнения запросов
    • 2.2.3. Настройка ПОДД-адаптер – Модуль MPPR
    • 2.2.4. Настройка ПОДД-адаптер-Модуль MPPW
    • 2.2.5. Настройка Модуля подписок
    • 2.2.6. Настройка Модуля группировки группировки чанков репликации
    • 2.2.7. Настройка CSV-Uploader
    • 2.2.8. Настройка Агента ПОДД
    • 2.2.9. Настройка взаимодействия программы с Агентом ПОДД
• 3. Запуск и остановка программы
• 4. Резервное копирование
  • 4.1. Плановое резервное копирование информации
  • 4.2. Рекомендации по выполнению резервного копирования
  • 4.3. Контроль результатов резервного копирования
  • 4.4. Внеплановое резервное копирование информационных ресурсов Системы
  • 4.5. Восстановление информации из резервных копий
• 5. Дополнительные возможности
  • 5.1. Логирование
  • 5.2. Проверка версии компонентов
• 6. Сообщения администратору
  • 6.1. Сообщения в ходе установки программы с помощью Ansible
  • 6.2. Сообщения при эксплуатации
• 7. REST API
  • 7.1. Получение данных
  • 7.2. Добавление/изменение данных (1 файл)
  • 7.3. Добавление/изменение данных (несколько файлов)
  • 7.4. Удаление данных (1 файл)
  • 7.5. Удаление данных (несколько файлов)
  • 7.6. Использование Curl для загрузки данных
• 8. Приложение 1
  • 8.1. Настройка firewall (Iptables)
    • 8.1.1. Инструкция по эксплуатации CSV-uploader