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
  • 监听&监听发现
  • Listener
  • Listener.DrainType (Enum)
  • Filter
  • FilterChainMatch
  • FilterChain
  • 返回

Was this helpful?

  1. V2 API参考

监听&监听发现

Previous启动引导Next集群&集群发现

Last updated 5 years ago

Was this helpful?

监听&监听发现

Listener

Listener

{
  "name": "...",
  "address": "{...}",
  "filter_chains": [],
  "use_original_dst": "{...}",
  "per_connection_buffer_limit_bytes": "{...}",
  "drain_type": "..."
}

Listener.DrainType (Enum)

  • DEFAULT (DEFAULT) 在调用/healthcheck/fail管理端口(连同健康检查过滤器),监听器删除/修改以及热重启时,进行响应处理。

  • MODIFY_ONLY 针对监听器删除/修改和热启动而响应处理。此设置不包括健康检查失败。 如果Envoy仅当作入口和出口监听器,这个设置是可取的。

Filter

{
  "name": "...",
  "config": "{...}"
}

FilterChainMatch

指定用于为监听器选择特定过滤器链的匹配条件。

{
  "sni_domains": []
}

FilterChain

过滤器链包含一组匹配条件,一个TLS上下文选项,一组过滤器和各种其他参数。

{
  "filter_chain_match": "{...}",
  "tls_context": "{...}",
  "filters": [],
  "use_proxy_proto": "{...}"
}

返回

name () 配置该监听器的唯一名称。如果没有提供名称,Envoy将为监听器分配一个内部UUID。如果要通过LDS动态更新或删除侦听器,则必须提供唯一的名称。默认情况下,监听器名称的最大长度限制为60个字符。可以通过--max-obj-name-len命令行参数设置为所需的最大长度限制。

address (, REQUIRED) 监听器应该监听的地址。一般来说,地址必须是唯一的,尽管这是由操作系统的根据绑定规则管理的。例如,多个监听器可以监听Linux上的0端口,因为实际的端口将被OS分配。

filter_chains (, REQUIRED) 这个监听器需要使用的过滤器列表。FilterChain在连接上使用特殊的FilterChainMatch。

注意:在当前版本中,仅支持多个过滤器链,因此可以配置SNI。有关如何配置SNI以获取更多信息,请参阅。当配置多个过滤器链时,每个过滤器链必须具有相同的一组过滤器。如果过滤器不同,配置将无法加载。将来,这种限制将被放宽,使得根据哪个过滤器链匹配(基于SNI或其他参数)可以使用不同的过滤器。

use_original_dst () 在连接重定向如果使用iptables,则代理接收连接的端口可能与原始目标地址不同。当此标志设置为true时,监听器将重定向的连接切换到与原始目标地址关联的监听程序。如果没有与原始目标地址关联的监听器,则连接由该监听器的接收处理。默认为false。

per_connection_buffer_limit_bytes () 监听器的新连接读取和写入缓冲区大小的软限制。如果未指定,则使用默认值定义(1MB)。

drain_type () 监听器的级别,执行的逐出类型。

name (, REQUIRED) 要实例化的过滤器的名称。 该名称必须与支持的过滤器匹配。内置的过滤器有:

config () 对应的过滤器配置,这取决于被实例化的过滤器。有关更多文档,请参阅支持的过滤器。

sni_domains () 如果非空,则考虑SNI域名。可能包含通配符前缀,例如*.example.com的。

注意: 有关如何配置SNI以获取更多信息,请参阅。

filter_chain_match () 将连接匹配到此过滤器链时使用的匹配规则。

tls_context () 此过滤器链的TLS上下文配置。

filters () 构成与监听器建立连接的过滤器链,包含各个网络过滤器的列表。当连接事件发生时,按顺序处理。注意:如果过滤器列表为空,则默认关闭连接。

use_proxy_proto () 监听器是否应该在新连接上使用PROXY协议V1头。如果启用此选项,则监听器将假定该连接的远程地址是在标题中指定的地址。包括AWS ELB的一些负载平衡器支持此选项。如果该选项不存在或设置为false,Envoy将使用物理对等地址作为远程连接地址。

string
Address
FAQ条目
BoolValue
UInt32Value
Listener.DrainType proto
Filter proto
string
envoy.echo
envoy.http_connection_manager
envoy.mongo_proxy
envoy.redis_proxy
envoy.tcp_proxy
Struct
FilterChainMatch proto
string
FAQ条目
FilterChain proto
DownstreamTlsContext
BoolValue
上一级
首页目录
架构概述
Listener proto
Listener
Listener.DrainType (Enum)
Filter
FilterChainMatch
FilterChain
FilterChain
Listener.DrainType
FilterChainMatch
Filter