Bug 1661073

Summary:	[DOCS] Add metrics-server document
Product:	OpenShift Container Platform	Reporter:	Takayoshi Kimura <tkimura>
Component:	Documentation	Assignee:	Maxim Svistunov <msvistun>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Weinan Liu <weinliu>
Severity:	high	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	low
Version:	unspecified	CC:	aos-bugs, bmchugh, cvogel, jjerezro, jokerman, juzhao, mjahangi, mmccomas, msvistun, mtaru, oarribas, rekhan, tkimura, vigoyal
Target Milestone:	---
Target Release:	3.11.0
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:	2019-02-21 08:48:06 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:

Description Takayoshi Kimura 2018-12-20 03:39:21 UTC

Describe the issue: 

Hawkular metrics and heapster are deprecated in 3.11 and we support Prometheus and metrics-server.

"oc adm top" command and horizontal pod autoscaler needs metrics-server to function.

However metrics-server is not installed by default and there's no document about it.

Suggestions for improvement: 

Add metrics-server document and mention it's heapster replacement, "oc adm top" command and HPA.

To install:

ansible-playbook /usr/share/ansible/openshift-ansible/playbooks/metrics-server/config.yml -e openshift_metrics_server_install=true

To confirm it's working:

"oc adm top node"
"oc adm top pod"

Additional information: 

- Bug 1647456

Comment 2 Christian Heidenreich 2019-01-24 08:38:31 UTC

Hi Kimura-san, would it be sufficient enough to update the "Requirements for Using Horizontal Pod Autoscalers" section on the HPA chapter? https://docs.openshift.com/container-platform/3.11/dev_guide/pod_autoscaling.html#req-for-using-hpas

My suggestion would be to remove the current paragraph with the reference to the cluster metrics stack and simply explain how to install the metrics server for 3.11 as you explained. WDYT?

Comment 3 Takayoshi Kimura 2019-01-28 01:28:24 UTC

> My suggestion would be to remove the current paragraph with the reference to the cluster metrics stack and simply explain how to install the metrics server for 3.11 as you explained. WDYT?

Yes I think that's ok.

We may also want to update footnote of the "oc adm top pod/node" commands and mention about this command in the HPA doc as a verification step.

https://docs.openshift.com/container-platform/3.11/admin_guide/managing_pods.html
https://docs.openshift.com/container-platform/3.11/admin_guide/manage_nodes.html

Comment 4 Christian Heidenreich 2019-01-28 08:13:43 UTC

> We may also want to update footnote of the "oc adm top pod/node" commands and mention about this command in the HPA doc as a verification step.

Good idea! I will leave it with Vikram now.

Comment 10 Weinan Liu 2019-02-20 11:00:24 UTC

LGTM (QE)

Comment 15 Red Hat Bugzilla 2023-09-15 00:14:43 UTC

The needinfo request[s] on this closed bug have been removed as they have been unresolved for 500 days