Документация
Назначение
Service Desk это программа для автоматизации службы поддержки: приём и обработка обращений, инцидентов, запросов на обслуживание, проблем и изменений, контроль сроков по соглашениям об уровне услуг, каталог услуг, база знаний и реестр конфигурационных единиц. Программа устанавливается в контур организации, в том числе в закрытый контур без выхода в интернет. Полный перечень функций приведён на странице «Возможности»
Требования к инфраструктуре
Состав и мощность узлов рассчитываются под профиль нагрузки организации
| Элемент | Требование |
|---|---|
| Среда выполнения | Среда оркестрации контейнеров. Допускается развёртывание в среде виртуализации организации |
| Хранилища | Реляционное (PostgreSQL), колоночное (ClickHouse), объектное хранилище S3, хранилище значений в памяти, шина событий |
| Публикация | Входной контроллер с завершением защищённого соединения. Прикладные службы во внешнюю сеть не публикуются |
| Клиентское место | Современный браузер. Установка программ на рабочее место не требуется |
| Внешние зависимости | Лицензионные серверы и облачные сервисы не нужны, исходящие соединения закрываются сетевыми правилами |
Установка и развёртывание
Развернуть продукт можно по переданной документации силами, не участвовавшими в его разработке
| Этап | Содержание |
|---|---|
| Состав поставки | Контейнерные образы служб и клиентского приложения, миграции базы данных, манифесты развёртывания, значения параметров, снимок настройки, документация |
| Развёртывание | Пространство имён и сетевые правила, инфраструктурные компоненты, миграции, запуск служб, область аутентификации, контрольные проверки |
| Обновление | Замена контейнерных образов с применением миграций до запуска служб. Настройки хранятся в базе данных и сохраняются |
| Масштабирование | Горизонтальное за счёт числа экземпляров служб, вертикальное за счёт ресурсов узлов хранилищ |
| Резервное копирование | База данных, содержимое объектного хранилища и описание области аутентификации. Порядок восстановления документирован |
Эксплуатационная документация
Документы, содержащие параметры доступа и сведения о защите, выдаются по запросу
Описание функциональных характеристик
Назначение, состав и возможности программы
Руководство пользователя
Работа специалиста и заявителя: регистрация, обработка, портал
Руководство администратора
Настройка процессов, справочников, доступа, каналов, отчётности
Порядок развёртывания и сопровождения
Состав поставки, установка, обновление, резервное копирование
Спецификация программных интерфейсов
Около 490 операций в формате OpenAPI с кодами ошибок
Описание интеграций
Механизмы обмена, форматы, журнал обменов, поведение при отказах
Регламент сопровождения
Классы обращений, сроки реакции и устранения, эскалация
Программные интерфейсы
Внешние системы регистрируют и изменяют записи по протоколу HTTPS с маркером доступа. Описано около 490 операций по более чем 300 адресам в формате OpenAPI: состав запросов и ответов, коды ошибок, примеры вызовов. Спецификация предоставляется по запросу вместе с описанием интеграций
Процессы жизненного цикла программы
Как программа развивается, выпускается и поддерживается
| Процесс | Как устроен |
|---|---|
| Разработка | Изменения проходят проверку кода и автоматические тесты в конвейере сборки, архитектурные решения фиксируются в журнале |
| Выпуск версий | Версии нумеруются последовательно, к каждой формируется перечень изменений |
| Обновление у заказчика | Замена контейнерных образов с миграцией базы данных, настройки сохраняются |
| Устранение ошибок | По обращениям в техническую поддержку, сроки определяются классом обращения |
| Сопровождение | По регламенту технической поддержки и договору сопровождения |
Порядок обращения в поддержку и сроки описаны на странице «Техническая поддержка»
Стороннее программное обеспечение
Компоненты, которые поставляются вместе с программой, и их лицензии. Компонентов с оплатой по числу пользователей, ядер или обращений в составе нет. Шина работает по протоколу Kafka, поэтому её можно заменить другой реализацией протокола без изменения кода
| Компонент | Назначение | Лицензия |
|---|---|---|
| PostgreSQL | Основное реляционное хранилище | PostgreSQL License |
| ClickHouse | Колоночное хранилище витрин и аналитики | Apache 2.0 |
| Valkey | Кеш и короткоживущие данные | BSD-3-Clause |
| MinIO | Объектное хранилище S3 для файлов и вложений | AGPL v3 |
| Redpanda | Шина событий по протоколу Kafka | BSL 1.1 |
| Cube | Слой витрин и отчётности | Apache 2.0 |
| Keycloak | Сервер идентификации, протокол OIDC | Apache 2.0 |
| ClamAV | Проверка вложений | GPL v2 |
| Kubernetes | Оркестрация контейнеров | Apache 2.0 |
Нужен документ, которого здесь нет?
Напишите, какой документ требуется для закупки или проектирования, пришлём