This paper mainly explains how to configure Apache ShenYu
properties on the gateway side.
shenyu: # httpclient: # strategy: webClient # connectTimeout: 45000 # readTimeout: 3000 # writeTimeout: 3000 # wiretap: false # pool: # type: ELASTIC # name: proxy # maxConnections: 16 # acquireTimeout: 45000 # proxy: # host: # port: # username: # password: # nonProxyHostsPattern: # ssl: # useInsecureTrustManager: false # trustedX509Certificates: # handshakeTimeout: # closeNotifyFlushTimeout: # closeNotifyReadTimeout: # defaultConfigurationType: file: enabled: true cross: enabled: true exclude: enabled: false paths: - /favicon.ico sync: websocket: urls: ws://localhost:9095/websocket # zookeeper: # url: localhost:2181 # sessionTimeout: 5000 # connectionTimeout: 2000 # http: # url: http://localhost:9095 # nacos: # url: localhost:8848 # namespace: 1c10d748-af86-43b9-8265-75f487d20c6c # username: # password: # acm: # enabled: false # endpoint: acm.aliyun.com # namespace: # accessKey: # secretKey: # etcd: # url: http://localhost:2379 # consul: # url: http://localhost:8500 # waitTime: 1000 # watchDelay: 1000
This is the HttpClient configuration used to send proxy requests after proxying the Http and SpringCloud protocols in the ShenYu
gateway.
Name | Type | Default | Required | Description |
---|---|---|---|---|
strategy | String | webcwebClient | No | The strategy of httpClientPlugin |
connectTimeout | int | 45000 | No | Connection timeout (millisecond), the default value is 45000. |
readTimeout | int | 3000 | No | Read timeout (millisecond), the default value is 3000. |
writeTimeout | int | 3000 | No | Write timeout (millisecond), the default value is 3000. |
wiretap | Boolean | false | No | Enables wiretap debugging for Netty HttpClient, the default value is false . |
pool | HttpClient connection pool config | |||
proxy | HttpClient proxy config | |||
ssl | HttpClient ssl config |
pool
configHttpClient connection pool configuration:
Name | Type | Default | Required | Description |
---|---|---|---|---|
type | String | ELASTIC | No | Type of pool for HttpClient to use, defaults to ELASTIC. - ELASTIC: The connection pool can be cached and grown on demand - FIXED: The connection pool cache and reuse a fixed maximum The number of connections. - DISABLED: The connection pool will always create a new connection. |
name | String | proxy | No | The channel pool map name, defaults to proxy. |
maxConnections | int | the maximum value of 2*CPU and 16 | No | Only for type FIXED, the maximum number of connections before starting pending acquisition on existing ones. the default value is available number of processors*2. (but with a minimum value of 16) |
acquireTimeout | int | 45000 | No | Only for type FIXED, the maximum time in millis to wait for aquiring. the default value is 45000 |
proxy
configNetty HttpClient proxy configuration:
Name | Type | Default | Required | Description |
---|---|---|---|---|
host | String | null | No | Hostname for proxy configuration of Netty HttpClient. |
port | String | null | No | Port for proxy configuration of Netty HttpClient. |
username | String | null | No | Username for proxy configuration of Netty HttpClient. |
password | String | null | No | Password for proxy configuration of Netty HttpClient. |
nonProxyHostsPattern | String | null | No | Regular expression (Java) for a configured list of hosts. that should be reached directly, bypassing the proxy |
SSL
configGateway routing can support routing to http and https back-end services at the same time. The following is the SSL-related configuration:
Name | Type | Default | Required | Description |
---|---|---|---|---|
useInsecureTrustManager | Boolean | false | No | Installs the netty InsecureTrustManagerFactory. This is insecure and not suitable for production. |
trustedX509Certificates | String | Null | No | Trusted certificates for verifying the remote endpoint's certificate.(Use , to separate multiple values) |
handshakeTimeout | int | 10000 | No | SSL handshake timeout. Default to 10000 ms |
closeNotifyFlushTimeout | int | 3000 | No | SSL close_notify flush timeout. Default to 3000 ms. |
closeNotifyReadTimeout | int | 0 | No | SSL close_notify read timeout. Default to 0 ms. |
defaultConfigurationType | String | TCP | No | The default ssl configuration type. Defaults to TCP. - H2: SslProvider will be set depending on OpenSsl.isAlpnSupported(), SslProvider.HTTP2_CIPHERS, ALPN support, HTTP/1.1 and HTTP/2 support. - TCP: SslProvider will be set depending on OpenSsl.isAvailable() - NONE: There will be no default configuration |
shenyu.file
configFile filter properties:
Name | Type | Default | Required | Description |
---|---|---|---|---|
enabled | Boolean | false | No | enable file size filtering |
shenyu.cross
configCross filter properties:
Name | Type | Default | Required | Description |
---|---|---|---|---|
enabled | Boolean | false | No | allow cross-domain requests |
shenyu.exclude
configExculde filter properties:
Name | Type | Default | Required | Description |
---|---|---|---|---|
enabled | Boolean | false | No | whether to enable exclude filter and reject the specified request to pass through the gateway |
paths | Array | null | Yes | Requests matching this list can not pass through the gateway (support Path-Matching) |
The Apache ShenYu gateway and the Admin System use data synchronization configurations.
The following properties are configured for data synchronization using websocket
:
Name | Type | Default | Required | Description |
---|---|---|---|---|
urls | String | null | Yes | The websocket server address of Admin , separate multiple addresses with , |
The following properties are configured for data synchronization using zookeeper
:
Name | Type | Default | Required | Description |
---|---|---|---|---|
url | String | null | Yes | zookeeper server url |
sessionTimeout | int | null | Yes | session timeout (millisecond) |
connectionTimeout | int | null | Yes | connection timeout (millisecond) |
The following properties are configured for data synchronization using http long polling
:
Name | Type | Default | Required | Description |
---|---|---|---|---|
url | String | null | Yes | Admin server address |
The following properties are configured for data synchronization using nacos
:
Name | Type | Default | Required | Description |
---|---|---|---|---|
url | String | null | 是 | nacos url |
namespace | String | null | Yes | namespace |
username | String | null | No | username |
password | String | null | No | password |
acm | No | aliyun ACM service configuration |
acm
configName | Type | Default | Required | Description |
---|---|---|---|---|
enabled | boolean | false | No | whether to enable |
endpoint | String | null | No | ACM service address |
namespace | String | null | No | namespace |
accessKey | String | null | No | accessKey |
secretKey | String | null | No | secretKey |
The following properties are configured for data synchronization using etcd
:
Name | Type | Default | Required | Description |
---|---|---|---|---|
url | String | null | Yes | etcd server url |
The following properties are configured for data synchronization using consul
:
Name | Type | Default | Required | Description |
---|---|---|---|---|
url | String | null | Yes | consul server url |
waitTime | int | null | Yes | the timeout period for requesting consul service to pull configuration information (milliseconds) |
watchDelay | int | null | Yes | Synchronization interval (milliseconds) |