Модуль ngx_mgmt_module

• Пример конфигурации
• Директивы
• mgmt
• enforce_initial_report
• license_token
• proxy
• proxy_username
• proxy_password
• resolver
• ssl_crl
• ssl_trusted_certificate
• ssl_verify
• state_path
• usage_report

Модуль ngx_mgmt_module обеспечивает проверку лицензии NGINX Plus и отправку отчетов об использовании. Начиная с версии 1.27.2 ( NGINX Plus R33) это обязательно для каждого экземпляра NGINX Plus.

JWT-файл лицензии с именем license.jwt должен находиться по пути /etc/nginx/ в Linux или /usr/local/etc/nginx/ во FreeBSD либо по пути, указанному директивой license_token. Файл лицензии доступен на сайте MyF5.

Отчет об использовании отправляется напрямую или через прокси на конечную точку лицензирования F5 каждый час по защищенному соединению. При необходимости в средах с ограниченным доступом к сети можно настроить отправку отчетов в F5 NGINX Instance Manager, откуда отчет можно передать на конечную точку лицензирования F5.

По умолчанию, если конечная точка лицензирования F5 не получает первоначальный отчет об использовании, nginx прекращает обработку трафика.

Автоматическое продление лицензии поддерживается начиная с версии 1.29.0 (NGINX Plus R35) для экземпляров, отправляющих отчеты напрямую на конечную точку лицензирования F5. При продлении NGINX загружает обновленный JWT с конечной точки лицензирования F5 и применяет его без перезагрузки конфигурации. Обновленная лицензия хранится в каталоге state_path.

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

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

mgmt {
    # in case if custom path is required
    license_token custom/file/path/license.jwt;

    # in case of reporting to NGINX Instance Manager
    usage_report endpoint=NIM_FQDN;
}

Директивы

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

Включает или отключает льготный период в 180 дней для отправки первоначального отчета об использовании.

Первоначальный отчет об использовании отправляется сразу после первого запуска nginx после установки. По умолчанию, если конечная точка лицензирования F5 не получает первоначальный отчет, nginx прекращает обработку трафика до успешной доставки отчета. Если задать директиве значение off, включается льготный период в 180 дней, в течение которого конечная точка лицензирования F5 должна получить первоначальный отчет об использовании.

Задает путь к JWT-лицензии file. По умолчанию файл license.jwt должен находиться по пути /etc/nginx/ в Linux или /usr/local/etc/nginx/ во FreeBSD.

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

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

Задает пароль для аутентификации на прокси.

По умолчанию пароль отправляется в незашифрованном виде. Если прокси поддерживает TLS, соединение с прокси можно защитить с помощью модуля stream:

mgmt {
    proxy          127.0.0.1:8080;
    proxy_username <name>;
    proxy_password <password>;
}

stream {
    server {
        listen 127.0.0.1:8080;
        
        proxy_ssl                     on;
        proxy_ssl_verify              on;
        proxy_ssl_trusted_certificate <proxy_ca_file>;

        proxy_pass <proxy_host>:<proxy_port>;
    }
}

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

Подробности см. в разделе resolver.

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

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

Включает или отключает проверку сертификата конечной точки отправки отчетов об использовании.

До версии 1.27.2 значением по умолчанию было off.

Задает каталог для хранения файлов состояния (nginx-mgmt-*), созданных модулем ngx_mgmt_module. Каталог по умолчанию в Linux — /var/lib/nginx/state, во FreeBSD — /var/db/nginx/state.

Задает address и port конечной точки отправки отчетов об использовании. Параметр interval задает интервал между последовательными отчетами.

До версии 1.27.2 значениями по умолчанию были nginx-mgmt.local и 30m.