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

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

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

При использовании Docker Compose v2 во всех последующих пунктах команда "docker-compose" должна быть заменена на "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.1

# License key
EDM_LICENSE_KEY=<ключ лицензии, полученный от коммерческого отдела компании ЭЛТЕКС>
```
Прочие переменные окружения, которые можно описать в .env файле, описаны в разделе v.1.1_Управление настройками 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"
Creating volume "edm-issue_edmi-healthcheck" with local driver
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.1)...
1.1: Pulling from edm/edmi-init
e7c96db7181b: Already exists
f910a506b6cb: Already exists
c2274a1a0e27: Already exists
185e3d702981: Pull complete
25d6ba00a20b: Pull complete
af1011828bcd: Pull complete
adbaf0e9ac91: Pull complete
538363d49e0e: Pull complete
Digest: sha256:98e193db973e996961549ed4902db760f31c73f4bcde4fffe363bf4877eb2183
Status: Downloaded newer image for hub.eltex-co.ru/edm/edmi-init:1.1
Pulling edmi-server (hub.eltex-co.ru/edm/edmi-server:1.1)...
1.1: Pulling from edm/edmi-server
e7c96db7181b: Already exists
f910a506b6cb: Already exists
c2274a1a0e27: Already exists
a3fa6932c8ec: Pull complete
fb10006c4b7b: Pull complete
42d9176543bd: Pull complete
2693fc0875a6: Pull complete
d58849bea063: Pull complete
Digest: sha256:b740aaba22fcbf45f8ac0a944fcde290192de0c75816f1322678e349bed60d2f
Status: Downloaded newer image for hub.eltex-co.ru/edm/edmi-server:1.1
Pulling edmi-loader (hub.eltex-co.ru/edm/edmi-loader:1.1)...
1.1: Pulling from edm/edmi-loader
e7c96db7181b: Already exists
f910a506b6cb: Already exists
c2274a1a0e27: Already exists
a3fa6932c8ec: Already exists
fb10006c4b7b: Already exists
abfc67f7b53b: Pull complete
2693fc0875a6: Pull complete
593f869e6e8a: Pull complete
Digest: sha256:39960c2e7c85992b86463f46a2fdbf6c841428f03c98cffccfb9da522f781a50
Status: Downloaded newer image for hub.eltex-co.ru/edm/edmi-loader:1.1
Pulling edmi-web-ui (hub.eltex-co.ru/edm/edmi-web-ui:1.1)...
1.1: Pulling from edm/edmi-web-ui
9aae54b2144e: Pull complete
deb02d0f047e: Pull complete
faa46c06ae12: Pull complete
8bbe2a6a37c5: Pull complete
f9b897942de0: Pull complete
7141e8eb7387: Pull complete
f47e45dd0dec: Pull complete
bf8755d0b310: Pull complete
49768d4a228a: Pull complete
d927e402abb0: Pull complete
92de66a12f98: Pull complete
3ed13b5407e0: Pull complete
Digest: sha256:d7f5c30e1a5398a1b6247d913f6831b1f77534b966972314b725bac829f9ebac
Status: Downloaded newer image for hub.eltex-co.ru/edm/edmi-web-ui:1.1
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 Issue в текущем каталоге появятся три новых директории:

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.1
Removing image hub.eltex-co.ru/edm/edmi-server:1.1
Removing image hub.eltex-co.ru/edm/edmi-loader:1.1
Removing image hub.eltex-co.ru/edm/edmi-web-ui:1.1
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 полностью удален с хоста.

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

v.1.1_Инструкция по установке EDM Issue

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

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

Запуск EDM Issue

Остановка EDM Issue

Удаление EDM Issue