...
При запуске будет предложено создать файл .env.personal при , при его отсутствии — подтвердите создание. После этого будет предложено добавить ключ шифрования в файл — подтвердите и это действие.
| Подсказкаnote |
|---|
Для переопределения переменных из
Файл нем переменные. |
| Примечание |
|---|
Скрипт применяет указанный в ECCM ADDRESS адрес к запускаемым контейнерам, но при этом не перезаписывает его в файлах с переменными. Чтобы при запуске использовать адрес, указанный в файлах с переменными, пропишите ключ |
...
3. Подтвердите создание файла .env.personal и создание ключа шифрования.
4. Синхронизируйте файл .env.personal с сервером приложений при помощью следующей команды:
...
3.1. Для переопределения переменных, отвечающих за авторизацию пользователя в системе ECCM и поведение проекта (адрес веб-интерфейса, временная зона, адрес БД, логин/пароль для доступа к БД и пр.), отредактируйте файл "файл eccm/.env";
3.2. Выполните запуск ЕССМ на сервере с ЕССМ с помощью следующей команды:
...
Начиная с версии 2.6 в ЕССМ появилось резервирование формата Active-Active. Процесс запуска ЕССМ в отказоустойчивой системе с сервером базы данных и с отдельным сервером для базы данных описан в разделе "Запуск ЕССМ в отказоустойчивой системе".
Якорь Vars Vars
Переменные окружения
| Vars | |
| Vars |
...
| Блок кода |
|---|
postgres/data/postgresql.conf eccm/.env .env.cluster .env.personal |
| Подсказка |
|---|
Файл |
Якорь Postgresdata Postgresdata
postgres/data/postgresql.conf
| Postgresdata | |
| Postgresdata |
...
| Переменная | Значение по умолчанию | Описание | ||
|---|---|---|---|---|
ECCM_NETWORK_MODE | cluster | Режим работы ЕССМ. Доступные значения: cluster, standalone
| ||
| Роль внешней базы данных при развертывании кластера. Автоматически заполняется при запуске ЕССМ в отказоустойчивой системе с разделением приложения и БД | |||
| IP-адрес master-ноды ECCM. Адрес также используется для PostgreSQL при запуске отказоустойчивой системы по стандартной схеме | |||
| IP-адрес slave-ноды ECCM. Адрес также используется для PostgreSQL при запуске отказоустойчивой системы по стандартной схеме | |||
| IP-адрес witness-ноды ECCM. Адрес также используется для PostgreSQL при запуске отказоустойчивой системы по стандартной схеме | |||
| IP-адрес master-базы данных. Адрес используется только при запуске отказоустойчивой системы с базой данных на отдельном сервере | |||
| IP-адрес slave-базы данных. Адрес используется только при запуске отказоустойчивой системы с базой данных на отдельном сервере | |||
| IP-адрес witness-базы данных. К заполнению не обязателен | |||
| IP-адрес подключения к внешней slave базе данных PostgreSQL, установленной на другом хосте. Использовать при развертывании отказоустойчивой системы с разделением на приложение и БД | |||
| 5432 | Порт подключения к внешней slave базе данных PostgreSQL, установленной на другом хосте. Использовать при развертывании отказоустойчивой системы с разделением на приложение и БД | ||
| 10 | Время в секундах, по истечении которого сервисы ECCM считают БД PostgreSQL недоступной | ||
| 60 | Время в секундах, в течение которого система будет ожидать запуска PostgreSQL. По умолчанию это значение может быть недостаточным для запуска slave-ноды в отказоустойчивой системе, если PostgreSQL не успевает перейти в консистентное состояние после pg_basebackup. Например, при большом размере базы данных на мастер-ноде. | ||
| | Пароль, используемый сервисом RabbitMQ для подключения к кластеру и синхронизации действий между узлами | ||
| Пароль, используемый сервисом Redis для подключения к кластеру | |||
| Пароль, используемый службой мониторинга для подключения к кластеру баз данных и получения информации о состоянии серверов | |||
| redis-master | Уникальное имя, присваиваемое кластеру баз данных для их мониторинга | ||
| 2 | Количество нод, используемых в репликации | ||
| 5000 | Время в миллисекундах, по истечении которого служба мониторинга считает ноду недоступной | ||
| 10000 | Максимальное время в миллисекундах, в течение которого система мониторинга пытается завершить процесс автоматического переключения мастерства между нодами | ||
| repmgr | Имя пользователя, созданного для управления работой и связью между серверами баз данных в кластере | ||
| repmgr | Пароль, обеспечивающий безопасный доступ к служебной базе данных для пользователя REPMGR_USER | ||
| 5 | Время в секундах, в течение которого система будет ожидать ответа при подключении к базе данных PostgreSQL | ||
| 2 | Интервал в секундах, с которым система проверяет состояние и доступность всех серверов в кластере | ||
| 3 | Количество повторных попыток для установления соединения с другим сервером в случае сбоя. Каждая попытка выполняется в течение REPMGR_RECONNECT_INTERVAL | ||
| 3 | Время в секундах между повторными попытками соединения с сервером после неудачи | ||
| 5 | Время в секундах между последовательными попытками проверки готовности базы данных принимать подключения | ||
PEEPER_MONITOR_POSTGRES_USER | peeper_monitor | Параметр, позволяющий переопределить логин по умолчанию для доступа Peeper к базе данных для сбора метрик | ||
PEEPER_MONITOR_POSTGRES_PASSWORD | peeper_monitor | Параметр, позволяющий переопределить пароль по умолчанию для доступа Peeper к базе данных для сбора метрик | ||
| cluster | Common name сертификата. Должен совпадать с Common name сертификата в блоке [ dn ] | ||
| cluster.crt | Наименование сертификата кластера | ||
| ca.crt | Наименование корневого сертификата. Необходим Необходимо для авторизации кластерного сертификата в Redis/Sentinel и Postgresql | ||
| cluster.key | Наименование ключа сертификата кластера | ||
| changeit | Пароль truststore.p12 при генерации средствами ECCM | ||
| truststore.p12 | Наименование truststore.p12 при загрузке пользовательского truststore.p12 | ||
| keystore.p12 | Наименование keystore.p12 при загрузке пользовательского keystore.p12 | ||
| eccm-ca | Имя, под которым Java будет хранить и идентифицировать сертификат внутри truststore.p12 | ||
| false | Использование перезапуска кластера с принудительным назначением ролей БД. Используется в случаях разрушения кластера или обновления |
...
| Подсказка |
|---|
Начиная с версии 2.9 для создания и переопределения системных переменных рекомендуется использовать файл.env.personal — рекомендуемый файл для переопределения системных переменных и добавления новых, вместо редактирования eccm/.env. |
В файле .env.personal находятся хранятся пользовательские секретные значения, переопределяющие которые переопределяют стандартные из значения из eccm/.env. В Описание представлено в таблице ниже представлено описание данных переменных:
| Переменная | Значение по умолчанию | Описание |
|---|---|---|
| ENCRYPTION_SECRET_KEY | – | Ключ шифрования чувствительных данных ECCM из 64 символов с использования использованием алгоритма AES-256 |
Доступ к веб-интерфейсу
...
| Опция | Описание | ||
|---|---|---|---|
| --clean, -c | Очистка всех контейнеров, томов и сетей | ||
| --delete-containers | Удаление контейнеров без удаления томов и сетей | ||
| --dhcp | Активация DHCP-сервера с поддержкой функциональности Zero Touch Provisioning (ZTP), автоматически добавляющей устройства в систему | ||
| --database-only | Запуск только сервиса базы данных PostgreSQL. Сервисы ECCM на хосте не будут запущены | ||
| --database-host <HOST> | IP-адрес подключения к внешней базе данных PostgreSQL, установленной на другом хосте. Для отказоустойчивой системы с разделением на приложение и БД указывается IP-адрес master-БД. Не использовать, если на хосте с ЕССМ запущена БД PostgreSQL. | ||
| --database-port <PORT> | Порт подключения к внешней базе данных PostgreSQL, установленной на другом хосте. Не использовать, если на хосте с ЕССМ запущена БД PostgreSQL | ||
| --backup-database-host <HOST> | IP-адрес slave-базы данных PostgreSQL, установленной на другом хосте. Используется при запуске отказоустойчивой системы с разделением на приложение и БД | ||
| --backup-database-port <PORT> | Порт подключения к slave-базе данных 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 |
| Информация |
|---|
Ключи |
...
Для преобразования контейнера с новыми параметрами выполните команду (контейнер пересоздаcтся согласно файлу .env соответствующего compose-проекта):
...