使用 erda.yml 管理配置

通过 erda.yml 为服务指定 endpoints 即可实现微服务网关功能,将一个域名的不同路径转发给相同项目和环境下的不同服务。

具体示例如下:

  1. version: 2.0
  2. services:
  3. user-center:
  4. ports:
  5. - port: 8080
  6. endpoints:
  7. # 可以写成 .* 后缀,会根据集群泛域名自动补全
  8. - domain: hello.*
  9. path: /api/user
  10. backend_path: /api
  11. policies:
  12. # 允许跨域访问
  13. cors:
  14. allow_origins: any
  15. # 限制访问 QPS 为100
  16. rate_limit:
  17. qps: 100
  18. # 可以写完整域名
  19. - domain: uc.app.terminus.io
  20. # 如果后端路径一致,可以省略 backendPath
  21. path: /
  22. acl-center:
  23. ports:
  24. - port: 8080
  25. endpoints:
  26. - domain: hello.*
  27. path: /api/acl
  28. backend_path: /api

endpoints 由以下属性组成:

  • domain(必填):

    域名,可填写完整域名,也可仅填写最后一级域名(平台会基于集群泛域名自动补全)。

  • path(选填):

    域名路径,域名下基于 URL 前缀匹配到当前路径的请求都将转发给该服务,未填写时默认为 /。URL 前缀会根据路径长度匹配,路径精确度越高,则优先级越高。

  • backend_path(选填):

    转发给服务的路径,可理解为将 path 部分匹配到的 URL 路径抹除后,剩余部分拼接在 backend_path 上转发给服务,未填写时默认和 path 一致。

  • policies(选填):

    当前支持跨域策略和限流策略。

    • 跨域策略:关于跨域相关信息,请参见 跨域资源共享

      以允许跨域应答头 Access-Control-Allow-Origin 为例,allow_origins 配置的值将作为这个应答头的值。当值为 any 时,则直接获取请求头的 Orgin 字段作为值。

      Access-Control-Allow-MethodsAccess-Control-Allow-Headers 等同理。

      1. policies:
      2. cors:
      3. # 必填字段,当为 any 时,允许 origin 是任何域名进行跨域访问
      4. allow_origins: any
      5. # 非必填,默认是 any,允许 http method 是任何类型
      6. allow_methods: any
      7. # 非必填,默认是 any,允许 http header 是任何字段
      8. allow_headers: any
      9. # 非必填,默认是 true,允许 cookie 字段跨域传输
      10. allow_credentials: true
      11. # 非必填,默认是 86400,跨域预检请求一次成功后的有效时间
      12. max_age: 86400
    • 限流降级策略:若填写 deny_status302,此时 deny_content 可作为 HTTP 地址提供跳转,还可将该地址配置为一个降级接口(例如 CDN 页面),用于透出当前服务过载的信息。

      1. policies:
      2. rate_limit:
      3. # 必填字段,每秒最大请求速率
      4. qps: 100
      5. # 非必填字段,最大延后处理时间,默认是 500 毫秒,超过速率时不会立即拒绝,进行去峰填谷处理
      6. max_delay: 500
      7. # 非必填字段,默认是 429,延后处理后仍然超过速率,会进行拒绝,返回对应的状态码
      8. deny_status: 429
      9. # 非必填字段,默认是 server is busy,拒绝时返回的应答
      10. deny_content: "server is busy"