Модуль ngx_mgmt_module

• Пример конфигурации
• Директивы
• connect_timeout
• mgmt
• read_timeout
• resolver
• resolver_timeout
• send_timeout
• ssl
• ssl_certificate
• ssl_certificate_key
• ssl_ciphers
• ssl_crl
• ssl_name
• ssl_password_file
• ssl_protocols
• ssl_server_name
• ssl_trusted_certificate
• ssl_verify
• ssl_verify_depth
• usage_report
• uuid_file

Модуль ngx_mgmt_module позволяет сообщать о текущей установке nginx менеджеру экземпляров NGINX Management Suite (NGINX Management Suite Instance Manager) (1.25.3). По умолчанию nginx отправляет информацию об использовании экземпляру менеджера, расположенному по адресу nginx-mgmt.local каждые 30 минут, используя SSL-соединение. Используется системный разрешатель, если не настроена настройка пользовательского разрешателя, и он вызывается только один раз при загрузке конфигурации.

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

Пример конфигурации

mgmt {
    usage_report endpoint=nginx-mgmt.local interval=30m;
    resolver     DNS_IP;

    uuid_file /var/lib/nginx/nginx.id;

    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers   DEFAULT;

    ssl_certificate     client_cert.pem;
    ssl_certificate_key client_cert.key;

    # configure server certificate verification
    # to validate the authenticity of NMS
    ssl_trusted_certificate  trusted_ca_cert.crt;
    ssl_verify               on;
    ssl_verify_depth         2;
}

Директивы

Определяет таймаут для установления соединения с менеджером экземпляров.

Предоставляет контекст файла конфигурации, в котором задаются директивы сервера управления.

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

Настраивает серверы имен, используемые для преобразования имён менеджера экземпляров в адреса, например:

resolver 127.0.0.1 [::1]:5353;

Адрес может быть указан как доменное имя или IP-адрес с необязательным портом. Если порт не указан, используется порт 53. К серверам имен обращаются по кругу.

По умолчанию nginx ищет как IPv4, так и IPv6 адреса при разрешении. Если поиск IPv4 или IPv6 адресов нежелателен, можно указать параметр ipv4=off или ipv6=off.

По умолчанию nginx кэширует ответы, используя значение TTL ответа. Необязательный параметр valid позволяет его переопределить:

resolver 127.0.0.1 [::1]:5353 valid=30s;

Для предотвращения подделки DNS рекомендуется настройка DNS-серверов в надёжной защищённой локальной сети.

Необязательный параметр status_zone позволяет собирать статистику DNS-серверов запросов и ответов в указанной zone.

Устанавливает таймаут для разрешения имени.

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

Включает протокол HTTPS для всех соединений с менеджером экземпляров.

Указывает file с сертификатом в формате PEM, используемым для аутентификации с менеджером экземпляров.

Указывает file с секретным ключом в формате PEM, используемым для аутентификации с менеджером экземпляров.

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

Полный список можно просмотреть с помощью команды “openssl ciphers”.

Указывает file с отозванными сертификатами (CRL) в формате PEM, используемом для проверки сертификата менеджера экземпляров.

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

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

Включает указанные протоколы для запросов к менеджеру экземпляров.

Включает или выключает передачу имени сервера через расширение TLS Server Name Indication (SNI, RFC 6066) при установлении соединения с менеджером экземпляров.

Указывает file с доверенными сертификатами CA в формате PEM, используемыми для проверки сертификата менеджера экземпляров.

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

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

Устанавливает address и port для IP или path для сокета доменной UNIX, на котором установлен менеджер экземпляров, по умолчанию nginx-mgmt.local. interval устанавливает интервал между отчётами менеджеру экземпляров, по умолчанию 30м.

Указывает file, который хранит идентификатор экземпляра nginx.

Примеры:

uuid_file /var/lib/nginx/nginx.id; # path for Linux
uuid_file /var/db/nginx/nginx.id;  # path for FreeBSD

Избегайте прямого изменения содержимого файла.