Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue

Версия ПО Firmware version 2.2


A Shared Block
hiddentrue


Metadata list
hiddentrue
|| DeviceType | СервисELTEX мониторингаCloud и управления конфигурациями «ELTEX»Configuration Manager |
|| DeviceName | ECCM |
|| DocTitleAdditional | Инструкция по установке и запускуInstallation manual |
|| fwversion | 2.2 |
|| username | eccm |
|| password | eccm |


Оглавление
printablefalse

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

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

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

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

...

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

Якорь
Install_ECCM
Install_ECCM
Установка ECCM

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

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

...

Блок кода
wget "https://cloud.eltex-co.ru/index.php/s/P8xDfmyo3XyEs0g/download?path=%2F&files=eccm-2.2.tar.gz" -O eccm-2.2.tar.gz
mkdir eccm
tar -zxvf eccm-2.2.tar.gz -C eccm/

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

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

...

Блок кода
docker-compose version

Offline-установка

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

Запуск ECCM

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

...

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

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

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

...

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

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

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

...

Блок кода
sudo ./compose-tools.sh --stop

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

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameСтруктурная схема_в2
simpleViewerfalse
width400
diagramWidth772
revision1

...

Блок кода
sudo ./compose-tools.sh --start 100.110.2.2 --database-host 100.110.2.4 --database-port 5432

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

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

Блок кода
postgres/.env
postgres/data/postgresql.conf​
​eccm/.env

Якорь
Postgres
Postgres
postgres/.env

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

ПеременнаяЗначение по умолчаниюОписание
COMPOSE_PROJECT_NAMEpostgresНазвание проекта в docker-compose (используется для идентификации, в случае если на сервере запущено несколько проектов)
POSTGRES_TAG2.2Версия образа контейнера postgres
POSTGRES_REGISTRYhub.eltex-co.ruАдрес docker-registry, с которого будет выполняться получение образа postgres. Если используется локальное зеркало, то можно указать его адрес
ROOT_POSTGRES_USER
Параметр, позволяющий переопределить логин суперпользователя для доступа и конфигурирования базы данных
ROOT_POSTGRES_PASSWORD
Параметр, позволяющий переопределить пароль суперпользователя для доступа и конфигурирования базы данных
ECCM_DATABASEeccmНазвание базы данных стека сервисов eccm
POSTGRES_TIMEZONEAsia/NovosibirskВременной пояс, в котором работает система (указывается в соответствии с tz database, например "Asia/Novosibirsk")
POSTGRES_SHM_SIZE2gbОграничение выделенной оперативной памяти для работы с БД Postgres
POSTGRES_PRIVILEGED_MODEfalseЗапуск контейнера в привилегированном режиме

POSTGRES_HOST

192.168.0.1

Внешний адрес БД Postgres

LOGGING_MAX_FILES

5

Максимальное количество лог-файлов контейнеров

LOGGING_MAX_FILE_SIZE

50MМаксимальный размер лог-файлов контейнеров

LOGGING_COMPRESS

trueРазрешение сжатия лог-файлов контейнеров

POSTGRES_CONFIGURATOR_REGISTRY

hub.eltex-co.ruАдрес docker-registry, с которого будет выполняться получение образа postgres-configurator. Если используется локальное зеркало, то можно указать его адрес

POSTGRES_CONFIGURATOR_TAG

0.5

Версия образа контейнера postgres-configurator

ENABLE_POSTGRES_CONFIGURATOR

trueАктивация запуска контейнера postgres-configurator при старте системы

Якорь
Postgresdata
Postgresdata
postgres/data/postgresql.conf

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

Якорь
Eccm
Eccm
eccm/.env

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

ПеременнаяЗначение по умолчаниюОписание
COMPOSE_PROJECT_NAMEeccmНазвание проекта в docker-compose (используется для идентификации, в случае если на сервере запущено несколько проектов)
ECCM_PROFILEproductionПрофиль проекта
ECCM_TAG2.2Версия образов контейнеров
ECCM_REGISTRYhub.eltex-co.ruАдрес docker-registry, с которого будет выполняться получение образов системы. Если используется локальное зеркало, то можно указать его адрес
ECCM_BACKBONE_ADDRESS192.168.0.1Внутренний адрес, на котором будет работать система ECCM с устройствами в сети
ECCM_WEB_ADDRESS192.168.0.1Адрес, на котором будет работать web-интерфейс системы ECCM
ECCM_WEB_PORT80Порт для доступа к web-интерфейсу
ECCM_TIMEZONEAsia/NovosibirskВременной пояс, в котором работает система (указывается в соответствии с tz database, например "Asia/Novosibirsk")
ECCM_LOGLEVEL'INFO'Уровень логирования в проекте
MAX_CONCURRENT_SSH_TASKS20Количество одновременно выполняемых операций с устройствами
POSTGRES_HOST192.168.0.1Адрес, на котором работает БД Postgres
POSTGRES_PORT5432Порт для доступа к БД Postgres
ROOT_POSTGRES_USER
Параметр, позволяющий переопределить логин суперпользователя для доступа и конфигурирования базы данных
ROOT_POSTGRES_PASSWORD
Параметр, позволяющий переопределить пароль суперпользователя для доступа и конфигурирования базы данных
ECCM_POSTGRES_DBeccmНазвание базы данных для сервисов eccm
ECCM_POSTGRES_USER
Параметр, позволяющий переопределить логин по умолчанию для доступа к базе данных ECCM_POSTGRES_DB
ECCM_POSTGRES_PASSWORD
Параметр, позволяющий переопределить пароль по умолчанию для доступа к базе данных ECCM_POSTGRES_DB

ECCM_DEVICE_MANAGER_ELM_DOWN_WEB_NOTIFICATION_INTERVAL

10mИнтервал отображения push-уведомлений в веб-интерфейсе при ошибке получения лицензии

ECCM_LICENSE_SERVICE_ELM_DOWN_NOTIFICATION_INTERVAL

60mИнтервал рассылки уведомлений telegram/email при ошибке получения лицензии

ECCM_LICENSE_SERVICE_NODE_NUMBER

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

ECCM_MONITORING_SERVICE_XMX

1GОграничение физической памяти для docker-контейнера

CERT_PATH

./cert/server.crt
Путь к файлу с сертификатом для HTTPS

KEY_PATH

./cert/server.key
Путь к файлу с ключом для HTTPS
KEY_PASS_PATH./cert/key.passПуть к файлу с паролем ключа для HTTPS

ECCM_WEB_HTTPS_PORT

443
Порт, на котором ECCM будет доступен по HTTPS
LOGGING_ASPECT_ENABLEDfalse

Включение логирования через аспекты сервисов. Аспект логирует все входы и выходы из методов, их параметры, а также возвращаемые значения

Примечание
Не рекомендуется включать этот параметр при штатной работе системы


Информация
Переменные настройки логирования (LOGGING_*) применяются ко всем контейнерам стека eccm


LOGGING_MAX_FILES

5

Максимальное количество лог-файлов контейнера

LOGGING_MAX_FILE_SIZE

50MМаксимальный размер лог-файлов контейнера

LOGGING_COMPRESS

trueРазрешить сжатие лог-файлов контейнера
AUTH_ECCM_AUTHENTICATION_ENABLEDfalseВключение аутентификации с помощью локальных учетных записей


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

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

...

Подсказка
По умолчанию используется логин 'eccm', пароль 'eccm'.


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

ОпцияОписание
--clean, -cОчистка всех контейнеров, томов и сетей
--delete-containersУдаление контейнеров без удаления томов и сетей
--dhcpАктивация DHCP-сервера с поддержкой функциональности Zero Touch Provisioning (ZTP), автоматически добавляющей устройства в систему
--database-host <HOST>IP-адрес подключения к внешней базе данных PostgreSQL, установленной на другом хосте. Не использовать, если на хосте с ЕССМ запущена БД PostgreSQL
--database-port <PORT>Порт подключения к внешней базе данных PostgreSQL, установленной на другом хосте. Не использовать, если на хосте с ЕССМ запущена БД PostgreSQL
--help, -hВызов справочной информации
--httpsАктивация режима поддержки https. Требует наличия сертификата
--installУстановка Docker и Docker-compose на хост
--interactive, -iЗапуск системы в интерактивном режиме. Использовать с ключом --start
--loadЗагрузить все доступные архивы .tar.gz из директории с образами в docker
--logging, -l <LEVEL>Задание уровня логирования для проекта ЕССМ. Доступные значения: DEBUG, INFO
--logging-aspectВключение логирования через аспекты сервисов. Аспект логирует все входы и выходы из методов, их параметры, а также возвращаемые значения. Не рекомендуется включать этот параметр при штатной работе системы
--metrics, -mЗапуск системы в режиме сбора метрик. В этом режиме запускаются сервисы Grafana, Prometheus и дополнительные средства мониторинга хоста, docker-контейнеров и БД PostgreSQL. Веб-интерфейс Grafana доступен по адресу http://<IP_ECCM>:3000
--pull, -pСкачивание/обновление образов перед запуском системы
--rootlog <LEVEL>Задание уровня логирования для всех проектов. Доступные значения: DEBUG, INFO
--saveСохранение всех docker-образов в архивы .tar.gz
--start, -s <ADDRESS>Запуск системы с IP-адресом, по которому будет выполняться подключение к серверу
--stopОстановка системы
--storage <ADDRESS>Адрес ECCM в сети управления устройствами (backbone). Используется для хранения прошивок устройств
--tracing, -t <ADDRESS>Активация сервиса трассировок Jaeger OpenTracing. Необходимо указать IP-адрес Jaeger-сервера
--show-containersПоказать все контейнеры на сервере
--show-imagesПоказать все образы на сервере
--recreate-service <SERVICE>

Пересоздать контейнер с новыми параметрами

Примечание

Контейнер пересоздается согласно файлу .env соответствующего compose-проекта.


Scroll Pagebreak

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

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

...

Блок кода
sudo ./compose-tools.sh --recreate-service monitoring-service

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

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

Ошибка:

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

...

Блок кода
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?

...

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

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

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

...

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

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

Ошибка:

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

...

Блок кода
sudo systemctl restart docker 

Scroll Pagebreak

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

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

...

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

Scroll Pagebreak

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

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

...

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

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

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

...

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

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

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

...