Skip to main content
Version: 2.6.1

Kubernetes 控制器配置

本篇介绍 Kubernetes 控制器配置。

开启 HTTPS#

开启 HTTPS 需要在网关的 application.yml 文件中进行 sni协议 的相关配置:

shenyu:  netty:    http:      sni:        enabled: true        mod: k8s #k8s模式适用        defaultK8sSecretNamespace: shenyu-ingress #默认secret资源的namespace        defaultK8sSecretName: default-cert #默认secret资源名字

其中,默认secret资源必须要有,但是目前不会实际使用。

Ingress 配置#

ShenYu Kubernetes Controller 实现了 K8s 原生的 Ingress 标准,原生标准的使用见 K8s 官方文档

另外,Apache ShenYu 基于 Ingress 的 Annotation 字段进行了拓展,配置见下文表格:

通用#

名称默认值是否必填说明
kubernetes.io/ingress.class填shenyu

Divide 插件(HTTP代理)#

名称默认值是否必填说明
shenyu.apache.org/loadbalancerrandom负载均衡算法,可选hash、random、roundRobin、leastActive、p2c、shortestResponse
shenyu.apache.org/retry3失败重试次数
shenyu.apache.org/timeout3000后端请求超时时间,单位毫秒
shenyu.apache.org/header-max-size10240请求头最大大小,单位byte
shenyu.apache.org/request-max-size102400请求体最大大小,单位byte

Dubbo插件#

名称默认值是否必填说明
shenyu.apache.org/loadbalancerrandom负载均衡算法,可选hash、random、roundRobin、leastActive、p2c、shortestResponse
shenyu.apache.org/retry3失败重试次数
shenyu.apache.org/timeout3000后端请求超时时间,单位毫秒
shenyu.apache.org/header-max-size10240请求头最大大小,单位byte
shenyu.apache.org/request-max-size102400请求体最大大小,单位byte
shenyu.apache.org/upstreams-protocoldubbo://指定upstream使用的protocol协议
shenyu.apache.org/plugin-dubbo-enabled确定是否启动dubbo插件
shenyu.apache.org/zookeeper-register-address指定zookeeper地址
shenyu.apache.org/plugin-dubbo-app-name指定元数据的应用名称
shenyu.apache.org/plugin-dubbo-path指定元数据的请求路径
shenyu.apache.org/plugin-dubbo-rpc-type指定元数据的rpc类型(dubbo,sofa,tars,springCloud,motan,grpc)
shenyu.apache.org/plugin-dubbo-service-name指定元数据的接口名称
shenyu.apache.org/plugin-dubbo-method-name指定元数据的方法名称
shenyu.apache.org/plugin-dubbo-rpc-expand指定元数据的rpc扩展参数(json对象)
shenyu.apache.org/plugin-dubbo-parameter-types指定元数据的参数类型

Motan插件#

名称默认值是否必填说明
shenyu.apache.org/loadbalancerrandom负载均衡算法,可选hash、random、roundRobin、leastActive、p2c、shortestResponse
shenyu.apache.org/retry3失败重试次数
shenyu.apache.org/timeout3000后端请求超时时间,单位毫秒
shenyu.apache.org/header-max-size10240请求头最大大小,单位byte
shenyu.apache.org/request-max-size102400请求体最大大小,单位byte
shenyu.apache.org/plugin-motan-enabled确定是否启动motan插件
shenyu.apache.org/zookeeper-register-address指定zookeeper地址
shenyu.apache.org/plugin-motan-app-name指定元数据的应用名称
shenyu.apache.org/plugin-motan-path指定元数据的请求路径
shenyu.apache.org/plugin-motan-rpc-type指定元数据的rpc类型(dubbo,sofa,tars,springCloud,motan,grpc)
shenyu.apache.org/plugin-motan-service-name指定元数据的接口名称
shenyu.apache.org/plugin-motan-method-name指定元数据的方法名称
shenyu.apache.org/plugin-motan-rpc-expand指定元数据的rpc扩展参数(json对象)
shenyu.apache.org/plugin-motan-parameter-types指定元数据的参数类型

SpringCloud插件#

名称默认值是否必填说明
shenyu.apache.org/loadbalancerrandom负载均衡算法,可选hash、random、roundRobin、leastActive、p2c、shortestResponse
shenyu.apache.org/retry3失败重试次数
shenyu.apache.org/timeout3000后端请求超时时间,单位毫秒
shenyu.apache.org/header-max-size10240请求头最大大小,单位byte
shenyu.apache.org/request-max-size102400请求体最大大小,单位byte
shenyu.apache.org/plugin-spring-cloud-enabled确定是否启动springCloud插件
shenyu.apache.org/zookeeper-register-address指定zookeeper地址
shenyu.apache.org/plugin-spring-cloud-app-name指定元数据的应用名称
shenyu.apache.org/plugin-spring-cloud-path指定元数据的请求路径
shenyu.apache.org/plugin-spring-cloud-rpc-type指定元数据的rpc类型(dubbo,sofa,tars,springCloud,motan,grpc)
shenyu.apache.org/plugin-spring-cloud-service-name指定元数据的接口名称
shenyu.apache.org/plugin-spring-cloud-method-name指定元数据的方法名称
shenyu.apache.org/plugin-spring-cloud-rpc-expand指定元数据的rpc扩展参数(json对象)
shenyu.apache.org/plugin-spring-cloud-parameter-types指定元数据的参数类型

WebSocket插件#

名称默认值是否必填说明
shenyu.apache.org/loadbalancerrandom负载均衡算法,可选hash、random、roundRobin、leastActive、p2c、shortestResponse
shenyu.apache.org/retry3失败重试次数
shenyu.apache.org/timeout3000后端请求超时时间,单位毫秒
shenyu.apache.org/header-max-size10240请求头最大大小,单位byte
shenyu.apache.org/request-max-size102400请求体最大大小,单位byte