Bug 1393218

Summary: User Agent field fix
Product: OpenShift Container Platform Reporter: brice <bfallonf>
Component: DocumentationAssignee: brice <bfallonf>
Status: CLOSED CURRENTRELEASE QA Contact: Vikram Goyal <vigoyal>
Severity: low Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 3.3.0CC: aos-bugs, bfallonf, jokerman, mmccomas, sjr
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: 2017-10-03 00:55:51 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 brice 2016-11-09 06:17:26 UTC
From BZ 1370463

About this section:

https://docs.openshift.com/enterprise/3.2/install_config/configuring_authentication.html#configuring-user-agent

"It is good that it includes examples of both OpenShift and Kubernetes libraries. However, the description of <version> field does not point the difference between versions when invoking /api and /oapi endpoints as the field <client> does. Both should do it."

https://bugzilla.redhat.com/show_bug.cgi?id=1370463

Comment 1 brice 2017-01-09 05:09:46 UTC
PR added for this BZ:

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

Comment 2 openshift-github-bot 2017-01-09 05:28:40 UTC
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/763d895ca603fe2156c0fafc6b0fc81e6e248e6c
Merge pull request #3460 from bfallonf/useragent_1393218

Bug 1393218 added detail about api vs oapi in useragent section

Comment 3 Sergi Jimenez Romero 2017-02-15 13:12:03 UTC
Hi,

sorry for the late update, the customer for case 01581508 gave us feedback about the docs commit referenced on #2.

They'd like to see a clarification/mention about what component version is sent to what endpoint:

* Kubernetes version (shown running oc version) is sent to /api
* OpenShift version (shown running oc version) is sent to /oapi

Given the current status of this BZ, should I open a new RFE for this improvement?

Best regards,
Sergi.

Comment 4 brice 2017-02-16 02:10:54 UTC
Sergi,

Sorry, I'm not sure if I understand. Is that not clear in the PR?

"This can change depending on if the request is made against the Kubernetes API at `/api`, or the {product-title} API at `/oapi"

Am I missing or misunderstanding something?

Comment 5 Sergi Jimenez Romero 2017-02-16 07:19:30 UTC
Hi,

sorry, my bad, I was checking wrong commit. The one in #2 looks perfect.

Thanks!
Sergi.

Comment 7 brice 2017-02-27 02:22:47 UTC
Sergi,

Added another PR:

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

I will merge with the next weekly release.

Comment 8 Sergi Jimenez Romero 2017-03-03 11:35:19 UTC
(In reply to brice from comment #7)
> Sergi,
> 
> Added another PR:
> 
> https://github.com/openshift/openshift-docs/pull/3842
> 
> I will merge with the next weekly release.

Brice, much appreciated.

Comment 10 brice 2017-10-03 00:55:51 UTC
No need to change the severity. Docs already published here:

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.6/html-single/installation_and_configuration/#configuring-user-agent

Moving this BZ to closed.