Документация Платформы

Перечень эксплуатационной документации Платформы состоит из следующих документов:

  • Описание функциональных возможностей – содержит перечень, состав и описание основных функциональных возможностей Платформы, перечисленных ниже:
    • управление правами доступа;
    • управление фоновыми задачами;
    • управление уведомлениями в Платформе;
    • проведение аудита;
    • управление окружением;
    • управление подписками;
    • управление настройками;
    • управление почтовыми уведомлениями;
    • хранение информации о пользователях;
    • проверка лицензий микросервисов;
    • управление информацией о микросервисах;
    • управление настройками пользователя;
  • Руководство администратора – содержит общую информацию о Платформе и работе администратора Платформы, включая следующее:
    • назначение Платформы;
    • архитектура Платформы (набор микросервисов);
    • проверка работоспособности Платформы;
    • мониторинг Платформы;
    • обслуживание Платформы;
    • резервное копирование контента и/или связанных метаданных;
    • устранение неисправностей Платформы;
    • авторизация в Платформе;
    • настройка сервиса «Шлюз API» (dh-gateway-api-service);
    • настройка интерфейса Платформы;
    • работа с фильтрацией и поиском (полнотекстовый и атрибутивный поиск);
    • работа с уведомлениями Платформы;
    • работа с почтовыми уведомлениями;
    • работа с подписками;
    • управление окружением;
    • управление настройками (конфигурациями) Платформы;
    • работа с правами доступа, включая следующее:
      • работа с ролями;
      • работа с ресурсами;
      • работа с моделями политик доступа;
      • работа с политиками доступа;
      • работа с ACL;
    • работу с фоновыми задачами (работа с планировщиком);
    • работа по настройке пользователей;
    • работа с информацией о пользователях;
    • работа с сервисом «Аудит» (dh-audit-service);
    • работа с реестром микросервисов;
  • Руководство по установке и конфигурированию – содержит следующую информацию по установке Платформы:
    • системные требования для развертывания Платформы, включая требования к аппаратному обеспечению, операционной системе и внешнему программному обеспечению;
    • установка Платформы в режиме Docker;
    • установка Платформы в режиме Kubernetes (включая описание работы с PostgreSQL, Redis, Keycloak и пути устранения возможных ошибок);
    • чеклист готовности установки Платформы;
    • порядок обновления Платформы в режиме Kubernetes;
    • настройка средств мониторинга Платформы посредством системы Prometheus;
    • сетевые параметры Платформы;
    • механизмы проверки целостности микросервисов Платформы;
    • рекомендации по настройке исключений антивирусного программного обеспечения;
  • Руководство разработчика и описание REST API – содержит информацию об используемых методах REST API в микросервисах Платформы;
  • Состав микросервисов и их описание – содержит перечень и краткое описание микросервисов, входящих в:
    • Платформу;
    • модуль ЛДМ. Конструктор микрофронтов;
    • модуль ЛДМ. Управление бизнес-процессами;
    • модуль ЛДМ. Управление документами;
    • модуль ЛДМ. Управление файлами;
    • модуль ЛДМ. Поиск;
    • модуль ЛДМ. Криптография;
  • Перечень разрешений для микросервисов – содержит UI-разрешения для микросервисов, которые создаются в разделе «Ресурсы» сервиса «Права доступа» Платформы.