Bug 1732141

Summary: API Server: Improve config.openshift.io resource description
Product: OpenShift Container Platform Reporter: Samuel Padgett <spadgett>
Component: kube-apiserverAssignee: Stefan Schimanski <sttts>
Status: CLOSED ERRATA QA Contact: Xingxing Xia <xxia>
Severity: high Docs Contact:
Priority: unspecified    
Version: 4.2.0CC: aos-bugs, mfojtik, yinzhou
Target Milestone: ---   
Target Release: 4.2.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of:
: 1732143 (view as bug list) Environment:
Last Closed: 2019-10-16 06:30:26 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:
Embargoed:
Attachments:
Description Flags
All components have the same description none

Description Samuel Padgett 2019-07-22 19:18:17 UTC
Created attachment 1592681 [details]
All components have the same description

The various cluster config config.openshift.io resource descriptions have been copied and pasted from each other and have no detail. Administrators don't know what these configurations are for. I've attached a screenshot of how this looks in console (not good) and why we want to update each description.

Per Clayton, this is a high severity bug.

Comment 1 Stefan Schimanski 2019-07-23 08:45:39 UTC
Fixed in https://github.com/openshift/api/pull/386

Comment 2 Stefan Schimanski 2019-07-23 11:40:44 UTC
Updated CRDs in https://github.com/openshift/cluster-config-operator/pull/74

Comment 3 zhou ying 2019-07-30 03:06:43 UTC
The fix PR has work:
[root@dhcp-140-138 ~]# oc version --short
Client Version: v4.2.0
Server Version: v1.14.0+1682e38

Payload: 4.2.0-0.nightly-2019-07-28-222114

[root@dhcp-140-138 ~]# oc explain consoles --api-version=config.openshift.io/v1
KIND:     Console
VERSION:  config.openshift.io/v1

DESCRIPTION:
     Console holds cluster-wide configuration for the web console, including the
     logout URL, and reports the public URL of the console. The canonical name
     is `cluster`.
....


[root@dhcp-140-138 ~]# oc explain authentications --api-version=config.openshift.io/v1
KIND:     Authentication
VERSION:  config.openshift.io/v1

DESCRIPTION:
     Authentication specifies cluster-wide settings for authentication (like
     OAuth and webhook token authenticators). The canonical name of an instance
     is `cluster`.

....


[root@dhcp-140-138 ~]# oc explain apiservers --api-version=config.openshift.io/v1
KIND:     APIServer
VERSION:  config.openshift.io/v1

DESCRIPTION:
     APIServer holds configuration (like serving certificates, client CA and
     CORS domains) shared by all API servers in the system, among them
     especially kube-apiserver and openshift-apiserver. The canonical name of an
     instance is 'cluster'.
....

Comment 4 errata-xmlrpc 2019-10-16 06:30:26 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2019:2922