envoy 中文参考文档
  • 首页
  • 简介
    • Envoy是什么
    • 架构介绍
      • 术语
      • 线程模型
      • 监听器
      • L3/L4网络过滤器
      • HTTP连接管理
      • HTTP过滤器
      • HTTP路由
      • gRPC
      • WebSocket支持
      • 集群管理
      • 服务发现
      • 健康检查
      • 连接池
      • 负载均衡
      • 异常检测
      • 熔断
      • 全局限速
      • TLS
      • 统计
      • 运行时配置
      • 跟踪
      • TCP代理
      • 访问日志
      • MongoDB
      • DynamoDB
      • Redis
      • 热重启
      • 动态配置
      • 初始化
      • 逐出
      • 脚本
    • 部署
    • 业界对比
    • 获得帮助
    • 历史版本
  • 编译安装
    • 编译
    • 参考配置
    • 演示沙箱
      • 前端代理
      • Zipkin跟踪
      • Jaeger跟踪
      • gRPC桥接
      • 构建Envoy Docker镜像
    • 工具
  • 配置参考
    • V1 API 概述
    • V2 API 概述
    • 监听器
    • 网络过滤器
      • TLS客户端身份认证
      • Echo
      • Mongo代理
      • 速率限制
      • Redis代理
      • TCP代理
    • HTTP连接管理器
      • 路由匹配
      • 流量转移/分流
      • HTTP头部操作
      • HTTP头部清理
      • 统计
      • 运行时设置
      • 路由发现服务
    • HTTP过滤器
      • 缓存
      • CORS过滤器
      • 故障注入
      • DynamoDB
      • gRPC HTTP/1.1 桥接
      • gRPC-JSON 转码过滤器
      • gRPC-Web 过滤器
      • 健康检查
      • 速率限制
      • 路由
      • Lua
    • 集群管理
      • 统计
      • 运行时设置
      • 集群发现服务
      • 健康检查
      • 熔断
    • 访问日志
    • 限速服务
    • 运行时配置
    • 路由表检查工具
  • 运维管理
    • 命令行选项
    • 热重启
    • 管理接口
    • 统计概述
    • 运行时配置
    • 文件系统
  • 自定义扩展示例
  • V1 API参考
    • 监听器
    • 网络过滤器
      • TLS客户端身份认证
      • Echo
      • HTTP连接管理
      • Mongo代理
      • 速率限制
      • Redis代理
      • TCP代理
    • HTTP路由配置
      • 虚拟主机
      • 路由
      • 虚拟集群
      • 速率限制配置
      • 路由发现服务
    • HTTP过滤器
      • 缓存
      • CORS过滤器
      • DynamoDB
      • 故障注入
      • gRPC HTTP/1.1 桥接
      • gRPC-JSON 转码过滤器
      • gRPC-Web 过滤器
      • 健康检查
      • Lua
      • 速率限制
      • 路由
    • 集群管理
      • 集群
        • 健康检查
        • 熔断
        • TLS上下文
        • 异常值检测
        • HASH环负载均衡配置
      • 异常检测
      • 集群发现服务
      • 服务发现服务
    • 访问日志
    • 管理接口
    • 限速服务
    • 运行时配置
    • 跟踪
  • V2 API参考
    • 启动引导
    • 监听&监听发现
    • 集群&集群发现
    • 服务发现
    • 健康检查
    • HTTP路由管理&发现
    • TLS配置
    • 通用的类型
    • 网络地址
    • 协议选项
    • 发现API
    • 限速组件
    • 过滤器
      • 网络过滤器
        • TLS客户端身份认证
        • HTTP连接管理
        • Mongo代理
        • 速率限制
        • Redis代理
        • TCP代理
      • HTTP过滤器
        • 缓存
        • 故障注入
        • 健康检查
        • Lua
        • 速率限制
        • 路由
        • gRPC-JSON转码器
      • 常见访问日志类型
      • 常见故障注入类型
  • FAQ
    • Envoy有多快?
    • 我在哪里获得二进制文件?
    • 我如何设置SNI?
    • 如何设置区域感知路由?
    • 我如何设置Zipkin跟踪?
Powered by GitBook
On this page
  • 集群
  • 子章节
  • 返回

Was this helpful?

  1. V1 API参考
  2. 集群管理

集群

集群

{
  "name": "...",
  "type": "...",
  "connect_timeout_ms": "...",
  "per_connection_buffer_limit_bytes": "...",
  "lb_type": "...",
  "ring_hash_lb_config": "{...}",
  "hosts": [],
  "service_name": "...",
  "health_check": "{...}",
  "max_requests_per_connection": "...",
  "circuit_breakers": "{...}",
  "ssl_context": "{...}",
  "features": "...",
  "http2_settings": "{...}",
  "cleanup_interval_ms": "...",
  "dns_refresh_rate_ms": "...",
  "dns_lookup_family": "...",
  "dns_resolvers": [],
  "outlier_detection": "{...}"
}
  • name (required, string) 群集名称,所提供群集名称在所有群集中必须唯一。发布统计信息时会使用集群名称。默认情况下,群集名称的最大长度限制为60个字符。可通过--max-obj-name-len命令行参数设置为所需的值,以提高此限制。

  • connect_timeout_ms (required, integer) 指定群集中主机网络连接超时时间,以毫秒为单位。

  • per_connection_buffer_limit_bytes (optional, integer) 集群连接的读写缓冲区大小限制。如果未指定,则默认值(1MB)。

  • hosts (sometimes required, array) 如果服务发现类型是static,strict_dns或logical_dns,则主机数组是必需的。主机数组不支持original_dst集群类型。指定方式由服务发现类型决于:

    • static 静态集群,必须使用完整解析主机,不需要DNS查找。支持TCP和unix域套接字(UDS)地址。

      一个TCP地址如下所示:

        tcp://<ip>:<port>

      一个UDS地址如下所示:

        unix://<file name>

      以下示例指定地址列表:

        [{"url": "tcp://10.0.0.2:1234"}, {"url": "tcp://10.0.0.3:5678"}]
    • strict_dns 严格DNS群集类型,可以指定任意数量的主机名、端口组合。将使用DNS解析所有名称,并组合在一起形成最终的群集。如果相同的名字返回多个记录,则所有将被使用。例如:

        [{"url": "tcp://foo1.bar.com:1234"}, {"url": "tcp://foo2.bar.com:5678"}]
    • logical_dns 逻辑DNS群集类型,指定主机名称方式与严格DNS非常类似,但只有第一个主机将被使用。例如:

        [{"url": "tcp://foo1.bar.com:1234"}]
  • max_requests_per_connection (optional, integer) 可选的单个上游连接的最大请求数。HTTP/1.1和HTTP/2连接池,都遵循此参数。如果没有指定,则没有限制。将此参数设置为1,将有效地禁用保活状态的请求。

  • features (optional, string) 上游群集支持的功能,以逗号分隔的字符串列表。目前支持的功能为:

    • http2

      如果指定了http2,Envoy将假定在建立新的HTTP连接时,支持HTTP/2。目前,Envoy仅支持上游连接的预知。即使TLS与ALPN一起使用,也必须指定http2。另外,这允许通过纯文本建立HTTP/2连接。

  • cleanup_interval_ms (optional, integer) 从original_dst集群类型中删除旧主机的时间间隔。如果主机在这段时间内,没有被用作上游目的地址,则认为它们是旧的。随着重定向到Envoy的新连接,新的主机被按需添加到原始目标集群中,从而导致集群中的主机数量随着时间而增长。若没有旧主机(它们被主动用作目的地址)被保存在群集中,从而允许与它们的连接保持打开状态,从而节省了打开新连接所花费的等待时间。如果未指定此设置,则默认为5000.对于original_dst以外的群集类型,此设置将被忽略。

  • dns_refresh_rate_ms (optional, integer) 如果指定了dns刷新率,并且群集类型为strict_dns或logical_dns,则将此值用作群集的dns刷新率。如果未指定此设置,则该值默认为5000。对于strict_dns和logical_dns以外的群集类型,此设置将被忽略。

  • dns_lookup_family (optional, string) DNS IP地址解析策略。选项为v4_only,v6_only和auto。如果未指定此设置,则该值默认为v4_only。当选择v4_only时,DNS解析器将仅执行IPv4系列的地址查找。如果选择v6_only,则DNS解析程序将仅执行IPv6系列的地址查找。如果指定了auto,则DNS解析器将首先执行IPv6系列的地址查找操作,并然会再回到IPv4系列的地址查找。对于strict_dns和logical_dns以外的集群类型,该设置将被忽略。

  • dns_resolvers (optional, array) 如果指定DNS解析程序,并且群集类型是strict_dns或logical_dns,则此值用于指定群集的dns解析程序。如果未指定此设置,则该值默认为使用/etc/resolv.conf配置的默认解析器。对于除strict_dns和logical_dns以外的集群类型,此设置将被忽略。

子章节

返回

Previous集群管理Next健康检查

Last updated 5 years ago

Was this helpful?

type (required, string) 用于解析集群的。可能的选项有static,strict_dns,logical_dns,original_dst和sds。

lb_type (required, string) 在集群中选择主机时使用的。可能的选项有round_robin,least_request,ring_hash,random和original_dst_lb。请注意,original_dst_lb必须与original_dst类型的集群一起使用,并且不能与其他任集群类型一起使用。

ring_hash_lb_config (optional, object) 可选的配置,当lb_type设置为ring_hash时使用。

service_name (sometimes required, string) 如果服务发现类型是,则此参数是必需的。当获取集群成员时,它将被传递给SDS API。

health_check (optional, object) 可选的群集主动。如果未指定配置,则不会执行健康检查,并且所有群集成员都将始终处于健康状态。

circuit_breakers (optional, object) 可选的群集。

ssl_context (optional, object) 上游群集的。如果没有指定TLS配置,则新的连接将不会使用TLS。

http2_settings (optional, object) 在启动HTTP连接池时,直接传递给HTTP/2编解码器的相关设置。这些与HTTP连接管理器选项相同。

outlier_detection (optional, object) 如果指定,则会为此上游群集启用。有关异常值检测的更多信息,请参阅相应。

服务发现类型
负载均衡器类型
环哈希负载均衡器
sds
健康检查配置
熔断配置
TLS配置
http2_settings
异常值检测
架构概述
健康检查
熔断
TLS上下文
异常值检测
环哈希负载均衡配置
上一级
首页目录