模块 ngx_mgmt_module
示例配置 指令 mgmt enforce_initial_report license_token resolver ssl_crl ssl_trusted_certificate ssl_verify state_path usage_report |
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 实例管理器,然后从该管理器将报告发送到 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; }
指令
语法 |
mgmt { ... } |
---|---|
默认值 | — |
上下文 |
main |
提供指定使用情况报告和许可证管理指令的配置文件上下文。
语法 |
enforce_initial_report |
---|---|
默认值 |
enforce_initial_report on; |
上下文 |
mgmt |
此指令出现在 1.27.2 版本中。
启用或禁用发送初始使用情况报告的 180 天宽限期。
初始使用情况报告在 nginx 安装后首次启动时立即发送。默认情况下,如果 F5 许可证端点未收到初始报告,则 nginx 将停止处理流量,直到成功交付该报告。将指令值设置为 off
将启用 180 天宽限期,在此期间必须由 F5 许可证端点收到初始使用情况报告。
语法 |
license_token |
---|---|
默认值 |
license_token license.jwt; |
上下文 |
mgmt |
此指令出现在 1.27.2 版本中。
指定 JWT 许可证 文件
。默认情况下,预期 license.jwt
文件位于 Linux 系统的 /etc/nginx/
或 FreeBSD 系统的 /usr/local/etc/nginx/
目录下。
语法 |
resolver |
---|---|
默认值 | — |
上下文 |
mgmt |
配置用于解析使用情况报告端点名称的名称服务器。默认情况下,使用系统解析器。
有关详细信息,请参阅 resolver。
语法 |
ssl_crl |
---|---|
默认值 | — |
上下文 |
mgmt |
指定一个包含 PEM 格式的吊销证书 (CRL) 的 文件
,用于 验证 使用情况报告端点的证书。
语法 |
ssl_trusted_certificate |
---|---|
默认值 |
ssl_trusted_certificate system CA bundle; |
上下文 |
mgmt |
指定一个包含 PEM 格式的可信 CA 证书的 文件
,用于 验证 使用情况报告端点的证书。
语法 |
ssl_verify |
---|---|
默认值 |
ssl_verify on; |
上下文 |
mgmt |
启用或禁用使用情况报告端点证书的验证。
在 1.27.2 之前,默认值为 off
。
语法 |
state_path |
---|---|
默认值 | — |
上下文 |
mgmt |
此指令出现在 1.27.2 版本中。
定义一个目录,用于存储由 ngx_mgmt_module
模块创建的状态文件 (nginx-mgmt-*
)。Linux 系统的默认目录为 /var/lib/nginx/state
,FreeBSD 系统的默认目录为 /var/db/nginx/state
。
语法 |
usage_report [ |
---|---|
默认值 |
usage_report endpoint=product.connect.nginx.com interval=1h; |
上下文 |
mgmt |
设置使用情况报告端点的 地址
和 端口
。interval
参数设置两次连续报告之间的时间间隔。
在 1.27.2 之前,默认值为nginx-mgmt.local
和30m
。