Completing the Guided Setup for Kubernetes

Use the Kubernetes guided setup to add the Kubernetes cluster that you want to protect to Commvault. The best way to ensure that the entire cluster is protected entails exiting the guided setup at step 4, "Add Application Group". This topic documents how to do that.

About the "Default" Application Group and Namespace-Centric Protection

When you exit the guided setup at step 4, "Add Application Group", an application group named "default" is created. The default application group uses the recommended namespace-centric protection method to protect your entire cluster.

Default application groups that were created before Commvault Platform Release 2022E use application-centric protection. After upgrading your CommServe server, MediaAgents, and Kubernetes access nodes to Commvault Platform Release 2022E, existing default application groups are automatically upgraded to use namespace-centric protection.

A default application group can be created only when you add a cluster to Commvault. After you add a cluster, you can't create a default application group for the cluster.

Verify That Your Environment Is Ready

Identify a Service Account

Identify a service account that Commvault can use to perform data management operations. You can use an existing service account or create a new one.

Use an Existing Service Account

  1. To list the existing service accounts on the cluster, run the following command:

    kubectl get sa -A
  2. To get the token for a service account, run the following command:

    kubectl describe sa service_account_name [ -n namespace]

  3. To extract the secret for the token, run the following command:

    kubectl get secrets -n namespace -o jsonpath="{.items[?(@.metadata.annotations['kubernetes\.io/service-account\.name']=='service_account_name')].data.token}"| base64 --decode

    Example command:

    kubectl get secrets -n default -o jsonpath="{.items[?(@.metadata.annotations['kubernetes\.io/service-account\.name']=='cvbackup')].data.token}"|base64 --decode

    Example output:


Create a Service Account

To manually create a service account and token, see Kubernetes service account and token.

Go to the Guided Setup

  1. From the navigation pane, go to Guided setup.

    The Welcome page appears.

  2. On the Protect tab, at the bottom of the page, click More.

  3. Click the Kubernetes tile, and then select Configure.

    The Access Node page of the guided setup appears.

Select Access Nodes

Access nodes run backups and other operations.

  1. From the Access nodes list, select the access nodes to use for the cluster.

    To ensure high availability for data management operations, select multiple access nodes. With multiple access nodes, Commvault performs load balancing and automatically recovers from access node outages. For optimal performance of data management operations, select access nodes that have a round trip time (RTT) between the access nodes and the Kubernetes cluster of less than 1 millisecond.

    To have the Commvault software automatically select access nodes, select the Automatic option. For information, see Automatic Access Node Selection for Virtualization.

  2. To add a Windows x86 64-bit Windows access node, click the add button add/plus button - gray - no border.

    The Commvault software downloads and installs the Virtual Server package that is required for Kubernetes access nodes.

    To add a Linux access node, see Adding an Access Node for Kubernetes.

  3. If the access nodes that you want to select are not listed, click the refresh button refresh button - gray - no border.

  4. Click Next.

    The Plan page of the guided setup appears.

Select a Server Plan

After you exit the guided setup at step 4, "Add Application Group", your selection of a server plan is not preserved. Later in this topic, you will select a server plan again, for the default application group that is created. If you create a new server plan at this point in the guided setup, you can select that server plan.

  1. Select the server plan to back up the cluster and applications.

    If you don't already have a server plan that you can use, to create one, click the add button add/plus button - gray - no border.

  2. Click Next.

    The Add Cluster page of the guided setup appears.

Add the Cluster

Specify the Kubernetes API server (control plane endpoint) and the service account for the cluster.

  1. In the Kubernetes API server box, enter the API server URL and port number in the following format:


    To get the URL, run the following command:

    kubectl cluster-info

    In the following example output, the Kubernetes control plane is running at https://k8s-123-4.your.domain:6443, so you would enter https://k8s-123-4.your.domain:6443 in the Kubernetes API server box.

    If your control plane is running on port 443, you don't have to include the port number.

    Kubernetes control plane is running at https://k8s-123-4.your.domain:6443 CoreDNS is running at https://k8s-123-4.your.domain:6443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy

  2. In Name, enter a descriptive name for the cluster.

  3. For Authentication Type, leave Service account selected.

  4. In Service account, enter the name of a service account to access the cluster for backups and other operations.

    To generate the service token script, click Create Service Account. In the Get Kubernetes service token script window, do the following:

    1. In Namespace, specify the namespace where you want to create the service account.

    2. In ClusterRoleBinding name, specify a name.

    3. In Secret, specify a secret name for service account.

    4. Copy the script using the Copy to clipboard button.

    5. Run the script on Kubernetes cluster to create the Service Account, ClusterRolebinding and Service Account Secret. Copy the service account token generated.

  5. In Service token, enter the service account token.

  6. To verify that you selected the correct access nodes and server plan for the cluster, click the Previous button.

    After you click Next, you the Commvault software adds the cluster, and you can't change the access nodes or server plan until after you complete the configuration wizard.

  7. Click Next.

    The Commvault software adds the cluster. To view the cluster, go to Protect > Kubernetes.

    The Add Application Group page appears.


    If you receive an "Unable to create a cluster with the details provided" error, do the following:

    • Verify that you entered the API server endpoint, service account, and service account token values correctly.

    • Verify that the access nodes you selected can access the API server endpoint. To check connectivity to the endpoint for an access node, log onto the access node, and then—using a browser or curl—connect to the kube-apiserver endpoint.

Exit the Guided Setup to Create a Default Application Group

The best way to ensure that the entire cluster is protected is to exit the guided setup at this point. When you exit the guided setup, the Commvault software creates a "default" application group that uses namespace-centric protection to protect the entire cluster.

  1. On the Add Application group page, click Cancel.

    A confirmation message appears.

  2. Click Exit Wizard.

    The cluster is added to the Commvault software, and an application group named "default" is created.

    The cluster overview page appears.

Select a Server Plan for the Default Application Group

You must assign a server plan to the default application group so that backups will run as specified by the server plan.

You can use region-based storage with Kubernetes. If you use region-based storage, you must update the Workload region setting for the cluster.

  1. On the cluster overview page, click the Application groups tab.

  2. Click the default application group.

    The default application group overview page appears.

  3. In the Summary section, for Plan, click Edit, and then select the server plan that you want to use for the application group.

Perform a Test Backup and Restore

Scheduled backups run according to the server plan that you selected. To verify that data protection operations can complete successfully, perform an on-demand test backup and restore.

  1. On the Application groups tab of the cluster page, in the row for the application group, click the action button action_button, and then select Back up.

    The Select backup level dialog box appears.

  2. Leave Incremental selected.

    If no full backup exists, Commvault automatically performs a full backup.

  3. Click OK.

  4. After the backup completes, on the Application groups tab, in the row for the application group, click the action button action_button, and then click Restore.

    The Select restore type page appears.

  5. Select Namespace and cluster level so that all API resources in the application namespace are restored.

    The other restore types are as follows:

    • To restore application files and folders, select Application files.

    • To restore application manifests (YAML), select Application manifests.

    • To restore applications, select Full application.

    The Restore page appears.

  6. Select the namespaces to restore.

    The Size column shows the protected size of any persistent storage (PersistsentVolumeClaims) within the namespace. For stateless applications, the Size column shows 0 B.

    The Modified column shows the date and time of the most recent backup time, in the local time of the CommServe server.

  7. Click Restore.

    The Restore options dialog box appears.

  8. For Type, select In place.

    The In place option restores the namespaces to the original cluster.

  9. Move the Unconditionally overwrite if it already exists toggle key to the right.

    A confirmation message appears.


    Commvault deletes the existing namespace and/or applications before restoring the data.

  10. To accept the risk and continue, click Yes.

  11. Click Submit.

For more information, see the following: