应用 IP 列表
目录结构
|-- ip_lists/
|-- ip_lists.yaml
|-- ...
YAML 文件中可以包含一个或多个应用 IP 列表。
配置说明
每个 IP 列表是一个包含以下参数的对象：
| 参数名 | 数据类型 | 是否必选 | 描述 |
|---|---|---|---|
| name | string | 是 | IP 列表的名称，也是该列表的唯一标识 |
| type | string | 是 | IP 地址类型，目前仅支持 “ipv4” |
| items | array | 是 | IP 地址列表 |
items 配置
| 参数名 | 数据类型 | 是否必选 | 描述 |
|---|---|---|---|
| ip | string | 是 | IP 地址 |
配置示例
- name: app-ip-list1
type: ipv4
items:
- ip: 1.1.1.1
- ip: 1.1.1.11
- name: app-ip-list2
type: ipv4
items:
- ip: 1.1.1.1
- ip: 1.1.1.2
此配置定义了五个 IP 列表，每个列表包含两个 IPv4 地址。
使用示例
更新配置到 OpenResty Edge 中：
edge-config https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -l ip_lists -i /root/oredge-configs -d test.com
从 OpenResty Edge 中导出配置：
edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -E -l ip_lists -d test.com
清理 OpenResty Edge 中的配置：
edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -c -l ip_lists -d test.com
示例中均使用 -l ip_lists 来指定只操作应用 IP 列表相关的配置。
注意事项
每个 IP 列表必须有一个唯一的名称。
目前仅支持 IPv4 地址类型。
在添加或更新 IP 列表时，工具会检查 IP 地址的有效性。
在更新配置时，工具会比较新旧配置来确定是否需要更新。如果配置有变化，则会执行更新操作。
在导入配置时，工具会先检查配置的有效性，然后再执行添加或更新操作。
如果配置中删除了某个 IP 列表，工具会自动从应用中移除该列表。
在导出配置时，工具会格式化 YAML 内容，只包含必要的信息（名称、类型和 IP 地址）。
IP 列表可以被其他功能引用，如 WAF 规则、访问控制等。
在处理配置时，如果发生错误，工具会自动清除已经进行的更改，以保持配置的一致性。
导出配置时，如果应用不存在，工具会给出警告信息。