Bug 1368878

Summary: [DOCS] [3.3] Document the ability to set configurable timeouts on routes
Product: OpenShift Container Platform Reporter: Vikram Goyal <vigoyal>
Component: DocumentationAssignee: brice <bfallonf>
Status: CLOSED CURRENTRELEASE QA Contact: Meng Bo <bmeng>
Severity: medium Docs Contact: Vikram Goyal <vigoyal>
Priority: medium    
Version: 3.3.0CC: aos-bugs, bmeng, jokerman, jtanenba, mmccomas
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-09-28 03:18:27 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Vikram Goyal 2016-08-22 02:35:39 UTC
As an OpenShift admin, I want to be able to configure timeouts on certain routes
so that services w/ a lower timeout (for SLA purposes) or a higher one (for cases where the backend service is slower) can be supported

This might need to be a note that says why we need configurable time-outs, and how we can set them.

Comment 2 brice 2016-08-24 05:49:32 UTC
PR submitted for this:

https://github.com/openshift/openshift-docs/pull/2722

Jacob,

Can I ask for an ack on this? 

1. The test cases seemed to have different cases for each type of route, but the step for adding the timeout was the same for each. So, is what I have correct? What about the secure vs unsecure routes?

2. Where it says "haproxy.route.openshift.io", should this be changed to something more generic? 

Thanks!

Comment 3 Jacob Tanenbaum 2016-08-24 12:58:10 UTC
What you have looks good. Setting the timeout is the same for secure or unsecure routes, the test cases are different because they are set slightly differently on the backend. The annotation name is part of a naming scheme used by annotations that was inherited from kubernetes and I don't believe will be changed.

Comment 4 Jacob Tanenbaum 2016-08-24 13:05:19 UTC
(In reply to jtanenba from comment #3)
> What you have looks good. Setting the timeout is the same for secure or
> unsecure routes, the test cases are different because they are set slightly
> differently on the backend. The annotation name is part of a naming scheme
> used by annotations that was inherited from kubernetes and I don't believe
> will be changed.

I just noticed you mentioned the units in your generic example, the timeout does not have to be specified in seconds.

Comment 5 brice 2016-08-25 04:00:13 UTC
Jacob, sure. Thanks for the answers. I added some extra info on the different units you can set. Please let me know if there's anything else, but for now I'll put this onto QA.

Comment 7 Meng Bo 2016-08-25 08:59:50 UTC
Added comment to the PR, other than that, looks good to me.

Comment 8 brice 2016-08-26 00:12:18 UTC
Thanks! I have changed to "Route". I'll move to peer review.

Comment 9 openshift-github-bot 2016-08-29 01:09:11 UTC
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/bd83d7f5825f25f3baee906d60fb8e2d1cf08d28
Merge pull request #2722 from bfallonf/bz1368878

Bug 1368878 added info on route timeouts and arranged native routing doc