...
| Переменная | Значение по умолчанию | Описание | ||||
|---|---|---|---|---|---|---|
COMPOSE_PROJECT_NAME | eccm | Название проекта в docker-compose (используется для идентификации, в случае если на сервере запущено несколько проектов) | ||||
ECCM_PROFILE | production | Профиль проекта | ||||
ECCM_TAG | 2.6 | Версия образов контейнеров | ||||
ECCM_REGISTRY | hub.eltex-co.ru | Адрес docker-registry, с которого будет выполняться получение образов системы. Если используется локальное зеркало, то можно указать его адрес | ||||
ECCM_BACKBONE_ADDRESS | 192.168.0.1 | Внутренний адрес, на котором будет работать система ECCM с устройствами в сети | ||||
ECCM_WEB_ADDRESS | 192.168.0.1 | Адрес, на котором будет работать веб-интерфейс системы ECCM | ||||
ECCM_WEB_PORT | 80 | Порт для доступа к веб-интерфейсу | ||||
ECCM_TIMEZONE | Asia/Novosibirsk | Временной пояс, в котором работает система (указывается в соответствии с tz database, например "Asia/Novosibirsk") | ||||
ECCM_LOGLEVEL | INFO | Уровень логирования в проекте | ||||
MAX_CONCURRENT_SSH_TASKS | 20 | Количество одновременно выполняемых операций с устройствами | ||||
POSTGRES_HOST | 192.168.0.1 | Адрес, на котором работает БД PostgreSQL | ||||
POSTGRES_PORT | 5432 | Порт для доступа к БД PostgreSQL | ||||
ROOT_POSTGRES_USER | Параметр, позволяющий переопределить логин суперпользователя для доступа и конфигурирования базы данных | |||||
ROOT_POSTGRES_PASSWORD | Параметр, позволяющий переопределить пароль суперпользователя для доступа и конфигурирования базы данных | |||||
ECCM_POSTGRES_DB | eccm | Название базы данных для сервисов eccm | ||||
ECCM_POSTGRES_USER | Параметр, позволяющий переопределить логин по умолчанию для доступа к базе данных ECCM_POSTGRES_DB | |||||
ECCM_POSTGRES_PASSWORD | Параметр, позволяющий переопределить пароль по умолчанию для доступа к базе данных ECCM_POSTGRES_DB | |||||
| 10m | Интервал отображения push-уведомлений в веб-интерфейсе при ошибке получения лицензии | ||||
| 60m | Интервал рассылки уведомлений telegram/email при ошибке получения лицензии | ||||
| 1 | Номер текущей ноды. Должен быть уникальным в схеме резервирования | ||||
| 1G | Ограничение физической памяти для docker-контейнера | ||||
| | Путь к файлу с сертификатом для HTTPS | ||||
| | Путь к файлу с ключом для HTTPS | ||||
KEY_PASS_PATH | ./cert/key.pass | Путь к файлу с паролем ключа для HTTPS | ||||
| | Порт, на котором ECCM будет доступен по HTTPS | ||||
LOGGING_ASPECT_ENABLED | false | Включение логирования через аспекты сервисов. Аспект логирует все входы и выходы из методов, их параметры, а также возвращаемые значения
| ||||
|
| Максимальное количество лог-файлов контейнера | ||||
| 50M | Максимальный размер лог-файлов контейнера | ||||
| true | Разрешить сжатие лог-файлов контейнера | ||||
AUTH_ECCM_AUTHENTICATION_ENABLED | false | Включение аутентификации с помощью локальных учетных записей |
Якорь Cluster Cluster
.env.cluster
| Cluster | |
| Cluster |
| Переменная | Значение по умолчанию | Описание |
|---|---|---|
ECCM_NETWORK_MODE | cluster | Режим работы ЕССМ: cluster, standalone. Если не использовать опцию cluster в скрипте запуска, то выбирается режим работы standalone |
| false | Использование перезапуска кластера. Используется в случаях разрушения кластера или необходимости обновления |
| repmgr | Наименование служебной базы данных, которая используется для отслеживания состояния баз данных в кластере |
| repmgr | Имя пользователя, созданного для управления работой и связью между серверами баз данных в кластере |
| repmgr | Пароль, обеспечивающий безопасный доступ к служебной базе данных для пользователя REPMGR_USER |
| 5 | Время в секундах, в течение которого система будет ожидать ответа при попытке подключиться базе данных мастера. |
| 2 | Время в секундах, с которым система проверяет состояние и доступность всех серверов в кластере |
| 3 | Количество повторных попыток для установления соединения с другим сервером в случае сбоя. Каждая попытка выполняется в течение REPMGR_RECONNECT_INTERVAL |
| 3 | Время в секундах между повторными попытками соединения с сервером после неудачи |
| Разрешенные хосты для подключения в кластер. Указываются все IP-адреса нод, составляющих кластер: master-нода, slave-ноды и witness-нода | |
| Имя хоста master-ноды. При неуказанном значении переменная автоматически заполнится именем хоста сервера, с которого происходит запуск мастер-ноды | |
| master | Наименование master-ноды внутри базы данных ECCM |
| 1 | Уникальный идентификатор мастер-ноды |
| Имя хоста slave-ноды. При неуказанном значении переменная автоматически заполнится именем хоста сервера, с которого происходит запуск slave-ноды | |
| slave | Наименование slave-ноды внутри базы данных ECCM |
| 2 | Уникальный идентификатор slave-ноды |
| Имя хоста witness-ноды. При неуказанном значении переменная автоматически заполнится именем хоста сервера, с которого происходит запуск witness-ноды | |
| witness | Наименование witness-ноды внутри базы данных ECCM |
| 100 | Уникальный идентификатор witness-ноды |
| Внутренний адрес сервера, используемый для связи внутри кластера. Указание не является обязательным, если переменная не задана, значение будет определено автоматически при запуске | |
| Уникальное имя, присваиваемое кластеру баз данных для их мониторинга | |
| Пароль, используемый службой мониторинга для подключения к кластеру баз данных и получения информации о состоянии серверов | |
| 1 | Количество нод, используемых в репликации. Учитываются только количество slave-нод |
| 5000 | Время в миллисекундах после которого служба мониторинга считает ноду недоступной |
| 10000 | Максимальное время в миллисекундах, в течение которого система мониторинга пытается завершить процесс автоматического переключения мастерства между нодами |
| 0.0.0.0 | Сетевые адреса, на которых сервер ожидает входящие подключения для репликации. Рекомендуется оставлять значение по умолчанию |
| eccm | Имя основной базы данных ЕССМ. Дублируется имя базы данных из postgres/.env |
| 5 | Время в секундах между последовательными попытками проверки готовности базы данных принимать подключения |
Доступ к веб-интерфейсу
Для подключения к веб-интерфейсу ECCM откройте браузер и в адресной строке введите следующее:
...
| Опция | Описание | ||
|---|---|---|---|
| --clean, -c | Очистка всех контейнеров, томов и сетей | ||
| --delete-containers | Удаление контейнеров без удаления томов и сетей | ||
| --dhcp | Активация DHCP-сервера с поддержкой функциональности Zero Touch Provisioning (ZTP), автоматически добавляющей устройства в систему | ||
| --database-host <HOST> | IP-адрес подключения к внешней базе данных PostgreSQL, установленной на другом хосте. Не использовать, если на хосте с ЕССМ запущена БД PostgreSQL | ||
| --database-port <PORT> | Порт подключения к внешней базе данных PostgreSQL, установленной на другом хосте. Не использовать, если на хосте с ЕССМ запущена БД PostgreSQL | ||
| --help, -h | Вызов справочной информации | ||
| --https | Активация режима поддержки https. Требует наличия сертификата | ||
| --install | Установка Docker и Docker-compose на хост | ||
| --interactive, -i | Запуск системы в интерактивном режиме. Использовать с ключом --start | ||
| --load | Загрузить все доступные архивы .tar.gz из директории с образами в docker | ||
| --logging, -l <LEVEL> | Задание уровня логирования для проекта ЕССМ. Доступные значения: DEBUG, INFO | ||
| --logging-aspect | Включение логирования через аспекты сервисов. Аспект логирует все входы и выходы из методов, их параметры, а также возвращаемые значения. Не рекомендуется включать этот параметр при штатной работе системы | ||
| --peeper | Запуск системы в интеграции с мониторинговым сервисом Peeper | ||
| --pull, -p | Скачивание/обновление образов перед запуском системы | ||
| --rootlog <LEVEL> | Задание уровня логирования для всех проектов. Доступные значения: DEBUG, INFO | ||
| --save | Сохранение всех docker-образов в архивы .tar.gz | ||
| --start, -s <ADDRESS> | Запуск системы с IP-адресом, по которому будет выполняться подключение к серверу | ||
| --stop | Остановка системы | ||
| --storage <ADDRESS> | Адрес ECCM в сети управления устройствами (backbone). Используется для хранения прошивок устройств | ||
| --tracing, -t <ADDRESS> | Активация сервиса трассировок Jaeger OpenTracing. Необходимо указать IP-адрес Jaeger-сервера | ||
| --show-containers | Показать все контейнеры на сервере | ||
| --show-images | Показать все образы на сервере | ||
| --recreate-service <SERVICE> | Пересоздать контейнер с новыми параметрами
| ||
| --cluster <NODE_ROLE> | Запуск системы в режиме кластера с определнной ролью. Доступные значения: MASTER, SLAVE, WITNESS |
| Информация |
|---|
Ключи --metrics, -m больше не поддерживаются, поскольку весь сбор метрик теперь осуществляет Peeper. Актуальные дашборды будут поставляться только для Peeper-server. |
...