...
| Varible | Default value | Description |
|---|---|---|
COMPOSE_PROJECT_NAME | postgres | Project name in docker-compose (used for identification if several projects are running on the server) |
POSTGRES_TAG | 2.2 | Version of the postgres container image |
POSTGRES_REGISTRY | hub.eltex-co.ru | The address of the docker-registry from which the postgres image will be retrieved. If a local mirror is used, its address can be specified. |
ROOT_POSTGRES_USER | Parameter that allows to override the superuser login for database access and configuration | |
ROOT_POSTGRES_PASSWORD | Parameter that allows to override the superuser password for database access and configuration | |
ECCM_DATABASE | eccm | Name of the eccm service stack database |
POSTGRES_TIMEZONE | Asia/Novosibirsk | The time zone in which the system operates (specified in accordance with the tz database, for example, “Asia/Novosibirsk”) |
POSTGRES_SHM_SIZE | 2gb | Limiting the allocated RAM for working with the Postgres database |
POSTGRES_PRIVILEGED_MODE | false | Running a container in privileged mode |
|
| External address of the Postgres database |
|
| Maximum number of container log files |
| 50M | Maximum size of container log files |
| true | Enable compression of container log files |
| hub.eltex-co.ru | The address of the docker-registry from which the postgres-configurator image will be retrieved. If a local mirror is used, its address can be specified |
|
| Version of the postgres-configurator container image |
| true | Activation of the postgres-configurator container at system launch |
...
| Varible | Default value | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
COMPOSE_PROJECT_NAME | eccm | Название проекта в Project name in docker-compose (используется для идентификации, в случае если на сервере запущено несколько проектовused for identification if several projects are running on the server) | ||||||||
ECCM_PROFILE | productionПрофиль | проектаProject profile | ||||||||
ECCM_TAG | 2.2 | Версия образов контейнеровContainer image version | ||||||||
ECCM_REGISTRY | hub.eltex-co.ru | Адрес The address of the docker-registry , с которого будет выполняться получение образов системы. Если используется локальное зеркало, то можно указать его адресfrom which system images will be retrieved. If a local mirror is used, its address can be specified | ||||||||
ECCM_BACKBONE_ADDRESS | 192.168.0.1 | Внутренний адрес, на котором будет работать система ECCM с устройствами в сетиInternal address at which the ECCM system will operate with devices on the network | ||||||||
ECCM_WEB_ADDRESS | 192.168.0.1 | Адрес, на котором будет работать web-интерфейс системы ECCMThe address at which the ECCM system web interface will operate | ||||||||
ECCM_WEB_PORT | 80Порт для доступа к web-интерфейсу | Port for accessing the web interface | ||||||||
ECCM_TIMEZONE | Asia/NovosibirskВременной пояс, в котором работает система (указывается в соответствии с tz database, например "Asia/Novosibirsk" | The time zone in which the system operates (specified in accordance with the tz database, for example, “Asia/Novosibirsk”) | ||||||||
ECCM_LOGLEVEL | 'INFO'Уровень логирования в проекте | Logging level in the project | ||||||||
MAX_CONCURRENT_SSH_TASKS | 20Количество одновременно выполняемых операций с устройствами | Number of simultaneous operations performed with devices | ||||||||
POSTGRES_HOST | 192.168.0.1 | Адрес, на котором работает БД PostgresThe address where the Postgres database is running | ||||||||
POSTGRES_PORT | 5432Порт для доступа к БД Postgres | Port for accessing the Postgres database | ||||||||
ROOT_POSTGRES_USER | Параметр, позволяющий переопределить логин суперпользователя для доступа и конфигурирования базы данныхParameter that allows overriding the superuser login for database access and configuration | |||||||||
ROOT_POSTGRES_PASSWORD | Параметр, позволяющий переопределить пароль суперпользователя для доступа и конфигурирования базы данныхParameter that allows to override the superuser password for database access and configuration | |||||||||
ECCM_POSTGRES_DB | eccmНазвание базы данных для сервисов eccm | Database name for eccm services | ||||||||
ECCM_POSTGRES_USER | Параметр, позволяющий переопределить логин по умолчанию для доступа к базе данных Parameter that allows to override the default login for accessing the ECCM_POSTGRES_DB database | |||||||||
ECCM_POSTGRES_PASSWORD | Параметр, позволяющий переопределить пароль по умолчанию для доступа к базе данных Parameter that allows to override the default password for accessing the ECCM_POSTGRES_DB database | |||||||||
| 10m | Интервал отображения push-уведомлений в веб-интерфейсе при ошибке получения лицензииInterval for displaying push notifications in the web interface when a license acquisition error occurs | ||||||||
| 60m | Интервал рассылки уведомлений telegram/email при ошибке получения лицензииTelegram/email notification interval when a license acquisition error occurs | ||||||||
| 1 | Номер текущей ноды. Должен быть уникальным в схеме резервированияCurrent node number. Must be unique in the reservation scheme | ||||||||
| 1GОграничение физической памяти для docker-контейнера | Physical memory limitation for a Docker container | ||||||||
| | Путь к файлу с сертификатом для HTTPSPath to the certificate file for HTTPS | ||||||||
| | Path to the file with the key for HTTPS | ||||||||
KEY_PASS_PATH | ./cert/key.passПуть к файлу с паролем ключа для HTTPS | Path to the file with the key password for HTTPS | ||||||||
| | , на котором ECCM будет доступен по The port on which ECCM will be available via HTTPS | ||||||||
LOGGING_ASPECT_ENABLED | false | Enabling logging via service aspects. The aspect logs all inputs and outputs from methods, their parameters, and return values.
Включение логирования через аспекты сервисов. Аспект логирует все входы и выходы из методов, их параметры, а также возвращаемые значения
| ||||||||
|
| Maximum number of container log files | ||||||||
| 50MМаксимальный размер лог-файлов контейнера | Maximum size of container log files | ||||||||
| trueРазрешить сжатие лог-файлов контейнера | Enable container log file compression | ||||||||
AUTH_ECCM_AUTHENTICATION_ENABLED | false | Включение аутентификации с помощью локальных учетных записей |
Доступ к web-интерфейсу
| Enabling authentication using local accounts |
Web interface access
To connect to the ECCM web interface, open a browser and enter the following in the address barДля подключения к web-интерфейсу ECCM откройте браузер и в адресной строке введите следующее:
http://<IP
...
address of your server (ECCM_WEB_ADDRESS)>/
| Подсказка |
|---|
| По умолчанию используется логин The default login is 'eccm', парольpassword 'eccm'. |
Якорь Composetools Composetools
| Composetools | |
| Composetools |
...
Options used by compose-tools.sh
| ОпцияOption | ОписаниеDescription | ||
|---|---|---|---|
| --clean, -cОчистка всех контейнеров, томов и | сетейCleaning all containers, volumes, and networks | ||
| --delete-containersУдаление контейнеров без удаления томов и сетей | Removing containers without removing volumes and networks | ||
| --dhcp | Активация 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 -адрес подключения к внешней базе данных PostgreSQL, установленной на другом хосте. Не использовать, если на хосте с ЕССМ запущена БД PostgreSQLaddress 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> | Порт подключения к внешней базе данных PostgreSQL, установленной на другом хосте. Не использовать, если на хосте с ЕССМ запущена БД PostgreSQLPort 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Активация режима | поддержки https. Требует наличия сертификатаActivation of https support mode. Requires a certificate. | ||
| --installУстановка | Installing Docker и Docker-compose на хост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 | Запуск системы в режиме сбора метрик. В этом режиме запускаются сервисы Grafana, Prometheus и дополнительные средства мониторинга хоста, docker-контейнеров и БД PostgreSQL. Веб-интерфейс Grafana доступен по адресу 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 | Сохранение всех docker-образов в архивы Saving all Docker images to .tar.gz archives | ||
| --start, -s <ADDRESS>Запуск системы с IP-адресом, по которому будет выполняться подключение к серверу | Running the system with the IP address that will be used to connect to the server | ||
| --stop | Остановка системыSystem shutdown | ||
| --storage <ADDRESS> | Адрес ECCM в сети управления устройствами ECCM address in the device management network (backbone). Используется для хранения прошивок устройствUsed to store device firmware | ||
| --tracing, -t <ADDRESS> | Активация сервиса трассировок Activation of the Jaeger OpenTracing . Необходимо указать IP-адрес Jaeger-сервера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 |
|---|
Примеры использования
...