A mod-cluster front end load balancer
Attribute | Value |
---|---|
Default Value | 10000 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | MILLISECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | / |
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | http |
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Type | STRING |
Nillable | false |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | 60000 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | MILLISECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | 40 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | 60 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | SECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | 40 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | false |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | 10000 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | MILLISECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | true |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | BYTES |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | BYTES |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | BYTES |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | BYTES |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Type | STRING |
Nillable | false |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Type | INT |
Nillable | true |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | -1 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Unit | MILLISECONDS |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Default Value | 1000 |
Type | INT |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Attribute | Value |
---|---|
Type | STRING |
Nillable | true |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | false |
Type | BOOLEAN |
Nillable | true |
Expressions Allowed | false |
Storage | configuration |
Access Type | read-write |
Restart Required | all-services |
Attribute | Value |
---|---|
Default Value | default |
Type | STRING |
Nillable | true |
Expressions Allowed | true |
Storage | configuration |
Access Type | read-write |
Restart Required | no-services |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
advertise-frequency | INT | false | true | 10000 | The frequency (in milliseconds) that mod-cluster advertises itself on the network |
advertise-path | STRING | false | true | / | The path that mod-cluster is registered under, defaults to / |
advertise-protocol | STRING | false | true | http | The protocol that is in use, defaults to HTTP |
advertise-socket-binding | STRING | true | true | The multicast group that is used to advertise | |
broken-node-timeout | INT | false | true | 60000 | The amount of time that must elapse before a broken node is removed from the table |
cached-connections-per-thread | INT | false | true | 40 | The number of connections that will be kept alive indefinitely |
connection-idle-timeout | INT | false | true | 60 | The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread) |
connections-per-thread | INT | false | true | 40 | The number of connections that will be maintained to backend servers, per IO thread. Defaults to 10. |
enable-http2 | BOOLEAN | false | false | false | If the load balancer should attempt to upgrade back end connections to HTTP2. If HTTP2 is not supported HTTP or HTTPS will be used as normal |
health-check-interval | INT | false | true | 10000 | The frequency of health check pings to backend nodes |
http2-enable-push | BOOLEAN | false | true | true | If push should be enabled for HTTP/2 connections |
http2-header-table-size | INT | false | true | The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression. | |
http2-initial-window-size | INT | false | true | The flow control window size that controls how quickly the client can send data to the server | |
http2-max-concurrent-streams | INT | false | true | The maximum number of HTTP/2 streams that can be active at any time on a single connection | |
http2-max-frame-size | INT | false | true | The max HTTP/2 frame size | |
http2-max-header-list-size | INT | false | true | The maximum size of request headers the server is prepared to accept | |
management-access-predicate | STRING | false | true | A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding | |
management-socket-binding | STRING | true | true | The socket binding of the mod_cluster management port. When using mod_cluster two HTTP listeners should be defined, a public one to handle requests, and one bound to the internal network to handle mod cluster commands. This socket binding should correspond to the internal listener, and should not be publicly accessible | |
max-ajp-packet-size | INT | false | false | The maximum size for AJP packets. Increasing this will allow AJP to work for requests/responses that have a large amount of headers. This is an advanced option, and must be the same between load balancers and backend servers. | |
max-request-time | INT | false | true | -1 | The max amount of time that a request to a backend node can take before it is killed |
request-queue-size | INT | false | true | 1000 | The number of requests that can be queued if the connection pool is full before requests are rejected with a 503 |
security-key | STRING | false | true | The security key that is used for the mod-cluster group. All members must use the same security key. | |
security-realm | STRING | false | false | The security realm that provides the SSL configuration | |
use-alias | BOOLEAN | false | false | false | If an alias check is performed |
worker | STRING | false | true | default | The XNIO worker that is used to send the advertise notifications |