You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: architecture/core_concepts/routes.adoc
+12-14
Original file line number
Diff line number
Diff line change
@@ -194,37 +194,35 @@ variables on the *deployment config* for the router to alter its configuration.
194
194
|===
195
195
|Variable | Default | Description
196
196
|`*DEFAULT_CERTIFICATE*` | | The contents of a default certificate to use for routes that don't expose a TLS server cert; in PEM format.
197
-
|`*DEFAULT_CERTIFICATE_DIR*` | | A path to a directory that contains a file named tls.crt. If tls.crt is not a PEM file which also contains a private key, it is first combined with a file named tls.key in the same directory. The PEM-format contents are then used as the default certificate. Only used if DEFAULT_CERTIFICATE or DEFAULT_CERTIFICATE_PATH are not specified.
198
-
|`*DEFAULT_CERTIFICATE_PATH*` | | A path to default certificate to use for routes that don't expose a TLS server cert; in PEM format. Only used if DEFAULT_CERTIFICATE is not specified.
199
-
|`*EXTENDED_VALIDATION*` | true | If __"true"__,perform an additional extended validation step on all routes admitted by this router.
197
+
|`*DEFAULT_CERTIFICATE_DIR*` | | A path to a directory that contains a file named *_tls.crt_*. If *_tls.crt_* is not a PEM file which also contains a private key, it is first combined with a file named tls.key in the same directory. The PEM-format contents are then used as the default certificate. Only used if `DEFAULT_CERTIFICATE` or `DEFAULT_CERTIFICATE_PATH` are not specified.
198
+
|`*DEFAULT_CERTIFICATE_PATH*` | | A path to default certificate to use for routes that don't expose a TLS server cert; in PEM format. Only used if `DEFAULT_CERTIFICATE` is not specified.
199
+
|`*EXTENDED_VALIDATION*` | true | If `true`,perform an additional extended validation step on all routes admitted by this router.
200
200
|`*NAMESPACE_LABELS*` | | A label selector to apply to namespaces to watch, empty means all.
201
201
|`*PROJECT_LABELS*` | | A label selector to apply to projects to watch, emtpy means all.
202
202
|`*RELOAD_SCRIPT*` | | The path to the reload script to use to reload the router.
203
-
|`*ROUTER_BACKEND_CHECK_INTERVAL*` | 5000ms | Time interval between subsequent __"liveness"__ checks on backends.
204
-
|`*ROUTER_COMPRESSION_MIME*` | "text/html text/plain text/css" | A space separated list of mime types to compress.
205
-
|`*ROUTER_DEFAULT_CLIENT_TIMEOUT*`| 30s | Time interval within which a client has to acknowledge or send data.
203
+
|`*ROUTER_BACKEND_CHECK_INTERVAL*` | 5000ms | Length of time between subsequent "liveness" checks on backends.
204
+
|`*ROUTER_DEFAULT_CLIENT_TIMEOUT*`| 30s | Length of time within which a client has to acknowledge or send data.
206
205
|`*ROUTER_DEFAULT_CONNECT_TIMEOUT*`| 5s | The maximum connect time.
207
-
|`*ROUTER_DEFAULT_SERVER_TIMEOUT*`| 30s | Time interval within which a server has to acknowledge or send data.
208
-
|`*ROUTER_DEFAULT_TUNNEL_TIMEOUT*` | 1h | Time till which TCP or WebSocket connections will remain open.
209
-
|`*ROUTER_ENABLE_COMPRESSION*`| false | If __"true"__, compress responses when possible.
206
+
|`*ROUTER_DEFAULT_SERVER_TIMEOUT*`| 30s | Length of time within which a server has to acknowledge or send data.
207
+
|`*ROUTER_DEFAULT_TUNNEL_TIMEOUT*` | 1h | Length of time till which TCP or WebSocket connections will remain open.
210
208
|`*ROUTER_LOG_LEVEL*` | warning | The log level to send to the syslog server.
211
209
|`*ROUTER_OVERRIDE_HOSTNAME*`| | If set, override the spec.host value for a route with the template in ROUTER_SUBDOMAIN.
212
210
|`*ROUTER_SERVICE_HTTPS_PORT*` | 443 | Port to listen for https requests.
213
211
|`*ROUTER_SERVICE_HTTP_PORT*` | 80 | Port to listen for http requests.
214
212
|`*ROUTER_SERVICE_NAME*` | public | The name that the router will identify itself with in route statuses.
215
-
|`*ROUTER_SERVICE_NAMESPACE*` | | The namespace the router will identify itself with in route statuses. Required if ROUTER_SERVICE_NAME is used.
213
+
|`*ROUTER_SERVICE_NAMESPACE*` | | The namespace the router will identify itself with in route statuses. Required if `ROUTER_SERVICE_NAME` is used.
216
214
|`*ROUTER_SERVICE_NO_SNI_PORT*` | 10443 | Internal port for some front-end to back-end communication (see note below).
217
215
|`*ROUTER_SERVICE_SNI_PORT*` | 10444 | Internal port for some front-end to back-end communication (see note below).
218
-
|`*ROUTER_SLOWLORIS_TIMEOUT*` | 10s | Time the transmission of an HTTP request can take.
219
-
|`*ROUTER_SUBDOMAIN*`| | The template that should be used to generate the hostname for a route without spec.host (e.g. '${name}-${namespace}.myapps.mycompany.com').
216
+
|`*ROUTER_SLOWLORIS_TIMEOUT*` | 10s | Length of time the transmission of an HTTP request can take.
217
+
|`*ROUTER_SUBDOMAIN*`| | The template that should be used to generate the hostname for a route without spec.host (e.g. `${name}-${namespace}.myapps.mycompany.com`).
220
218
|`*ROUTER_SYSLOG_ADDRESS*` | | Address to send log messages. Disabled if empty.
221
-
|`*ROUTER_TCP_BALANCE_SCHEME*` | source | Load-balancing strategy for multiple endpoints for pass-through routes. Available options are __"source"__, __"roundrobin"__, or __"leastconn"__.
219
+
|`*ROUTER_TCP_BALANCE_SCHEME*` | source | Load-balancing strategy for multiple endpoints for pass-through routes. Available options are `source`, `roundrobin`, or `leastconn`.
222
220
|`*ROUTE_FIELDS*` | | A field selector to apply to routes to watch, empty means all.
223
221
|`*ROUTE_LABELS*` | | A label selector to apply to the routes to watch, empty means all.
224
222
|`*STATS_PASSWORD*` | | The password needed to access router stats (if the router implementation supports it).
225
223
|`*STATS_PORT*` | | Port to expose statistics on (if the router implementation supports it). If not set, stats are not exposed.
226
224
|`*STATS_USERNAME*` | | The username needed to access router stats (if the router implementation supports it).
227
-
|`*TEMPLATE_FILE*` | /var/lib/haproxy/conf/custom/haproxy-config-custom.template | The path to the haproxy template file (in the image).
225
+
|`*TEMPLATE_FILE*` | `/var/lib/haproxy/conf/custom/haproxy-config-custom.template` | The path to the haproxy template file (in the image).
228
226
|`*RELOAD_INTERVAL*` | 12s | The minimum frequency the router is allowed to reload to accept new changes.
0 commit comments