The steps below in this blog will help you setup Kubernetes Metrics Server on Docker Desktop which provides a standalone instance of Kubernetes running as a Docker container.
Kubernetes Metrics Server is a scalable, efficient source of container resource metrics for Kubernetes built-in autoscaling pipelines. Metrics Server collects resource metrics from Kubelets and exposes them in Kubernetes apiserver through Metrics API for use by Horizontal Pod Autoscaler and Vertical Pod Autoscaler.
Metrics Server offers:
- A single deployment that works on most clusters
- Scalable support up to 5,000 node clusters
- Resource efficiency: Metrics Server uses 1m core of CPU and 3 MB of memory per node
You can use Metrics Server for:
- CPU/Memory based horizontal autoscaling
- Automatically adjusting/suggesting resources needed by containers
Prerequisites
- Install Docker Desktop
- Enable Kubernetes on Docker Desktop
Once you have enabled the Kubernetes on Docker Desktop, and if you run the below commands you should see messages like:
kubectl top node
error: Metrics API not available
kubectl top pod -A
error: Metrics API not available
Metrics server isn't included with Docker Desktop's installation of Kubernetes and to install it we will have to download the latest components.yaml
file from Metrics-Server releases page and open it in your text editor.
If you try to execute the command kubectl apply -f components.yaml
you will see the pods get created but with some errors as highlighted below:
Add the line --kubelet-insecure-tls under the args section as shown below [L136] :
Execute the command kubectl apply -f components.yaml
to apply the changes:
Now if you execute the kubectl top node
& kubectl top pod -A
commands you should see the output:
$ kubectl top node
NAME CPU(cores) CPU% MEMORY(bytes) MEMORY%
docker-desktop 1310m 32% 1351Mi 71%
$ kubectl top pod -A
NAMESPACE NAME CPU(cores) MEMORY(bytes)
cpu-example cpu-demo 1003m 1Mi
kube-system coredns-f9fd979d6-g2rfx 9m 9Mi
kube-system coredns-f9fd979d6-wndgm 6m 9Mi
kube-system etcd-docker-desktop 35m 36Mi
kube-system kube-apiserver-docker-desktop 55m 325Mi
kube-system kube-controller-manager-docker-desktop 41m 47Mi
kube-system kube-proxy-s72fj 1m 25Mi
kube-system kube-scheduler-docker-desktop 9m 17Mi
kube-system metrics-server-56c59cf9ff-jndxd 10m 14Mi
kube-system storage-provisioner 4m 5Mi
kube-system vpnkit-controller 1m 15Mi
You can also use Kubernetes Dashboard to view the above data (and more information) in a web UI. It allows users to manage applications running in the cluster and troubleshoot them, as well as manage the cluster itself.
To deploy Dashboard, execute following command:
$ kubectl apply -f https://raw.githubusercontent.com/kubernetes/dashboard/v2.1.0/aio/deploy/recommended.yaml
To access Dashboard from your local workstation you must create a secure channel to your Kubernetes cluster. Run the following command:
$ kubectl proxy
Get the token for login to dashboard using the below command:
$ kubectl -n kubernetes-dashboard describe secret $(kubectl -n kubernetes-dashboard get secret |grep default-token | awk '{print $1}')
To access the HTTPS endpoint of dashboard go to:
http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/
Login to the dashboard using the token from above step and you should see a dashboard as below:
This setting should only be used for the local Docker Desktop Kubernetes cluster, and not recommended for any hosted or production clusters.
Top comments (3)
Nice article 👏👏, worth mentioning that my enabling metrics, actually mean that we enable
metrics.k8s.io/v1beta1
API and one can examine this bykubectl get --raw /apis/metrics.k8s.io/v1beta1/nodes
Thank you my friend, just used it on Orbstack (MacOS), working like a Charm 😚
Thank you for the great article.