Deploying the Kubernetes Metrics Server on a Cluster Using Kubectl
You can deploy the Kubernetes Metrics Server on clusters you create using Container Engine for Kubernetes to enable autoscaling.
The Kubernetes Metrics Server is a cluster-wide aggregator of resource usage data. The Kubernetes Metrics Server collects resource metrics from the kubelet running on each worker node and exposes them in the Kubernetes API server through the Kubernetes Metrics API. Other Kubernetes add-ons require the Kubernetes Metrics Server, including:
- the Horizontal Pod Autoscaler (see Using the Kubernetes Horizontal Pod Autoscaler)
- the Vertical Pod Autoscaler (see Using the Kubernetes Vertical Pod Autoscaler)
Note that the Kubernetes Metrics Server is not intended to be used for anything other than autoscaling. For example, it is not recommended that you use the Kubernetes Metrics Server to forward metrics to monitoring solutions, nor as a source of monitoring solution metrics. For more information, see the Kubernetes Metrics Server documentation.
To deploy the Kubernetes Metrics Server on a cluster you've created with Container Engine for Kubernetes:
If you haven't already done so, follow the steps to set up the cluster's kubeconfig configuration file and (if necessary) set the KUBECONFIG environment variable to point to the file. Note that you must set up your own kubeconfig file. You cannot access a cluster using a kubeconfig file that a different user set up. See Setting Up Cluster Access.
- If your Oracle Cloud Infrastructure user is a tenancy administrator or cluster administrator, skip the next step and go straight to the following step.
- If your Oracle Cloud
Infrastructure user is not a tenancy
administrator or cluster administrator, ask a tenancy administrator or cluster
administrator to grant your user the Kubernetes RBAC cluster-admin clusterrole on
the cluster by
kubectl create clusterrolebinding <my-cluster-admin-binding> --clusterrole=cluster-admin --user=<user-OCID>
For more information, see About Access Control and Container Engine for Kubernetes.
In a terminal window, deploy the Kubernetes Metrics Server by entering:
kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/download/<version-number>/components.yaml
<version-number>is the Kubernetes Metrics Server version that you want to deploy. For example,
Note that the Kubernetes Metrics Server is being actively developed, so the version number to specify will change over time. To find out the currently available versions, see the Kubernetes Metrics Server documentation.Tip
If the command fails to connect to
https://github.com/kubernetes-sigs/metrics-server/releases/download/<version-number>/components.yaml, go to the url in a browser and download the manifest file
components.yamlto a local directory. Repeat the
kubectl applycommand and specify the local location of the
Confirm that the Kubernetes Metrics Server has been deployed successfully and is available by entering:
kubectl get deployment metrics-server -n kube-system