document all the route annotations and PR11984 #3301

JacobTanenbaum · 2016-11-30T16:01:55Z

No description provided.

ramr · 2016-11-30T21:23:47Z

architecture/core_concepts/routes.adoc


-By default, a server-side timeout is set across all routes. It is possible to
-change that timeout using an annotation in the route configuration.
+By default, or using an environment variable a number of configuration options


Maybe reword this - sounds a bit odd by default or using - something like Using environment variables as defined in <add-link-to-section>, a router can set the default options for all the routes it exposes. An individual route can choose to override some of these defaults by providing specific configuration via/in (I like via but its normally not used in docs) its annotations.

JacobTanenbaum · 2016-12-01T14:53:07Z

@ramr does this clear it up?

ramr · 2016-12-01T18:59:50Z

LGTM

ramr

LGTM

knobunc · 2016-12-06T13:18:18Z

architecture/core_concepts/routes.adoc

@@ -219,6 +220,7 @@ variables on the *deployment config* for the router to alter its configuration.
 |`*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_LOAD_BALANCE_ALGORITHM*` | leastconn | Load-balanceing strategy for multiple endpoints for edge and reencrypt terminated routes. Available options are `source`, `roundrobin`, or `leastconn`.


Load-balanceing => Load-balancing

Doesn't this also apply to http routes?

knobunc · 2016-12-06T13:19:02Z

architecture/core_concepts/routes.adoc

+.Route Annotations
+[cols="2*", options="header"]
+|===
+|Variable | Description


Can we sort this section alphabetically by annotation?

knobunc · 2016-12-06T13:20:14Z

architecture/core_concepts/routes.adoc

+[cols="2*", options="header"]
+|===
+|Variable | Description
+|`*haproxy.router.openshift.io/balance*`| sets the load balance algorithm. Available options are `source`, `roundrobin`, or `leastconn`.


The first letter of the description should be uppercase to match the other table.

Should we indicate the ENV that provides the default (perhaps in a new column)

load-balancing (or make the pervious one match this case)

knobunc · 2016-12-06T13:21:14Z

architecture/core_concepts/routes.adoc

+|===
+|Variable | Description
+|`*haproxy.router.openshift.io/balance*`| sets the load balance algorithm. Available options are `source`, `roundrobin`, or `leastconn`.
+|`*haproxy.router.openshift.io/timeout*` | sets a server side timeout. overwrites `*ROUTER_DEFAULT_SERVER_TIMEOUT*` for that route


server-side

Just make the default env be noted in a new column

knobunc · 2016-12-06T13:21:48Z

architecture/core_concepts/routes.adoc

+|Variable | Description
+|`*haproxy.router.openshift.io/balance*`| sets the load balance algorithm. Available options are `source`, `roundrobin`, or `leastconn`.
+|`*haproxy.router.openshift.io/timeout*` | sets a server side timeout. overwrites `*ROUTER_DEFAULT_SERVER_TIMEOUT*` for that route
+|`*haproxy.router.openshift.io/rate-limit-connections*`| setting to true enables rate limiting functionality


Should true be in quotes? Or in a fixed width font? What's the style elsewhere?

knobunc · 2016-12-06T13:22:08Z

architecture/core_concepts/routes.adoc

+|`*haproxy.router.openshift.io/balance*`| sets the load balance algorithm. Available options are `source`, `roundrobin`, or `leastconn`.
+|`*haproxy.router.openshift.io/timeout*` | sets a server side timeout. overwrites `*ROUTER_DEFAULT_SERVER_TIMEOUT*` for that route
+|`*haproxy.router.openshift.io/rate-limit-connections*`| setting to true enables rate limiting functionality
+|`*haproxy.router.openshift.io/rate-limit-connections.concurrent-tcp*`| limits the number of concurrent tcp connections shared by an IP address


TCP? What's the style?

knobunc · 2016-12-06T13:22:21Z

architecture/core_concepts/routes.adoc

+|`*haproxy.router.openshift.io/rate-limit-connections*`| setting to true enables rate limiting functionality
+|`*haproxy.router.openshift.io/rate-limit-connections.concurrent-tcp*`| limits the number of concurrent tcp connections shared by an IP address
+|`*haproxy.router.openshift.io/rate-limit-connections.rate-tcp*`| limits the rate at which an IP address can make tcp connections
+|`*haproxy.router.openshift.io/rate-limit-connections.rate-http*`| limits the rate at which an IP address can make http requests


HTTP? What's the style?

knobunc · 2016-12-06T13:23:19Z

architecture/core_concepts/routes.adoc

+|`*haproxy.router.openshift.io/rate-limit-connections.concurrent-tcp*`| limits the number of concurrent tcp connections shared by an IP address
+|`*haproxy.router.openshift.io/rate-limit-connections.rate-tcp*`| limits the rate at which an IP address can make tcp connections
+|`*haproxy.router.openshift.io/rate-limit-connections.rate-http*`| limits the rate at which an IP address can make http requests
+|`*haproxy.router.openshift.io/disable_cookies*`| disables the use of cookies, the balance algorithm is used to determine which backend serves connections everytime


Disables the use of cookies to track related connections. If set to 'true' the balance algorithm is used to choose which back-end serves connections for each HTTP request.

knobunc · 2016-12-06T13:24:54Z

architecture/core_concepts/routes.adoc

+|`*haproxy.router.openshift.io/rate-limit-connections.rate-tcp*`| limits the rate at which an IP address can make tcp connections
+|`*haproxy.router.openshift.io/rate-limit-connections.rate-http*`| limits the rate at which an IP address can make http requests
+|`*haproxy.router.openshift.io/disable_cookies*`| disables the use of cookies, the balance algorithm is used to determine which backend serves connections everytime
+|`*router.openshift.io/haproxy.health.check.interval*`| set the health check interval for backend endpoints


Sets the interval for the back-end health checks.

knobunc

LGTM

knobunc · 2016-12-08T14:58:58Z

@JacobTanenbaum What releases should this be for? Please put that in the PR description.

@openshift/team-documentation PTAL. This has passed technical review.

ahardin-rh · 2016-12-08T16:41:44Z

LGTM. I added a to_followup label, as I will make some minor follow-up edits to the topic as a whole in a follow-up PR. @JacobTanenbaum Is this for 3.4? Thanks!

ahardin-rh · 2016-12-08T21:36:31Z

@JacobTanenbaum Also, can you please give this a squash?

change log added a referance name to Configuration parameters and reworded the introduction to Route-specific Annotations address a number of issues brought by ben bennet - Load-balanceing => Load-balancing for ROUTER_LOAC_BALANCE_ALGORITHM - sorted annotation table alphabetically - first letter of annotation tables descriptions are uppercase - server side => server-side in description of haproxy.router.openshift.io/timeout - added a column to the annotations for the default env variables they overwrite - changed true to fixed witdth in description of haproxy/openshift.io/rate-limit-connections - changed occurances of tcp, http, https to TCP, HTTP, HTTPS respectivly to conform with style - changed description of haproxy.router.openshift.io/disable_cookies and router.openshift.io/haproxy.health.check.interval

JacobTanenbaum · 2016-12-18T15:59:57Z

@ahardin-rh squashed

ahardin-rh · 2016-12-19T12:51:26Z

@JacobTanenbaum Thanks! Can you please check my labels? I am assuming this is for 3.4. is that correct?

JacobTanenbaum · 2017-01-03T19:33:22Z

@knobunc is this for 3.4 or 3.5?

knobunc · 2017-01-06T16:26:56Z

@JacobTanenbaum if all of the annotations are in 3.4, then it can be for 3.4. Can you confirm if they are?

JacobTanenbaum · 2017-01-06T17:54:51Z

they are in 3.4

ahardin-rh · 2017-01-06T18:42:13Z

Thanks!

ahardin-rh · 2017-01-06T18:49:35Z

[rev_history]
|xref:../architecture/core_concepts/routes.adoc#architecture-core-concepts-routes[Core Concepts -> Routes]
|Added descriptions of all xref:../architecture/core_concepts/routes.adoc#route-specific-annotations[route annotations].
%

JacobTanenbaum mentioned this pull request Nov 30, 2016

added an enviroment variable for balance alg. and ability to disable route cookies openshift/origin#11984

Merged

JacobTanenbaum force-pushed the load_balance_docs branch from 7fe9b79 to 8274e59 Compare November 30, 2016 16:05

ramr suggested changes Nov 30, 2016

View reviewed changes

ramr reviewed Dec 1, 2016

View reviewed changes

ramr approved these changes Dec 1, 2016

View reviewed changes

knobunc requested changes Dec 6, 2016

View reviewed changes

knobunc approved these changes Dec 8, 2016

View reviewed changes

ahardin-rh added the to_followup label Dec 8, 2016

JacobTanenbaum force-pushed the load_balance_docs branch from 42ac0ab to d45d2a4 Compare December 9, 2016 17:45

ahardin-rh added this to the Future Release milestone Dec 19, 2016

ahardin-rh added the branch/enterprise-3.4 label Dec 19, 2016

ahardin-rh self-assigned this Dec 19, 2016

ahardin-rh added branch/dedicated branch/online labels Dec 19, 2016

ahardin-rh merged commit 0c32bfc into openshift:master Jan 6, 2017

ahardin-rh mentioned this pull request Jan 9, 2017

Follow-up edits to PR#3301 #3469

Merged

ahardin-rh removed the to_followup label Jan 9, 2017

vikram-redhat modified the milestones: Staging, Future Release, OCP 3.4 GA Jan 16, 2017

adellape modified the milestones: OCP 3.4 GA, Staging, Temp Feb 1, 2017

DanyC97 mentioned this pull request Mar 28, 2017

configure HAProxy through route annotation - add some documentation #2960

Closed

vikram-redhat modified the milestones: OCP 3.4 GA, Dedicated-Staging Mar 31, 2017

document all the route annotations and PR11984 #3301

document all the route annotations and PR11984 #3301

Uh oh!

Conversation

JacobTanenbaum commented Nov 30, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JacobTanenbaum commented Dec 1, 2016

Uh oh!

ramr commented Dec 1, 2016

Uh oh!

ramr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

knobunc left a comment

Choose a reason for hiding this comment

Uh oh!

knobunc commented Dec 8, 2016

Uh oh!

ahardin-rh commented Dec 8, 2016

Uh oh!

ahardin-rh commented Dec 8, 2016

Uh oh!

JacobTanenbaum commented Dec 18, 2016

Uh oh!

ahardin-rh commented Dec 19, 2016

Uh oh!

JacobTanenbaum commented Jan 3, 2017

Uh oh!

knobunc commented Jan 6, 2017

Uh oh!

JacobTanenbaum commented Jan 6, 2017

Uh oh!

ahardin-rh commented Jan 6, 2017

Uh oh!

ahardin-rh commented Jan 6, 2017

Uh oh!

Uh oh!