ngx_mgmt_module 模組

ngx_mgmt_module 模組啟用 NGINX Plus 授權驗證和使用情況報告。這對於每個 nginx/1.27.2 (nginx-plus-r33) 實例都是強制性的。

名為 license.jwt 的 JWT 授權檔案應位於 Linux 的 /etc/nginx/ 或 FreeBSD 的 /usr/local/etc/nginx/，或由 license_token 指令指定的路徑。授權檔案可從 MyF5 取得。

使用情況報告會使用安全連線，每小時傳送至 F5 授權端點。或者，在網路受限的環境中，可以設定將報告傳送至 F5 NGINX Instance Manager，然後由該管理器將報告傳送至 F5 授權端點。

預設情況下，如果 F5 授權端點未收到初始使用情況報告，nginx 將停止處理流量。

此模組是我們商業訂閱的一部分。

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;
}

提供設定檔上下文，用於指定使用情況報告和授權管理指令。

enforce_initial_report on;

啟用或停用傳送初始使用情況報告的 180 天寬限期。

初始使用情況報告會在 nginx 安裝後首次啟動時立即傳送。預設情況下，如果 F5 授權端點未收到初始報告，nginx 會停止處理流量，直到成功傳送報告為止。將指令值設定為 off 會啟用 180 天的寬限期，在此期間必須由 F5 授權端點收到初始使用情況報告。

license_token license.jwt;

指定 JWT 授權檔案。預設情況下，license.jwt 檔案預期位於 Linux 的 /etc/nginx/ 或 FreeBSD 的 /usr/local/etc/nginx/。

設定用於解析使用情況報告端點名稱的名稱伺服器。預設情況下，會使用系統解析器。

詳細資訊請參閱resolver。

指定一個 PEM 格式的已撤銷憑證 (CRL) 檔案，用於驗證使用情況報告端點的憑證。

ssl_trusted_certificate system CA bundle;

指定一個 PEM 格式的受信任 CA 憑證 檔案，用於驗證使用情況報告端點的憑證。

ssl_verify on;

啟用或停用使用情況報告端點憑證的驗證。

在 1.27.2 之前，預設值為 off。

定義儲存 ngx_mgmt_module 模組建立的狀態檔案 (nginx-mgmt-*) 的目錄。Linux 的預設目錄為 /var/lib/nginx/state，FreeBSD 的預設目錄為 /var/db/nginx/state。

usage_report endpoint=product.connect.nginx.com interval=1h;

設定使用情況報告端點的 address 和 port。interval 參數設定兩個連續報告之間的時間間隔。

在 1.27.2 之前，預設值為 nginx-mgmt.local 和 30m。