Described all router environment variables #3090

knobunc · 2016-10-21T13:44:53Z

Added missing router environment variables to the documentation, and
added descriptons to all of them.

For 3.3 and 3.4.

knobunc · 2016-10-21T13:45:18Z

JacobTanenbaum · 2016-10-21T19:22:19Z

architecture/core_concepts/routes.adoc

-|`*ROUTER_SLOWLORIS_TIMEOUT*` | 10s
+|Variable | Default | Description
+|`*ROUTER_SERVICE_HTTP_PORT*` | 80 | What port to listen for http requests on
+|`*ROUTER_SERVICE_HTTPS_PORT*` | 443 | What port to listen for http requests on


should this be "What port to listen for https requests on"?

JacobTanenbaum · 2016-10-21T19:24:22Z

LGTM

knobunc · 2016-10-21T19:24:26Z

@adellape PTAL

ramr · 2016-10-24T19:52:49Z

architecture/core_concepts/routes.adoc

+|`*ROUTER_LOG_LEVEL*` | warning | What log level to send to the above address
+|`*ROUTER_BACKEND_CHECK_INTERVAL*` | 5000ms | How frequently to check backends for "liveness"
+|`*ROUTER_DEFAULT_CONNECT_TIMEOUT*`| 5s | The maximum connect time
+|`*ROUTER_DEFAULT_CLIENT_TIMEOUT*`| 30s |How long a client has to acknowledge or send data


Minor nit space between '|' and 'How'.

ramr · 2016-10-24T19:53:00Z

architecture/core_concepts/routes.adoc

+|`*ROUTER_BACKEND_CHECK_INTERVAL*` | 5000ms | How frequently to check backends for "liveness"
+|`*ROUTER_DEFAULT_CONNECT_TIMEOUT*`| 5s | The maximum connect time
+|`*ROUTER_DEFAULT_CLIENT_TIMEOUT*`| 30s |How long a client has to acknowledge or send data
+|`*ROUTER_DEFAULT_SERVER_TIMEOUT*`| 30s |How long a server has to acknowledge or send data


Same as above: Minor nit space between '|' and 'How'.

ramr · 2016-10-24T20:01:34Z

@knobunc this LGTM - minor nits and there's a few others if you want to add 'em here or in another PR:

STATS_PORT: If the underlying router implementation can provide statistics this is a hint to expose it on this port.  
STATS_PASSWORD: If the underlying router implementation can provide statistics this is the requested password for auth.  
STATS_USERNAME: If the underlying router implementation can provide statistics this is the requested username for auth.  

ROUTER_SUBDOMAIN: If specified, a template that should be used to generate the hostname for a route without spec.host (e.g. '${name}-${namespace}.myapps.mycompany.com')  
ROUTER_OVERRIDE_HOSTNAME: Override the spec.host value for a route with --hostname-template   

ROUTE_LABELS:  A label selector to apply to the routes to watch  
ROUTE_FIELDS: A field selector to apply to routes to watch  
PROJECT_LABELS:  A label selector to apply to projects to watch; if '*' watches all projects the client can access  
NAMESPACE_LABELS: A label selector to apply to namespaces to watch  

EXTENDED_VALIDATION: If set, then an additional extended validation step is performed on all routes admitted in by this router. Defaults to true and enables the extended validation checks.

Thx

knobunc · 2016-10-25T19:05:30Z

@ramr Updated per your suggestion. Thanks

ramr · 2016-10-26T01:56:50Z

LGTM

zhaozhanqi · 2016-11-02T10:22:47Z

Could you also help add the following which I knowed:
oc env dc/router TEMPLATE_FILE=/var/lib/haproxy/conf/custom/haproxy-config-custom.template
oc env dc/router RELOAD_INTERVAL=12s

knobunc · 2016-11-02T13:07:08Z

@zhaozhanqi thanks for the suggestion. By looking for those I found more to add as well.

knobunc · 2016-11-16T17:05:42Z

@openshift/team-documentation this is ready to merge.

vikram-redhat · 2016-11-17T05:54:54Z

@gaurav-nelson - PTAL and if no issues, please merge.

gaurav-nelson · 2016-11-17T06:36:18Z

architecture/core_concepts/routes.adoc

+|`*ROUTER_ENABLE_COMPRESSION*`| false | If "true", compress responses when possible.
+|`*ROUTER_LOG_LEVEL*` | warning | What log level to send to the above address.
+|`*ROUTER_OVERRIDE_HOSTNAME*`|  | If set, override the spec.host value for a route with the template in ROUTER_SUBDOMAIN.
+|`*ROUTER_SERVICE_HTTPS_PORT*` | 443 | What port to listen for https requests on.


Suggestion: Please change "What port to listen for https requests on." to "Port to listen for https requests." OR "Port on which to listen for https requests."

gaurav-nelson · 2016-11-17T06:36:42Z

architecture/core_concepts/routes.adoc

+|`*ROUTER_LOG_LEVEL*` | warning | What log level to send to the above address.
+|`*ROUTER_OVERRIDE_HOSTNAME*`|  | If set, override the spec.host value for a route with the template in ROUTER_SUBDOMAIN.
+|`*ROUTER_SERVICE_HTTPS_PORT*` | 443 | What port to listen for https requests on.
+|`*ROUTER_SERVICE_HTTP_PORT*` | 80 | What port to listen for http requests on.


Suggestion: Please change "What port to listen for http requests on." to "Port to listen for http requests." OR "Port on which to listen for http requests."

gaurav-nelson · 2016-11-17T06:39:19Z

architecture/core_concepts/routes.adoc

+|`*ROUTER_OVERRIDE_HOSTNAME*`|  | If set, override the spec.host value for a route with the template in ROUTER_SUBDOMAIN.
+|`*ROUTER_SERVICE_HTTPS_PORT*` | 443 | What port to listen for https requests on.
+|`*ROUTER_SERVICE_HTTP_PORT*` | 80 | What port to listen for http requests on.
+|`*ROUTER_SERVICE_NAME*` | public | The name the router will identify itself with in route statuses.


Suggestion: Please change "The name the router will identify itself with in route statuses." to "The name that router will identify itself with in route statuses."

gaurav-nelson · 2016-11-17T06:47:52Z

Everything looks good. I will do a merge and then update the language changes I suggested.

knobunc · 2016-11-17T15:19:11Z

Thank you @gaurav-nelson. Your suggestions look good.

If this can go in 3.4 and 3.3 that would be nice, but really getting it in 3.4 alone is sufficient.

adellape · 2016-11-17T16:25:42Z

@knobunc Can you also squash down to 1 commit? Will leave the merging to @gaurav-nelson though here.

Added missing router environment variables to the documentation, and added descriptons to all of them. For 3.4 only.

knobunc · 2016-11-17T16:36:42Z

Squashed and addressed @gaurav-nelson's comments.

Language changes for #3090

gaurav-nelson · 2016-11-18T00:49:38Z

Follow up is now in PR #3251 (#3251)

gaurav-nelson · 2016-11-18T00:53:09Z

@knobunc Can you please confirm that all these options available in 3.3 now? Before it gets released this Monday. Thanks.

knobunc · 2016-11-18T14:39:38Z

@gaurav-nelson thank you for checking. I just ran through them all and there are two that are not:

ROUTER_ENABLE_COMPRESSION
ROUTER_COMPRESSION_MIME

knobunc force-pushed the feature/desribe-all-router-env branch 4 times, most recently from d75018f to fff15b9 Compare October 21, 2016 13:56

knobunc mentioned this pull request Oct 21, 2016

Add compression to haproxy v2 openshift/origin#11469

Merged

JacobTanenbaum reviewed Oct 21, 2016

View reviewed changes

knobunc force-pushed the feature/desribe-all-router-env branch from fff15b9 to 0180a61 Compare October 21, 2016 19:24

ramr reviewed Oct 24, 2016

View reviewed changes

knobunc force-pushed the feature/desribe-all-router-env branch 2 times, most recently from 300aecb to bb9d691 Compare October 25, 2016 14:46

knobunc force-pushed the feature/desribe-all-router-env branch from bb9d691 to 1ee0697 Compare October 28, 2016 13:56

knobunc assigned knobunc and adellape Nov 1, 2016

knobunc force-pushed the feature/desribe-all-router-env branch from 1ee0697 to b2f23cb Compare November 2, 2016 13:10

knobunc mentioned this pull request Nov 4, 2016

router: Add option to bind ports only when ready openshift/origin#11768

Merged

vikram-redhat added branch/dedicated branch/enterprise-3.3 branch/online labels Nov 17, 2016

vikram-redhat added this to the Next Release milestone Nov 17, 2016

gaurav-nelson reviewed Nov 17, 2016

View reviewed changes

bfallonf added the to_followup label Nov 17, 2016

knobunc force-pushed the feature/desribe-all-router-env branch from b2f23cb to 9c10e1b Compare November 17, 2016 16:31

Described all router environment variables

66a6d22

Added missing router environment variables to the documentation, and added descriptons to all of them. For 3.4 only.

knobunc force-pushed the feature/desribe-all-router-env branch from 9c10e1b to 66a6d22 Compare November 17, 2016 16:36

gaurav-nelson added the branch/enterprise-3.4 label Nov 18, 2016

gaurav-nelson merged commit efe81ee into openshift:master Nov 18, 2016

gaurav-nelson mentioned this pull request Nov 18, 2016

Language changes for https://github.com/openshift/openshift-docs/pull/3090 #3251

Merged

gaurav-nelson pushed a commit that referenced this pull request Nov 18, 2016

Merge pull request #3251 from gaurav-nelson/FollowUp(pull3090)

baf5887

Language changes for #3090

gaurav-nelson removed branch/enterprise-3.4 to_followup labels Nov 18, 2016

This was referenced Nov 21, 2016

typo fixes #3258

Merged

Added Rotuter Variables for version 3.4 #3259

Merged

adellape modified the milestones: Next Release, Staging Nov 21, 2016

bfallonf modified the milestones: Staging, Published - 21/11/2016 Nov 28, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Described all router environment variables #3090

Described all router environment variables #3090

knobunc commented Oct 21, 2016 •

edited

Loading

knobunc commented Oct 21, 2016 •

edited

Loading

JacobTanenbaum Oct 21, 2016

knobunc Oct 21, 2016

JacobTanenbaum commented Oct 21, 2016

knobunc commented Oct 21, 2016

ramr Oct 24, 2016

ramr Oct 24, 2016

ramr commented Oct 24, 2016

knobunc commented Oct 25, 2016

ramr commented Oct 26, 2016

zhaozhanqi commented Nov 2, 2016

knobunc commented Nov 2, 2016

knobunc commented Nov 16, 2016

vikram-redhat commented Nov 17, 2016

gaurav-nelson Nov 17, 2016

gaurav-nelson Nov 17, 2016

gaurav-nelson Nov 17, 2016

gaurav-nelson commented Nov 17, 2016

knobunc commented Nov 17, 2016

adellape commented Nov 17, 2016

knobunc commented Nov 17, 2016

gaurav-nelson commented Nov 18, 2016

gaurav-nelson commented Nov 18, 2016

knobunc commented Nov 18, 2016

Described all router environment variables #3090

Described all router environment variables #3090

Conversation

knobunc commented Oct 21, 2016 • edited Loading

knobunc commented Oct 21, 2016 • edited Loading

JacobTanenbaum Oct 21, 2016

Choose a reason for hiding this comment

knobunc Oct 21, 2016

Choose a reason for hiding this comment

JacobTanenbaum commented Oct 21, 2016

knobunc commented Oct 21, 2016

ramr Oct 24, 2016

Choose a reason for hiding this comment

ramr Oct 24, 2016

Choose a reason for hiding this comment

ramr commented Oct 24, 2016

knobunc commented Oct 25, 2016

ramr commented Oct 26, 2016

zhaozhanqi commented Nov 2, 2016

knobunc commented Nov 2, 2016

knobunc commented Nov 16, 2016

vikram-redhat commented Nov 17, 2016

gaurav-nelson Nov 17, 2016

Choose a reason for hiding this comment

gaurav-nelson Nov 17, 2016

Choose a reason for hiding this comment

gaurav-nelson Nov 17, 2016

Choose a reason for hiding this comment

gaurav-nelson commented Nov 17, 2016

knobunc commented Nov 17, 2016

adellape commented Nov 17, 2016

knobunc commented Nov 17, 2016

gaurav-nelson commented Nov 18, 2016

gaurav-nelson commented Nov 18, 2016

knobunc commented Nov 18, 2016

knobunc commented Oct 21, 2016 •

edited

Loading

knobunc commented Oct 21, 2016 •

edited

Loading