You are viewing documentation for KubeSphere version:v3.0.0

KubeSphere v3.0.0 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.

Network Policies

What are Network Policies

Starting from v3.0.0, users can configure network policies of native Kubernetes in KubeSphere. Network Policies are an application-centric construct, enabling you to specify how a Pod is allowed to communicate with various network entities over the network. With network policies, users can achieve network isolation within the same cluster, which means firewalls can be set up between certain instances (Pods).


  • Please make sure that the CNI network plugin used by the cluster supports Network Policies before you enable the feature. There are a number of CNI network plugins that support Network Policies, including Calico, Cilium, Kube-router, Romana and Weave Net.
  • It is recommended that you use Calico as the CNI plugin before you enable Network Policies.

For more information, see Network Policies.

Enable the Network Policy 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 the Network Policy in this mode (for example, for testing purposes), refer to the following section to see how the Network Policy can be installed after installation.
  2. In this file, navigate to networkpolicy 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

The process of installing KubeSphere on Kubernetes is same as stated in the tutorial of Installing KubeSphere on Kubernetes except the optional component Network Policy needs to be enabled first in the cluster-configuration.yaml file.

  1. Download the file cluster-configuration.yaml and open it for editing.

    vi cluster-configuration.yaml
  2. In this local cluster-configuration.yaml file, navigate to networkpolicy 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
    kubectl apply -f cluster-configuration.yaml

Enable the Network Policy after Installation

  1. Log in to the console as admin. Click Platform in the top-left corner and select Clusters 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 the three dots on the right of ks-installer and select Edit YAML.


  4. In this yaml file, navigate to networkpolicy 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]}') -f


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

Verify the Installation of the Component

If you can see Network Policies in Network as the image below, it means the installation succeeds as this part won’t display until you install the component.