Сценарии администрирования EDMS#

Предусловия#

Предусловия для выполнения сценария представлены индивидуально для каждого сценария администрирования при необходимости.

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

Не применимо.

Описание механизмов безопасности#

Не применимо.

Последовательность выполнения#

Сценарий 1. Создание архивных копий компонентов EDMS#

Предусловия: Необходимо заполнить параметры в конфигурационном файле vars.yml. Пример заполненного файла приведен в документе Руководство по установке в разделе Подготовка окружения EDMS (подраздел Пример заполненного файла vars.yml).

  • в разделе emc:

    • backup_installdir_to: — директория создания архивных копий для директории установки EDMS.

Для создания архивной копии UI EDMS необходимо запустить Jenkins Job emc_custom (поставляется в дистрибутиве) с выбором playbook emc.yml c тегом backup_create. Результатом выполнения Jenkins Job является архив с названием emc_backup.tar.gz, расположенный в директории, указанной в параметрах конфигурационного файла vars.yml.

Созданные архивные копии хранятся в директориях в единичном экземпляре, что позволяет предотвратить переполнения директории хранения архивов. При попытке создания архивных копий компонентов повторно, выполнение Jenkins Job будет прерываться, если в указанной директории ранее уже был создан архив. Поэтому необходимо перед созданием нового архива предварительно удалить существующие архивные копии из данных директорий. Для этого необходимо запустить Jenkins Job emc_custom с выбором соответствующего playbook с тегом backup_remove.

Теги backup_remove и backup_create можно совмещать в одном запуске Jenkins Job для экономии времени.

Создание архивных копий БД#

Создание архивных копий БД выполняется администраторами БД средствами БД.

Сценарий 2. Восстановление из архивных копий компонентов EDMS#

Предусловия: Необходимо заполнить параметры в конфигурационном файле vars.yml. Пример заполненного файла приведен в документе Руководство по установке в разделе Подготовка окружения EDMS (подраздел Пример заполненного файла vars.yml).

  • в разделе emc:

    • backup_installdir_to: — директория хранения архивных копий для директории установки EDMS.

Для восстановления UI EDMS из архивной копии необходимо запустить Jenkins Job emc_custom (поставляется в дистрибутиве) с выбором playbook emc.yml c тегом backup_restore. Результатом будет являться восстановление директории установки EDMS из архива, помещенного в указанную в файле vars.yml директорию.

Восстановление из архивных копий БД#

Восстановление из архивных копий БД выполняется администраторами БД средствами БД.

Сценарий 3. Запуск компонентов EDMS#

Ручной способ#

Запуск UI EDMS

В командной строке перейдите в директорию установки EDMS (параметр ansible emc.installdir, настраиваемый в файле vars.yml, например /opt/emc ) и выполните команду перезапуска:

  • Чтобы запустить сервис — выполнить команду: sudo systemctl start emc.service;

  • Чтобы запустить процесс — выполнить команду из директории установки: ./bin/emc start.

С помощью Jenkins#

Запуск UI EDMS

  1. Запустите Jenkins Job emc_custom.

  2. Выберите playbook emc.yml с тегом start.

Сценарий 4. Остановка компонентов EDMS#

Ручной способ#

Остановка UI EDMS

Зайдите на узел, на котором будет производиться остановка, под пользователем emc:

  • Определите, что запущено: сервис или процесс, командой: systemctl list-units --state=active,activating | grep "^[ ]*emc.service" Если данная команда не вывела результата, то запущен процесс, иначе - сервис.

  • При запущенном сервисе — остановите сервис: sudo systemctl stop emc.service.

  • При запущенном процессе — остановите процесс из директории установки: ./bin/emc stop.

С помощью Jenkins#

Остановка UI EDMS

  1. Запустите Jenkins Job emc_custom.

  2. Выберите playbook emc.yml с тегом stop.

Сценарий 5. Перезапуск компонентов EDMS#

Ручной способ#

Перезапуск компонентов EDMS на сервере для каждого узла#

Перезапуск UI EDMS

  1. Зайдите на узел, на котором будет производиться перезапуск, под пользователем emc:

  • Определите, что запущено: сервис или процесс, командой: systemctl list-units --state=active,activating | grep "^[ ]*emc.service" Если данная команда не вывела результата, то запущен процесс, иначе - сервис.

  • При запущенном сервисе — остановите сервис: sudo systemctl stop emc.service.

  • При запущенном процессе — остановите процесс из директории установки: ./bin/emc stop.

  1. В командной строке перейдите в директорию установки EDMS (параметр ansible emc.installdir, настраиваемый в файле vars.yml, например /opt/emc ) и выполните команду перезапуска:

    • Чтобы запустить сервис — выполнить команду: sudo systemctl start emc.service.

    • Чтобы запустить процесс — выполнить команду из директории установки: ./bin/emc restart.

С помощью Jenkins#

Перезапуск UI EDMS

  1. Запустите Jenkins Job emc_custom.

  2. Выберите playbook emc.yml с тегами start, stop или с тегом restart.

  3. В случае необходимости запуска только на конкретном узле необходимо указать этот узел в поле only_on_host.

Сценарий 6. Изменение конфигурации EDMS без полной переустановки#

Этот сценарий предназначен для изменения конфигурации EDMS без полной переустановки. Для этого используется в Jenkins Job emc_custom тег change_config, позволяющий изменить файлы: application.yml, logback.xml.

Предварительные условия#

  • Первичная установка EDMS с дистрибутивом уже выполнена.

Шаги для изменения конфигурации EDMS без полной переустановки#

  1. Внесите изменения параметров в файл vars.yaml.

  2. Проверьте, что первичная установка с дистрибутивом уже была выполнена.

  3. **Запустите Jenkins job для изменения конфигурации без полной установки.

    • Параметры:

      • inventory: выберите ваш инвентори из списка

      • playbook: emc.yml

      • tags: change_config, restart

  4. Дождитесь завершения выполнения Jenkins Job emc_custom.

  5. Проверьте, что новая конфигурация применилась в EDMS.

Примечания#

  • Файл application.yml всегда перезаписывается.

  • Файл logback.xml перезаписывается только при наличии отличий между новыми параметрами и текущим файлом на сервере.

Сценарий 7. Первоначальное заполнение справочников и инициализация первоначального состояния сущностей#

После установки экземпляра EDMS необходимо выполнить первоначальное заполнение Cправочников, Доменов, Систем, выдать права пользователям на использование доменов и систем.

Данные действия осуществляет пользователь с ролью EMC Admin. Подробнее о заполнении справочников и первоначальной инициализации сущностей описано в документе Руководство пользователя EDMS, раздел: «Роль - Администратор приложения EDMS».

Сценарий 8. Настройка параметров домена#

Для возможности размещения в домене заявок, а также для установки заявок в домене необходимо предварительно заполнить параметры домена. Добавление записи о новом домене выполняет пользователь с ролью EMC Admin. EMC Admin назначает права пользователю с ролью Domain Owner на конкретный домен. Domain Owner назначает права пользователю с ролью Domain Admin на конкретный домен в котором он является владельцем. После чего пользователь с ролью DomainAdmin может произвести заполнение параметров данного домена и произвести активацию домена на контуре, а также установить ограничения по времени и объемам хранения информации в домене. Подробнее данные сценарии работы описаны в документе Руководство пользователя EDMS, раздел: «Работа с доменами».

Сценарий 9. Настройка конфигурационных файлов для развертывания заявок#

Развертывание заявок осуществляется с помощью RLM.

Используется защищенное соединение с использованием ssl-сертификатов при подключении EDMS к другим компонентам.

Для RLM используется токен для авторизации при запуске задания на развертывание.

Пример настройки взаимодействия EDMS с RLM для развертывания заявок#

  deploy: rlm # Выбор способа деплоя rlm or direct
  rlm: # Блок настройки деплоя rlm
    url: https://rlm.ru # Адрес rlm
    token: __PLACEHOLDER__ # Токен для подключения к rlm
    table_id: kafka # Идентификатор таблицы с Kafka-ресурсами
    timeout: # Блок настроек таймингов
      job_update_cron: 0 */5 * * * * # Задача cron, с помощью которой происходит периодическая проверка состояния RLM-job. Формат Quartz - * * * * * *, который расшифровывается: (секунда) (минута) (час) (день месяца) (месяц) (день недели)
      task_update_cron: 0 */2 * * * * # Задача cron, с помощью которой происходит обновление статусов заявок. Формат Quartz - * * * * * *, который расшифровывается: (секунда) (минута) (час) (день месяца) (месяц) (день недели)
    jobs: # Блок настроек rlm jobs
      create-topic: # Название job
        service: createtopicKafka # параметр service job
        action: aktag_create_topic,aktag_modify_topic # параметр action job
      add-acls: # Название job
        service: ak_add_acl # параметр service job
        action: aktag_add_acls # параметр action job
      modify-topic: # Название job
        service: ak_modify_topic # параметр service job
        action: aktag_modify_topic # параметр action job
      delete-topic: # Название job
        service: ak_delete_topic # параметр service job
        action: aktag_delete_topics # параметр action job
      delete-acls: # Название job
        service: ak_delete_acl # параметр service job
        action: aktag_delete_acls # параметр action job
    ssl:
      keystore: ssl/rlm.jks # Сертификат для rlm
      keystore_password: __PLACEHOLDER__ # Пароль для сертификата rlm
      truststore: ssl/rlm.jks # Сертификат для rlm
      truststore_password: __PLACEHOLDER__ # Пароль для сертификата rlm

Результат#

Сценарии администрирования выполнены.