應用 IP 列表

目錄結構

|-- ip_lists/
  |-- ip_lists.yaml
  |-- ...

YAML 檔案中可以包含一個或多個應用 IP 列表。

配置說明

每個 IP 列表是一個包含以下引數的物件:

引數名資料型別是否必選描述
namestringIP 列表的名稱,也是該列表的唯一標識
typestringIP 地址型別,目前僅支援 “ipv4”
itemsarrayIP 地址列表

items 配置

引數名資料型別是否必選描述
ipstringIP 地址

配置示例

- 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 列表相關的配置。

注意事項

  1. 每個 IP 列表必須有一個唯一的名稱。

  2. 目前僅支援 IPv4 地址型別。

  3. 在新增或更新 IP 列表時,工具會檢查 IP 地址的有效性。

  4. 在更新配置時,工具會比較新舊配置來確定是否需要更新。如果配置有變化,則會執行更新操作。

  5. 在匯入配置時,工具會先檢查配置的有效性,然後再執行新增或更新操作。

  6. 如果配置中刪除了某個 IP 列表,工具會自動從應用中移除該列表。

  7. 在匯出配置時,工具會格式化 YAML 內容,只包含必要的資訊(名稱、型別和 IP 地址)。

  8. IP 列表可以被其他功能引用,如 WAF 規則、訪問控制等。

  9. 在處理配置時,如果發生錯誤,工具會自動清除已經進行的更改,以保持配置的一致性。

  10. 匯出配置時,如果應用不存在,工具會給出警告資訊。

相關文件