...
| A Shared Block | |||||
|---|---|---|---|---|---|
| |||||
|
| Оглавление | ||
|---|---|---|
|
Для стабильной работы сервер должен отвечать следующим требованиям:
операционная система семейства Linux, поддерживающая docker (рекомендуется Ubuntu server 20 и новее);
объем оперативной памяти от 8 ГБ;
процессор, поддерживающий виртуализацию и имеющий от 4-х ядер;
от 40 ГБ свободного места на жестком диске;
наличие сетевого интерфейса 1 Гбит/с.
Получение привилегий sudo без дополнительного ввода пароля (опционально)
От имени непривилегированного пользователя необходимо выполнить команду:
...
Далее необходимо ввести пароль. После этого для выполнения команд с sudo или перехода в режим суперпользователя дополнительный ввод пароля не потребуется.
Установочный архив
Файлы, необходимые для запуска проекта, распространяются в виде tar-архива. Их можно получить с общедоступного ftp-сервера. Загрузите архив на сервер и распакуйте его. Рекомендуется распаковывать архив в заранее созданную отдельную директорию.
...
| Блок кода |
|---|
wget ftp://wifiguest:GuestWiFi@ftp.eltex.org/eccm/eccm-1.5.tar.gz mkdir eccm sudo tar -zxvf eccm-1.5.tar.gz eccm/ |
Установка docker и docker-compose
Наиболее простой и быстрый способ установки — перейти в директорию, в которую был распакован установочный архив, и воспользоваться скриптом compose-tools.sh, используя флаг --install:
...
| Блок кода |
|---|
docker-compose version 1.29.2, build 5becea4 |
Запуск ECCM
Проект ECCM в данное время распространяется в виде набора файлов, позволяющих запустить все необходимые сервисы с помощью docker-compose. Проект разделен на три docker-стека:
...
Такое разделение обусловлено необходимостью обеспечения горизонтального масштабирования проекта и созданием возможности интеграции с другими проектами компании, например Eltex.EDM.
Скрипт для запуска ECCM
Ввиду обилия параметров запуска системы, был подготовлен скрипт, выполняющий запуск проекта на одном хосте с параметрами производительности, позволяющими обслуживать около 100 устройств (фактическая производительность зависит от многих факторов, включающих производительность аппаратной части и сложность обслуживаемых сетевых устройств).
...
| Блок кода |
|---|
sudo ./compose-tools.sh --start 100.110.2.2 --dhcp |
Переменные окружения
Файлы, необходимые для запуска ECCM и содержащие переменные окружения и конфигурации, находятся в директории, в которую вы распаковали установочный архив:
| Блок кода |
|---|
postgres/.env postgres/data/postgresql.conf identity-provider/.env eccm/.env |
postgres/.env
В postgres/.env находятся переменные, определяющие поведение БД Postgres при запуске её в контейнере. В таблице представлен перечень данных переменных:
| Переменная | Значение по умолчанию | Описание |
|---|---|---|
COMPOSE_PROJECT_NAME | postgres | Название проекта в docker-compose (используется для идентификации, в случае если на сервере запущено несколько проектов) |
POSTGRES_USER | Параметр, позволяющий переопределить логин по умолчанию для доступа к базе данных | |
POSTGRES_PASSWORD | Параметр, позволяющий переопределить пароль по умолчанию для доступа к базе данных | |
POSTGRES_TIMEZONE | Asia/Novosibirsk | Временной пояс, в котором работает система (указывается в соответствии с tz database, например Asia/Novosibirsk) |
POSTGRES_SHM_SIZE | 2gb | Ограничение выделенной оперативной памяти для работы с БД Postgres |
postgres/data/postgresql.conf
Файл содержит параметры, влияющие на производительность базы данных. Настройки по умолчанию достаточны для тестового запуска и поддержки около 100 устройств. Инструкции по изменению конфигурации можно найти на странице ECCM на сайте https://eltex-co.ru/ или обратиться в службу технической поддержки ELTEX.
identity-provider/.env
В файле identity-provider/.env находятся переменные, определяющие поведение группы контейнеров, отвечающих за авторизацию пользователя в системе ECCM.
...
| Переменная | Значение по умолчанию | Описание |
|---|---|---|
COMPOSE_PROJECT_NAME | eccm | Название проекта в docker-compose (используется для идентификации, в случае если на сервере запущено несколько проектов) |
ECCM_PROFILE | production | |
IDENTITY_PROVIDER_TAG | 1.5 | |
IDENTITY_PROVIDER_REGISTRY | hub.eltex-co.ru | Адрес docker-registry, с которого будет выполняться получение образов системы. Если используется локальное зеркало, то можно указать его адрес |
IDENTITY_PROVIDER_WEB_ADDRESS | 192.168.0.1 | Адрес, на котором будет работать сервис identity-provider |
IDENTITY_PROVIDER_WEB_PORT | 9090 | Порт для доступа к сервису identity-provider |
POSTGRES_HOST | 192.168.0.1 | Адрес, на котором работает БД Postgres |
POSTGRES_PORT | 5432 | Порт для доступа к БД Postgres |
POSTGRES_USER | Параметр, позволяющий переопределить логин по умолчанию для доступа к базе данных | |
POSTGRES_PASSWORD | Параметр, позволяющий переопределить пароль по умолчанию для доступа к базе данных |
eccm/.env
В файле eccm/.env находятся переменные, определяющие поведение проекта.
...
| Переменная | Значение по умолчанию | Описание |
|---|---|---|
COMPOSE_PROJECT_NAME | eccm | Название проекта в docker-compose (используется для идентификации, в случае если на сервере запущено несколько проектов) |
ECCM_PROFILE | production | |
ECCM_TAG | 1.5 | |
ECCM_REGISTRY | hub.eltex-co.ru | Адрес docker-registry, с которого будет выполняться получение образов системы. Если используется локальное зеркало, то можно указать его адрес |
ECCM_BACKBONE_ADDRESS | 192.168.0.1 | Внутренний адрес, на котором будет работать система ECCM с устройствами в сети |
ECCM_WEB_ADDRESS | 192.168.0.1 | Адрес, на котором будет работать web-интерфейс системы ECCM |
IDENTITY_PROVIDER_HOST | 192.168.0.1 | Внешний адрес сервиса identity-provider |
IDENTITY_PROVIDER_PORT | 9090 | Порт для доступа к сервису identity-provider |
ECCM_WEB_PORT | 80 | Порт для доступа к web-интерфейсу |
ECCM_TIMEZONE | Asia/Novosibirsk | Временной пояс, в котором работает система (указывается в соответствии с tz database, например Asia/Novosibirsk) |
ECCM_LOGLEVEL | 'INFO' | Уровень логирования в проекте |
MAX_PARALLEL_TASKS | 4 | Количество одновременно выполняемых операций с устройствами |
ECCM_MONITORING_SERVER_MEM_HARD_LIMIT | 512M | Ограничение физической памяти для docker-контейнера |
ECCM_MONITORING_WEB_MEM_HARD_LIMIT | 256M | Ограничение физической памяти для docker-контейнера |
POSTGRES_HOST | 192.168.0.1 | Адрес, на котором работает БД Postgres |
POSTGRES_PORT | 5432 | Порт для доступа к БД Postgres |
POSTGRES_USER | Параметр, позволяющий переопределить логин по умолчанию для доступа к базе данных | |
POSTGRES_PASSWORD | Параметр, позволяющий переопределить пароль по умолчанию для доступа к базе данных |
Доступ к web-интерфейсу
Для подключения к web-интерфейсу ECCM нужно ввести в браузере следующий адрес:
...
Учетные данные, используемые по умолчанию: логин 'eccm', пароль 'eccm'.
Известные проблемы и методы решения
Ошибки, возникающие при запуске проекта
Ошибка:
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 }}' |
Ошибки, возникающие при остановке проекта
Ошибка:
ERROR: error while removing network: network eccm_eltex-internal id 324bd72dd9c107cf2ea48effb75d9e7ad2dfbc8f5f7317b89cd7f318d61d5c4b has active endpoints...