应用上游

目录结构

|-- upstreams/
  |-- 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 状态码列表

配置示例

app_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:
    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: tcp
    fall: 3
    interval: 3
    timeout: 1
    http_req_method: GET
    http_req_host: test.com
    http_req_uri: /status
app_upstream_name2:
  ssl: true
  disable_ssl_verify: false
  enable_checker: true
  servers:
  - host: 1.1.1.3
    port: 443
  checker:
    type: https
    interval: 3
    timeout: 1
    fall: 3
    rise: 2
    http_req_method: GET
    http_req_uri: /status
    valid_statuses:
    - 200
    - 302

此配置定义了两个应用上游,一个使用 TCP 健康检查,另一个使用 HTTPS 健康检查。

使用示例

更新配置到 OpenResty Edge 中:

edge-config https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -l upstreams -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 upstreams -d test.com

清理 OpenResty Edge 中的配置:

edge-config -u https://192.168.1.1 -s -t 2051e780-1897-4ea0-92b4-2c2f0169aa94 -c -l upstreams -d test.com

示例中均使用 -l upstreams 来指定只操作应用上游相关的配置。

注意事项

  1. 每个应用上游必须有一个唯一的名称。

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

  3. port 必须是一个有效的端口号(1-65535)。

  4. 如果启用了健康检查(enable_checker: true),必须提供有效的 checker 配置。

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

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

  7. 如果配置中删除了某个上游,工具会自动从应用中移除该上游。

  8. 在处理配置时,如果发生错误,工具会自动清除已经进行的更改,以保持配置的一致性。

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

  10. 导出配置时,如果应用不存在,工具会给出警告信息。

相关文档