Настройка с использованием конфигурационного файла

Если до установки была выполнена предварительная настройка приложения, то дополнительные действия не требуются.

При необходимости изменения параметров (например, уровня логирования или параметров подключения к контроллеру домена) отредактируйте конфигурационный файл application.yml на сервере, где установлено приложение (путь к файлу — /opt/dsm/application.yml), и выполните перезапуск командой:

sudo systemctl restart dsm.service

Для успешного запуска приложения при создании или редактировании файла application.yml учитывайте следующее:

  • формат *.yml чувствителен к форматированию (см. RFC 9512), соблюдайте отступы;

  • если используется HTTPS, то значения server.ssl.key-store-password и server.ssl.key-password также укажите в зашифрованном виде с использованием Base64.

Параметры конфигурационного файла

Ниже приведены параметры файла application.yml (см. «Пример application.yml»), которые доступны для настройки приложения.

Секция server

Параметры сервера для подключения к приложению.

port

Порт для подключения к приложению.

Значение по умолчанию — port: 8080.

Настройки SSL-соединения:

В примере application.yml указаны параметры SSL-соединения, при которых приложение будет доступно только по HTTPS.
metrics_enabled

Включает мониторинг для ssl-соединения (см. секцию Prometheus в разделе «Сбор метрик приложения "Менеджер службы каталогов"»).

Доступные значения:

  • true — включает;

  • false — выключает.

key-store

Путь к хранилищу ключей, содержащему сертификат SSL.

key-store-password

Пароль в зашифрованном виде с использованием Base64, используемый для доступа к хранилищу ключей.

key-store-type

Тип хранилища ключей (JKS или PKCS12).

key-alias

Псевдоним, идентифицирующий ключ в хранилище ключей.

key-password

Пароль в зашифрованном виде с использованием Base64, используемый для доступа к ключу в хранилище ключей.

Секция logging

Параметры логирования.

В секции приведены параметры, которые установлены по умолчанию в приложение и применяются, если в application.yml не заданы другие.

Более подробно по настройке логирования см. в разделе «Логирование приложения "Менеджер службы каталогов"».
level

Устанавливает уровень логирования для приложения (формат: tech.inno.dsm: <уровень логирования>).

Доступные уровни логирования:

  • DEBUG — уровень отладочных сообщений;

  • ERROR — уровень ошибок;

  • INFO — уровень информационных сообщений;

  • OFF — логирование выключено;

  • TRACE — уровень всех сообщений;

  • WARN — уровень предупреждений.

file

В параметре name указывается название файла с логом.

logback

Библиотека для работы с логами.

Используется секция rollingpolicy с параметрами:

  • file-name-pattern — определяет название лог-файла и частоту ротации;

  • max-file-size — максимальный размер лог-файла;

  • total-size-cap — максимальный суммарный размер всех лог-файлов;

  • max-history — максимальное количество лог-файлов.

Cекция ldap

Настройки для ldap-соединения.

Настройки connection

Настройки для подключения к контроллеру домена.

LDAP-сервер контроллера домена должен поддерживать подключение с типом шифрования STARTTLS для подключения к приложению «Менеджер службы каталогов». Данное требование относится к глобальному каталогу, обслуживающему лес, а также к внешним контроллерам доменов, с которыми установлены доверительные отношения или с которыми планируется установить.
host

Адрес для подключения.

port

Порт для подключения.

responseTimeoutMillis

Тайм-аут ответа ldap-операций, в миллисекундах.

Значение по умолчанию — 120000.
sso

В параметре krb-tgt-path указывается путь до тикета kerberos технической учетной записи, от имени которой будут выполняться операции, после авторизации по SSO.

Секция authentication

Настройки доступа по технологии единого входа (SSO) (см. «Настройка доступа по технологии единого входа (SSO)»).

kdc-address

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

service-principal

Логин UPN.

keytab-location

Путь до keytab-файла.

Cекция gpm

Настройки admx-шаблонов.

Настройки admx

path

Путь к admx-шаблонам, содержащим описание политик.

locale

Применяемая локализация, а также название директории относительно пути к admx-шаблонам, определенным в параметре path.

target-namespace

Целевое пространство имен в случае отсутствия или различия с определенных в файлах шаблонов и локализации.

hide-empty-categories

Cкрытие категорий, не содержащих других категорий и политик.

Доступные значения:

  • true — включает;

  • false — выключает.

server-path

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

Секция management

Параметры для подключения к актуаторам приложения (см. «Сбор метрик приложения "Менеджер службы каталогов"»).

server

IP-адрес для подключения.

port

Порт для подключения.

Пример application.yml

server:
  port: 8090
  ssl:
    metrics_enabled: true
    key-store: /opt/dsm/springboot.p12
    key-store-password: cGFzc3dvcmQx
    key-store-type: pkcs12
    key-alias: springboot
    key-password: cGFzc3dvcmQy

logging:
  level:
    tech.inno.dsm: DEBUG
  file:
    name: /var/log/dsm.log
  logback:
    rollingpolicy:
      file-name-pattern: /var/log/dsm_%d{yyyy-MM-dd}_archive-%i.log
      max-file-size: 10MB
      total-size-cap: 1000MB
      max-history: 365

ldap:
  connection:
    host: 127.0.0.1
    port: 389
    responseTimeoutMillis: 120000
    sso:
      krb-tgt-path: /tmp/krb5cc_1000

authentication:
  kerberos:
    kdc-address: ast-dc1.dsmreview.lan
    service-principal: HTTP/dsmsso.inno.tech
    keytab-location: /opt/dsm/sso.keytab

gpm:
  admx:
    path: /app/inno-samba/share/samba/admx
    locale: en-US
    target-namespace: http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions
  server-path: /app/inno-samba/var/locks

management:
  server:
    port: 8081