Metrics Server
KubeSphere supports Horizontal Pod Autoscalers (HPA) for Deployments. In KubeSphere, the Metrics Server controls whether the HPA is enabled. You use an HPA object to autoscale a Deployment based on different types of metrics, such as CPU and memory utilization, as well as the minimum and maximum number of replicas. In this way, an HPA helps to make sure your application runs smoothly and consistently in different situations.
Enable the Metrics Server before Installation
Installing on Linux
When you implement multi-node installation of KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components.
-
In the tutorial of Installing KubeSphere on Linux, you create a default file
config-sample.yaml
. Modify the file by executing the following command:vi config-sample.yaml
Note
If you adopt All-in-One Installation, you do not need to create aconfig-sample.yaml
file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable the Metrics Server in this mode (for example, for testing purposes), refer to the following section to see how the Metrics Server can be installed after installation. -
In this file, navigate to
metrics_server
and changefalse
totrue
forenabled
. Save the file after you finish.metrics_server: enabled: true # Change "false" to "true".
-
Create a cluster using the configuration file:
./kk create cluster -f config-sample.yaml
Installing on Kubernetes
As you install KubeSphere on Kubernetes, you can enable the Metrics Server first in the cluster-configuration.yaml file.
-
Download the file cluster-configuration.yaml and edit it.
vi cluster-configuration.yaml
-
In this local
cluster-configuration.yaml
file, navigate tometrics_server
and enable it by changingfalse
totrue
forenabled
. Save the file after you finish.metrics_server: enabled: true # Change "false" to "true".
-
Execute the following commands to start installation:
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml kubectl apply -f cluster-configuration.yaml
Note
If you install KubeSphere on some cloud hosted Kubernetes engines, it is probable that the Metrics Server is already installed in your environment. In this case, it is not recommended that you enable it incluster-configuration.yaml
as it may cause conflicts during installation.
Enable the Metrics Server after Installation
-
Log in to the console as
admin
. Click Platform in the top-left corner and select Cluster Management. -
Click CRDs and enter
clusterconfiguration
in the search bar. Click the result to view its detail page.Info
A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects. -
In Resource List, click
on the right of
ks-installer
and select Edit YAML. -
In this YAML file, navigate to
metrics_server
and changefalse
totrue
forenabled
. After you finish, click Update in the bottom-right corner to save the configuration.metrics_server: enabled: true # Change "false" to "true".
-
You can use the web kubectl to check the installation process by executing the following command:
kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f
Note
You can find the web kubectl tool by clickingin the bottom-right corner of the console.
Verify the Installation of the Component
Execute the following command to verify that the Pod of Metrics Server is up and running.
kubectl get pod -n kube-system
If the Metrics Server is successfully installed, your cluster may return the following output (excluding irrelevant Pods):
NAME READY STATUS RESTARTS AGE
metrics-server-6c767c9f94-hfsb7 1/1 Running 0 9m38s
Feedback
Was this page Helpful?
Thanks for the feedback. If you have a specific question about how to use KubeSphere, ask it on Slack. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.