1235574d99
Created 2 new topics: Kubernetes user tutorials metrics server and kubernetes admin tutorials metrics server. Source of information PDF file with both topics. Input from PDF file 'Documentation Metrics Server' (file attached in Jira card) Patch 1: completed review comments by Ron Patch 2: fixed broken links and malformed hyperlink targets at the beginning of the document implemented comment from review (Mary) Patch 3: implemented changes from review comments (Ron) Patch 4: added missing link for review Patch 5: implemented changes received from Greg Patch 6: implemented suggested changes by Greg Patch 7: implemeneted suggested changes by Mary Patch 8: removed empty spaces Patch 9: removed trailing spaces Patch 10: removed trailing spaces Patch 11: acted on Ron's comments Added 'release caveat' Patch 13: corrected index and added prereq in user task after cherry-pick (Greg) patch 14: corrected toc not showing 'metrics server' Story: 2008457 Task: 42207 https://review.opendev.org/c/starlingx/docs/+/784121 Signed-off-by: Adil <mohamed.adilassakkali@windriver.com> Change-Id: Ia64ab589844e9e11a06ac5b51d8a9cb1ccd1e986
80 lines
2.9 KiB
ReStructuredText
80 lines
2.9 KiB
ReStructuredText
..
|
|
.. _kubernetes-admin-tutorials-metrics-server:
|
|
|
|
======================
|
|
Install Metrics Server
|
|
======================
|
|
|
|
|release-caveat|
|
|
|
|
.. rubric:: |context|
|
|
|
|
Metrics Server is a scalable, efficient source of container resource metrics for Kubernetes
|
|
built-in autoscaling pipelines.
|
|
|
|
Metrics Server is meant for autoscaling purposes only. It is not intended to
|
|
provide metrics for monitoring solutions that persist and analyze historical metrics.
|
|
|
|
Specifically, in |prod|, Metrics Server supports:
|
|
|
|
* Use of Kubernetes' horizontal application auto-scaling based on resources
|
|
consumption, for scaling end users' containerized application deployments.
|
|
* Use of Metrics Server API within end user's containerized applications in
|
|
order for end user's application to, for example, enable application-specific
|
|
incoming load management mechanisms based on metrics of selected pods.
|
|
|
|
For details on leveraging Metrics Server for horizontal autoscaling or for
|
|
Metrics API, see :ref:`Kubernetes User Tasks <kubernetes-user-tutorials-metrics-server>`.
|
|
Metrics Server is an optional component of |prod|. It is packaged as a system
|
|
application and included in the |prod| installation ISO. In order to enable
|
|
Metrics Server, you must upload and apply the Metrics Server system
|
|
application.
|
|
|
|
.. rubric:: |proc|
|
|
|
|
Perform the following steps to enable Metrics Server such that its services are
|
|
available to containerized applications for horizontal autoscaling and/or use
|
|
of Metrics API.
|
|
|
|
#. Go to the path ``/usr/local/share/applications/helm/`` to access ``metrics-server-1.0-1.tgz``
|
|
|
|
#. Upload the application tarball:
|
|
|
|
.. code-block::
|
|
|
|
~(keystone_admin)]$ system application-upload metrics-server-1.0-1.tgz
|
|
|
|
#. Run the application list to confirm that it was uploaded:
|
|
|
|
.. code-block::
|
|
|
|
~(keystone_admin)]$ system application-list
|
|
|
|
#. Run the application to apply the metrics server:
|
|
|
|
.. code-block::
|
|
|
|
~(keystone_admin)]$ system application-apply metrics-server
|
|
|
|
#. Run the application list to confirm it was applied:
|
|
|
|
.. code-block::
|
|
|
|
~(keystone_admin)]$ system application-list
|
|
|
|
#. Run the following command to see the pod running:
|
|
|
|
.. code-block::
|
|
|
|
~(keystone_admin)]$ kubectl get pods -l app=metrics-server -n metrics-server
|
|
|
|
For details on leveraging Metrics Server for horizontal autoscaling or for
|
|
Metrics API, see :ref:`Kubernetes User Tasks <kubernetes-user-tutorials-metrics-server>`.
|
|
After installing Metrics Server, the :command:`kubectl top` |CLI| command is available
|
|
to display the metrics being collected by Metrics Server and the ones being
|
|
used for defined autoscaling definitions. These metrics are also displayed
|
|
within the Kubernetes Dashboard.
|
|
|
|
For more information see:
|
|
`https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#top
|
|
<https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#top>`__ |