Skip to content

Renaming the Cluster

Objective: Quickly change your Kubernetes cluster’s display name from the default local to something more descriptive (e.g., Demo Cluster).

Prerequisites

  • You have an SSH session to the Management/Control Plan node.
  • You have kubectl installed and configured to manage the cluster.
  • You have sufficient permissions (e.g., cluster-admin) to edit cluster objects.

Steps

  1. Open the Cluster Configuration

    kubectl edit clusters.management.cattle.io local

    This command opens the cluster’s YAML configuration in your default text editor.

  2. Update the displayName Field In the YAML file, locate the displayName field. Change its value from local to your desired name, such as:

    yaml displayName: "Demo Cluster"

  3. Save and Exit After editing, save the file and close your editor. The change is automatically applied.

  4. Verify the New Display Name

    • Refresh your cluster UI or run:

      kubectl get clusters.management.cattle.io local -o yaml

    • Ensure the displayName reflects the new name (e.g., Demo Cluster).

Need More Details?
If you get stuck or want advanced tips (e.g., about multi-cluster setups or working with specific Kubernetes distributions), refer to the in-depth Renaming the Cluster documentation.