Bug 1376096 - oc get documentation
Summary: oc get documentation
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: oc
Version: 3.3.0
Hardware: All
OS: All
low
low
Target Milestone: ---
: ---
Assignee: Maciej Szulik
QA Contact: Xingxing Xia
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-09-14 16:37 UTC by Dan Yocum
Modified: 2019-08-21 09:08 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-08-21 09:08:33 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Dan Yocum 2016-09-14 16:37:02 UTC
Description of problem:

oc get help does not contain documentation to list the available templates. For example, this exists, but is not documented:

oc get template -n default


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

atomic-openshift-clients-3.3.0.30-1.git.0.c5ee292.el7.x86_64

How reproducible:

always

Steps to Reproduce:
1. oc get | grep template

or

oc help get | grep template


Actual results:

no docs describing how to list the available templates

Expected results:

docs describing how to list the available templates
Additional info:


Document URL: 

Section Number and Name: 

Describe the issue: 

Suggestions for improvement: 

Additional information:

Comment 3 Juan Vallejo 2017-02-01 16:50:13 UTC
> oc get help does not contain documentation to list the available templates. For example, this exists, but is not documented:

Right now, the list of available resources that is printed on `oc get` is hardcoded upstream. Ideally, we would want to "discover" available resources through the server in a future update.

Comment 4 Juan Vallejo 2017-09-20 15:11:32 UTC
Related upstream PR [1] and proposal [2].

1. https://github.com/kubernetes/kubernetes/pull/51324
2. https://github.com/kubernetes/community/pull/1017

Comment 5 Juan Vallejo 2018-01-15 15:31:04 UTC
@David, I'd be in favor of using discovery to generate a list of resources that you can run against `oc explain`, if no other arguments are passed to the `oc explain` command.

Comment 6 David Eads 2018-01-15 17:46:02 UTC
That's fine.  Open it upstream.

Comment 7 Maciej Szulik 2019-08-21 09:08:33 UTC
This is addressed in current release.


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