模块 ngx_stream_keyval_module

示例配置 指令      keyval      keyval_zone

ngx_stream_keyval_module 模块 (1.13.7) 使用 API 或也可以使用 njs 设置的变量管理的键值对创建变量。

此模块作为我们 商业订阅 的一部分提供。

示例配置

http {

    server {
        ...
        location /api {
            api write=on;
        }
    }
}

stream {

    keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval;
    keyval      $ssl_server_name $name zone=one;

    server {
        listen              12345 ssl;
        proxy_pass          $name;
        ssl_certificate     /usr/local/nginx/conf/cert.pem;
        ssl_certificate_key /usr/local/nginx/conf/cert.key;
    }
}

指令

创建新的 $variable，其值由键值数据库中的 key 查找。匹配规则由 keyval_zone 指令的 type 参数定义。数据库存储在由 zone 参数指定的共享内存区域中。

设置保存键值数据库的共享内存区域的 name 和 size。键值对由 API 管理。

可选的 state 参数指定一个 file，该文件以 JSON 格式保存键值数据库的当前状态，并使其在 nginx 重启时保持持久性。应避免直接更改文件内容。

示例

keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval; # path for Linux
keyval_zone zone=one:32k state=/var/db/nginx/state/one.keyval;  # path for FreeBSD

可选的 timeout 参数 (1.15.0) 设置键值对从区域中删除的时间。

可选的 type 参数 (1.17.1) 激活针对匹配特定类型的键进行了优化的额外索引，并在评估 keyval $variable 时定义匹配规则。

索引存储在同一共享内存区域中，因此需要额外的存储空间。

type=string

默认情况下，未启用索引；变量查找使用记录键和搜索键的完全匹配执行

type=ip

搜索键是 IPv4 或 IPv6 地址或 CIDR 范围的文本表示；要匹配记录键，搜索键必须属于记录键指定的子网或与 IP 地址完全匹配

type=prefix

使用记录键和搜索键（1.17.5）的前缀匹配执行变量查找；要匹配记录键，记录键必须是搜索键的前缀

可选的 sync 参数（1.15.0）启用共享内存区域的同步。同步需要设置 timeout 参数。

如果启用了同步，则仅在目标集群节点上执行键值对的删除（无论一个还是全部）。其他集群节点上的相同键值对将在 timeout 时删除。