Quickstarts

Minimal KubeSphere on Kubernetes

In addition to installing KubeSphere on a Linux machine, you can also deploy it on existing Kubernetes clusters directly. This QuickStart guide walks you through the general steps of completing a minimal KubeSphere installation on Kubernetes. For more information, see Installing on Kubernetes.

Note

  • To install KubeSphere on Kubernetes, your Kubernetes version must be 1.15.x, 1.16.x, 1.17.x, or 1.18.x;
  • Make sure your machine meets the minimal hardware requirement: CPU > 1 Core, Memory > 2 G;
  • A default Storage Class in your Kubernetes cluster needs to be configured before the installation;
  • The CSR signing feature is activated in kube-apiserver when it is started with the --cluster-signing-cert-file and --cluster-signing-key-file parameters. See RKE installation issue.
  • For more information about the prerequisites of installing KubeSphere on Kubernetes, see Prerequisites.

Deploy KubeSphere

After you make sure your machine meets the prerequisites, you can follow the steps below to install KubeSphere.

  • Execute the following commands:
kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/kubesphere-installer.yaml
kubectl apply -f https://raw.githubusercontent.com/kubesphere/ks-installer/v3.0.0/deploy/cluster-configuration.yaml

Note

If your server has trouble accessing GitHub, you can copy the content in kubesphere-installer.yaml and cluster-configuration.yaml respectively and past it to local files. You then can use kubectl apply -f for the local files to install KubeSphere.

Inspect the logs of installation:

kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f
  • Use kubectl get pod --all-namespaces to see whether all pods are running normally in relevant namespaces of KubeSphere. If they are, check the port (30880 by default) of the console through the following command:
kubectl get svc/ks-console -n kubesphere-system
  • Make sure port 30880 is opened in security groups and access the web console through the NodePort (IP:30880) with the default account and password (admin/[email protected]).
  • After logging in the console, you can check the status of different components in Components. You may need to wait for some components to be up and running if you want to use related services.

components

Enable Pluggable Components (Optional)

The guide above is used only for minimal installation by default. To enable other components in KubeSphere, see Enable Pluggable Components for more details.