Руководство оператора#

Термины и определения#

Термин/Аббревиатура

Определение

EDMS

Сервис управления событийными доменами

LDAP

Lightweight Directory Access Protocol — открытый и кроссплатформенный протокол, используемый для аутентификации служб каталогов

Домен

Логическое объединение продуктов, минимально необходимое для обслуживания потребностей клиентов. Домен наполняется по следующим принципам: сервис передачи событий (EVTD) — 1, сервис потоковой обработки (EVTP) — 0-1, сервис междоменной репликации (SEDR) — 0-N

Контур EDMS

Текстовая метка, обозначающая ландшафт, к которому у данной инсталляции EDMS имеется доступ для развертывания дистрибутивов

Подписка

Получение разрешения на вычитку событий из определенного топика

Публикация

Отправка события в заданный топик заданного домена

Репликация

Передача события из топика домена-источника в топик домена-получателя без изменений

Сегмент EDMS

Текстовая метка, описывающая сетевой сегмент, в котором работает данный экземпляр EDMS

Федерация доменов

объединение доменов по бизнес-направлениям

Доступ к приложению#

Работа с EDMS осуществляется через веб-браузер по ссылке.

  1. При входе в EDMS введите логин и пароль учетной записи пользователя в форме аутентификации и нажмите кнопку Вход:

    Authorization

  2. Получите доступ к EDMS одним из способов:

    • Через назначение роли пользователю оператором с ролью Access Manager.

      Назначение пользователю роли Администратором доступа (оператором с ролью Access Manager) осуществляется с помощью LDAP через стандартный запрос к Access Manager с предоставлением логина пользователя и ролей, которые необходимо ему присвоить. Описание действий оператора Access Manager см. в документе Руководство пользователя Администратор доступа (Access Manager), раздел Сценарии работы.

    • Через стороннюю систему. Для внутрибанковских инсталляций используйте СУДИР.

      В случае использования СУДИР назначение ролей пользователям выполняется функциональным администратором СУДИР после соответствующего распоряжения.

  3. Задайте роль Access Manager в конфигурационном файле application.yml при подготовке к установке конкретного экземпляра EDMS. Пример определения пользователя с ролью Access Manager:

    access:
    manager:
        - login: ivanov-uu
            pass: <зашифрованный пароль>
        - login: petrov-ii
            pass: <зашифрованный пароль>
    can_create: true
    

Авторизация пользователя производится на основании ролей, предоставленных данному пользователю. После авторизации EDMS предоставляет пользователю интерфейс, соответствующий его ролям.

Использование приложения оператором#

Интерфейс и доступная функциональность в EDMS зависят от роли, выданной конкретному оператору EDMS. Панель меню содержит иконки разделов, доступных пользователю. При нажатии на иконку Меню на панели отображаются названия разделов. Например:

Interface menu

В верхней части меню располагается информационная панель, которая содержит следующие данные: Info Board

  1. Сегмент EDMS — текстовая метка, описывающая сетевой сегмент, в котором работает данный экземпляр EDMS.

  2. Контур EDMS — текстовая метка, обозначающая ландшафт, к которому у данной инсталляции EDMS имеется доступ для развертывания дистрибутивов.

  3. Логин текущего пользователя и его роли. Роли отображаются при наведении курсора на иконку пользователя.

  4. Кнопка выхода.

Работа в EDMS может осуществляться с несколькими сегментами на нескольких контурах. В данном руководстве примем следующие условные обозначения:

  • Contour0 — стартовый контур. Является редуцированным, используется для начального создания заявок.

  • Contour1, Contour2 — одинаковые между собой. Являются реальными рабочими ландшафтами.

Роли операторов EDMS#

Роли операторов подразделяются на внедоменные и доменные.

Внедоменные роли не имеют привязки к конкретному домену, могут использоваться для работы на разных доменах или для выполнения внедоменных функций.

Доменные роли назначаются для работы на конкретном домене.

Внедоменные роли#

  • Администратор доступа EDMS (Access Manager) — роль, предназначенная для раздачи других ролей операторам EDMS. Как правило назначается инженерам, отвечающим за эксплуатацию продуктов. Администраторы доступа (Access Manager) назначаются по соответствующему распоряжению. Запрещено совмещение данной роли с другими ролями для оператора EDMS.

    Основные функции, доступные оператору с ролью Администратор доступа (Access Manager): назначение прав для УЗ или согласование прав при авторизации пользователей посредством системы управления доступами к информационным ресурсам (СУДИР).

  • Администратор EDMS (Service Admin) — роль оператора EDMS, предназначенная для настройки EDMS (заполнение и расширение справочников). Роль назначается оператором с ролью Администратор доступа (Access Manager) инженерам, отвечающим за эксплуатацию продуктов (инженерам DevOps). Данная роль может быть совмещена с ролями Editor и Domain Admin.

    Основные функции, доступные оператору с ролью Администратор EDMS (Service Admin):

    • Добавление, редактирование и удаление записей в справочниках.

    • Просмотр журналов внутреннего аудита в разделе Журнал аудита.

    • Добавление новых элементов в справочники топологии (Домены, Репликаторы и т. д.).

    • Запуск инициализации состояния сущностей для осуществления внутреннего аудита после переустановки EDMS.

    • Запуск репликации данных между различными инсталляциями EDMS.

      Реплицируемые данные:

      • справочники;

      • пользователи;

      • заявки и события об откате дистрибутивов.

    • Запуск репликации списков событий между EDMS, размещенными в разных сетевых зонах (сегментах).

  • Пользователь с правами просмотра (Viewer) — гостевая роль, назначается пользователям, которым требуется только просмотр списка событий. Пользователь с правами поиска и просмотра событий в любом домене, но без возможности просмотра, создания и редактирования заявок. Данная роль может быть назначена любой категории пользователей. Не может быть совмещена с другими ролями.

  • Пользователь с правами редактирования (Editor) — роль для создания заявок на публикацию, подписку и репликацию в любом домене, а также просмотра и редактирования заявок, созданных под своей УЗ. Роль назначается следующим категориям пользователей: инженер-разработчик, инженер по тестированию, инженер, отвечающий за эксплуатацию продуктов. Также может быть назначена лидеру подразделения, лидеру продукта, владельцу продукта. Разрешено совмещение с ролями Domain Owner, Domain Admin и Service Admin.

    Основные функции, доступные оператору с ролью Editor:

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

    • просмотр/редактирование своей заявки;

    • удаление своей заявки);

    • просмотр списка своих заявок, поиск по заданным фильтрам;

    • запрос выпуска дистрибутива по своей заявке;

    • добавление новых элементов в справочник Системы (через заявку);

    • редактирование описания и списка контактных лиц в справочнике Системы;

    • просмотр параметров события (формат, схема, имя топика);

    • поиск события по заданным фильтрам в списке событий.

Доменные роли#

  • Владелец домена (Domain Owner) — инициатор создания домена, спонсор выделения КТС для домена и владелец основного потока данных, обрабатываемых внутри домена (либо владелец бизнес-процесса, под чьи нужды выполняется обработка данных). Имеет права на просмотр всех заявок своего домена. Согласует заявки на публикацию и создание обработчиков в своем домене, подтверждая правомерность выделения ресурсов. Также может передать заявку на исполнение администратору домена для установки дистрибутивов в своем домене. Роль может быть назначена лидеру подразделения, лидеру продукта, владельцу продукта. Разрешено совмещение с ролью Editor. Основные функции, доступные оператору с ролью Domain Owner:

    • Просмотр списка заявок в своем домене (созданных под различными УЗ).

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

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

    • Удаление заявок своего домена. При удалении заявка и все связанные данные удаляются из БД.

    • Просмотр списка событий во всех контурах, доменах и сетевых сегментах.

    • Поиск по справочнику событий.

  • Администратор домена (Domain Admin) — инженер сопровождения. Обеспечивает бесперебойную работу домена. Имеет права на просмотр всех заявок своего домена. Инициирует все изменения структуры своего домена (подтверждение заявок на выпуск дистрибутива, изменение настроек, установка дистрибутивов и т. п.). Роль назначается инженерам, отвечающим за эксплуатацию продуктов. Разрешено совмещение с ролями Editor и Service Admin. Основные функции, доступные оператору с ролью Domain Admin:

    • Выполнение установки дистрибутива или отказ в установке дистрибутива в своем домене.

    • Выполнение отката дистрибутива или отказ в откате дистрибутива в своем домене.

    • Удаление заявок своего домена. При удалении заявка и все связанные данные удаляются из БД.

    • Просмотр списка заявок в своем домене (созданных под различными УЗ).

    • Просмотр списка событий во всех контурах, доменах и сетевых сегментах.

    • Поиск по справочнику событий.

    • В справочнике доменов: редактирование названия, сегмента, заполнение параметров домена, смена статуса домена для своего домена.

Часто встречающиеся проблемы и пути их устранения#

Не выявлено.

Параметры настройки#

Параметры настройки заполняются операторами с ролями Service Admin (заполнение справочников, журнал аудита, первоначальная инициализация EDMS) и администратор домена (для конкретного домена, владельцем которого он является). Подробнее о параметрах настройки написано в документах «Руководство оператора Администратор EDMS (Service Admin)», раздел «Сценарии работы» и «Настройки параметров домена», раздел «Заполнение параметров подключения к домену, активация домена на контуре».

Правила эксплуатации#

Дополнительные правила отсутствуют.