Bug 1810039
| Summary: | oc explain doesn't provide the proper explanation | ||||||
|---|---|---|---|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Shivkumar Ople <sople> | ||||
| Component: | Cloud Compute | Assignee: | Alberto <agarcial> | ||||
| Status: | CLOSED DUPLICATE | QA Contact: | Jianwei Hou <jhou> | ||||
| Severity: | unspecified | Docs Contact: | |||||
| Priority: | unspecified | ||||||
| Version: | 4.3.0 | CC: | aos-bugs, jokerman, mfojtik | ||||
| 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: | 2020-03-04 15:13:55 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: |
|
||||||
Created attachment 1667488 [details]
OCP missing resources doc
Moving to proper owners. (In reply to Maciej Szulik from comment #2) > Moving to proper owners. Machine resouce is Cloud Compute, not MCO. *** This bug has been marked as a duplicate of bug 1769004 *** |
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.