Документация по поддержанию жизненного цикла программного обеспечения - FACETER Облачное видеонаблюдение

Документация по поддержанию жизненного цикла программного обеспечения

Программный комплекс «Faceter Storage»

Разработчик: ООО «Авалаб»

Версия документа: 1.0

Дата: 14 ноября 2025 г.

1. Общие положения

Настоящий документ описывает процессы, обеспечивающие поддержание жизненного цикла программного обеспечения «Faceter Storage», включая:

  • Устранение неисправностей, выявленных в ходе эксплуатации;
  • Совершенствование и модернизацию функциональности;
  • Поддержку работоспособности ПО в штатном и аварийном режимах;
  • Состав, количество и квалификационные требования к персоналу, обеспечивающему сопровождение ПО.

Программный комплекс «Faceter Storage» является серверным модулем, интегрированным в экосистему видеонаблюдения и не имеет собственного пользовательского интерфейса. Взаимодействие с ним осуществляется исключительно через REST API другими компонентами системы (например, веб-интерфейсом управления, мобильным приложением и сервисами обработки событий).

2. Описание жизненного цикла ПО

Жизненный цикл «Faceter Storage» охватывает следующие ключевые фазы:

ЭтапКраткое описание
РазработкаНаписание и тестирование кода в среде Microsoft Visual Studio. Язык программирования — C#. Используемая СУБД — PostgreSQL.
Сборка и доставкаАвтоматизированная сборка Docker-образов через GitLab CI с последующим развертыванием в тестовой и продуктивной средах.
ЭксплуатацияПостоянная работа модуля в составе инфраструктуры заказчика: приём RTSP-потоков, запись, хранение, предоставление видеоданных по API.
Поддержка и сопровождениеТехническая поддержка, исправление ошибок, обновление версий, консультирование администраторов и интеграторов.
МодернизацияРегулярное расширение функциональности на основе требований заказчиков и изменений в технологической среде.
Вывод из эксплуатацииПроцедура архивирования данных, миграции и деактивации сервиса при прекращении использования.

3. Процессы устранения неисправностей

3.1. Выявление и регистрация неисправностей

Неисправности могут быть выявлены:

  • автоматически через систему мониторинга (например, zabbix, graylog);
  • вручную администраторами инфраструктуры или интеграторами;
  • конечными пользователями через обращения в службу поддержки.

Каждое обращение регистрируется в платформе Gitlab с указанием:

  • критичности инцидента;
  • версии ПО;
  • логов и диагностических данных;
  • шагов воспроизведения (если применимо).

3.2. Диагностика и анализ

Аналитик или разработчик проводит:

  • анализ логов приложения и контейнеров;
  • проверку работоспособности зависимостей (PostgreSQL, сетевые подключения к камерам и другим сервисам);
  • воспроизведение инцидента в тестовой среде.

3.3. Устранение и верификация

Исправление реализуется в виде hotfix или включается в плановый релиз.

После исправления проводится:

  • регрессионное тестирование;
  • верификация в тестовой среде;
  • при необходимости — срочное развертывание обновления (CI/CD pipeline).

3.4. Документирование и обратная связь

В отчёт по инциденту включаются:

  • причина возникновения;
  • способ устранения;
  • рекомендации по недопущению подобных случаев.

Заказчику направляется уведомление об устранении неисправности.

4. Процессы совершенствования ПО

4.1. Источники требований к модернизации

  • Обратная связь от заказчиков и пользователей;
  • Технические предложения внутренней команды;
  • Актуализация требований законодательства и стандартов безопасности;
  • Изменение протоколов или форматов взаимодействия с камерами/внешними системами.

4.2. Этапы модернизации

1. Формализация требований — составление технического задания или user story.

2. Планирование — включение задачи в бэклог и roadmap.

3. Разработка и тестирование — реализация в ветке Git, code review, автоматизированное тестирование.

4. Интеграция и релиз — сборка образа через GitLab CI, публикация релиза.

5. Обновление документации — актуализация API-документации, руководств для администраторов.

6. Информирование пользователей — рассылка changelog, инструкции по обновлению.

4.3. Механизм обновления

Обновление осуществляется путём замены Docker-контейнера новой версией.

Совместимость с предыдущими версиями API сохраняется в пределах одного мажорного релиза.

Миграция метаданных базы данных PostgreSQL выполняется автоматически при старте контейнера (с использованием миграционных скриптов).

5. Состав и квалификация персонала, обеспечивающего поддержку жизненного цикла

Для обеспечения бесперебойной эксплуатации и развития ПО «Faceter Storage» задействованы следующие специалисты:

РольКоличествоТребуемая квалификация
Системный администратор / DevOps-инженер1–2– Опыт администрирования Linux-серверов – Навыки работы с Docker, Docker Compose, Kubernetes – Знание принципов CI/CD (GitLab CI – Опыт настройки мониторинга и логирования
Backend-разработчик (C#/.NET)2–3– Глубокое знание C# и .NET 6/8 – Опыт работы с REST API и асинхронной обработкой видеопотоков – Практика интеграции с PostgreSQL – Понимание сетевых протоколов (RTSP, HTTP/HTTPS, TCP/IP)
Тестировщик ПО1– Навыки автоматизированного и ручного тестирования – Опыт тестирования API и нагрузочного тестирования – Работа с Postman, JMeter, pytest и пр.
Технический писатель1 (по необходимости)– Составление технической документации, руководств, API-спецификаций – Опыт работы с OpenAPI/Swagger
Менеджер продукта / проекта1– Управление требованиями и приоритетами доработок – Взаимодействие с заказчиками и внутренней командой

Примечание: При эксплуатации ПО у конечного заказчика требуется как минимум:

Администратор серверной инфраструктуры, знакомый с Docker и базовыми принципами видеонаблюдения;

Оператор системы видеонаблюдения, понимающий процессы добавления камер, настройки архивации и экспорта записей через интегрированные клиентские приложения.

6. Контакты службы технической поддержки

В случае возникновения нештатных ситуаций или вопросов по эксплуатации ПО «Faceter Storage» следует обращаться:

Электронная почта поддержки: support@faceter.cam

Телеграм-бот: https://t.me/FaceterTeam_Bot

7. Заключение

Настоящий документ обеспечивает прозрачность и регламентированность процессов поддержки, сопровождения и развития ПО «Faceter Storage». Все процессы соответствуют отраслевым практикам разработки и эксплуатации серверных микросервисов и ориентированы на обеспечение высокой доступности, масштабируемости и надёжности видеозаписей в составе экосистемы видеонаблюдения.