diff --git a/modules/nw-route-specific-annotations.adoc b/modules/nw-route-specific-annotations.adoc index a3c97eac3f..f61a5b10e2 100644 --- a/modules/nw-route-specific-annotations.adoc +++ b/modules/nw-route-specific-annotations.adoc @@ -20,13 +20,13 @@ To create a whitelist with multiple source IPs or subnets, use a space-delimited |=== |Variable | Description | Environment variable used as default |`haproxy.router.openshift.io/balance`| Sets the load-balancing algorithm. Available options are `random`, `source`, `roundrobin`, and `leastconn`. | `ROUTER_TCP_BALANCE_SCHEME` for passthrough routes. Otherwise, use `ROUTER_LOAD_BALANCE_ALGORITHM`. -|`haproxy.router.openshift.io/disable_cookies`| Disables the use of cookies to track related connections. If set to `true` or `TRUE`, the balance algorithm is used to choose which back-end serves connections for each incoming HTTP request. | +|`haproxy.router.openshift.io/disable_cookies`| Disables the use of cookies to track related connections. If set to `'true'` or `'TRUE'`, the balance algorithm is used to choose which back-end serves connections for each incoming HTTP request. | |`router.openshift.io/cookie_name`| Specifies an optional cookie to use for this route. The name must consist of any combination of upper and lower case letters, digits, "_", and "-". The default is the hashed internal key name for the route. | |`haproxy.router.openshift.io/pod-concurrent-connections`| Sets the maximum number of connections that are allowed to a backing pod from a router. + Note: If there are multiple pods, each can have this many connections. If you have multiple routers, there is no coordination among them, each may connect this many times. If not set, or set to 0, there is no limit. | -|`haproxy.router.openshift.io/rate-limit-connections`| Setting `true` or `TRUE` enables rate limiting functionality which is implemented through stick-tables on the specific backend per route. + +|`haproxy.router.openshift.io/rate-limit-connections`| Setting `'true'` or `'TRUE'` enables rate limiting functionality which is implemented through stick-tables on the specific backend per route. + Note: Using this annotation provides basic protection against distributed denial-of-service (DDoS) attacks. | |`haproxy.router.openshift.io/rate-limit-connections.concurrent-tcp`| Limits the number of concurrent TCP connections made through the same source IP address. It accepts a numeric value. + Note: Using this annotation provides basic protection against distributed denial-of-service (DDoS) attacks. |