Предварительная установка дополнительного ПО на сервере

Для запуска EDM Issue на сервере требуется произвести установку дополнительного ПО:

Установить последнюю стабильную версию Docker (ссылка на инструкцию на официальном сайте).
Установить последнюю стабильную версию Docker Compose (ссылка на инструкцию на официальном сайте).

Дальнейшие инструкции предполагают, что пользователь обладает правами взаимодействия с Docker и запуска Docker Compose без повышения привилегий командой sudo. Для формирования таких прав у текущего пользователя рекомендуется изучить следующий раздел официальной документации Docker.

Получение файлов, необходимых для запуска EDM Issue

Набор файлов, необходимых для запуска EDM Issue, находится в архиве: edm-issue.tar.gz

Структура архива

.
├── .env
├── data
│   ├── edmi-db
│   │   ├── init-db
│   │   │   └── init-db.sql
│   │   └── postgresql.conf
│   └── edmi-web-ui
│       └── ssl
│           ├── autocreated-cert.crt
│           └── autocreated-cert.key
├── docker-compose-cli.yml
├── docker-compose.yml
└── monitoring
    ├── .env
    ├── docker-compose.yml
    ├── grafana
    │   └── provisioning
    │       ├── dashboards
    │       │   ├── dashboard.yml
    │       │   ├── edm_alert_metrics.json
    │       │   └── edm_monitor.json
    │       ├── datasources
    │       │   └── datasource.yml
    │       └── notifiers
    │           ├── email.yml
    │           └── telegram.yml
    ├── influxdb
    │   └── influx_init.iql
    ├── prometheus
    │   └── prometheus.yml
    └── telegraf
        └── telegraf.conf

Архив должен быть загружен на целевой сервер и распакован в любой удобной для дальнейшей эксплуатации директории.

У администраторов EDM Issue для запуска, остановки и редактирования конфигурации EDM Issue должны быть права на чтение и запись распакованных файлов.

Запуск EDM Issue

Для запуска EDM Issue требуется произвести следующие шаги:

Перейти в директорию с содержимым распакованного архива.
Открыть любым текстовым редактором файл .env и ввести для переменной "EDM_LICENSE_KEY" ключ лицензии, полученной от коммерческого отдела компании ЭЛТЕКС:
Заполнение файла .env
```
# EDM version
EDM_TAG=1.0

# License key
EDM_LICENSE_KEY=<ключ лицензии, полученный от коммерческого отдела компании ЭЛТЕКС>
```
Прочие переменные окружения, которые можно описать в .env файле, описаны в разделе v1.0__Управление настройками EDM Issue.

Запустить EDM Issue командой:

Команда запуска EDM Issue

docker-compose up -d

Пример вывода команды при первом запуске EDM Issue на хосту

edm@edm-server:/opt/edm$ docker-compose up -d
Creating network "edmi-network" with driver "bridge"
Creating network "edm-monitoring-network" with driver "bridge"
Pulling edmi-db (hub.eltex-co.ru/edm/postgres:12.5)...
12.5: Pulling from edm/postgres
45b42c59be33: Pull complete
40adec129f1a: Pull complete
b4c431d00c78: Pull complete
2696974e2815: Pull complete
564b77596399: Pull complete
5044045cf6f2: Pull complete
d736e67e6ac3: Pull complete
390c1c9a5ae4: Pull complete
fbb0dc403c2f: Pull complete
1b9ba7c0986e: Pull complete
b6c9d2fab5c1: Pull complete
19f04f19f5bb: Pull complete
0a195310fe0b: Pull complete
1a99568d6863: Pull complete
Digest: sha256:53a6dd80815c9f65eef32cdd24387830bdac3c903fca2ff474bed9ea6f39405f
Status: Downloaded newer image for hub.eltex-co.ru/edm/postgres:12.5
Pulling edmi-init (hub.eltex-co.ru/edm/edmi-init:1.0)...
1.0: Pulling from edm/edmi-init
e7c96db7181b: Pull complete
f910a506b6cb: Pull complete
c2274a1a0e27: Pull complete
185e3d702981: Pull complete
25d6ba00a20b: Pull complete
8b1c64ce09a7: Pull complete
8b1d7fabb509: Pull complete
90fc92f0840d: Pull complete

Пример вывода команды при первом запуске EDM Issue на хосту (продолжение)

Digest: sha256:7ea28a286586ae357c5238120dfaf9d3ccced31d24e38f036a99915044279d0f
Status: Downloaded newer image for hub.eltex-co.ru/edm/edmi-init:1.0
Pulling edmi-server (hub.eltex-co.ru/edm/edmi-server:1.0)...
1.0: Pulling from edm/edmi-server
e7c96db7181b: Already exists
f910a506b6cb: Already exists
c2274a1a0e27: Already exists
68899f563e75: Pull complete
f354aa216779: Pull complete
ca630caca83d: Pull complete
d9833dabdd81: Pull complete
9eeba2f2e5c3: Pull complete
Digest: sha256:4b6e97ec97186153a378dda0f59987c8e405afb75721363e42623af55e6ed821
Status: Downloaded newer image for hub.eltex-co.ru/edm/edmi-server:1.0
Pulling edmi-loader (hub.eltex-co.ru/edm/edmi-loader:1.0)...
1.0: Pulling from edm/edmi-loader
e7c96db7181b: Already exists
f910a506b6cb: Already exists
c2274a1a0e27: Already exists
68899f563e75: Already exists
f354aa216779: Already exists
10e56aeb0d01: Pull complete
d9833dabdd81: Pull complete
1e872e1f5975: Pull complete
Digest: sha256:9822cc039536fb3cd1b2ee518d9ab54090789d2c862686f3f3a8be14ce031a79
Status: Downloaded newer image for hub.eltex-co.ru/edm/edmi-loader:1.0
Pulling edmi-web-ui (hub.eltex-co.ru/edm/edmi-web-ui:1.0)...
1.0: Pulling from edm/edmi-web-ui
9aae54b2144e: Pull complete
deb02d0f047e: Pull complete
faa46c06ae12: Pull complete
8bbe2a6a37c5: Pull complete
f9b897942de0: Pull complete
7141e8eb7387: Pull complete
2de65cd1b767: Pull complete
86f8066da9a0: Pull complete
4dd4a9d2995a: Pull complete
2b4616077d7f: Pull complete
f94738441a6e: Pull complete
fbdbae97b01c: Pull complete
Digest: sha256:2b91a7c0ad98acbc4d3c25d312554f138faebb98df923959960fa7c749786e10
Status: Downloaded newer image for hub.eltex-co.ru/edm/edmi-web-ui:1.0
Creating edmi-db ... done
Creating edmi-init ... done
Creating edmi-loader ... done
Creating edmi-server ... done
Creating edmi-web-ui ... done
edm@edm-server:/opt/edm$

Убедиться, что все контейнеры EDM Issue успешно запустились, используя команду:

Команда проверки статуса контейнеров EDM Issue

docker-compose ps

Пример вывода команды при успешном запуске всех контейнеров EDM Issue

edm@edm-server:/opt/edm$ docker-compose ps
   Name                  Command               State                    Ports                  
-----------------------------------------------------------------------------------------------
edmi-db       docker-entrypoint.sh postg ...   Up      5432/tcp                                
edmi-init     /bin/sh -c /usr/local/bin/ ...   Up                                              
edmi-loader   /bin/sh -e /usr/local/bin/ ...   Up      8098/tcp                                
edmi-server   /bin/sh -e /usr/local/bin/ ...   Up      0.0.0.0:8098->8098/tcp,:::8098->8098/tcp
edmi-web-ui   /usr/local/bin/entrypoint. ...   Up      0.0.0.0:8091->80/tcp,:::8091->80/tcp    
edm@edm-server:/opt/edm$

Теперь с EDM Issue можно взаимодействовать через web-интерфейс и через интерфейс командной строки.

После первого запуска EDM Isssue в текущем каталоге появятся три новых директории:

db - содержит файлы базы данных, используемой в EDM Issue;
config - содержит файлы конфигурации для сервисов EDM Issue;
logs - содержит логи сервисов EDM Issue.

Остановка EDM Issue

Для остановки EDM Issue требуется произвести следующие шаги:

Перейти в директорию с файлами работающего EDM Issue.

Выполнить команду:

Команда остановки EDM Issue

docker-compose down

Пример вывода команды при успешной остановке всех контейенров EDM Issue

edm@edm-server:/opt/edm$ docker-compose down 
Stopping edmi-web-ui ... done
Stopping edmi-loader ... done
Stopping edmi-server ... done
Stopping edmi-init   ... done
Stopping edmi-db     ... done
Removing edmi-web-ui ... done
Removing edmi-loader ... done
Removing edmi-server ... done
Removing edmi-init   ... done
Removing edmi-db     ... done
Removing network edmi-network
Removing network edm-monitoring-network
edm@edm-server:/opt/edm$

EDM Issue теперь остановлен. Для повторного запуска остановленного EDM Issue нужно выполнить команду "docker-compose up -d".

Удаление EDM Issue

Для удаления EDM Issue требуется произвести следующие шаги:

Перейти в директорию с файлами работающего EDM Issue.

Выполнить команду:

Команда для удаления EDM Issue с хоста

docker-compose down --remove-orphans --rmi all --volumes

Пример вывода команды при успешной остановке EDM с удалением данных в Docker

edm@edm-server:/opt/edm$ docker-compose down --remove-orphans --rmi all --volumes
Stopping edmi-web-ui ... done
Stopping edmi-server ... done
Stopping edmi-loader ... done
Stopping edmi-init   ... done
Stopping edmi-db     ... done
Removing edmi-web-ui ... done
Removing edmi-server ... done
Removing edmi-loader ... done
Removing edmi-init   ... done
Removing edmi-db     ... done
Removing network edmi-network
Removing network edm-monitoring-network
Removing volume edm-issue_edmi-healthcheck
Removing image hub.eltex-co.ru/edm/postgres:12.5
Removing image hub.eltex-co.ru/edm/edmi-init:1.0
Removing image hub.eltex-co.ru/edm/edmi-server:1.0
Removing image hub.eltex-co.ru/edm/edmi-loader:1.0
Removing image hub.eltex-co.ru/edm/edmi-web-ui:1.0
edm@edm-server:/opt/edm$

В результате выполнения команды EDM Issue будет остановлен. В случае, если на момент выполнения команды он еще функционировал, будут удалены служебные сети, хранилища и образы в Docker.

Удалим оставшиеся от EDM Issue каталоги и служебные файлы:
Удаление оставшихся служебных файлов
```
sudo rm -rf .env config  data  db  docker-compose-cli.yml  docker-compose.yml  log  monitoring
```

Теперь EDM Issue полностью удален с хоста.

Дерево страниц

v1.0__Инструкция по установке EDM Issue

Предварительная установка дополнительного ПО на сервере

Получение файлов, необходимых для запуска EDM Issue

Запуск EDM Issue

Остановка EDM Issue

Удаление EDM Issue