模块 ngx_http_keyval_module

这ngx_http_keyval_modulemodule （1.13.3） 创建变量 其值取自由 API 管理的键值对或也可以使用 njs 设置的变量 （1.15.10）。

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

http {

    keyval_zone zone=one:32k state=/var/lib/nginx/state/one.keyval;
    keyval $arg_text $text zone=one;
    ...
    server {
        ...
        location / {
            return 200 $text;
        }

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

创建一个新的$variable其值 由key在 key-value 数据库中。 匹配规则由type参数的keyval_zone命令。 数据库存储在共享内存区域中 由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

default，则不启用索引; 使用 Exact Match 执行变量查找 记录键和搜索键

type=ip

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

type=prefix

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

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

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