Изменение параметров ELMA365 Enterprise

Наименование

Описание

GLOBAL — Параметры платформы

elma365.global.host

Домен (FQDN) или IP-адрес, по которому будет доступна система.

При установке системы с указанием доменного имени необходимо в DNS-сервер внести соответствующую А-запись: "myelma365.com" <-> "IP адрес машины с ELMA365". Обратите внимание, имя домена вводится строчными буквами.

Значение по умолчанию: example.ru.

elma365.global.ingress.hostEnabled

Включение host в ingress (значение берётся из elma365.global.host), если включена поддержка TLS значение автоматически выставляется true.

Важно: если не включена поддержка TLS, рекомендуется ее включить. Также планируется использовать домен (FQDN) для доступа к хранилищу S3 minio, установленному в Kubernetes-кластер чартами elma365-dbs.

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.global.ingress.annotations

Аннотации для ingress.

{"kubernetes.io/ingress.class": "nginx"}.

elma365.global.kubeVersion

Переопределить версию Kubernetes.

elma365.global.openshift

Включение поддержки HAProxy Ingress для работы на платформе OpenShift.

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.global.machineId

Начало внимание

Начиная с версии 2023.10 параметр не используется.

Конец внимание

Путь к файлу machine-id.

Значение по умолчанию: /etc/machine-id.

elma365.global.checkdbs

Включает проверку подключения к БД при установке или обновлении приложения ELMA365.

Значение по умолчанию: true.

Доступные варианты: true, false.

GLOBAL — Параметры TLS шифрования

elma365.global.ingress.onpremiseTls.enabled

Включение поддержки TLS (Включение HTTPS).

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.global.ingress.onpremiseTls.secret

Наименование секрета с сертификатами для работы HTTPS.

Значение по умолчанию: elma365-onpremise-tls.

elma365.global.ingress.onpremiseTls.enabledCA

Включение сертификата корневого CA для работы HTTPS с самоподписанным сертификатом.

Важно: перед включением необходимо установить компоненты дополнений.

Подробнее читайте в статье «Включение Network Encryption (TLS) в ELMA365 Enterprise».

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.global.ingress.onpremiseTls.configCA

Наименование конфигмапа с сертификатом корневого CA для работы HTTPS с самоподписанным сертификатом.

Значение по умолчанию: elma365-onpremise-ca.

GLOBAL — Параметры мониторинга

elma365.global.monitoring.enabled

Включает поддержку мониторинга на стороне приложения ELMA365.

Важно: перед включением мониторинга сервисов необходимо установить компоненты дополнений. Подробнее читайте в статье «Включение параметров мониторинга в ELMA365 Enterprise».

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.global.monitoring.metrics.enabled

Включает установку ServiceMonitor в Kubernetes-кластер для сервисов приложения ELMA365.

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.global.monitoring.metrics.all

Включает предоставление значительно большего количества метрик в формате Prometheus сервисами приложения ELMA365. По умолчанию отключено, для предотвращения нарушения работы всего мониторинга слишком большим количеством метрик.

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.global.monitoring.provisioner

Настраивает поставляемые средства мониторинга под целевую платформу.

Значение по умолчанию: k8s.

Доступные варианты: k8s, deckhouse.

elma365.global.monitoring.dashboard.enabled

Включает установку Dashboards (ConfigMap) в Kubernetes-кластер для сервисов приложения ELMA365.

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.global.monitoring.alerts.enabled

Включает установку PrometheusRule (CRD) в Kubernetes-кластер для сервисов приложения ELMA365.

Значение по умолчанию: false.

Доступные варианты: true, false.

global.monitoring.lowcode.metricExportEnabled

Включает экспорт метрик elma365_telemetry_*, которые фиксируются в отчёте о производительности, в хранилище Prometheus для их визуализации с помощью Grafana.

Значение по умолчанию: false.

Доступные варианты: true, false.

GLOBAL — Параметры переносимых сервисов

elma365.global.managedServices.enabled

Включает поддержку переносимых сервисов.
Значение по умолчанию: true.
Доступные варианты: true, false.

elma365.global.managedServices.defaultStorageClass

Укажите систему хранения данных.
Значение по умолчанию: longhorn.

elma365.global.managedServices.namespace

Наименования namespace, где будут размещаться переносимые сервисы.
Значение по умолчанию: elma365-applets.

GLOBAL — Параметры масштабирования сервисов

elma365.global.autoscaling.enabled

Включает поддержку автомаcштабирования на стороне приложения ELMA365.

Важно: перед включением масштабирования сервисов необходимо установить компоненты дополнений. Подробнее читайте в статье «Включение автомасштабирования сервисов в ELMA365 Enterprise».

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.global.autoscaling.type

Выбор метода автомасштабирования.

Значение по умолчанию: hpa.

Доступные варианты: hpa, keda.

Где:

• keda — Kubernetes Event-driven Autoscaling;
• hpa — Horizontal Pod Autoscaler.

elma365.global.autoscaling.minReplicas

Настраивает минимальное количество реплик.

Значение по умолчанию: 1.

elma365.global.autoscaling.maxReplicas

Настраивает максимальное количество реплик.

Значение по умолчанию: 9.

GLOBAL — Параметры подключения к приватному хранилищу образов контейнеров

elma365.global.image.repository

Строка подключения к приватному registry.

Формат: hostname:port/path.

Где:

• hostname — IP или доменное имя приватного registry;
• port — порт для подключения;
• path — путь до каталога.

Значение по умолчанию: hub.elma365.tech.

elma365.global.image.pullSecret

Наименование секрета с правами доступа к приватному registry (должен быть создан вручную, зашифрован в Base64).

Значение по умолчанию: yandexsecret.

GLOBAL — Дополнительные параметры

elma365.global.postgres.maxIdleConns

Максимальное количество подключений в пуле незанятых подключений.

Значение по умолчанию: 10.

elma365.global.postgres.maxOpenConns

Максимальное количество открытых подключений из пула.

Значение по умолчанию: 50.

elma365.global.postgres.maxConnLife

Максимальное время жизни подключения из пула.

Значение по умолчанию: 1m.

elma365.global.postgres.poolMaxIdleConns

Максимальное количество подключений в пуле незанятых подключений.

Значение по умолчанию: 10.

elma365.global.postgres.poolMaxOpenConns

Максимальное количество открытых подключений из пула.

Значение по умолчанию: 50.

elma365.global.postgres.poolConnMaxLifetime

Максимальное время жизни подключения из пула.

Значение по умолчанию: 5m.

elma365.global.maxGrpcMessageSize

Максимальный размер ответов.

Значение по умолчанию: 8388608.

elma365.global.maxGrpcBackoffDelay

Максимальная задержка между попытками установки GRPC соединения.

Значение по умолчанию: 2s.

elma365.global.activeDeadlineSeconds

Количество секунд, которое отводится всему Job на выполнение.

Значение по умолчанию: 3000.

elma365.global.backoffLimit

Количество попыток миграции при обновлении ELMA365.

Значение по умолчанию: 5.

Параметры отладки платформы

elma365.debug

Включает режим отладки платформы.

Значение по умолчанию: false.

Доступные варианты: true, false.

Параметры компании

elma365.bootstrapCompany.email

Указывается электронный адрес. Электронный адрес будет являться логином для входа главного администратора.

Важно: используется при создании компании в момент установки ELMA365, изменение elma365.bootstrapCompany.email делает невозможным применении новых параметров или обновление ELMA365.

Значение по умолчанию: admin@mail.com.

elma365.bootstrapCompany.password

Пароль для входа главного администратора.

Важно: используется при создании компании в момент установки ELMA365.

Значение по умолчанию: test.

elma365.bootstrapCompany.locale

Язык интерфейса компании.

Значение по умолчанию: ru-RU.

Доступные варианты: "ru-RU", "en-US", "sk-SK", "es-ES", "de-DE".

Параметры языка платформы

elma365.language.default

Язык установленной платформы.

Значение по умолчанию: ru-RU.

Доступные варианты: "ru-RU", "en-US", "sk-SK", "es-ES", "de-DE".

Параметры подключения к базам данных

elma365.db.psqlUrl

Строка подключения к PostgreSQL для операций записи и чтения.

Формат: postgresql://user:password@hostname:port/databaseName?sslmode=disable.

Где:

• user — имя пользователя PostgreSQL имеющего права на базу данных databaseName
• password — пароль для пользователя PostgreSQL;
• hostname — IP или доменное имя сервера PostgreSQL;
• port — порт для подключения к PostgreSQL, стандартный порт: 5432;
• databaseName — наименование базы данных;
• sslmode — использование защищённого соединения.

elma365.db.secrets

Включает возможность использовать внешние секреты для подключения к БД (psqlSecret, roPsqlSecret, mongoSecret, redisSecret, amqpSecret, s3Secret).

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.db.psqlSecret

Наименование секрета с подключением к PostgreSQL для операций чтения (должен быть создан вручную, зашифрован в Base64).

Должен содержать ключ PSQL_URL.

Важно: включение elma365.db.psqlSecret отключает параметр elma365.db.roPsqlUrl.

elma365.db.roPsqlUrl

Строка подключения к PostgreSQL для операций чтения.

Формат: postgresql://user:password@hostname:port/databaseName?sslmode=disable.

Где:

• user — имя пользователя PostgreSQL имеющего права на базу данных databaseName
• password — пароль для пользователя PostgreSQL;
• hostname — IP или доменное имя сервера PostgreSQL;
• port — порт для подключения к PostgreSQL, стандартный порт: 5432;
• databaseName — наименование базы данных;
• sslmode — использование защищённого соединения.

elma365.db.roPsqlSecret

Наименование секрета с подключением к PostgreSQL для операций чтения (должен быть создан вручную, зашифрован в Base64).

Должен содержать ключ RO_POSTGRES_URL.

Важно: включение elma365.db.roPsqlSecret отключает параметр elma365.db.roPsqlUrl.

elma365.db.mongoUrl

Строка подключения к MongoDB.

Формат: mongodb://user:password@hostname:port/databaseName?ssl=false&replicaSet=rs0&readPreference=nearest.

Где:

• user — имя пользователя MongoDB имеющего права на базу данных databaseName;
• password — пароль для пользователя MongoDB;
• hostname — IP или доменное имя сервера MongoDB;
• port — порт для подключения к MongoDB, стандартный порт 27017;
• databaseName — наименование базы данных;
• ssl — использование защищённого соединения;
• replicaSet — номер набора реплик;
• readPreference — предпочтительный режим чтения.

elma365.db.mongoSecret

Наименование секрета с подключением к MongoDB (должен быть создан вручную, зашифрован в Base64).

Должен содержать ключ MONGO_URL.

Важно: включение elma365.db.mongoSecret отключает параметр elma365.db.mongoUrl.

elma365.db.vahterMongoUrl

Строка подключения к MongoDB для сервера авторизации.

Формат: mongodb://user:password@hostname:port/databaseName?ssl=false&replicaSet=rs0&readPreference=primaryPreferred.

Где:

• user — имя пользователя MongoDB имеющего права на базу данных databaseName;
• password — пароль для пользователя MongoDB;
• hostname — IP или доменное имя сервера MongoDB;
• port — порт для подключения к MongoDB, стандартный порт 27017;
• databaseName — наименование базы данных;
• ssl — использование защищённого соединения;
• replicaSet — номер набора реплик;
• readPreference — предпочтительный режим чтения.

elma365.db.vahterMongoSecret

Наименование секрета с подключением к MongoDB для сервера авторизации (должен быть создан вручную, зашифрован в Base64).

Должен содержать ключ VAHTER_MONGO_URL.

Важно: включение elma365.db.vahterMongoSecret отключает параметр elma365.db.vahterMongoUrl.

elma365.db.redisUrl

Строка подключения к Redis.

Формат: redis://user:password@hostname:port/databaseName.

Где:

• user — имя пользователя Redis имеющего права на базу данных databaseName;
• password — пароль для пользователя Redis;
• hostname — IP или доменное имя сервера Redis;
• port — порт для подключения к Redis, стандартный порт 6379;
• databaseName — наименование базы данных.

elma365.db.redisSecret

Наименование секрета с подключением к Redis (должен быть создан вручную, зашифрован в Base64).

Должен содержать ключ REDIS_URL.

Важно: включение elma365.db.redisSecret отключает параметр elma365.db.redisUrl.

elma365.db.amqpUrl

Строка подключения к RabbitMQ.

Формат: amqp://user:password@hostname:port/vhost.

Где:

• user — имя пользователя RabbitMQ имеющего права на vhost;
• password — пароль для пользователя RabbitMQ;
• hostname — IP или доменное имя сервера RabbitMQ;
• port — порт для подключения к RabbitMQ, стандартный порт 5672;
• databaseName — наименование базы данных.

elma365.db.amqpSecret

Наименование секрета с подключением к RabbitMQ (должен быть создан вручную, зашифрован в Base64).

Должен содержать ключ AMQP_URL.

Важно: включение elma365.db.amqpSecret отключает параметр elma365.db.amqpUrl.

Параметры подключение к S3-хранилищу файлов

elma365.db.s3.method

Метод загрузки файлов в S3.

Значение по умолчанию: PUT.

elma365.db.s3.accesskeyid

Логин пользователя для подключения к серверу S3.

elma365.db.s3.secretaccesskey

Пароль пользователя для подключения к серверу S3.

elma365.db.s3.bucket

Наименование бакета в S3.

Значение по умолчанию: s3elma365.

elma365.db.s3.backend.address

Строка подключения к S3.

Формат: hostname:port.

Где:

• hostname — IP или доменное имя сервера S3;
• port — порт для подключения к S3, стандартный порт S3 9000.

Если порт не задан:

• s3.ssl.enabled: false — выбирается порт 80;
• s3.ssl.enabled: true — выбирается порт 443.

elma365.db.s3.backend.region

Регион расположения сервера S3.

elma365.db.s3.ssl.enabled

Использование TLS шифрования сервером S3.

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.db.s3.virtualHostedStyle.enabled

Включение режима Virtual-hosted style для S3. В этом режиме имя бакета является частью имени домена в URL‑адресе, например: https://bucketname.example.ru/objectName.

Если параметр отключен, используется модель адресации Path‑style.

Значение по умолчанию: false.

Доступные варианты: true, false.

elma365.db.s3.dumpurl

Адрес сервера S3 для резервного копирования скриптом elma365db.sh.

Формат:

• для S3 в Kubernetes-кластере — http(s)://minio.<namespace>.svc.<cluster.local>;

• для внешнего S3 — http(s)://example.ru:9000.

elma365.db.s3Secret

Наименование секрета с подключением к S3 хранилищу (должен быть создан вручную, зашифрован в Base64).

Должен содержать ключи S3_BACKEND_ADDRESS, S3_REGION, S3_KEY, S3_SECRET, S3_BUCKET, S3_SSL_ENABLED, S3_UPLOAD_METHOD, S3_DUMP_URL, S3_VIRTUAL_HOSTED_STYLE_ENABLED.

Важно: включение s3Secret отключает параметры:

• db.s3.method;
• db.s3.accesskeyid;
• db.s3.secretaccesskey;
• db.s3.bucket;
• db.s3.backend.address;
• db.s3.backend.region;
• db.s3.ssl.enabled;
• db.s3.dumpurl;
• db.s3.virtualHostedStyle.enabled.

Значение по умолчанию: elma365-custom-db-connections.

Параметры подключения к SMTP-серверу

elma365.mailer.smtp.host

IP или URL‑адрес для подключения к SMTP‑серверу.

Значение по умолчанию: " ".

elma365.mailer.smtp.port

Порт для подключения к SMTP-серверу.

Значение по умолчанию: " ".

elma365.mailer.smtp.from

Email-адрес (наименование почтового ящика), от имени которого происходит отправка сообщений.

Значение по умолчанию: " ".

elma365.mailer.smtp.user

Логин пользователя для подключения к SMTP‑серверу.

Значение по умолчанию: " ".

elma365.mailer.smtp.password

Пароль пользователя для подключения к SMTP‑серверу.

Значение по умолчанию: " ".

elma365.mailer.smtp.needTLS

Использование TLS‑шифрования SMTP‑сервером.

Значение по умолчанию: false.

Доступные варианты: true, false.

Параметры исполнения серверных скриптов

forkAvailableMemorySize

Задаёт ограничение в МБ для памяти, используемой одним форком исполнения внутри одной реплики сервиса worker.

Если значение параметра не задано или равно 0, работа сервиса worker остаётся без изменений.

Параметры параллельной обработки переменных/функций

ELMA365_MAX_NUMBER_OF_WORKERS_TO_FILL_VARIABLES

Настраивается после включения фича-флага enableConcurrencyTemplateMapper и задаёт количество параллельных экземпляров worker внутри сервиса для обработки переменных.

Удобно, если при генерации шаблона документа используется много пользовательских переменных.

Значение по умолчанию 5.

Включение фича-флагов

elma365.settings.onPremiseEnabledFeatureFlags

Чтобы включить фича-флаг, введите его наименование с новой строки, поставив тире и пробел перед наименованием. Все включённые фича-флаги представлены в разделе в виде списка.