モジュール 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 に設定すると、初期使用状況レポートを F5 ライセンスエンドポイントで受信する必要がある 180 日間の猶予期間が有効になります。

license_token license.jwt;

JWT ライセンス file を指定します。デフォルトでは、license.jwt ファイルは、Linux の場合は /etc/nginx/、FreeBSD の場合は /usr/local/etc/nginx/ にあると想定されます。

使用状況レポートのエンドポイント名を解決するために使用されるネームサーバーを設定します。デフォルトでは、システムリゾルバーが使用されます。

詳細については、resolver を参照してください。

使用状況レポートのエンドポイントの証明書を 検証するために使用される、PEM 形式で失効した証明書 (CRL) を含む file を指定します。

ssl_trusted_certificate system CA bundle;

使用状況レポートのエンドポイントの証明書を 検証するために使用される、PEM 形式で信頼できる CA 証明書を含む file を指定します。

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 パラメーターは、2 つの連続するレポート間の間隔を設定します。

1.27.2 より前では、デフォルト値は nginx-mgmt.local と 30m でした。