|| DeviceType | Сервис мониторинга и управления конфигурациями «ELTEX» |
|| DeviceName | ECCM |
|| DocTitleAdditional | Инструкция по установке и запуску |
|| fwversion | 2.6 |
|| username | eccm |
|| password | eccm |

Требования к серверу

Системные требования описаны в разделе "Требования к оборудованию и персоналу".

Получение привилегий sudo без дополнительного ввода пароля (опционально)

От имени непривилегированного пользователя выполните команду:

echo "$(whoami)    ALL=(ALL) NOPASSWD: ALL" | sudo EDITOR='tee -a' visudo

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

Установка ECCM

Установочный архив

Файлы, необходимые для запуска проекта, распространяются в виде tar-архива. Их можно получить с общедоступного облака. Загрузите архив на сервер и распакуйте его. Рекомендуется распаковывать архив в заранее созданную отдельную директорию.

Пример команд:

wget "https://cloud.eltex-co.ru/index.php/s/P8xDfmyo3XyEs0g/download?path=%2F&files=eccm-2.6.tar.gz" -O eccm-2.6.tar.gz
mkdir eccm
tar -zxvf eccm-2.6.tar.gz -C eccm/

Установка docker и docker-compose 

Наиболее простой и быстрый способ установки — перейти в директорию, в которую был распакован установочный архив, и воспользоваться скриптом compose-tools.sh, используя флаг --install:

cd eccm/2.6
sudo ./compose-tools.sh --install

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

docker --version

Для проверки установленного docker-compose в Ubuntu можно выполнить команды:

docker compose version

При установке на операционные системы Astra Linux, RedOS или Альт Сервер команда проверки версии установленного docker-compose имеет вид:

docker-compose version

Offline-установка

Установка ЕССМ в систему без доступа к сети Интернет подробно описана в разделе "Offline-установка ECCM".

Запуск ECCM

Проект ECCM распространяется в виде набора файлов, позволяющих запустить все необходимые сервисы с помощью docker-compose. Проект разделен на два docker-стека:

• база данных (PostgreSQL 14.10);
• стек сервисов ECCM. 

Такое разделение обусловлено необходимостью обеспечения горизонтального масштабирования проекта и возможности интеграции с другими проектами компании, например EDM.

Подробнее в разделе "Векторы сетевого взаимодействия".

Скрипт для запуска ECCM

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

sudo ./compose-tools.sh -h

Список всех используемых ключей и их описание можно найти в разделе "Используемые опции compose-tools.sh".

Запуск ECCM на одном хосте

Для запуска проекта перейдите в директорию с файлами установочного архива и выполните команду:

sudo ./compose-tools.sh --start <ECCM ADDRESS>

, где **ECCM ADDRESS** — это IP-адрес, по которому будет выполняться подключение к серверу. Например, если адрес сервера 100.110.2.2, команда будет выглядеть:

sudo ./compose-tools.sh --start 100.110.2.2

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

sudo ./compose-tools.sh --stop

Запуск ECCM на одном хосте в интеграции с Peeper

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

Файлы, необходимые для запуска проекта, также распространяются в виде tar-архива. Распаковывать архив нужно в заранее созданную директорию внутри проекта ECCM.

Пример команд:

cd eccm/2.6
wget "https://cloud.eltex-co.ru/index.php/s/n4RRd4rgx9pgxUO/download?path=%2F&files=peeper-client.tar" -O peeper-client.tar
tar -xvf peeper-client.tar -C peeper

Сгенерируйте token в WEB Grafana (https://<адрес Peeper Server>:443). Зайдите в меню "Administration" → "Users and access" → "Service accounts" → "Add service account" → "Add service account token" → "Generate token".

В файле peeper/.env укажите:

1. IP-адрес или доменное имя для подключения к Peeper-server в переменной PEEPER_HOST 
2. В переменной PEEPER_EXTERNAL_MODE установите значение true, во избежание конфликтов при создании external сети в Docker.
3. В переменной PEEPER_TOKEN укажите токен:

   PEEPER_HOST="peeper.eltex.loc" # Доменное имя или IP-адрес Peeper-сервера PEEPER_EXTERNAL_MODE="true" # false, если на сервере отсутствует external network в docker PEEPER_TOKEN="" # Токен сервисного аккаунта, который создается в peeper-server

Для сбора информации с базы данных ECCM настройте файл peeper/.env.postgres. Ниже представлен пример настройки файла:

POSTGRES_EXPORTER_ENABLED=true # Включение снятия метрик с базы данных PostgreSQL
POSTGRES_HOST="100.110.2.2" # Адрес базы данных PostgreSQL для подключения и снятия метрик
POSTGRES_PORT="5432" # Порт базы данных PostgreSQL для подключения и снятия метрик
POSTGRES_DB="" # Название базы данных PostgreSQL для мониторинга
POSTGRES_USER="tester" # Пользователь базы данных PostgreSQL для подключения и снятия метрик
POSTGRES_PASSWORD="tester" # Пароль для пользователя $POSTGRES_USER, который нужен для снятия метрик

Для запуска проекта ECCM в интеграции с Peeper добавьте ключ --peeper к стандартной команде запуска:  

sudo ./compose-tools.sh --start 100.110.2.2 --peeper

Запуск ЕССМ с базой данных на отдельном сервере

ECCM Application Server  — сервер, на котором развернуто приложение, обеспечивающее работу системы и взаимодействие с устройствами, а также веб-интерфейс пользователя.

Database Server  — сервер с базами данных PostgreSQL 14. Возможно использование уже существующего в инфраструктуре кластера.

Device Management Network  — IP-сеть управления оборудованием, через которые ECCM имеет доступ по L3.

Operator/Administrator  — оператор системы, занимающийся мониторингом и настройкой подконтрольного оборудования/системный администратор компании или сотрудники техподдержки Eltex, если есть договоренность об удаленном доступе.

Для случая, когда необходимо запустить ЕССМ на нескольких серверах (один сервер — для базы данных PostgreSQL, второй сервер — для остального стека сервисов ЕССМ), возможно использовать опцию многохостовой установки. Для этого:

1. Установите docker и docker-compose на обоих серверах согласно разделу "Установка ЕССМ";

2. Настройте сервер с базами данных:

2.1. Для переопределения логина/пароля/временной зоны/ограничения ОЗУ для работы с БД отредактируйте файл postgres/.env. Для изменения параметров, влияющих на производительность базы данных, отредактируйте файл postgres/data/postgresql.conf (настройки по умолчанию достаточны для тестового запуска и поддержки около 100 устройств);

2.2. Запустите базу данных PostgreSQL на сервере с БД. Для запуска БД перейдите в директорию eccm/postgres и выполните команду для запуска контейнера:

cd eccm/postgres
docker compose up -d

3. Настройте сервер с приложениями:

3.1. Для переопределения переменных, отвечающих за авторизацию пользователя в системе ECCM и поведение проекта (адрес веб-интерфейса, временная зона, адрес БД, логин/пароль для доступа к БД и пр.), отредактируйте файл "eccm/.env";

3.2. Выполните запуск ЕССМ на сервере с ЕССМ с помощью следующей команды:

sudo ./compose-tools.sh --start <ECCM ADDRESS> --database-host <DB ADDRESS> --database-port <DB PORT>

, где <DB ADDRESS> и <DB PORT>— это IP-адрес и порт, по которым будет выполняться подключение к серверу БД. Например, если адрес сервера ЕССМ 100.110.2.2, адрес сервера БД 100.110.2.4, порт сервера БД 5432, то команда будет выглядеть:

sudo ./compose-tools.sh --start 100.110.2.2 --database-host 100.110.2.4 --database-port 5432

Переменные окружения

Файлы, необходимые для запуска ECCM и содержащие переменные окружения и конфигурации, находятся в директории, в которую был распакован установочный архив:

postgres/.env
postgres/data/postgresql.conf​
​eccm/.env

postgres/.env

В postgres/.env содержатся переменные, определяющие поведение стека БД PostgreSQL при его запуске в контейнере. В таблице ниже представлено описание данных переменных:

postgres/data/postgresql.conf

Файл содержит параметры, влияющие на производительность базы данных. Настройки по умолчанию достаточны для тестового запуска и поддержки около 100 устройств. Для изменения конфигурации ECCM ознакомьтесь с полным Руководством пользователя или обратитесь в Службу технической поддержки Eltex.

eccm/.env

В файле eccm/.env находятся переменные, определяющие поведение проекта. В таблице ниже представлено описание данных переменных:

./cert/server.crt

./cert/server.key

443

.env.cluster

В файле .env.cluster находятся переменные, определяющие поведение кластера при инсталяции ЕССМ в отказоустойчивой системе. В таблице ниже представлено описание данных переменных:

REPMGR_USER

Доступ к веб-интерфейсу

Для подключения к веб-интерфейсу ECCM откройте браузер и в адресной строке введите следующее:

http://<IP-адрес вашего сервера (ECCM_WEB_ADDRESS)>/

Используемые опции compose-tools.sh

Примеры использования

Для установки Docker и Docker-compose на хост выполните команду:

sudo ./compose-tools.sh --install

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

sudo ./compose-tools.sh --pull

Для запуска проекта перейдите в директорию с файлами установочного архива и выполните команду:

sudo ./compose-tools.sh --start <ECCM ADDRESS>

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

sudo ./compose-tools.sh --start <ECCM ADDRESS> --database-host <DB ADDRESS> --database-port <DB PORT>

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

sudo ./compose-tools.sh --stop

Для очистки всех контейнеров, томов и сетей ECCM выполните команду:

sudo ./compose-tools.sh --clean

Для запуска проекта с нужным уровнем логирования добавьте ключ --logging в строку запуска:

sudo ./compose-tools.sh --start <ECCM ADDRESS> --logging DEBUG

С версии 1.5 в проекте присутствует DHCP-сервер с поддержкой функциональности Zero Touch Provisioning (ZTP), автоматически добавляющей устройства в систему. По умолчанию сервер отключен. Для активации добавьте ключ --dhcp в строку запуска:

sudo ./compose-tools.sh --start <ECCM ADDRESS> --dhcp

Для сохранения всех образов контейнеров в архивы .tar.gz выполните команду:

sudo ./compose-tools.sh --save

Для преобразования архивов с образами (.tar.gz) в docker-образы выполните команду:

sudo ./compose-tools.sh --load

Для преобразования контейнера с новыми параметрами выполните команду (контейнер пересоздаcтся согласно файлу .env соответствующего compose-проекта):

sudo ./compose-tools.sh --recreate-service monitoring-service

Известные проблемы и методы решения

Возможные ошибки при установке проекта

Ошибка:

E: Невозможно найти пакет conntrack

Возможная причина: в системе настроены неактуальные репозитории менеджера пакетов.

Решение: добавить актуальный репозиторий в файл /etc/apt/sources.list и запустить установку проекта:

echo "deb https://download.astralinux.ru/astra/stable/1.7_x86-64/repository-extended/ 1.7_x86-64 main contrib non-free" | sudo tee -a /etc/apt/sources.list
sudo ./compose-tools.sh --install

Возможные ошибки при запуске проекта

Ошибка:

ERROR: Couldn't connect to Docker daemon at http+[docker://localhost](docker://localhost) - is it running?

Возможная причина: docker-демон не запущен. Для проверки выполните команду:

sudo systemctl status docker

Если в строке Active статус отличается от Active (running), причина определена верно.

Решение: запустить docker командой:

sudo systemctl start docker

Ошибка:

Got permission denied while trying to connect to the Docker daemon socket at [unix:///var/run/docker.sock]
(unix://intdocs.eltex.loc/var/run/docker.sock): Get http://%2Fvar%2Frun%2Fdocker.sock/v1.40/containers/json: 
dial unix /var/run/docker.sock: connect: permission denied

Возможная причина: запуск производился от имени непривилегированного пользователя, который не был добавлен в группу docker.

Решение 1 (рекомендуется): добавить пользователя в группу docker с помощью команды:

sudo usermod -aG docker $(whoami)

Решение 2: выполнять все операции с привилегиями root.

Ошибка:

Services starting...
Creating network "eccm_eltex-internal" with the default driver
ERROR: Pool overlaps with other one on this address space

Возможная причина: подсеть, указанная в ECCM_INTERNAL_SUBNETWORK, уже используется docker.

Решение: выбрать другую подсеть в файле .env. Просмотреть уже созданные docker-ом подсети можно с помощью команды:

sudo docker network inspect $(docker network ls --filter "DRIVER=bridge" --format '{{ .Name }}')  -f '{{ .Name  }} {{ (index .IPAM.Config 0).Subnet }}'

Возможные ошибки при работе проекта

Ошибка: некорректно работает мониторинг, не собираются метрики устройств.

Возможная причина: сервису мониторинга не хватает памяти для корректной работы. В логах monitoring-service встречаются записи типа:

WARN  [b1a52920966f70af] [item-poll-executor  ] o.e.e.m.service.BackpressureController   : Batch size adjusted for job 'item polling': 100000 → 0 (adjustment factor: 0.000, memory usage: 97%)

Решение: увеличить лимит памяти для monitoring-service. Для этого в файле eccm/.env увеличить значение переменной ECCM_MONITORING_SERVICE_XMX:

-ECCM_MONITORING_SERVICE_XMX=1G  <--- старое значение
+ECCM_MONITORING_SERVICE_XMX=2G  <--- новое значение

Возможные ошибки при остановке проекта

Ошибка:

ERROR: error while removing network: network eccm_eltex-internal id 324bd72dd9c107cf2ea48effb75d9e7ad2dfbc8f5f7317b89cd7f318d61d5c4b has active endpoints

Возможная причина: docker не полностью очистил кэш.

Решение: перезапуск docker с помощью команды:

sudo systemctl restart docker 

Возможные ошибки при аутентификации

Ошибка: невозможно аутентифицироваться с помощью учетной записи LDAP.

Возможная причина: некорректная настройка подключения к LDAP-серверу.

Решение: в файле eccm/.env установить переменную AUTH_ECCM_AUTHENTICATION_ENABLED=true и перезапустить сервис identity-provider:

sudo ./compose-tools.sh --recreate-service identity-provider

После этого будет доступна аутентификация по локальной учетной записи.

Рекомендации к оформлению заявок в техническую поддержку ECCM

Для получения консультации по работе системы обратитесь в Сервисный центр компании. Способы обращения указаны на последней странице данного руководства.

Для более быстрого и удобного взаимодействия с сотрудниками технической поддержки ECCM укажите при обращении следующую информацию:

1. Установленная версия ECCM и используемая лицензия;
2. Есть ли доступ в сеть Интернет с сервера, на котором разворачивается ПО (без доступа, прямой доступ, через NAT, через Proxy и т. п.);
3. Время возникновения проблемы (желательно как можно более точное);
4. Скриншот или видеофайл, если проблема проявилась в GUI браузера;
5. Информация об устройстве (это может быть IP-адрес устройства, модель устройства), если проблема была связана с каким-то устройством.

Также настоятельно рекомендуется воспользоваться скриптом для сбора информации.

Определение версии ECCM и лицензии

Определить установленную версию ECCM можно одним из следующих способов:

1. При загрузке релизного архива найти информацию о версии в его имени, например, eccm-2.6.tar.gz.
2. Если исходный архив tar.gz был удалён, то информацию о версии можно найти в конфигурационном файле $ECCM_ROOT/eccm/.env (в строке вида: ECCM_TAG=2.6).
3. Просмотреть информацию о версии в левом нижнем углу экрана веб-интерфейса запущенного ECCM:

1 — версия ECCM;
2 — срок действия выпущенной лицензии.

Лицензию можно приложить из исходного файла или выгрузить из веб-интерфейса ECCM. Подробное описание приведено в разделе документации "Руководство пользователя" → "Настройки" → "Система" → "Лицензия".

Скрипт сбора информации

Скрипт автоматизирует сбор метрик c системы ECCM, а затем упаковывает их в сжатый архив для более удобной транспортировки. Предназначен для выполнения на ОС Linux/Ubuntu.

Запуск скрипта:

1. Перейдите в директорию ~/eccm/<версия ECCM>/:

cd ~/eccm/<версия ECCM>/

2. Выполните следующую команду:

sudo ./technical_support.sh

3. Дождитесь, пока скрипт осуществит сбор информации;
4. В директорию будет загружен архив <date_time>-technical_support.tar.gz.

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