2 分钟阅读 | 最后修改: 2024-08-23, 6:04:07 pm

全局上游

目录结构

|-- global_upstreams/
  |-- global_upstreams.yaml
  |-- ...

YAML 文件中可以包含一个或多个全局上游配置。

配置说明

每个全局上游配置是一个键值对，其中键是上游名称，值是一个包含以下参数的对象：

参数名数据类型是否必选描述
sslboolean否是否启用 SSL 连接，默认为 false
disable_ssl_verifyboolean否是否禁用 SSL 验证，默认为 false
enable_checkerboolean否是否启用健康检查，默认为 false
serversarray是上游服务器列表
checkerobject否健康检查配置，仅在 enable_checker 为 true 时有效

servers 配置

参数名数据类型是否必选描述
hoststring是服务器主机名或 IP 地址
portinteger是服务器端口号

checker 配置

健康检查配置包含多个参数，用于定义如何进行健康检查。主要参数包括：

参数名数据类型描述
typestring健康检查类型，如 “tcp”, “http”, “https”
intervalinteger检查间隔
timeoutinteger超时时间
fallinteger连续失败次数阈值
riseinteger连续成功次数阈值
http_req_methodstringHTTP 请求方法
http_req_uristringHTTP 请求 URI
valid_statusesarray有效的 HTTP 状态码列表

配置示例

global_upstream_name1:
  ssl: false
  disable_ssl_verify: false
  enable_checker: true
  servers:
  - host: 1.1.1.1
    port: 80
  - host: 1.1.1.2
    port: 80
  checker:
    interval_unit: sec
    http_req_method: GET
    ssl_verify: true
    concurrency: 5
    always_check: false
    report_interval_unit: min
    rise: 2
    timeout: 1
    interval: 3
    type: tcp
    http_ver: '1.0'
    report_interval: 3
    fall: 3
global_upstream_name2:
  ssl: true
  disable_ssl_verify: false
  enable_checker: true
  servers:
  - host: 1.1.1.3
    port: 443
  checker:
    user_agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0
    valid_statuses:
    - 200
    - 302
    rise: 2
    type: https
    fall: 3
    ssl_verify: true
    interval_unit: sec
    http_req_method: GET
    concurrency: 5
    http_req_host: test.com
    resp_body_match: abc
    timeout: 1
    interval: 3
    always_check: false
    http_ver: '1.0'
    http_req_uri: /status
    report_interval_unit: min
global_upstream_name3:
  ssl: false
  disable_ssl_verify: false
  enable_checker: false
  servers:
  - host: 1.1.1.1
    port: 80
  - host: 1.1.1.2
    port: 80

此配置定义了三个全局上游，分别启用了不同的设置和健康检查配置。

使用示例

更新配置到 OpenResty Edge 中：

edge-config https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -l global_upstreams -i /root/oredge-configs

从 OpenResty Edge 中导出配置：

edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -E -l global_upstreams

示例中均使用 -l global_upstreams 来指定只导入/导出全局上游相关的配置。

注意事项

  1. 全局上游是一个全局配置，为了保持与多个本地配置的兼容性，在更新配置时不会执行删除操作。

  2. 每个全局上游必须有一个唯一的名称。

  3. 服务器的 host 可以是 IPv4 地址、IPv6 地址或域名。

  4. port 必须是一个有效的端口号（1-65535）。

  5. 如果启用了健康检查（enable_checker: true），必须提供有效的 checker 配置。

  6. 在更新配置时，工具会比较新旧配置来确定是否需要更新。如果配置有变化，则会执行更新操作。

  7. 在导入配置时，工具会先检查配置的有效性，然后再执行添加或更新操作。

  8. 在导出配置时，工具会将服务器信息格式化为统一的结构，便于配置的可读性和可移植性。

相关文档