ppem-manager.yml

ppem-manager.yml — Файл конфигурации YAML для менеджера

Обзор #

Файл конфигурации расположен в /etc/ppem-manager.yml.

Вы можете указать способ обработки параметров с помощью специального параметра use_storage_config.

После внесения любых изменений в файл конфигурации необходимо перезапустить службу менеджера:


systemctl restart ppem

Файл конфигурации состоит из следующих разделов:

Настройка обработки параметров #

Файл конфигурации содержит специальный параметр use_storage_config.

Если для этого параметра указано значение true, значения из хранилища конфигурации переопределяют значения из файла конфигурации.

Значение по умолчанию: false — менеджер использует параметры из файла конфигурации.

Параметры журналирования #

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

За подробной информацией о настройке журнала событий аудита и уведомлений об оповещениях обратитесь к Разделу «Параметры журнала событий аудита» и Разделу «Параметры оповещений и уведомлений».

log:
  level: уровень_журналирования
  format: формат_журналов
  options:
    csv_field_delimiter: символ_разделителя
  file:
    path: абсолютный_путь_к_файлу_журнала
    mode: режим_доступа_к_файлу_журнала
    rotation_age: интервал_ротации_файла_журнала
    rotation_size: размер_файла_журнала_для_ротации
level (enum) #

Уровень журналирования.

Возможные значения:

  • debug

  • info

  • warn

  • error

Каждый уровень журналирования включает в себя предыдущие, например warn содержит сообщения журнала уровней info и debug.

format (enum, необязательный) #

Формат журналирования.

Возможные значения:

  • json: формат JSON.

  • pretty: отформатированный формат JSON, например создаваемый утилитой jq.

  • csv: текстовый формат CSV.

    Символ разделителя CSV можно указать с помощью параметра options.csv_field_delimiter.

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

options.csv_field_delimiter (string, необязательный) #

Строка из одного символа, которая используется в качестве разделителя CSV.

Этот параметр применим, только если для параметра format указано значение csv.

Значение по умолчанию: , (символ запятой).

file (object, необязательный) #

Файл для записи журналов. У менеджера должны быть права на запись в этот файл. Если файл не существует, менеджер создаёт его автоматически.

Если этот параметр не указан, PPEM записывает журналы в stdout.

PPEM выполняет ротацию файла журнала, если выполняется любое из следующих условий:

  • Служба ppem получает сигнал SIGHUP.

  • Время жизни или размер файла журнала равен значению параметра rotation_age или rotation_size соответственно.

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

path (string, непустое значение) #

Абсолютный путь к файлу журнала, например /var/log/ppem.log.

mode (string, непустое значение) #

Числовая строка, которая определяет режим доступа к файлу в формате, аналогичном формату, используемому chmod, например 0644.

rotation_age (time string, необязательный) #

Максимальное время жизни отдельного файла журнала. По истечении этого времени создаётся новый файл.

Значение по умолчанию: "" (пустая строка) — смена файлов по времени жизни не производится.

rotation_size (string, необязательный) #

Максимальный размер отдельного файла журнала. При достижении этого размера создаётся новый файл.

Значение по умолчанию: "" (пустая строка) — смена файлов по размеру не производится.

Параметры базы данных репозитория #

Раздел repo позволяет настроить параметры базы данных репозитория.

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

repo:
  schema: схема_для_объектов_репозитория
  url: URL_подключения

  # Строка подключения в формате «ключ/значение» (альтернативный вариант)
  host: имя_хоста
  port: порт
  name: имя_базы_данных
  user: имя_пользователя
  password: пароль_пользователя

  fallback_addresses: [список_резервных_адресов_хостов]
  target_session_attrs: атрибуты_целевого_сеанса

  sslmode: режим_безопасного_подключения
  sslrootcert: файл_корневого_сертификата_CA
  sslcert: файл_публичного_сертификата
  sslkey: файл_закрытого_ключа

  max_conns: максимальное_количество_подключений
  max_conn_lifetime: тай-маут_активного_подключения
  max_conn_idle_time: тай-маут_неактивного_подключения

  # Параметры подключений, связанных с объектами экземпляров
  instance_objects_repo_pool:
    max_conns: максимальное_количество_подключений
    max_conn_lifetime: тай-маут_активного_подключения
    max_conn_idle_time: тай-маут_неактивного_подключения
schema (string) #

Имя схемы, в которой требуется хранить объекты базы данных репозитория.

Для новой установки PPEM достаточно указать имя схемы. Изменение имени схемы для уже работающего PPEM с большим количеством созданных объектов требует выполнения более сложной процедуры.

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

url (string, необязательный) #

URL-адрес подключения к базе данных репозитория.

Пример: postgres://ppem@dbms.example.org/ppem.

Значение по умолчанию: "" (пустая строка).

host (string, необязательный)
port (номер порта, необязательный)
name (string, необязательный)
user (string, необязательный)
password (string, необязательный) #

Параметры строки подключения вида «ключ/значение» для базы данных репозитория.

Если URI подключения указан с помощью параметра url, он имеет приоритет над строкой подключения вида «ключ/значение».

Значение по умолчанию для port: 5432.

Значение по умолчанию для других параметров: "" (пустая строка).

fallback_addresses (список строк, необязательный) #

Список резервных адресов в формате хост:порт.

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

Пример:

fallback_addresses:
  - prod.example.org:5432
  - dev.example.com:55432

Значение по умолчанию: [] (пустой список).

target_session_attrs (string, необязательный) #

Атрибуты целевого сеанса.

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

sslmode (string, необязательный)
sslrootcert (string, необязательный)
sslcert (string, необязательный)
sslkey (string, необязательный) #

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

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

Значение по умолчанию для других параметров: "" (пустая строка).

max_conns (integer, необязательный)
max_conn_lifetime (time string, необязательный)
max_conn_idle_time (time string, необязательный) #

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

  • max_conns: максимальное количество разрешённых подключений.

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

  • max_conn_lifetime: тайм-аут активного подключения.

    Активные подключения, превысившие тайм-аут, закрываются.

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

  • max_conn_idle_time: тайм-аут неактивного подключения.

    Неактивные подключения, превысившие тайм-аут, закрываются.

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

instance_objects_repo_pool (object, необязательный) #

Параметры пула соединений, используемого при работе с объектами экземпляров:

max_conns (integer, необязательный)
max_conn_lifetime (time string, необязательный)
max_conn_idle_time (time string, необязательный)
  • max_conns: максимальное количество разрешённых подключений.

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

  • max_conn_lifetime: тайм-аут активного подключения.

    Активные подключения, превысившие тайм-аут, закрываются.

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

  • max_conn_idle_time: тайм-аут неактивного подключения.

    Неактивные подключения, превысившие тайм-аут, закрываются.

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

Параметры интеграций #

Раздел integrations позволяет настроить интеграцию PPEM с другими продуктами и решениями Postgres Pro.

integrations:
  askpostgres:
    enabled: true_или_false
    base_url: "https://ask.postgrespro.ru"
    source: "ppem"
    timeouts:
      base: тайм_аут_непотоковых_HTTP_запросов
      time_to_first_token: тайм_аут_первого_токена
      idle: тайм_аут_неактивных_потоковых_HTTP_запросов
askpostgres (object) #

Параметры интеграции с Ask Postgres. За подробной информацией обратитесь к Главе 75.

enabled (boolean) #

Указывает, включена ли интеграция с чатом AskPostgres.

Если указано значение false, значок чата не отображается в веб-приложении, а оставшиеся параметры становятся необязательными.

Значение по умолчанию: false — интеграция отключена.

base_url (string) #

Базовый URL-адрес службы Ask Postgres.

Не изменяйте этот параметр, если вы не используете локально развёрнутый экземпляр Ask Postgres.

Значение по умолчанию: https://ask.postgrespro.ru/api/v1.

source (string) #

Важно

Это служебный параметр, не изменяйте его.

Идентификатор источника запроса, отправляемый в HTTP-заголовке X-Source службе Ask Postgres.

Постоянное значение: ppem.

timeouts (object) #

Параметры тайм-аутов для запросов к Ask Postgres:

base (time string) #

Тайм-аут для непотоковых HTTP-запросов, таких как создание чата, получение сообщений или отмена генерации ответа.

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

time_to_first_token (time string) #

Тайм-аут получения первого токена в потоке ответов. Если поток запускается, но в течение этого времени токен не получен, запрос завершается с ошибкой тайм-аута.

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

idle (time string) #

Тайм-аут неактивности для потока ответов, который сбрасывается при получении каждого нового токена. Если в течение этого времени токен не получен, поток завершается с ошибкой тайм-аута.

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

Параметры HTTP #

Раздел http позволяет настроить параметры HTTP-сервера и клиента, а также несколько параметров, связанных с API.

http:
  server:
    address: сетевой_адрес_прослушивания
    port: сетевой_порт_прослушивания
    mtls_port: сетевой_порт_прослушивания_для_mtls
    tls:
      cert_file: файл_публичного_сертификата
      key_file: файл_закрытого_ключа
      client_ca_file: файл_корневого_сертификата_ca
    static_files_path: путь_к_статическим_файлам_веб-приложения
    timeout: тайм_аут_обработки_HTTP_запросов
    security:
      enabled: true_или_false
      csp_policy: заголовок_content_security_policy
      cache_control: заголовок_cache_control
      pragma: заголовок_Pragma
      expires: заголовок_expires
      frame_options: заголовок_x_content_type
      content_type_options: заголовок_x_content_type_options
      permissions_policy: заголовок_permissions_policy
      referrer_policy: заголовок_referrer_policy
      strict_transport_security: заголовок_strict_transport_security
      cross_origin_embedder_policy: заголовок_cross_origin_embedder_policy
      cross_origin_opener_policy: заголовок_cross_origin_opener_policy
      cross_origin_resource_policy: заголовок_cross_origin_resource_policy
    cors:
      allowed_origins: [список_разрешённых_источников]
      allowed_methods: [список_разрешённых_HTTP_методов]
      allowed_headers: [список_разрешённых_HTTP_заголовков]
      exposed_headers: [список_раскрытых_HTTP_заголовков]
      allow_credentials: заголовок_access_control_allow_credentials
      max_age: заголовок_access_control_max_age
    real_ip_header_name: заголовок_с_исходным_IP_адресом
    response_compression_level: уровень_сжатия_ответа_сервера

  client:
    timeouts:
      http: тайм_аут_HTTP_запросов
      tls_handshake: тайм_аут_TLS-рукопожатия
      dialer: тайм_аут_установки_подключения_к_серверу_для_HTTP
      response_header: тайм_аут_ожидания_заголовков_HTTP_ответа
    insecure_skip_verify: пропустить_проверку_сертификата_сервера
    root_ca_files: [список_файлов_корневых_сертификатов_CA]

  pagination:
    max_page_size: максимальное_количество_объектов_в_одном_ответе
  api:
    disabled: {объект_с_отключёнными_конечными_точками_API}

Параметры HTTP-сервера #

address (string, необязательный) #

Сетевой адрес, на котором необходимо слушать.

Если указать пустую строку, сервер будет слушать на всех сетевых интерфейсах.

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

port (номер порта, необязательный) #

Сетевой порт, на котором необходимо слушать.

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

mtls_port (номер порта, необязательный) #

Сетевой порт для mTLS, на котором необходимо слушать.

Этот параметр действует только когда в разделе tls настроен mTLS.

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

tls (object) #

Параметры TLS-сертификата, необходимые для включения HTTPS как для веб-приложения, так и для соединений с агентами. Дополнительно можно настроить взаимную проверку TLS (mTLS).

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

Если не указать файлы сертификата и ключа (пустые строки), веб-приложение будет доступно только по HTTP, а HTTPS и mTLS не будут использоваться для соединений типа менеджер-агент.

Порт для веб-приложения указывается в параметре port, а порт для mTLS/входящих соединений от агентов — в параметре mtls_port.

cert_file (string) #

Абсолютный путь к файлу публичного сертификата.

Значение по умолчанию: "" (пустая строка).

key_file (string) #

Абсолютный путь к файлу закрытого ключа.

Значение по умолчанию: "" (пустая строка).

client_ca_file (string) #

Абсолютный путь к корневому CA-сертификату, который используется для проверки сертификатов агентов.

Значение по умолчанию: "" (пустая строка).

static_files_path (string) #

Путь к статическим файлам веб-приложения PPEM.

Значение по умолчанию: "" (пустая строка).

timeout (time string, необязательный) #

Тайм-аут обработки HTTP-запроса.

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

security (object) #

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

Параметры cross-origin-*-policy необходимо настроить вручную, так как PPEM не предоставляет для них значений по умолчанию.

enabled (boolean, необязательный) #

Указывает, включена ли обработка HTTP-заголовков, связанных с безопасностью.

Значение по умолчанию: false — обработка отключена.

csp_policy (string, необязательный) #

Значение HTTP-заголовка ответа Content-Security-Policy. Помогает предотвратить XSS, кликджекинг и другие атаки с внедрением кода.

Значение по умолчанию зависит от того, настроен ли HTTP-сервер на работу с HTTPS:

  • Режим HTTP: default-src 'none'; script-src 'self' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: blob:; font-src 'self'; connect-src 'self'; media-src 'self'; form-action 'self'; base-uri 'self'; frame-ancestors 'none'; frame-src https://postgrespro.com/; object-src 'none'.

  • Режим HTTPS: default-src 'none'; script-src 'self' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: blob:; font-src 'self'; connect-src 'self'; media-src 'self'; form-action 'self'; base-uri 'self'; frame-ancestors 'none'; frame-src https://postgrespro.com/; object-src 'none'; upgrade-insecure-requests.

cache_control (string, необязательный) #

Значение HTTP-заголовка Cache-Control. Управляет кешированием в браузерах. Значение по умолчанию помогает предотвратить кеширование API-ответов, которые могут содержать конфиденциальные или постоянно изменяющиеся данные.

Значение по умолчанию: no-store, no-cache, must-revalidate.

pragma (string, необязательный) #

Значение HTTP-заголовка Pragma.

Этот заголовок является устаревшим и обеспечивает обратную совместимость с кешами HTTP/1.0, которые не поддерживают HTTP-заголовок Cache-Control.

Значение по умолчанию: no-cache.

expires (string, необязательный) #

Значение HTTP-заголовка ответа Expires.

Этот заголовок обеспечивает обратную совместимость с кешами HTTP/1.0, которые не поддерживают HTTP-заголовок Cache-Control.

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

frame_options (string, необязательный) #

Значение HTTP-заголовка ответа X-Frame-Options. Помогает предотвратить кликджекинг-атаки.

Значение по умолчанию: "" (пустая строка).

content_type_options (string, необязательный) #

Значение HTTP-заголовка ответа X-Content-Type-Options. Помогает предотвратить атаки с подменой MIME-типов.

Значение по умолчанию: "" (пустая строка).

permissions_policy (string, необязательный) #

Значение HTTP-заголовка ответа Permissions-Policy. Определяет, какие возможности браузера и API устройств могут быть использованы. Значение по умолчанию запрещает доступ к возможностям, которые могут раскрыть конфиденциальную информацию, таким как камера, микрофон и геолокация.

Значение по умолчанию: "accelerometer=(), autoplay=(), camera=(), geolocation=(), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()".

referrer_policy (string, необязательный) #

Значение HTTP-заголовка ответа Referrer-Policy. Определяет, какой объём информации о реферере включается в запросы.

Значение по умолчанию: strict-origin-when-cross-origin.

strict_transport_security (string, необязательный) #

Значение HTTP-заголовка ответа Strict-Transport-Security. Принудительно заставляет браузеры использовать только HTTPS-подключения. Применяется, только если HTTP-сервер настроен на работу с HTTPS, иначе игнорируется.

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

  • Режим HTTP: "" (пустая строка) — не применимо.

  • Режим HTTPS: max-age=31536000; includeSubDomains.

cross_origin_embedder_policy (string) #

Значение HTTP-заголовка ответа Cross-Origin-Embedder-Policy.

Значение по умолчанию: "" (пустая строка).

cross_origin_opener_policy (string) #

Значение HTTP-заголовка ответа Cross-Origin-Opener-Policy.

Значение по умолчанию: "" (пустая строка).

cross_origin_resource_policy (string) #

Значение HTTP-заголовка ответа Cross-Origin-Resource-Policy.

Значение по умолчанию: "" (пустая строка).

cors (object) #

Связанные с CORS параметры безопасности HTTP-сервера.

Большинство из этих параметров связаны с заголовками Access-Control-*. Для удобства такие параметры представлены в виде списка строк. Затем, в зависимости от формата заголовка, эти строки обрабатываются следующим образом:

  • Если в заголовке может быть указано только одно значение, каждая строка из списка отправляется в отдельном заголовке.

    Пример:

    allowed_origins:
    - "example.com"               ->    Access-Control-Allow-Origin: example.com
    - "prod.example.org"          ->    Access-Control-Allow-Origin: prod.example.org
  • Если в заголовке может быть указано несколько значений, строки из списка объединяются в одну, и полученная строка отправляется в заголовке.

    Пример:

    exposed_headers:               -> Access-Control-Expose-Headers: Content-Encoding, X-Forwarded-For
    - "Content-Encoding"
    - "X-Forwarded-For"
allowed_origins (список строк) #

Значения HTTP-заголовков ответа Access-Control-Allow-Origin.

Значение по умолчанию: [] (пустой список).

allowed_methods (список строк) #

Значения HTTP-заголовка ответа Access-Control-Allow-Methods.

Значение по умолчанию: [] (пустой список).

allowed_headers (список строк) #

Значения HTTP-заголовка ответа Access-Control-Allow-Headers.

Значение по умолчанию: [] (пустой список).

exposed_headers (список строк) #

Значения HTTP-заголовка ответа Access-Control-Expose-Headers.

Значение по умолчанию: [] (пустой список).

allow_credentials (boolean) #

Значение HTTP-заголовка ответа Access-Control-Allow-Credentials.

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

max_age (integer) #

Значение HTTP-заголовка ответа Access-Control-Max-Age.

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

real_ip_header_name (string, необязательный) #

Имя HTTP-заголовка, который должен использоваться для определения исходного IP-адреса клиента, подключающегося к HTTP-серверу через прокси-сервер.

Заголовок X-Forwarded-For является примером такого заголовка.

Значение по умолчанию: "" (пустая строка).

response_compression_level (integer, необязательный) #

Уровень сжатия ответа от сервера.

Возможные значения:

  • -2 (только сжатие Хаффмана)

  • -1 (уровень сжатия по умолчанию установлен на 6)

  • 0 (сжатие отключено)

  • Число в диапазоне от 1 (наилучшая скорость) до 9 (наилучшая степень сжатия)

Значение по умолчанию: 0 (сжатие отключено).

Параметры HTTP-клиента #

timeouts (object) #

Тайм-ауты для HTTP-клиента.

http (time string) #

Тайм-аут HTTP-запроса.

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

tls_handshake (time string) #

Тайм-аут TLS-рукопожатия.

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

dialer (time string) #

Тайм-аут установки подключения, когда клиент пытается подключиться к серверу. Попытка подключения должна завершиться успешно в течение этого интервала времени.

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

response_header (time string) #

Тайм-аут ожидания HTTP-заголовков ответа после отправки HTTP-запроса серверу.

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

отключить_проверку_безопасности (boolean, необязательный) #

Важно

Использование этого параметра представляет риск для безопасности.

Рекомендуется использовать его исключительно для тестирования и отладки, но не в эксплуатационной среде.

Указывает, отключена ли проверка TLS-сертификата сервера.

Значение по умолчанию: false — сертификат проверяется.

root_ca_files (список строк, необязательный) #

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

Значение по умолчанию: [] (пустой список) — используются сертификаты из хранилища операционной системы.

Параметры HTTP API-сервера #

pagination.max_page_size (integer, необязательный) #

Максимальное количество записей в одном API-ответе (размер страницы).

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

api.disabled (object, необязательный) #

Объект, содержащий отключённые конечные точки HTTP REST API. Если клиент запрашивает отключённую конечную точку, сервер возвращает ответ об ошибке с кодом состояния HTTP 503 Service Unavailable.

Объект содержит записи в следующем формате: конечная_точка_API: список_отключённых_HTTP_методов.

Пример:

api:
  disabled:
    "/v1/endpoint": ["GET", "POST", "PUT", "DELETE", "PATCH"]
    "/v1/instances/{id}/endpoint": ["POST"]

Значение по умолчанию: {} (пустой объект) — включены все конечные точки API.

Параметры JWT-сеансов #

Раздел jwt позволяет настроить параметры пользовательских сеансов и параметры, связанные с JSON Web Tokens.

jwt:
  secret: секрет_для_подписи_токенов_JWTS

  lifetime:
    access: время_жизни_токена_доступа
    refresh: время_жизни_токена_обновления

  max_sessions_per_user: максимальное_количество_сеансов_на_пользователя
  max_failed_login_attempts: максимальное_количество_неудачных_попыток_аутентификации_на_пользователя

  password_policy:
    length_min: минимальная_длина_пароля
    length_max: максимальная_длина_пароля
    allowed_symbols: разрешённые_символы_в_пароле
    entropy_min: минимальная_энтропия_пароля
    history_depth: размер_хранимой_истории_паролей
secret (string) #

Секрет, используемый для подписи выпущенного токена.

Токены обновления используются для выпуска токенов доступа. Токены доступа используются для аутентификации пользователей в PPEM.

За подробной информацией об этих токенах обратитесь к Разделу 7.5.

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

lifetime (object) #

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

access (time string) #

Время жизни токена доступа.

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

refresh (time string) #

Время жизни токена обновления.

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

max_sessions_per_user (integer) #

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

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

Сеанс считается активным, пока не истекло время жизни его токена обновления. Когда число активных сеансов достигает лимита, новая попытка входа отклоняется, но существующие сеансы не завершаются.

Ограничение распространяется только на сеансы пользователей. Оно не распространяется на встроенную учётную запись администратора и на сеансы агентов.

max_failed_login_attempts (integer) #

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

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

Если установлено значение 0, автоматическая блокировка отключена, а неудачные попытки входа не подсчитываются. Если параметр больше 0, учётная запись пользователя автоматически блокируется, когда число неудачных попыток входа достигает заданного порога. Счётчик неудачных попыток входа ведётся для каждого пользователя отдельно и сбрасывается после успешного входа.

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

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

Примечание

Для соответствия политикам безопасности вашей организации задайте для параметра max_failed_login_attempts значение, отличное от значения по умолчанию.

password_policy (object) #

Парольная политика, которая применяется ко всем объектам, требующим указания пароля. Эта политика действует глобально, на уровне установленного PPEM.

length_min (integer) #

Минимальная длина пароля.

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

length_max (integer) #

Максимальная длина пароля.

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

allowed_symbols (string) #

Разрешённые символы пароля.

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

Пример:

abcdEFGHI123456$%^

Значение по умолчанию: "" (пустая строка) — разрешены любые символы.

entropy_min (integer) #

Минимальное значение энтропии паролей, вычисляемое по формуле

длина_пароля × log2(размер(разрешённые_символы))

Значение энтропии служит мерой сложности пароля и его криптографической стойкости. Рекомендуется поддерживать значение энтропии в диапазоне 50–70 или выше.

Пример:

Если разрешёнными символами являются abcdefghijklmnopqrstuvwxyz, а паролем — helloaaa, энтропия составляет:

8 × log2(размер(26)) = 37.6

Следовательно, этот пароль имеет низкое значение энтропии.

Значение по умолчанию: 0 — может использоваться пароль с любым значением энтропии.

history_depth (integer) #

Количество предыдущих паролей, которые хранит PPEM.

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

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

Значение по умолчанию: 0 — ранее использованные пароли не сохраняются, новый пароль может быть любым.

Параметры шифрования #

Репозиторий может содержать конфиденциальную информацию.

Раздел crypto позволяет настроить дополнительный уровень защиты для таких секретов.

crypto:
  enabled: true_или_false
  key: ключ_шифрования
  salt: строка_соли
enabled (boolean) #

Указывает, включено ли шифрование секретов.

Значение по умолчанию: false — шифрование отключено.

key (string) #

Ключ шифрования.

Значение по умолчанию: "" (пустая строка).

salt (string, необязательный) #

Строка соли, которая добавляется к ключу перед его хешированием и сохранением.

Эта строка помогает защититься от атак с использованием предвычисленных хеш-таблиц для наиболее распространённых паролей.

Значение по умолчанию: "" (пустая строка) — соль к ключу не добавляется.

Параметры интеграции резервного копирования #

PPEM не предоставляет встроенных возможностей резервного копирования и восстановления. Вместо этого он интегрируется с решением для резервного копирования и восстановления, установленным на серверах СУБД.

Раздел backups позволяет настроить интеграцию с решениями для резервного копирования.

backups:
  scheduler:
    interval: интервал_синхронизации_данных
  commands:
    timeout: тайм_аут_команд_резервного_копирования_и_восстановления
scheduler.interval (time string) #

Интервал синхронизации данных между менеджером и агентами.

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

commands.timeout (time string) #

Тайм-аут команд резервного копирования и восстановления, выполняемых агентом на сервере СУБД.

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

Параметры интеграции с OIDC #

PPEM поддерживает различные сценарии аутентификации: пользователи могут проходить аутентификацию как локально, так и через сторонние службы.

Раздел oidc позволяет настроить интеграцию с поставщиком услуг OpenID Connect.

С точки зрения поставщика услуг PPEM является доверяющей стороной (relying party, RP).

За примером настройки поставщика услуг Keycloak обратитесь к Разделу 7.6.

oidc:
  issuer: URL_поставщика_услуг_OpenID
  client_id: идентификатор_доверяющей_стороны
  client_secret: секрет_доверяющей_стороны
  callback_host: хост_доверяющей_стороны
  login_timeout: тайм_аут_аутентификации
  scopes: [области_доступа_OpenID]
issuer (string, непустое значение) #

URL-адрес поставщика услуг OpenID Connect.

client_id (string, непустое значение) #

Идентификатор клиента доверяющей стороны (RP).

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

client_secret (string, непустое значение) #

Секрет клиента доверяющей стороны (RP).

Этот секрет должен быть выдан поставщиком услуг OpenID при настройке на его стороне.

callback_host (string, непустое значение) #

Адрес и порт менеджера.

После успешной аутентификации пользователя поставщик услуг OpenID перенаправляет его обратно в PPEM, используя URL обратного вызова для завершения процесса аутентификации.

URL обратного вызова имеет следующий вид:

схема://хост_для_обратного_вызова/auth/oidc/callback

схема может быть http или https в зависимости от того, включён ли HTTPS для HTTP-сервера PPEM.

login_timeout (time string) #

Тайм-аут аутентификации пользователя.

Если происходит тайм-аут, требуется повторная аутентификация.

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

scopes (список строк) #

Список областей доступа OpenID Connect.

Области доступа openid и email являются обязательными для успешной интеграции PPEM с поставщиком услуг OpenID Connect.

Значение по умолчанию: [openid, profile, email].

Параметры интеграции с LDAP #

PPEM поддерживает различные сценарии аутентификации: пользователи могут проходить аутентификацию как локально, так и через сторонние службы.

Раздел ldap позволяет настроить интеграцию со службами каталогов OpenLDAP и Microsoft Active Directory.

За подробной информацией о настройке такой интеграции обратитесь к Главе 35.

ldap:
  type: тип_службы_каталогов
  url: сетевой_адрес_службы_каталогов
  bind_username: имя_пользователя_службы_каталогов
  bind_password: пароль_пользователя_службы_каталогов
  base_dn: базовое_отличительное_имя_службы_каталогов
  prefix_user_dn: префикс_отличительного_имени_для_пользователей
  prefix_group_dn: префикс_отличительного_имени_для_групп_пользователей
  user_class: класс_объектов_пользователей
  user_name_attr: атрибут_логина_пользователя
  user_first_name_attr: атрибут_имени_пользователя
  user_last_name_attr: атрибут_фамилии_пользователя
  user_display_name_attr: атрибут_отображаемого_имени_пользователя
  user_email_attr: атрибут_электронной_почты_пользователя
  user_phone_attr: атрибут_телефона_пользователя
  user_job_title_attr: атрибут_должности_пользователя
  user_id_attr: атрибут_идентификатора_пользователя
  group_class: класс_объекта_групп
  group_name_attr: атрибут_имени_группы
  group_filter: пользовательский_фильтр_групп
  group_list_size_limit: максимальное_количество_групп_в_одном_запросе
  group_members_attr: атрибут_участника_группы
  group_membership_filter: пользовательский_фильтр_участия_в_группах
  user_membership_attr: атрибут_участия_пользователя_в_группах
  user_sync_interval: время_синхронизации_между_менеджером_и_службой_каталогов
  ssl_cert_skip_verify: пропустить_проверку_сертификата_сервера
  ssl_root_ca: файл_корневого_сертификата_CA
типу (enum, непустое значение) #

Тип службы каталогов.

Возможные значения:

  • openldap: OpenLDAP.

  • ms_active_directory: Microsoft Active Directory.

url (string, непустое значение) #

Сетевой адрес службы каталогов.

bind_username (string, непустое значение) #

Имя пользователя, используемое PPEM для подключения к службе каталогов.

Формат значения зависит от службы каталогов:

  • Для OpenLDAP обычно указывается полное отличительное имя (DN). Например, cn=admin,ou=users,dc=example,dc=com.

  • Для Microsoft Active Directory обычно указывается значение в формате имя_пользователя@домен. Например, admin@example.com.

bind_password (string, непустое значение) #

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

base_dn (string, непустое значение) #

Базовое отличительное имя службы каталогов.

prefix_user_dn (string, необязательный) #

Префикс отличительного имени для пользователей.

Если этот параметр указан, поиск пользователей выполняется с помощью отличительного имени base_user_dn=prefix_user_dn,base_dn.

Значение по умолчанию: "" (пустая строка) — поиск пользователей происходит по всему каталогу.

prefix_group_dn (string, необязательный) #

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

Если этот параметр указан, поиск групп выполняется с помощью отличительного имени base_group_dn=prefix_group_dn,base_dn.

Значение по умолчанию: "" (пустая строка) — поиск групп происходит по всему каталогу.

user_class (string, непустое значение) #

Имя класса объекта пользователя.

Обязательно для OpenLDAP, необязательно для Microsoft Active Directory.

Значение по умолчанию для Microsoft Active Directory: "" (пустая строка).

user_name_attr (string) #

Имя атрибута логина пользователя.

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

  • Для OpenLDAP: cn.

  • Для Microsoft Active Directory: sAMAccountName.

user_first_name_attr (string, необязательный) #

Имя атрибута имени пользователя.

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

user_last_name_attr (string, необязательный) #

Имя атрибута фамилии пользователя.

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

user_display_name_attr (string, необязательный) #

Имя атрибута отображаемого имени пользователя.

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

user_email_attr (string, необязательный) #

Имя атрибута электронной почты пользователя.

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

user_phone_attr (string, необязательный) #

Имя атрибута телефона пользователя.

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

user_job_title_attr (string, необязательный) #

Имя атрибута должности пользователя.

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

user_id_attr (string, необязательный) #

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

Значение по умолчанию для Microsoft Active Directory: sAMAccountName.

group_class (string, непустое значение) #

Имя класса объекта группы.

Значение по умолчанию для Microsoft Active Directory: group.

group_name_attr (string) #

Имя атрибута имени группы.

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

group_filter (string, необязательный) #

Фильтр для поиска групп пользователей.

Пример:

(&(objectClass=group)(cn=*PPEM*))

Значение по умолчанию: "" (пустая строка).

group_list_size_limit (integer, необязательный) #

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

Значение по умолчанию: 0 — количество определяется службой каталогов.

group_members_attr (string, необязательный) #

Важно

Указывайте этот параметр, только если соответствующий атрибут существует в службе каталогов.

Имя атрибута списка участников группы.

Этот параметр и user_membership_attr — взаимоисключающие параметры.

Значение по умолчанию: "" (пустая строка).

group_membership_filter (string, необязательный) #

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

Оберните отличительное имя пользователя в знаки процента, чтобы использовать это имя в фильтре.

Переопределяет параметр group_members_attr.

Пример:

(&(objectClass=group)(uniqueMember=%отличительное_имя_целевого_пользователя%))

Значение по умолчанию: "" (пустая строка).

user_membership_attr (string, необязательный) #

Важно

Указывайте этот параметр, только если соответствующий атрибут существует в службе каталогов.

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

Этот параметр и group-members-attr — взаимоисключающие параметры.

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

  • Для OpenLDAP: "" (пустая строка).

  • Для Microsoft Active Directory: memberOf.

user_sync_interval (time string, необязательный) #

Интервал, с которым PPEM синхронизируется со службой каталогов.

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

ssl_cert_skip_verify (boolean, необязательный) #

Важно

Использование этого параметра представляет риск для безопасности.

Рекомендуется использовать его исключительно для тестирования и отладки, но не в эксплуатационной среде.

Указывает, отключена ли проверка TLS-сертификата сервера.

Значение по умолчанию: false — сертификат проверяется.

ssl_root_ca (string, необязательный) #

Абсолютный путь к корневому CA-сертификату, который используется для проверки сертификата сервера.

Значение по умолчанию: "" (пустая строка) — используются сертификаты из хранилища операционной системы.

Параметры менеджера пакетов #

Раздел package_managers позволяет настроить параметры, связанные с менеджером пакетов операционной системы серверов СУБД.

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

package_managers:
  scheduler:
    interval: интервал_синхронизации
    initial_delay: начальная_задержка_перед_запуском_планировщика
  commands:
    timeout: тайм_аут_команд_менеджера_пакетов
scheduler (object) #

Параметры планировщика PPEM.

interval (time string) #

Интервал времени, согласно которому синхронизируются репозитории.

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

initial_delay (time string) #

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

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

commands.timeout (time string) #

Тайм-аут команд, связанных с менеджером пакетов, которые выполняются агентом на сервере СУБД.

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

Параметры сборщика метрик #

Раздел metrics позволяет настроить параметры сборщика метрик.

За подробной информацией о процессе сбора метрик и архитектуре мониторинга обратитесь к Разделу 3.4.

metrics:
  enabled: true_или_false
  timeout: тайм_аут_запроса_метрик
enabled (boolean) #

Указывает, включён ли сбор метрик.

Значение по умолчанию: true — метрики собираются.

timeout (time string) #

Тайм-аут запроса метрик.

Значение по умолчанию: такое же значение, что и для тайм-аута HTTP-клиента.

Параметры оповещений и уведомлений #

Раздел alerts позволяет настроить параметры оповещений и уведомлений.

За подробной информацией об оповещениях обратитесь к Главе 55.

alerts:
  metrics:
    request_chunk_size: количество_идентификаторов_экземпляров
  logs:
    request_chunk_size: количество_идентификаторов_экземпляров
  cleanup_grace_period: интервал_очистки_оповещений_при_отсутствии_данных
  scheduler:
    interval: интервал_проверки_новых_оповещений
    initial_delay: задержка_перед_запуском_планировщика_оповещений
    timeout: тайм_аут_обновления_правил_триггеров_оповещений
  delayed_data:
    is_enabled: true_или_false
    data_delay: задержка_поступления_данных_по_умолчанию_для_всех_источников
    datasource_delays:
      metrics: задержка_поступления_метрик
      logs: задержка_поступления_журналов
    max_delay: максимальная_разрешённая_задержка_поступления_данных
    is_adaptive_delay: true_или_false
  notifier:
    num_workers: количество_параллельных_рабочих_процессов
    worker_batch_size: количество_оповещений_в_одном_пакете
    worker_interval: интервал_проверки_новых_оповещений
    backoff_base: длительность_расчёта_экспоненциальной_задержки
    max_retries: максимальное_количество_попыток_оповещения
    notification_timeout: тайм_аут_оповещения
    janitor_interval: интервал_опроса_рабочего_процесса_очистки
    stale_processing_timeout: тайм_аут_обработки_устаревших_оповещений
  email:
    is_enabled: true_или_false
    pool_size: максимальное_количество_параллельных_подключений
    smtp:
      host: имя_хоста_или_IP-адрес_SMTP-сервера
      port: порт_SMTP-сервера
      username: имя_пользователя_для_аутентификации_на_SMTP-сервере
      password: пароль_для_аутентификации_на_SMTP-сервере
      auth_type: тип_аутентификации_SMTP
      from: электронная_почта_отправителя_оповещения
      timeout: тайм_аут_подключения_к_SMTP-серверу
      use_starttls: true_или_false
      use_ssl: true_или_false
      tls:
        insecure_skip_verify: true_или_false
        root_ca_path: файл_корневого_сертификата_CA
  
metrics.request_chunk_size (integer) #

Максимальное количество идентификаторов экземпляров в одном запросе при обработке метрик.

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

logs.request_chunk_size (integer) #

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

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

cleanup_grace_period (time string) #

Интервал очистки оповещений при отсутствии данных.

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

scheduler (object) #

Параметры планировщика, который обновляет оповещения в памяти менеджера.

interval (time string) #

Интервал проверки планировщиком новых оповещений для обработки.

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

initial_delay (time string) #

Задержка перед первым запуском планировщика после запуска PPEM.

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

timeout (time string) #

Тайм-аут планировщика для обновления правил триггеров оповещений.

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

delayed_data (object) #

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

is_enabled (boolean) #

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

Значение по умолчанию: false — PPEM не проверяет метрики и журналы, получаемые с задержкой.

data_delay (time string) #

Задержка данных по умолчанию для всех источников данных, если для них не настроены конкретные задержки.

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

datasource_delays (object) #

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

метрик (time string, непустое значение) #

Задержка поступления метрик. Метрики обычно имеют более стабильные интервалы сбора, но могут задерживаться из-за проблем с сетью или обработкой.

журналов (time string, непустое значение) #

Задержка поступления журналов. Журналы могут поступать чаще, но время их доставки может сильно варьироваться из-за ротации журналов и их обработки.

max_delay (time string) #

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

Значение по умолчанию: 600s (10 минут).

is_adaptive_delay (boolean) #

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

Если этот параметр включён, фактические задержки при получении данных анализируются в PPEM на основе меток времени, и временное окно настраивается динамически.

Значение по умолчанию: true — обучение включено.

notifier (object) #

Параметры системы уведомлений, которая отправляет оповещения.

num_workers (integer) #

Количество параллельных рабочих процессов, которые отправляют оповещения.

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

worker_batch_size (integer) #

Количество оповещений, обрабатываемых рабочими процессами в одном пакете.

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

worker_interval (time string) #

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

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

backoff_base (time string) #

Базовая длительность расчёта экспоненциальной задержки при повторной отправке неудавшегося оповещения.

Задержка повторной отправки оповещения рассчитывается как:

backoff_base × 2количество_попыток_повторной_отправки

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

max_retries (integer) #

Максимальное количество попыток повторно отправить неудавшееся оповещение.

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

notification_timeout (time string) #

Максимальное время, в течение которого система уведомлений должна ожидать отправки оповещения. Если по прошествии этого времени оповещение не было отправлено, оно считается неудавшимся.

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

janitor_interval (time string) #

Интервал опроса рабочего процесса очистки (janitor worker), который очищает оповещения, застрявшие в состоянии обработки.

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

stale_processing_timeout (time string) #

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

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

email (object) #

Параметры отправки оповещений по электронной почте.

is_enabled (boolean) #

Указывает, включена ли отправка оповещений по электронной почте.

Если отправка по электронной почте отключена, вместо отправки по электронной почте оповещения попадают в журнал.

Значение по умолчанию: false — оповещения по электронной почте отключены.

pool_size (integer) #

Количество параллельных подключений к SMTP-серверам.

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

smtp (object) #

Параметры SMTP-сервера, который используется для отправки оповещений.

host (string) #

Имя хоста или IP-адрес SMTP-сервера.

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

port (номер порта) #

Номер порта SMTP-сервера.

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

username (string) #

Имя пользователя для аутентификации на SMTP-сервере.

Значение по умолчанию: "" (пустая строка).

password (string) #

Пароль для аутентификации на SMTP-сервере.

Значение по умолчанию: "" (пустая строка).

auth_type (enum) #

Тип аутентификации, который нужно использовать при аутентификации на SMTP-сервере.

Возможные значения:

  • plain: тип AUTH PLAIN.

  • login: тип AUTH LOGIN.

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

from (string) #

Адрес электронной почты отправителя оповещений.

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

timeout (time string) #

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

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

use_starttls (boolean) #

Указывает, включено ли расширение STARTTLS.

Если этот параметр включён, после установления незащищённого подключения выполняется команда STARTTLS для обновления этого подключения до защищённого.

Значение по умолчанию: false — STARTTLS отключён.

use_ssl (boolean) #

Указывает, включён ли TLS.

Если этот параметр включён, подключение является защищённым с самого начала.

Значение по умолчанию: false — TLS отключён.

tls (object) #

Параметры протокола TLS.

отключить_проверку_безопасности (boolean) #

Важно

Использование этого параметра представляет риск для безопасности.

Рекомендуется использовать его исключительно для тестирования и отладки, но не в эксплуатационной среде.

Указывает, отключена ли проверка TLS-сертификата сервера.

Значение по умолчанию: false — сертификат проверяется.

root_ca_path (string) #

Абсолютный путь к корневому CA-сертификату, который используется для проверки сертификата сервера.

Значение по умолчанию: "" (пустая строка) — используются сертификаты из хранилища операционной системы.

Параметры исполнителя #

Раздел executor позволяет настроить параметры исполнителя заданий.

За подробной информацией о заданиях обратитесь к Главе 70.

executor:
  get_tasks_frequency: частота_сбора_заданий
  get_tasks_timeout: тайм_аут_сбора_заданий
  get_tasks_batch_size: размер_пакета_сбора_заданий
  processing_at_update_frequency: частота_обновления_параметра_processing_at
  stop_running_tasks_frequency: частота_остановки_заданий
get_tasks_frequency (time string, непустое значение) #

Частота, с которой запланированные задания собираются исполнителем для выполнения.

get_tasks_timeout (time string, непустое значение) #

Тайм-аут сбора запланированных заданий.

get_tasks_batch_size (integer, непустое значение) #

Количество задач, которые могут быть собраны исполнителем в одном запросе.

processing_at_update_frequency (time string, непустое значение) #

Частота обновления параметра processing_at для активных заданий.

stop_running_tasks_frequency (time string, непустое значение) #

Частота, с которой останавливаются задания.

Параметры OpenTelemetry (OTLP) #

Раздел otlp позволяет настроить параметры интеграции PPEM с инструментами трассировки, совместимыми с OpenTelemetry.

otlp:
  traces:
    sampler_ratio: коэффициент_выборки_трассировок
    exporter:
      protocol: протокол_экспорта_трассировок
      endpoint_url: URL_конечной_точки_для_экспорта_трассировок
      tls:
        insecure_skip_verify: пропустить_проверку_сертификата_сборщика
traces (object) #

Параметры трассировки.

sampler_ratio (float, необязательный) #

Процент трассировок, который подлежит выборке.

В зависимости от значения параметра выборка трассировок выполняется следующим образом:

  • 0.0 < sampler_ratio < 1.0: выборке подлежит указанный процент трассировок.

    Например, значение 0.7 означает, что выборке подлежит 70% трассировок.

  • sampler_ratio ≥ 1.0: выборке подлежат все трассировки.

    Пример значения: 1.8.

  • sampler_ratio ≤ 0.0: никакие трассировки не подлежат выборке.

    Пример значения: -3.3.

Значение по умолчанию: 1.0 — выборке подлежат все трассировки.

exporter (object) #

Параметры экспортера.

protocol (enum, необязательный) #

Протокол OpenTelemetry для экспорта трассировок.

Возможные значения:

Значение по умолчанию: "" (пустая строка) — экспорт трассировок отключён.

endpoint_url (string, непустое значение) #

URL-адрес конечной точки сборщика, используемый экспортером для отправки трассировок.

URL-адрес может содержать номер порта и путь, но не должен содержать полную или частичную строку запроса.

Примеры:

  • Для OTLP через HTTP: http://localhost:4318/v1/traces.

  • Для OTLP через gRPC: http://localhost:4317.

tls.insecure_skip_verify (boolean, необязательный) #

Важно

Использование этого параметра представляет риск для безопасности.

Рекомендуется использовать его исключительно для тестирования и отладки, но не в эксплуатационной среде.

Указывает, отключена ли проверка TLS-сертификата сервера.

Значение по умолчанию: false — сертификат проверяется.

Параметры журнала событий аудита #

Раздел audit позволяет настроить параметры журнала событий аудита.

audit:
  enabled: true_или_false
  syslog:
    protocol: один_из_поддерживаемых_транспортных_протоколов
    address: адрес_syslog_сервера
    port: порт_Syslog_сервера
    facility: категория_syslog_сообщений
    tag: тег_syslog_сообщений
  log:
    path: путь_к_файлу_журнала
    mode: режим_доступа_к_файлу_журнала
enabled (boolean) #

Указывает, включён ли журнал событий аудита.

Если журнал включён, PPEM добавляет системное правило очистки audit_events_housekeeping для базы данных репозитория.

По умолчанию расписание автоматического запуска не настроено для этого правила. При необходимости настройте расписание.

Значение по умолчанию: false — журнал отключён, PPEM не ведёт журнал событий аудита.

syslog (object) #

Параметры отправки журнала событий аудита на сервер syslog.

Если этот параметр не указан, для параметра audit.enabled указывается значение true, события аудита записываются журнал, но не отправляются на syslog-сервер.

protocol (enum) #

Транспортный протокол, используемый для доставки syslog-сообщений.

Возможные значения:

  • local или '' (пустая строка): сообщения доставляются в пределах исходного сервера и не отправляются по сети.

  • tcp, tcp4 или tcp6: использовать TCP в качестве транспорта.

    Укажите tcp4 или tcp6, чтобы явно использовать TCP поверх IPv4 или IPv6 соответственно. Укажите tcp, чтобы PPEM выбирал протокол автоматически.

  • udp, udp4 или udp6: использовать UDP в качестве транспорта.

    Укажите udp4 или udp6, чтобы явно использовать UDP поверх IPv4 или IPv6 соответственно. Укажите udp, чтобы PPEM выбирал протокол автоматически.

  • ip, ip4 или ip6: использовать IP в качестве транспорта.

    Укажите ip4 или ip6, чтобы явно использовать IPv4 или IPv6 соответственно. Укажите ip, чтобы PPEM выбирал протокол автоматически.

  • unix, unixgram или unixpacket: использовать сокет домена UNIX в качестве транспорта.

    Указанные выше значения являются типами сокетов домена UNIX, которые используют различную семантику:

    • Сокет типа unix использует семантику SOCK_STREAM.

    • Сокет типа unixgram использует семантику SOCK_DGRAM.

    • Сокет типа unixpacket использует семантику SOCK_SEQPACKET.

address (string) #

Сетевой адрес syslog-сервера, если это требуется для выбранного транспортного протокола.

port (номер порта) #

Порт syslog-сервера, если это требуется для выбранного транспортного протокола.

facility (enum) #

Категория syslog-сообщений.

Возможные значения:

  • kern: сообщения ядра.

  • user: сообщения пользовательского уровня.

  • mail: почтовая система.

  • daemon: системные демоны.

  • auth: сообщения безопасности/авторизации.

  • syslog: сообщения, генерируемые внутри syslogd.

  • lpr: подсистема строчной печати.

  • news: подсистема сетевых новостей.

  • uucp: подсистема UUCP.

  • cron: демон планировщика задач.

  • authpriv: сообщения безопасности/авторизации.

  • ftp: служба FTP.

  • local0 — local7: локальная подсистема 0–7.

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

tag (string) #

Тег syslog-сообщений.

Значение по умолчанию: "" (пустая строка) — в качестве тега используется значение AUDIT.

log (object) #

Параметры отправки журнала событий аудита в текстовый файл.

Если этот параметр не указан и для параметра audit.enabled указано значение true, события аудита записываются в журнал, но не отправляются в текстовый файл.

path (string) #

Путь к текстовому файлу журнала.

Если файл не существует, он создаётся автоматически.

Пример: /tmp/auth.log.

mode (string) #

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

Формат параметра — 0xxx, такой же, как и для команды chmod.

Пример: 0644.

Параметры подключения к агентам #

Раздел agents_connection позволяет настроить параметры подключения к агентам.

agents_connection:
  read_timeout: тайм_аут_получения_данных
  write_timeout: тайм_аут_отправки_данных
  max_connections_per_second: ограничение_частоты_подключений
  log_pings: true_или_false
read_timeout (time string) #

Тайм-аут получения данных от агентов.

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

write_timeout (time string) #

Тайм-аут отправки данных агентам.

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

max_connections_per_second (integer) #

Ограничение частоты подключений.

Если количество подключений к агентам в секунду превышает это значение, любые новые подключения отклоняются с кодом состояния HTTP 429 Too Many Requests.

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

log_pings (boolean, необязательный) #

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

Значение по умолчанию: false — журналирование запросов отключено.

Параметры автоматического обнаружения #

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

autodiscovery:
  instance_name_template: шаблон_имени_экземпляра
instance_name_template (string, необязательный) #

Шаблон имени для экземпляров, обнаруженных автоматически.

Файл конфигурации агента также поддерживает этот параметр. При этом значение из файла конфигурации агента имеет приоритет над значением, заданным в файле конфигурации менеджера.

Этот параметр применяется, когда в файле конфигурации агента не задан шаблон имени экземпляра.

Шаблон должен представлять собой одну строку без переносов.

Поддерживаются следующие переменные: {{.Host}}, {{.HostName}}, {{.Port}}, {{.Version}}, {{.Edition}}, {{.ServiceType}}, {{.ClusterType}} и {{.SystemIdentifier}}.

Если полученное имя совпадает с именем существующего экземпляра, к нему добавляется числовой суффикс (-1, -2 и так далее).

Если шаблон не задан ни агентом, ни менеджером, используется шаблон по умолчанию instance-{ID}.

Значение по умолчанию: "" (пустая строка).

Параметры различных временных интервалов и тайм-аутов #

В этом разделе можно настроить различные временные интервалы и тайм-ауты.

collectors:
  agent_time_desync_allowance: максимально_допустимое_расхождение_времени

replication:
  worker:
    interval: интервал_между_циклами_перерасчёта_кластера

operations:
  watcher_timeout: тайм_аут_проверки_состояния_операций

notifications:
  cleanup_age: срок_хранения_прочитанных_уведомлений

commands:
  cleanup_age: срок_хранения_истории_выполненных_команд
collectors.agent_time_desync_allowance (time string, необязательный) #

Максимально разрешённое расхождение во времени между менеджером и агентами.

Если указанное ограничение превышается, в журналы PPEM записывается соответствующее предупреждение.

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

replication.worker.interval (time string, необязательный) #

Интервал между циклами перерасчёта кластера.

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

operations.watcher_timeout (time string) #

Тайм-аут проверки состояния операции.

notifications.cleanup_age (time string, необязательный) #

Срок хранения прочитанных уведомлений.

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

Значение по умолчанию: 168h (7 дней).

commands.cleanup_age (time string, необязательный) #

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

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

Значение по умолчанию: 720h (30 дней).

FAQ