...
| Option | Description | ||
|---|---|---|---|
| --clean, -c | Cleaning all containers, volumes, and networks | ||
| --delete-containers | Removing containers without removing volumes and networks | ||
| --dhcp | Activation of a DHCP server with support for Zero Touch Provisioning (ZTP) functionality, which automatically adds devices to the system | ||
| --database-host <HOST> | IP address for connecting to an external PostgreSQL database installed on another host. Do not use if the PostgreSQL database is running on the host with ЕССM | ||
| --database-port <PORT> | Port for connecting to an external PostgreSQL database installed on another host. Do not use if the PostgreSQL database is running on the host with ЕССM | ||
| --help, -h | Calling up reference information | ||
| --https | Activation of https support mode. Requires a certificate. | ||
| --install | Installing Docker and Docker Compose on the host | ||
| --interactive, -i | Start the system in interactive mode. Use with the --start key | ||
| --load | Load all available .tar.gz archives from the image directory into docker | ||
| --logging, -l <LEVEL> | Set the logging level for the ESSM project. Available values: DEBUG, INFO | ||
| --logging-aspect | Enabling logging via service aspects. The aspect logs all entries and exits from methods, their parameters, and return values. It is not recommended to enable this parameter during normal system operation | ||
| --metrics, -m | Launching the system in metric collection mode. In this mode, Grafana, Prometheus, and additional monitoring tools for the host, Docker containers, and PostgreSQL databases are launched. The Grafana web interface is available at http://<IP_ECCM>:3000 | ||
| --pull, -p | Downloading/updating images before system launch | ||
| --rootlog <LEVEL> | Set the logging level for all projects. Available values: DEBUG, INFO | ||
| --save | Saving all Docker images to .tar.gz archives | ||
| --start, -s <ADDRESS> | Running the system with the IP address that will be used to connect to the server | ||
| --stop | System shutdown | ||
| --storage <ADDRESS> | ECCM address in the device management network (backbone). Used to store device firmware | ||
| --tracing, -t <ADDRESS> | Activation of the Jaeger OpenTracing tracing service. It is necessary to specify the IP address of the Jaeger server | ||
| --show-containers | Show all containers on the server | ||
| --show-images | Show all images on the server | ||
| --recreate-service <SERVICE> | Recreate the container with new parameters
|
| Scroll Pagebreak |
|---|
Примеры использования
Examples of use
To install Docker and Docker-compose on the host, run the commandДля установки Docker и Docker-compose на хост выполните команду:
| Блок кода |
|---|
sudo ./compose-tools.sh --install |
Для обновления образов всех контейнеров ECCM выполните командуTo update the images of all ECCM containers, run the command:
| Блок кода |
|---|
sudo ./compose-tools.sh --pull |
Для запуска проекта перейдите в директорию с файлами установочного архива и выполните командуTo run the project, enter the directory containing the installation archive files and run the command:
| Блок кода |
|---|
sudo ./compose-tools.sh --start <ECCM ADDRESS> |
Для запуска и подключения проекта к базе данных, установленной на другом хосте, выполните командуTo run and connect the project to a database installed on another host, run the command:
| Блок кода |
|---|
sudo ./compose-tools.sh --start <ECCM ADDRESS> --database-host <DB ADDRESS> --database-port <DB PORT> |
Для остановки проекта выполните командуTo stop the project, run the command:
| Блок кода |
|---|
sudo ./compose-tools.sh --stop |
Для очистки всех контейнеров, томов и сетей ECCM выполните командуTo clean all containers, volumes, and ECCM networks, run the command:
| Блок кода |
|---|
sudo ./compose-tools.sh --clean |
| Примечание |
|---|
| При запуске скрипта с флагом When running the script with the flag, data from the Postgres database will also be deleted. This flag is recommended only when completely uninstalling ECCM from the server. |
Для запуска проекта с нужным уровнем логирования добавьте ключ --logging в строку запуска:
...