Bug 1697216 - [DOCS] Correct a annotation for overriding existing cookie name
Summary: [DOCS] Correct a annotation for overriding existing cookie name
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.11.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: ---
Assignee: Vikram Goyal
QA Contact: Hongan Li
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-04-08 06:04 UTC by Daein Park
Modified: 2019-09-18 06:24 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-04-11 07:45:37 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Daein Park 2019-04-08 06:04:07 UTC
Document URL: 

  Routes
    [ https://docs.openshift.com/container-platform/3.11/dev_guide/routes.html ]

Section Number and Name: 
  Allowing Route Endpoints to Control Cookie Names
    [ https://docs.openshift.com/container-platform/3.11/dev_guide/routes.html#dev-guide-routes-allowing-endpoints-to-control-cookies ]

Describe the issue: 

There are wrong guidance as follows.

[x] $ oc annotate route <route_name> router.openshift.io/<cookie_name>="-<cookie_annotation>"
[o] $ oc annotate route <route_name> router.openshift.io/cookie_name=<custom_cookie_name>

[x] For example, to annotate the cookie name of my_cookie to the my_route with the annotation of my_cookie_anno:
[o] For example, to specify my_cookie as new cookie name:

[x] $ oc annotate route my_route router.openshift.io/my_cookie="-my_cookie_anno"
[o] $ oc annotate route my_route router.openshift.io/cookie_name=my_cookie

Suggestions for improvement: 

correct the annotation name.

Additional information:

Comment 2 Daein Park 2019-04-08 07:07:04 UTC
Additionally if both "insert" and "indirect" options are configured, the cookie will be removed from transmitted request, so "This allows the application receiving route traffic to know the cookie name. " is not true.
The HAProxy session cookie does not been transmitted to the back end Application.


Note You need to log in before you can comment on or make changes to this bug.