Bug 1469999 - [DOCS] Missing "oc adm top"
Summary: [DOCS] Missing "oc adm top"
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.5.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Traci Morrison
QA Contact: DeShuai Ma
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-07-12 09:02 UTC by Eduardo Minguez
Modified: 2018-06-29 19:24 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-06-29 19:24:07 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Eduardo Minguez 2017-07-12 09:02:35 UTC
Document URL: none

Section Number and Name: none

Describe the issue: There is a oc command "oc adm top" which is pretty useful but it is missing in the documentation

Suggestions for improvement: Add how to use oc adm top command

Additional information: oc adm top -h shows some stuff

Comment 2 Traci Morrison 2018-04-24 14:22:25 UTC
Hi Eduardo,

This information is included in the 3.9 admin guide:

https://docs.openshift.com/container-platform/3.9/admin_guide/monitoring_images.html

Also, included in 3.7 and 3.5:

https://docs.openshift.com/container-platform/3.7/admin_guide/monitoring_images.html

https://docs.openshift.com/container-platform/3.5/admin_guide/monitoring_images.html

Is this information sufficient?

Thanks,
Traci

Comment 3 Eduardo Minguez 2018-04-24 14:26:29 UTC
Hi Traci,

Good stuff, but I'm still missing "oc adm top nodes" and "oc adm top pods". Also, it would be nice to specify the requirements such as hawkular deployed, etc.

Comment 4 Traci Morrison 2018-04-24 14:36:53 UTC
Thanks, Eduardo. I will research those commands and create a PR to update the docs. The PR will require your approval, as well as approval from our QE team.

Comment 5 Traci Morrison 2018-05-07 18:01:58 UTC
Sent email to xiaocwan and yanpzhan for QE review and more information.

Comment 6 Traci Morrison 2018-05-15 00:44:11 UTC
Hi @dma, can you please review this BZ? Thanks.

Comment 7 Traci Morrison 2018-05-17 17:28:28 UTC
Sent email to @dma (Cc @xiaocwan and @yanpzhan) requesting a QE review.

Comment 8 DeShuai Ma 2018-05-18 08:00:04 UTC
The do LGTM, thanks!

Comment 13 DeShuai Ma 2018-05-21 08:40:23 UTC
For `oc adm top pod` and `oc adm top node`, QE don't find any doc about it. But the command `oc adm top` help info maybe can help us. http://pastebin.test.redhat.com/593617  For node and pod it required metrics component.

Comment 14 Traci Morrison 2018-05-23 16:03:08 UTC
Work in progress: https://github.com/openshift/openshift-docs/pull/9550

Also, please specify what release versions this applies to (3.9 is the most current release).

Comment 15 Eduardo Minguez 2018-05-24 07:31:22 UTC
IDK in which OCP version was added and still missing:

* Requirements. AFAIK metrics stack deployed and I think some cluster-reader permissions.
* oc adm top nodes/pods example output
* More elaborated examples such as get information per selector

Comment 16 Traci Morrison 2018-05-24 20:13:04 UTC
@dma Can you review Comment 15?

Comment 17 Traci Morrison 2018-06-11 22:01:14 UTC
@dma PTAL at the updated PR.

@

Comment 18 Traci Morrison 2018-06-11 22:02:22 UTC
@eminguez PTAL at the updated PR. Does this provide enough information to fix the bug?

Comment 19 Eduardo Minguez 2018-06-12 07:52:10 UTC
LGTM, thanks!

Comment 20 DeShuai Ma 2018-06-12 09:53:22 UTC
This udpate LGTM, THANKS

Comment 21 Traci Morrison 2018-06-14 19:20:39 UTC
PR 9550 merged and cherry picked to 3.7, 3.9, and 3.10. Moving this bug to release pending.


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