Bug 1370463

Summary:	[DOCS] How User-Agents are formed by oc CLI
Product:	OpenShift Container Platform	Reporter:	Javier Ramirez <javier.ramirez>
Component:	Documentation	Assignee:	brice <bfallonf>
Status:	CLOSED CURRENTRELEASE	QA Contact:	XiaochuanWang <xiaocwan>
Severity:	low	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	unspecified
Version:	3.2.0	CC:	aos-bugs, jokerman, mmccomas, xxia
Target Milestone:	---
Target Release:	---
Hardware:	All
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-22 01:17:28 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 Javier Ramirez 2016-08-26 12:11:31 UTC

Document URL: 
https://access.redhat.com/documentation/en/openshift-enterprise/3.2/single/installation-and-configuration/#configuring-user-agent

Section Number and Name: 
9.7. User Agent

Describe the issue: 

In the documents there is no mention about the different user agents used by oc CLI.

Suggestions for improvement:

It would be good to clarify how User-Agents are formed by oc CLI (for instance, it was not trivial to determine that a kubernetes user agent is used for /api calls and a openshift user agent use used for /oapi calls) 

Additional information:

Comment 1 brice 2016-09-08 04:27:27 UTC

PR submitted for this BZ:

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

Asking devs for review in PR.

Comment 2 openshift-github-bot 2016-09-12 04:06:06 UTC

Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/7ba4bdbe0131608d90c6f11f70aec63a4cf86f1c
Merge pull request #2815 from bfallonf/useragent-bz1370463

Bug 1370463 more information on user agent

Comment 3 brice 2016-09-22 01:17:28 UTC

Link to released docs:

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

Comment 4 Javier Ramirez 2016-11-08 14:42:00 UTC

Feedback from customer:

"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."

Comment 5 brice 2016-11-09 06:18:48 UTC

Thanks, Javier

I created a BZ for this: https://bugzilla.redhat.com/show_bug.cgi?id=1393218

In the future, feel free to email openshift-docs with any feedback, or create another BZ.

Thanks, again.