ExeMES поставляется в формате контейнеризированного приложения, которое может быть запущено как в Docker, так и в кластере Kubernetes.

На данной странице представлена инструкция для инсталляции ПО ExeMES в Docker. По вопросам установки ПО ExeMES в кластере Kubernetes необходимо обращаться на портал технической поддержки.

Подготовка к установке

1. Установка Docker
   Инструкция по установке

   Для установки Docker потребуется доступ в интернет. После установки завершения установки доступ в интернет можно будет закрыть

   Детальную информацию по установке Docker также можно найти на сайте Вендора - https://docs.docker.com/engine/install/.

   Пример установки Docker для Ubuntu

   Установка Docker выполняется в терминале ОС под пользователем с правами root

   Для установки docker, в терминале Ubuntu необходимо последовательно выполнить следующие команды:

   # Add Docker's official GPG key:
   sudo apt-get update
   sudo apt-get install ca-certificates curl
   sudo install -m 0755 -d /etc/apt/keyrings
   sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
   sudo chmod a+r /etc/apt/keyrings/docker.asc
   
   # Add the repository to Apt sources:
   echo \
     "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
     $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | \
     sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
   sudo apt-get update
   
   # Install latest version:
   sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

   Приведенные в блоке выше команды устанавливают последнюю версию docker из репозитория.

   Для проверки работоспособности docker необходимо выполнить команду:

   sudo docker run hello-world

   В результате выполнения команды будет загружен тестовый образ и запущен контейнер с ним. Сообщение, представленное ниже подтверждает корректную установку Docker

   

   Пример установки Docker для Cent OS

   Установка Docker выполняется в терминале ОС под пользователем с правами root

   Для установки docker, в терминале Cent OS необходимо последовательно выполнить следующие команды:

   sudo yum check-update
   sudo yum install -y yum-utils device-mapper-persistent-data lvm2
   sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
   sudo yum install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
   sudo systemctl start docker
   sudo systemctl enable docker
   sudo systemctl status docker

   Последняя команда показывает состояние docker. Состояние после успешной установки должно быть active(running).

   Состояние docker

   Пример установки Docker для Debian

   Установка Docker выполняется в терминале ОС под пользователем с правами root

    Для установки docker, в терминале Debian необходимо последовательно выполнить следующие команды:

   apt install lsb-release gnupg2 apt-transport-https ca-certificates curl software-properties-common -y
   curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /etc/apt/trusted.gpg.d/debian.gpg
   add-apt-repository "deb [arch=$(dpkg --print-architecture)] https://download.docker.com/linux/debian $(lsb_release -cs) stable"
   apt update
   apt install docker-ce docker-ce-cli containerd.io docker-compose-plugin
   systemctl start docker 
   systemctl enable docker
   docker version

   Последняя команда позволяет определить успешную установку docker, при успешной установке будут выведены версии установленных компонетов:

   Версии установленных компонентов

   
   

2. Для хоста, на котором установлен Docker обязательно должен быть сконфигурирован ip адрес отличный от "127.0.0.1". Данный ip адрес должен быть использован в качестве [host_ip] при выполнении дальнейших пунктов инструкции.

3. Подготовка сертификатов 

   Инструкция

   Для использования защищенных протоколов https ssl, необходимо сгенерировать и сконвертировать сертификаты для вашего домена.

   Для создания и конвертации сертификатов необходимо установить openssl. Детальная инструкция по установке доступна по ссылке https://wiki.openssl.org/index.php/Binaries.

   На первом шаге необходимо сгенерировать key файл. Для этого необходимо выполнить команду в терминале:

   openssl genrsa -out wildcard.[домен].key 2048

   Затем необходимо создать файл cnf с конфигурационной информацией следующего содержания:

   [ req ]
   default_bits = 2048
   distinguished_name = req_distinguished_name
   req_extensions = req_ext
   prompt = no
   
   [ req_distinguished_name ]
   C = RU
   ST = Russia
   L = Moscow
   O = [организация]
   CN =[домен]
   
   [ req_ext ]
   subjectAltName = @alt_names
   extendedKeyUsage = serverAuth, clientAuth
   basicConstraints=CA:TRUE
   
   [alt_names]
   DNS.1 = keycloak.[домен]
   DNS.2 = middleware.[домен]
   DNS.3 = client.[домен]
   DNS.4 = mes-runtime.[домен]
   DNS.5 = exesched.[домен]
   DNS.6 = report.[домен]
   DNS.7 = *.[домен]

   После чего с использование key и cnf файла сгенерировать crt файл сертификата используя команду:

   openssl req -x509 -nodes -newkey rsa:4096 -extensions req_ext -keyout wildcard.[домен].key -out wildcard.[домен].crt -days [срок действия сертификата в днях] -config wildcard.[домен].cnf

   На основании crt файла необходимо сгенерировать pfx сертификат.

   Для конвертации сертификатов в pfx необходимо воспользоваться следующей командой:

   openssl pkcs12 -export -out wildcard.[домен].pfx -inkey wildcard.[домен].key -in wildcard.[домен].crt

   После выполнения команды openssl запросит ввести новый пароль и подтвердить его, после чего, будет создан сертификат в формате pfx.

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

   При установке в Docker необходимо внести правки в docker-compose.yaml в строках, указав новый crt сертификат и новый pfx сертификат

   source: /root/dev/crt/wildcard.[домен].pfx
   ...
   source: /root/dev/crt/wildcard.[домен].crt

   Для pfx сертификатов, необходимо изменить пароль в следующих строках:

   ASPNETCORE_Kestrel__Certificates__Default__Password: "пароль указанный при генерации pfx сертификата"

   
   

   В инсталляционном пакете в папке crt поставляются самоподписанные сертификаты для домена mycompany.local. Если вы разворачиваете ПО ExeMES в демонстрационных, тестовых или обучающих целях (не на продуктивной среде) и не планируете использовать другой домен для работы приложения, то вы можете пропустить данный шаг инструкции и воспользоваться готовыми сертификатами.

4. Настройка DNS
   Инструкция

   Адреса сервисов продуктов ExePlant должны быть добавлены в DNS:

   [host_ip] client.[домен]
   [host_ip] middleware.[домен]
   [host_ip] keycloak.[домен]
   [host_ip] mes-runtime.[домен]
   [host_ip] exesched.[домен]
   [host_ip] report.[домен]

   При использовании DNS необходимо в docker-compose.yaml (из состава инсталляционного пакета) удалить конфигурацию extra_hosts

   При установке в Docker и отсутствии DNS сервера необходимо добавить в файл hosts ОС записи для каждого сервиса:

   [host_ip] client.[домен]
   [host_ip] middleware.[домен]
   [host_ip] keycloak.[домен]
   [host_ip] mes-runtime.[домен]
   [host_ip] exesched.[домен]
   [host_ip] report.[домен]

   
   

   
   

5. Установка Guardant Control Center и Guardant SLK

   Инструкция

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

   Допускается использовать в качестве сервера лицензирования хост, на котором установлен Docker

   Дистрибутивы Guardant Control Center для различных ОС поставляются совместно с ПО ExePlant и находятся в инсталляционном пакете в папке gcc:

   Установочные файлы Guardant Control Center

   Выберите любой подходящий для вашей ОС файл установщик и произведите установку ПО любым удобным способом доступным в вашей ОС.

   Примеры установки Guardant Control Center в ОС Ubuntu:

   Установка в графическом режиме

   Для установки Guardant Control Center в графическом режиме в ОС Ubuntu удобно использовать установочный файл grdcontrol*.deb (конкретный файл необходимо выбрать в зависимости от разрядности ОС). Файл необходимо открыть через Центр приложений и нажать на кнопку "Установить", после чего дождаться завершения установки.

   Установка Guardant Control Center в ОС Ubuntu

   Установка в консольном режиме

   Для установки Guardant Control Center в консольном режиме в ОС Ubuntu удобно использовать установочный файл grdcontrol*.deb (конкретный файл необходимо выбрать в зависимости от разрядности ОС). В консоли необходимо перейти в каталог расположения установочного файла и выполнить команду:

   sudo apt install ./[имя_файла].deb

   После установки ПО Guardant Control Center необходимо активировать лицензию. Активация лицензий производится с использованием ПО Мастер лицензий Guardant (входит в состав Guardant SLK и не требует установки).

   Активация лицензии может производиться в двух режимах:

   Графический режим мастера лицензий Guardant

   Для запуска ПО Мастер лицензий Guardant в визуальном режиме необходимо запустить файл license_wizard из архива grdcontrol-3.29.tar.gz (соответствующий файл находится в папке x86 или x86_64 в зависимости от разрядности вашей ОС).

   Мастер лицензий

   Для активации лицензии необходимо нажать на кнопку "+ Активация лицензии", после чего ввести в форму Программный ключ лицензии и завершить процесс активации следуя инструкциям в Мастере лицензий Guardant.

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

   После успешной активации лицензии в Мастере лицензий Guardant отобразится информация об активированной лицензии.

   Активированная лицензия

   Консольный режим мастера лицензий Guardant

   Для активации лицензии необходимо перейти в папку с файлом license_wizard из архива grdcontrol-3.29.tar.gz в режиме консоли (соответствующий файл находится в папке x86 или x86_64 в зависимости от разрядности вашей ОС).

   Далее необходимо предоставить права на файл Мастера лицензий Guardant, выполнив команду:

   chmod +x license_wizard

   Для активации лицензии необходимо выполнить команду:

   ./license_wizard --console --activate [Программный ключ лицензии] --host https://getlicense.guardant.ru

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

   Для проверки активации лицензии необходимо выполнить команду:

   ./license_wizard --console --list

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

   Детальная информация по работе с Мастером лицензий Guardant представлена на сайте производителя.

   
   

Установка ExeMES для ОС семейства Linux

Для установки и запуска ExeMES необходимо распаковать архив, содержащий ПО ExeMES (инсталляционный пакет) и предоставленный Вендором используя команду:

gunzip -c exemes.tar.gz | tar -xvf –

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

Затем необходимо отредактировать файл docker-compose.yaml, расположенный в корневой папке каталога:

• заменить по тексту файла параметр [host_ip] на ip адрес хоста, на котором инсталлирован Docker;
• заменить по тексту файла параметр [license_server_ip] на ip адрес хоста, на котором установлен сервер лицензирования Guardant Control Center;
• настроить необходимые переменные окружения;

• скопировать в каталог /exemes/crt сгенерированные ранее сертификаты;
• предоставить права на сгенерированные ранее файлы сертификатов, выполнив команду:

  chmod -R 777 /exemes/crt/

• отредактировать файл docker-compose.yaml: заменить по тексту файла "mycompany.local" на имя домена, для которого сгенерированы сертификаты;
• отредактировать файлы: /exemes/data/exemesmiddleware/keycloak.json, /exemes/data/exemesclient/keycloak.json, /exemes/data/exeruntimeclient/keycloak.json, /exemes/data/exesched/keycloak.json: заменить в ссылках "mycompany.local" на имя домена, для которого сгенерированы сертификаты. Пример:
  /exemes/data/exemesclient/keycloak.json

  {
    "realm": "exemes",
    "auth-server-url": "https://keycloak.[домен]:5787/",
    "ssl-required": "external",
    "resource": "mes-client",
    "verify-token-audience": false,
    "credentials": {
      "secret": "SFY1TvAoSgrHQooduT9OstvHsKdwufKo"
    },
    "use-resource-role-mappings": true,
    "confidential-port": 0,
    "policy-enforcer": {},
    "Logout": "https://client.[домен]:8142/"
  }

Далее необходимо открыть терминал ОС с root доступом, перейти в каталог, появившийся после распаковки архива, и выполнить команду:

bash install-exemes.sh

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

docker volume create portainer_data
docker run -d -p 8000:8000 -p 9443:9443 --name portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce:2.20.2
systemctl restart docker

chmod g+x install_exemes.sh

После завершения выполнения скрипта будут запущены контейнеры приложений ExeMES, что будет подтверждено соответствующим сообщением в терминале.

После завершения инсталляции необходимо открыть web-консоль администрирования Keycloak в браузере по адресу https://keycloak.[домен]:5787. Для доступа в Keycloak необходимо воспользоваться логином и паролем административной учетной записи, которые указаны в параметрах KEYCLOAK_ADMIN_USER и KEYCLOAK_ADMIN_PASSWORD настроек контейнера keycloak в docker-compose.yaml.

В Keycloak необходимо перейти в настройки realm exemes, создать пользователя и добавить его в группу EXEMES_Admins.

Настройка переменных окружения

Пакет инсталляции ExeMES уже содержит настроенные переменные окружения и если вы не планируете менять настройки по умолчанию, то можете пропустить данный шаг.

Доступные настройки:

MESDBContext: "Server=localhost; User Id=middleware; Database=mesdb; Port=5432; Password=password; SSLMode=Prefer"
MESDBContextRO: "Server=localhost; User Id=middleware_ro; Database=mesdb; Port=5432; Password=password; SSLMode=Prefer"

MESDBOwnerContext: "Server=localhost; User Id=postgres; Database=mesdb; Port=5432; Password=password; SSLMode=Prefer"

DBStrategyOnStartUp: "CreateIfNotExists"

CORS: "https://elma365.exeplant.local,https://keycloak.exeplant.local"

EntityAccessProtection: "enabled"

MiddlewareApiRootUri: "https://mesmiddleware.myweb.local/api"

DBConnection: "Host=localhost;Port=5432;Database=exesched;Username=user;Password=pass"

GCCSettings:Remotehosts: "170.10.10.1, 170.10.10.2"

Проверка работоспособности ExeMES после установки

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

• ExeMES Client  - https://client.[домен]:8142/
• ExeMES RuntimeClient - https://mes-runtime.[домен]:8143/
• ExeSched - https://exesched.[домен]:8135/