Skip to content

Renaming the Cluster

By default, GPU Cluster Manager names the main cluster as local. If you prefer a more descriptive name, you can use kubectl to edit the cluster object and update its display name.

Prerequisites

  • You must have kubectl installed and configured to communicate with the cluster you want to rename.
  • You need sufficient permissions to edit cluster objects (e.g., a cluster-admin role).

Steps to Rename

  1. Open the Cluster Configuration in an Editor
    Run the following command to open the cluster configuration in your default text editor:

    kubectl edit clusters.management.cattle.io local

  2. Locate the displayName Field
    In the editor, look for the displayName field within the YAML. It will likely be set to "local" by default.

  3. Update the displayName
    Change the value from "local" to your desired name, for example:

    displayName: "Demo Cluster"

  4. Save and Exit
    Save your changes and close the editor. kubectl will automatically apply the updated configuration to the cluster.

  5. Verify the Change

    • Return to your cluster UI or run kubectl get clusters.management.cattle.io local -o yaml to confirm that the displayName field reflects the new name.
    • The UI should now show Demo Cluster in place of local, improving clarity for administrators and users alike.

Tip

Keep your cluster name concise yet descriptive, especially in multi-cluster environments where clear labeling helps avoid misconfiguration or confusion.