Skip to content

Commit

Permalink
Merge pull request #213 from jajik/issue-211
Browse files Browse the repository at this point in the history
Add descriptions for all available CONFIG parameters
  • Loading branch information
rhusar authored Oct 8, 2024
2 parents eda1cf6 + 718d044 commit 927b5b5
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/src/main/asciidoc/developer/management_protocol.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,21 @@ This message adds a new node or updates an existing one.
| JVMRoute | Is what is after the . in the JSESSIONID cookie or the parameter jsessionid | | Yes
| Port | is the port on which the node except to receive requests | 8009 |
| Type | http/https/ajp The protocol to use between httpd and AS to process requests | ajp |

| Reversed | Reverse connection | no |
| Flushpackets | Enables/disables packet flushing (values: on/off/auto) | off |
| Flushwait | Time to wait before flushing packets in milliseconds. A value of -1 means wait forever | PROXY_FLUSH_WAIT |
| Ping | Time (in seconds) in which to wait for a pong answer to a ping | 10 seconds |
| Smax | Soft maximum idle connection count (that is the smax in worker mod_proxy documentation). The maximum value depends on the httpd thread configuration (ThreadsPerChild or 1) | -1 |
| Ttl | Time to live (in seconds) for idle connections above smax (in seconds) | 60 seconds |
| Timeout | Timeout (in seconds) for proxy connections to a node. That is the time mod_cluster will wait for the back-end response before returning error. That corresponds to timeout in the worker mod_proxy documentation. A value of -1 indicates no timeout. Note that mod_cluster always uses a cping/cpong before forwarding a request and the connectiontimeout value used by mod_cluster is the ping value | 0 |
| StickySession | Indicates whether subsequent requests for a given session should be routed to the same node, if possible | yes |
| StickySessionCookie | Value of the Session cookie | JSESSIONID |
| StickySessionPath | Value of the Session path | jsessionid |
| StickySessionRemove | Indicates whether the httpd proxy should remove session stickiness in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if stickySession is false | no |
| StickySessionForce | Indicates whether the httpd proxy should return an error in the event that the balancer is unable to route a request to the node to which it is stuck. Ignored if stickySession is false | yes |
| WaitWorker | Number of seconds to wait for a worker to become available to handle a request. When no workers of a balancer are usable, mod_cluster will retry after a while (workerTimeout/100). That is timeout in the balancer mod_proxy documentation. A value of -1 indicates that the httpd will not wait for a worker to be available and will return an error if none is available (in seconds) | 0 |
| MaxAttempts | Maximum number of failover attempts before giving up. The minimum value is 0, i.e. no failover. The default value is 1, i.e. do a one failover attempt | 1 |
|===

NOTE: There are some limitations with regard to maximal lengths of some values. See
Expand Down

0 comments on commit 927b5b5

Please sign in to comment.