...

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

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:

...

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.

...

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:

...

docker-compose version

Running ECCM 

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:

...

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.

Script for running ECCM

Due to the abundance of the system running 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:

...

sudo ./compose-tools.sh --stop

Running ECCM with a database on a separate server

...

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:

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

Якорь
Postgres Postgres

postgres/.env

The postgres/.env 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

The 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

Web interface access

To connect to the ECCM web interface, open a browser and enter the following in the address bar:

...

Якорь
Composetools Composetools

Options used by compose-tools.sh

Examples of use

To install Docker and Docker-compose on the host, run the command:

...

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

Known issues and solution methods

Possible errors during project installation

Error:

E: Cannot find the conntrack package

...

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

Possible errors during project launching

Error:

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

Possible errors during the work of the project

Error: monitoring is not working correctly, device metrics are not collected.

...

-ECCM_MONITORING_SERVICE_XMX=1G  <--- old value
+ECCM_MONITORING_SERVICE_XMX=2G  <--- new value

Possible errors when stopping a project

Error:

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

...

sudo systemctl restart docker 

Possible authentication errors

Error: Unable to authenticate with an LDAP account.

...

Local account authentication will then be available.

Якорь
Techsupp Techsupp

Recommendations for ECCM technical support requests

Contact the company's Service Center for advice on system operation. Refer to the last page of this manual for contact methods.

...

1. The installed version of ECCM and the license used;
2. Whether there is access to the Internet from the server where the firmware is deployed (no access, direct access, via NAT, via Proxy, etc.);
3. The time the issue occurred (preferably as accurate as possible);
4. Screenshot or video file if the issue occurred in the browser GUI;
5. Device information (this could be device IP address, device model) if the problem was related to some device.

Defining the ECCM version and license

It is possible to determine the installed version of ECCM using one of the following methods:

...

The license can be attached from the source file or uploaded from the ECCM web interface.

Якорь
Script Script

Information collection script

The script automates the collection of metrics from the ECCM system, and then packages them into a compressed archive for more convenient transportation. Designed to run on Linux/Ubuntu OS.

...