Установка пакета inno-samba-dc-exporter

Раздел содержит инструкции по установке модуля экспорта метрик (inno-samba-dc-exporter).

Подготовка к установке

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

Требования к программному обеспечению

В текущей реализации модуль может устанавливаться на сервер под управлением ОС Astra Linux Special Edition версии 1.7 и выше.

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

Предварительная настройка

Для предварительной настройки:

  1. В каталоге etc создайте подкаталог samba-dc-exporter.

  2. В подкаталоге samba-dc-exporter создайте файл config.yaml.

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

  3. В созданном файле /etc/samba-dc-exporter/config.yaml задайте настройки формирования и сбора метрик (см. пример файла):

    • dc_hostname — имя хоста контроллера домена Samba, для которого требуется формировать и экспортировать метрики;

    • domain_name — имя домена, в рамках которого осуществляется мониторинг;

    • port — порт, на котором доступны для сбора метрики (значение по умолчанию — 9099);

    • настройки логирования:

      • logLevel — уровень логирования (значение по умолчанию — INFO);

      • logFormat — набор атрибутов для формирования записи в лог-файле (значение по умолчанию — '%(asctime)s - %(levelname)s - %(name)s - %(message)s');

    • metric_collect_interval_sec — интервал сбора метрик в секундах в секундах (значение по умолчанию — 5);

    • настройки LDAP:

      • ldap_search_path — уникальное составное имя объекта AD (DN) в LDAP для поиска sAMAccountName по заданному значению ldap_user;

      • ldap_timeout — время ожидания ответа от LDAP в секундах (значение по умолчанию — 2.0);

      • ldap_credentials_path — путь к файлу с реквизитами доступа для LDAP (значение по умолчанию — /etc/samba-dc-exporter/cred);

        В указанном файле ожидаются два параметра, значения которых должны быть зашифрованы с помощью base64:

        • ldap_user — имя пользователя для доступа к LDAP;

        • ldap_user_pw — пароль пользователя для доступа к LDAP.

    • rpc_connect_transport — способ подключения к службе dcerpc; возможные варианты подключения:

      • ncacn_np — подключение по именованным каналам;

      • ncacn_ip_tcp — подключение по TCP/IP (значение по умолчанию — ncacn_ip_tcp:127.0.0.1);

      • ncalrpc — подключение по протоколу LRPC;

    • krb5_keytab_path — путь к keytab-файлу (значение по умолчанию — /etc/krb5.keytab);

    • ntp_config — путь к конфигурационному файлу службы синхронизации времени (значение по умолчанию при использовании chrony — /etc/chrony/chrony.conf; значение при использовании ntpd — /etc/ntpd.conf);

    • настройки DNS:

      • dns_timeout — период ожидания ответа от DNS-сервера в секундах (значение по умолчанию — 2.0);

      • dns_log_path — путь к лог-файлу (значение по умолчанию — /var/log/syslog).

  4. Создайте файл с реквизитами для доступа к LDAP по пути, указанному в параметре ldap_credentials_path в config.yaml (по умолчанию — /etc/samba-dc-exporter/cred):

    printf 'ldap_user=%s\n' `echo username | base64` | sudo tee /etc/samba-dc-exporter/cred
printf 'ldap_user_pw=%s\n' `echo userpassword | base64` | sudo tee -a /etc/samba-dc-exporter/cred

    Если файл создается после установки пакета, обеспечьте доступ сервиса к нему:

    sudo chown samba-dc-exporter:samba-dc-exporter /etc/samba-dc-exporter/cred
sudo chmod 400 /etc/samba-dc-exporter/cred

Пример файла config.yaml:

dc_hostname: "dc1"
domain_name: "example.com"
port: 9099

# Logging parameters
log:
  logLevel: INFO
  logFormat: '%(asctime)s - %(levelname)s - %(name)s -  %(message)s'

# Collection interval
metric_collect_interval_sec: 5

# LDAP parameters
ldap_search_path: 'CN=Users, DC=example,DC=com'
ldap_timeout: 2.0
ldap_credentials_path: /etc/samba-dc-exporter/cred

# RPC parameters
rpc_connect_transport: "ncacn_ip_tcp:127.0.0.1"

# KDC parameters
krb5_keytab_path: '/etc/krb5.keytab'

# NTP parameters
ntp_config: "/etc/chrony/chrony.conf"
# ntp_config: "/etc/ntpd.conf"

# DNS parameters
dns_timeout: 2.0
dns_log_path: "/var/log/syslog"

Установка

Для установки:

  1. Подключите apt-репозиторий или загрузите архив с пакетом inno-samba-dc-exporter (см. раздел «Способы установки»).

  2. Установите пакет:

    • при установке из apt-репозитория выполните:

      sudo apt install inno-samba-dc-exporter

    • при установке из архива укажите путь к распакованным файлам и имя пакета; например:

      sudo apt install /inno-samba-dc-exporter/packages/inno-samba-dc-exporter_1.5.1_amd64.deb

  3. Запустите сервис:

    sudo systemctl start samba-dc-exporter

После этого на сервере будет доступна служба samba-dc-exporter.service, реализующая функции экспорта метрик.

Для указания пути к файлу с реквизитами для доступа к LDAP после установки также может использоваться параметр командной строки --credentials, который необходимо добавить в файл /etc/systemd/samba-dc-exporter.service в следующем формате:

ExecStart=/usr/bin/python3 /app/samba-dc-exporter/samba_exporter.py --credentials /path/to/credentials/file

Данный параметр имеет более высокий приоритет, чем параметр ldap_credentials_path в файле config.yaml.