Bug 1810039 - oc explain doesn't provide the proper explanation
Summary: oc explain doesn't provide the proper explanation
Keywords:
Status: CLOSED DUPLICATE of bug 1769004
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Cloud Compute
Version: 4.3.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Alberto
QA Contact: Jianwei Hou
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-03-04 13:23 UTC by Shivkumar Ople
Modified: 2023-10-06 19:19 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-03-04 15:13:55 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
OCP missing resources doc (3.44 KB, text/plain)
2020-03-04 13:24 UTC, Shivkumar Ople
no flags Details

Description Shivkumar Ople 2020-03-04 13:23:51 UTC
Description of problem:
oc explain against openshift resources, several are missing details 

Version-Release number of selected component (if applicable):
4.3


How reproducible:
always.

Steps to Reproduce:
1. oc explain machine

You will see something like below:

`````
KIND:     Machine
VERSION:  machine.openshift.io/v1beta1

DESCRIPTION:
     <empty>
`````



Actual results:
oc explain not showing explanation

Expected results:
oc explain should show the explanation


Additional info:

The ask here is to have the various CRDs that we include in OpenShift documented so that using "oc explain" or viewing them in the Explore tab of the console shows the relevant information with regards to the schema. My understanding is that this is engineering's direction, all custom CRD's need to have documented schema.


for example, executing "oc explain machine" returns:

````````````````
KIND:     Machine
VERSION:  machine.openshift.io/v1beta1

DESCRIPTION:
     <empty>

```````````````

Whereas "oc explain oauth":

KIND:     OAuth
VERSION:  config.openshift.io/v1

DESCRIPTION:
     OAuth holds cluster-wide information about OAuth. The canonical name is
     `cluster`. It is used to configure the integrated OAuth server. This
     configuration is only honored when the top level Authentication config has
     type set to IntegratedOAuth.

FIELDS:
...

-- Attaching the file to the bug which includes all such resource which needs the #oc explain attention.

Comment 1 Shivkumar Ople 2020-03-04 13:24:43 UTC
Created attachment 1667488 [details]
OCP missing resources doc

Comment 2 Maciej Szulik 2020-03-04 14:32:43 UTC
Moving to proper owners.

Comment 3 Antonio Murdaca 2020-03-04 15:12:08 UTC
(In reply to Maciej Szulik from comment #2)
> Moving to proper owners.

Machine resouce is Cloud Compute, not MCO.

Comment 4 Alberto 2020-03-04 15:13:55 UTC

*** This bug has been marked as a duplicate of bug 1769004 ***


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