Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typo fixes #3258

Merged
merged 1 commit into from
Nov 21, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions architecture/core_concepts/routes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -194,37 +194,35 @@ variables on the *deployment config* for the router to alter its configuration.
|===
|Variable | Default | Description
|`*DEFAULT_CERTIFICATE*` | | The contents of a default certificate to use for routes that don't expose a TLS server cert; in PEM format.
|`*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.
|`*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.
|`*EXTENDED_VALIDATION*` | true | If __"true"__,perform an additional extended validation step on all routes admitted by this router.
|`*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.
|`*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.
|`*EXTENDED_VALIDATION*` | true | If `true`,perform an additional extended validation step on all routes admitted by this router.
|`*NAMESPACE_LABELS*` | | A label selector to apply to namespaces to watch, empty means all.
|`*PROJECT_LABELS*` | | A label selector to apply to projects to watch, emtpy means all.
|`*RELOAD_SCRIPT*` | | The path to the reload script to use to reload the router.
|`*ROUTER_BACKEND_CHECK_INTERVAL*` | 5000ms | Time interval between subsequent __"liveness"__ checks on backends.
|`*ROUTER_COMPRESSION_MIME*` | "text/html text/plain text/css" | A space separated list of mime types to compress.
|`*ROUTER_DEFAULT_CLIENT_TIMEOUT*`| 30s | Time interval within which a client has to acknowledge or send data.
|`*ROUTER_BACKEND_CHECK_INTERVAL*` | 5000ms | Length of time between subsequent "liveness" checks on backends.
|`*ROUTER_DEFAULT_CLIENT_TIMEOUT*`| 30s | Length of time within which a client has to acknowledge or send data.
|`*ROUTER_DEFAULT_CONNECT_TIMEOUT*`| 5s | The maximum connect time.
|`*ROUTER_DEFAULT_SERVER_TIMEOUT*`| 30s | Time interval within which a server has to acknowledge or send data.
|`*ROUTER_DEFAULT_TUNNEL_TIMEOUT*` | 1h | Time till which TCP or WebSocket connections will remain open.
|`*ROUTER_ENABLE_COMPRESSION*`| false | If __"true"__, compress responses when possible.
|`*ROUTER_DEFAULT_SERVER_TIMEOUT*`| 30s | Length of time within which a server has to acknowledge or send data.
|`*ROUTER_DEFAULT_TUNNEL_TIMEOUT*` | 1h | Length of time till which TCP or WebSocket connections will remain open.
|`*ROUTER_LOG_LEVEL*` | warning | The log level to send to the syslog server.
|`*ROUTER_OVERRIDE_HOSTNAME*`| | If set, override the spec.host value for a route with the template in ROUTER_SUBDOMAIN.
|`*ROUTER_SERVICE_HTTPS_PORT*` | 443 | Port to listen for https requests.
|`*ROUTER_SERVICE_HTTP_PORT*` | 80 | Port to listen for http requests.
|`*ROUTER_SERVICE_NAME*` | public | The name that the router will identify itself with in route statuses.
|`*ROUTER_SERVICE_NAMESPACE*` | | The namespace the router will identify itself with in route statuses. Required if ROUTER_SERVICE_NAME is used.
|`*ROUTER_SERVICE_NAMESPACE*` | | The namespace the router will identify itself with in route statuses. Required if `ROUTER_SERVICE_NAME` is used.
|`*ROUTER_SERVICE_NO_SNI_PORT*` | 10443 | Internal port for some front-end to back-end communication (see note below).
|`*ROUTER_SERVICE_SNI_PORT*` | 10444 | Internal port for some front-end to back-end communication (see note below).
|`*ROUTER_SLOWLORIS_TIMEOUT*` | 10s | Time the transmission of an HTTP request can take.
|`*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').
|`*ROUTER_SLOWLORIS_TIMEOUT*` | 10s | Length of time the transmission of an HTTP request can take.
|`*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`).
|`*ROUTER_SYSLOG_ADDRESS*` | | Address to send log messages. Disabled if empty.
|`*ROUTER_TCP_BALANCE_SCHEME*` | source | Load-balancing strategy for multiple endpoints for pass-through routes. Available options are __"source"__, __"roundrobin"__, or __"leastconn"__.
|`*ROUTER_TCP_BALANCE_SCHEME*` | source | Load-balancing strategy for multiple endpoints for pass-through routes. Available options are `source`, `roundrobin`, or `leastconn`.
|`*ROUTE_FIELDS*` | | A field selector to apply to routes to watch, empty means all.
|`*ROUTE_LABELS*` | | A label selector to apply to the routes to watch, empty means all.
|`*STATS_PASSWORD*` | | The password needed to access router stats (if the router implementation supports it).
|`*STATS_PORT*` | | Port to expose statistics on (if the router implementation supports it). If not set, stats are not exposed.
|`*STATS_USERNAME*` | | The username needed to access router stats (if the router implementation supports it).
|`*TEMPLATE_FILE*` | /var/lib/haproxy/conf/custom/haproxy-config-custom.template | The path to the haproxy template file (in the image).
|`*TEMPLATE_FILE*` | `/var/lib/haproxy/conf/custom/haproxy-config-custom.template` | The path to the haproxy template file (in the image).
|`*RELOAD_INTERVAL*` | 12s | The minimum frequency the router is allowed to reload to accept new changes.
|===

Expand Down