...

|| DeviceType | ELTEX Cloud Configuration Manager |
|| DeviceName | ECCM |
|| DocTitleAdditional | Installation manual |
|| fwversion | 2.2 |
|| username | eccm |
|| password | eccm |

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

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

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

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

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

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

...

Server requirements

For stable operation, the server must meet the following requirements:

• Linux operating system with Docker support: Ubuntu Server 20.04 (recommended) and newer, Astra Linux 1.7 (server), RedOS 7.3.1, Alt Server 10;

• 16 GB of RAM or more;

• CPU with virtualization support with at least 4 cores;
• free hard disk space from 200GB;
• 1Gbit/s network interface availability.

Obtaining sudo privileges without additional password input (optional)

As an unprivileged user, run the command:

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

Next, enter the password. After that, additional password entry is not required for executing sudo commands or switching to the superuser mode.

Якорь
Install_ECCM Install_ECCM

ECCM installation

Installation archive

The files needed to run the project are distributed as a tar archive. They can be obtained from the public cloud. Download the archive to the server and unpack it. It is recommended to unpack the archive into the pre-created separate directory.

Commands example:

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 and docker-compose installation

The easiest and fastest way to install is to switch to the directory where the installation archive was unpacked and use the compose-tools.sh script using the --install flag:

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

To check the installed docker, the following commands can be run:

docker --version

To check the installed docker-compose in Ubuntu, the following commands can be run:

docker compose version

When installing on Astra Linux, RedOS or Alt Server operating systems, the command to check the version of the installed docker-compose is:

docker-compose version

ECCM start

The ECCM project is distributed as a set of files that allows to run all necessary services using docker-compose. The project is divided into two docker-stacks:

• database (PostgreSQL 14.10);
• ECCM service stack. 

This separation is caused by the need to ensure horizontal scaling of the project and the possibility of integration with other projects of the company, such as Eltex.EDM.

ECCM start script

Due to the abundance of the system startup parameters, a script was prepared that runs the project on one or more hosts with performance parameters that allow servicing about 100 devices. Actual performance depends on many factors, including hardware performance and the complexity of the network devices being serviced. To invoke the help information, navigate to the directory with the script and run the following command:

sudo ./compose-tools.sh -h

Running ECCM on a single host

To start the project, switch to the directory with the files of the installation archive and run the following command

...

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

Файлы, необходимые для запуска проекта, распространяются в виде 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:

cd eccm/2.2
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>

, где where **ECCM ADDRESS** — это IP-адрес, по которому будет выполняться подключение к серверу. Например, если адрес сервера is the IP address that is used for connection to the server. For example, if the server address is 100.110.2.2, команда будет выглядеть the command will look as follows:

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

To stop the project, run the commandДля остановки проекта выполните команду:

sudo ./compose-tools.sh --stop

...

Running ECCM with a database on a separate server

• ECCM Application Server  —

...

• server on which an application is deployed that ensures the operation of the system and interaction with devices, as well as a web user interface;
• Database Server  — server with Postgres14 databases. It is possible to use one that already exists in the cluster infrastructure.
• Device Management Network  — IP

...

• network for managing equipment, through which ECCM has access via L3.
• Operator/Administrator  —

...

• system operator engaged in monitoring and configuration of the controlled equipment/system administrator of the company or ELTEX technical support specialist, if remote access has been agreed upon.

If it is necessary to run ЕССM on multiple servers (one server for the Postgres database, the second server for the rest of the ЕССM service stack), it is possible to use the multi-host installation option. To do this it is neccessary to:

1. Install Docker and Docker Compose on both servers.
2. Configure the server with databases:

2.1. To change login/password/temporary zone/RAM limits for working with the database, edit the postgres/.env file. To change parameters that affect database performance, edit the

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

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

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

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

2.2. Запустите базу данных PostgreSQL на сервере с БД. Для запуска БД перейдите в директорию eccm/postgres и выполните команду для запуска контейнераRun the PostgreSQL database on the server with the database. To run the database, switch to the eccm/postgres directory and execute the command to run the container:

cd eccm/postgers
docker compose up -d

      3. Настройте сервер с приложениями Configure the server with applications:

3.1. Для переопределения переменных, отвечающих за авторизацию пользователя в системе ECCM и поведение проекта (адрес web-интерфейса, временная зона, адрес БД, логин/пароль для доступа к БД и пр.), отредактируйте файл "eccm/.env";To redefine the variables responsible for user authorization in the ECCM system and project behavior (web interface address, time zone, database address, login/password for database access, etc.), edit the “eccm/.env” file;

3.2. Run ECCM on the server with ECCM using the following command3.2. Выполните запуск ЕССМ на сервере с ЕССМ с помощью следующей команды:

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

, где where <DB ADDRESS> и and <DB PORT>— это IP-адрес и порт, по которым будет выполняться подключение к серверу БД. Например, если адрес сервера ЕССМ are the IP address and port to connect to the database server. For example, if the ESSM server address is 100.110.2.2, адрес сервера БД the database server address is 100.110.2.4, порт сервера БД 5432, то команда будет выглядетьand the database server port is 5432, the command is as follows:

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

Якорь
Vars Vars

...

Environment variables

The files required to run ECCM, containing environment and configuration variables, are located in the directory where the installation archive was extracted

...

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

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

Якорь
Postgres Postgres

postgres/.env

В The postgres/.env содержатся переменные, определяющие поведение стека БД Postgres при его запуске в контейнере. В таблице ниже представлено описание данных переменных: file contains variables that determine the behavior of the Postgres database stack when it is launched in a container. The table below provides a description of these variables:

Якорь
Postgresdata Postgresdata

postgres/data/postgresql.conf

Файл содержит параметры, влияющие на производительность базы данных. Настройки по умолчанию достаточны для тестового запуска и поддержки около 100 устройств. Для изменения конфигурации ECCM ознакомьтесь с полным Руководством пользователя или обратитесь в Службу технической поддержки EltexThe file contains parameters that affect database performance. The default settings are sufficient for a test run and support for approximately 100 devices.

Якорь
Eccm Eccm

eccm/.env

В файле The eccm/.env находятся переменные, определяющие поведение проекта. В таблице ниже представлено описание данных переменных: file contains variables that determine the behavior of the project. The table below provides a description of these variables:

./cert/server.crt

./cert/server.key

443

...