Router 配置

优质

小牛编辑

129浏览

2023-12-01

路由配置说明。

router 用于描述 MOSN 的路由配置，通常与 proxy 配合使用。

{
  "router_config_name":"",
  "virtual_hosts": [
  ]
}

VirtualHost

{
  "name":"",
  "domains":[],
  "routers":[]
}

name，字符串。用作 virtual host 的唯一标识。
domains，字符串数组。表示一组可以匹配到该 virtual host 的 domain，支持配置通配符。domain 的匹配优先级如下：
- 首先匹配精确的，如 www.foo.com。
- 其次匹配最长后缀的通配符，如 *.foo.com、*-bar.foo.com，其中如果一个 domain 是 foo-bar.foo.com，那么会优先匹配 *-bar.foo.com。
- 最后匹配任意domain的通配符 * 。
routers，一组具体的路由匹配规则。

{
  "match":{},
  "route":{},
  "per_filter_config":{}
}

match，路由的匹配参数。
route，路由行为，描述请求将被路由的 upstream 信息。
per_filter_config，是一个 key: json 格式的 json。
其中 key 需要匹配一个 stream filter 的 type，key 对应的 json 是该 stream filter 的 config。
- 当配置了该字段时，对于某些 stream filter（依赖具体 filter 的实现），可以使用该字段表示的配置覆盖原有 stream filter 的配置，以此做到路由匹配级别的 stream filter 配置。

{
  "prefix":"",
  "path":"",
  "regex":"",
  "headers": []
}

路径（path）匹配
- prefix，表示路由会匹配 path 的前缀，该配置的优先级高于 path 和 regex。如果 prefix 被配置，那么请求首先要满足 path 的前缀与 prefix 配置相符合。
- path，表示路由会匹配精确的 path，该配置的优先级高于 regex。如果 path被配置，那么请求首先要满足 path 与 path 配置相符合。
- regex，表示路由会按照正则匹配的方式匹配 path。如果 regex 被配置，那么请求首先要满足 path 与 regex 配置相符合。
- 路径匹配配置同时存在时，只有高优先级的配置会生效。
Heaer 匹配
- headers，表示一组请求需要匹配的 header。请求需要满足配置中所有的 Header 配置条件才算匹配成功。

{
  "name":"",
  "value":"",
  "regex":""
}

{
  "cluster_name":"",
  "metadata_match":"",
  "timeout":"",
  "retry_policy":{}
}

cluster_name，表示请求将路由到的 upstream cluster。
metadata_match，metadata，如果配置了该字段，表示该路由会基于该 metadata 去匹配 upstream cluster 的 subset 。
timeout，Duration String，表示默认情况下请求转发的超时时间。如果请求中明确指定了超时时间，那么这个配置会被忽略。
retry_policy，重试配置，表示如果请求在遇到了特定的错误时采取的重试策略，默认没有配置的情况下，表示没有重试。

{
  "retry_on":"",
  "retry_timeout":"",
  "num_retries":""
}

retry_on，bool 类型，表示是否开启重试。
retry_timeout，Duration String，表示每次重试的超时时间。当 retry_timeout 大于 route 配置的 timeout 或者请求明确指定的 timeout 时，属于无效配置。
num_retries，表示最大的重试次数。