You can change the cluster display name in the Tanzu Service Mesh Console and edit the configuration of a cluster to change the namespace exclusions defined for the cluster.

When you onboard a cluster, you provide a display name for the cluster. The cluster display name appears wherever data is displayed for the cluster in the Tanzu Service Mesh Console UI, including data tables and topology views. To change the cluster display name, you edit the cluster.

You can edit the cluster configuration to specify the namespaces on the cluster that you want to include for automatic Istio sidecar injection. Including a namespace enables automatic Istio sidecar injection in the namespace. Include a namespace if you want the pods in that namespace to be part of the mesh. If you enable automatic Istio sidecar injection for a namespace, all new pods that are created in that namespace will automatically have a sidecar proxy added to them.

For more information about the namespace inclusion feature, called Namespace Onboarding Workflow, see Namespace Onboarding Workflow. For more information about sidecar proxy injection, also see the Istio documentation.

Prerequisites

  • Access the Tanzu Service Mesh Console.

  • If you want to enable Tanzu Service Mesh only in some of the namespaces of the cluster, decide beforehand which namespaces you want to exclude from Tanzu Service Mesh.

Procedure

  1. In the navigation panel on the left, click Home.
  2. On the Home page, click the Cluster Overview tab.
  3. In the upper-right corner of the card for the cluster that you want to edit, click the three vertical dots and then click Edit Cluster.


  4. In the Edit Cluster dialog box, in the Cluster Name box, enter a new display name for the cluster.

    The cluster display name cannot contain special characters, such as a number sign (#), at sign (@), apostrophe ('), underscore (_), and uppercase letters.

    Note:

    You cannot change the cluster ID.

  5. Under Namespace Inclusions, specify the namespaces on the cluster that you want to include for automatic Istio sidecar injection.

    You can select namespaces for inclusion (the Select Namespaces option) or define namespace inclusion rules based on a namespace naming pattern (the Create Namespace Inclusion Rule option). For more information about these options, see Namespace Inclusions.

    You can include only the user-defined namespaces on the cluster. The system namespaces are automatically excluded from Istio sidecar injection.

    Note:

    • Including a namespace for automatic Istio sidecar injection sets the istio-injection=enabled label on the namespace.

    • You can also define namespace inclusion rules for a cluster using the Tanzu Service Mesh API. For more information, see Define Namespace Inclusions in Tanzu Service Mesh API Programming Guide.

    Important:

    If you set namespace inclusions for a cluster in the Tanzu Service Mesh UI (during onboarding or when editing a cluster configuration) or through the API,  you will not be able to manually label any namespaces on the cluster with istio-injection in Kubernetes. To take control over namespace labeling and prevent Tanzu Service Mesh from overriding the namespace labeling changes you make in Kubernetes, do the following:

    1. Annotate each namespace on which you want to set the istio-injection label with allspark=disable update:

    kubectl annotate ns {namespace-name} allspark=disable-update

    2. Set the istio-injection label on the namespace:

    kubectl label ns {namespace-name} istio-injection=enabled | disabled

    Be aware that the Tanzu Service Mesh UI currently does not reflect the namespace labeling changes you make in Kubernetes if you set the override annotation. In a future release, Tanzu Service Mesh will have the ability to reflect the real-time status of namespaces and delegate control of namespace labeling to users.

  6. To save the changes, click Save.

Results

The message Cluster {name} updated successfully appears in the lower-left corner of the Tanzu Service Mesh Console UI.

When you create namespaces on the cluster, Tanzu Service Mesh is automatically enabled in them unless they match any of the namespace exclusions that you have defined for the cluster.