KubeSphere Service Mesh

On the basis of Istio, KubeSphere Service Mesh visualizes microservices governance and traffic management. It features a powerful toolkit including circuit breaking, blue-green deployment, canary release, traffic mirroring, distributed tracing, observability and traffic control. Developers can easily get started with KubeSphere Service Mesh without any code hacking, with the learning curve of Istio greatly reduced. All features of KubeSphere Service Mesh are designed to meet users’ demand for their business.

For more information, see Grayscale Release.

Enable KubeSphere Service Mesh 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.

  1. 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


    If you adopt All-in-One Installation, you do not need to create a config-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 KubeSphere Service Mesh in this mode (for example, for testing purposes), refer to the following section to see how KubeSphere Service Mesh can be installed after installation.
  2. In this file, navigate to servicemesh and change false to true for enabled. Save the file after you finish.

      enabled: true # Change "false" to "true".
  3. 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 KubeSphere Service Mesh first in the cluster-configuration.yaml file.

  1. Download the file cluster-configuration.yaml and edit it.

    vi cluster-configuration.yaml
  2. In this local cluster-configuration.yaml file, navigate to servicemesh and enable it by changing false to true for enabled. Save the file after you finish.

      enabled: true # Change "false" to "true".
  3. 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

Enable KubeSphere Service Mesh after Installation

  1. Log in to the console as admin. Click Platform in the top-left corner and select Cluster Management.

  2. Click CRDs and enter clusterconfiguration in the search bar. Click the result to view its detail page.


    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.
  3. In Resource List, click on the right of ks-installer and select Edit YAML.

  4. In this YAML file, navigate to servicemesh and change false to true for enabled. After you finish, click Update in the bottom-right corner to save the configuration.

      enabled: true # Change "false" to "true".
  5. 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


    You can find the web kubectl tool by clicking in the bottom-right corner of the console.

Verify the Installation of the Component

Go to Components and check the status of Istio. You may see an image as follows:


Execute the following command to check the status of Pods:

kubectl get pod -n istio-system

The output may look as follows if the component runs successfully:

NAME                                    READY   STATUS    RESTARTS   AGE
istio-ingressgateway-78dbc5fbfd-f4cwt   1/1     Running   0          9m5s
istiod-1-6-10-7db56f875b-mbj5p          1/1     Running   0          10m
jaeger-collector-76bf54b467-k8blr       1/1     Running   0          6m48s
jaeger-operator-7559f9d455-89hqm        1/1     Running   0          7m
jaeger-query-b478c5655-4lzrn            2/2     Running   0          6m48s
kiali-f9f7d6f9f-gfsfl                   1/1     Running   0          4m1s
kiali-operator-7d5dc9d766-qpkb6         1/1     Running   0          6m53s

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.