...

|| DeviceType | Облачный сервис мониторинга и управления конфигурациями «ELTEX» |
|| DeviceName | ECCM |
|| DocTitleAdditional | Инструкция по установке |
|| fwversion | 1.6 |
|| username | eccm |
|| password | eccm |

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

Для стабильной работы сервер должен отвечать следующим требованиям:

• операционная система семейства Linux, поддерживающая docker (рекомендуется Ubuntu server 20 и новее);

• объем оперативной памяти от 8 ГБ;

• процессор, поддерживающий виртуализацию и имеющий от 4-х ядер;

• от 40 ГБ свободного места на жестком диске;

• наличие сетевого интерфейса 1 Гбит/с.

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

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

...

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

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

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

...

wget ftp://wifiguest:GuestWiFi@ftp.eltex.org/eccm/eccm-1.6.tar.gz
mkdir eccm
sudo tar -zxvf eccm-1.6.tar.gz -C eccm/

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

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

...

docker-compose version 1.29.2, build 5becea4

Запуск ECCM

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

...

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

Скрипт запуска

Ввиду обилия параметров запуска системы, был подготовлен скрипт compose-tools.sh, выполняющий запуск проекта на одном хосте с параметрами производительности, позволяющими обслуживать около 100 устройств (фактическая производительность зависит от многих факторов, включающих производительность аппаратной части и сложность обслуживаемых сетевых устройств). 

...

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

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

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

postgres/.env
postgres/data/postgresql.conf​
identity-provider/.env
​eccm/.env

postgres/.env

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

postgres/data/postgresql.conf

Файл содержит параметры, влияющие на производительность базы данных. Настройки по умолчанию достаточны для тестового запуска и поддержки около 100 устройств. Инструкции по изменению конфигурации можно найти на странице ECCM на сайте https://eltex-co.ru/ или обратиться в службу технической поддержки ELTEX.

identity-provider/.env

В файле identity-provider/.env находятся переменные, определяющие поведение группы контейнеров, отвечающих за авторизацию пользователя в системе ECCM.

...

eccm/.env

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

...

Оффлайн установка

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

• Установить docker на хост.
• Загрузить сохраненные docker-образы в хранилище docker-хоста.
• Запустить ECCM.

Установка docker

Docker можно установить в систему множеством способов, выбор которых зависит от используемой операционной системы. Различные варианты установки приведены на официальном сайте https://docs.docker.com/engine/install/ubuntu/#install-from-a-package , далее рассмотрим установку для Ubuntu 20.04 amd64.

...

2. скопируйте на целевой хост и установите командой dpkg -i <packege_name>

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

Скопируйте на хост файл для запуска docker-compose https://github.com/docker/compose/releases/download/1.29.1/docker-compose-Linux-x86_64, поместите его в /usr/local/bin/, с именем docker-compose. Установите для него разрешение на выполнение командой:

...

Для более подробного описания процесса установки обратитесь к официальной документации docker-compose https://docs.docker.com/compose/install/.

Установка сохраненных docker-образов ECCM

Скопируйте на хост установочную директорию с сохраненными архивами docker-образов. Распакуйте их в директорию с установочными файлами ECCM. И запустите их выгрузку в docker.

wget ftp://wifiguest:GuestWiFi@ftp.eltex.org/eccm/images/eccm_images_1.6.tar
sudo tar -xvf eccm_images_1.6.tar -C eccm/1.6
sudo eccm/1.6/compose-tools.sh --load

Запуск ECCM из загруженных образов

После загрузки нужных образов, процедура запуска не отличается от описанной в разделе "Запуск ECCM".

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

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

...

Учетные данные, используемые по умолчанию: логин 'eccm', пароль 'eccm'.

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

Ошибки, возникающие при запуске проекта

Ошибка:

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 }}'

Ошибки, возникающие при остановке проекта

Ошибка:

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

...

sudo systemctl restart docker 

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

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

Общие рекомендации

При обращении стоит сразу указать информацию:

...

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

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

Скрипт автоматизирует сбор метрик c системы, а затем упаковывает их в сжатый архив для более удобной транспортировки.

...