Registering a Kubernetes cluster

If necessary, you can use the IBM Spectrum® Protect Plus user interface to manually register a Kubernetes cluster or to modify the properties of a registered Kubernetes cluster.

To manually register a cluster or to modify cluster properties, complete the following steps:

1. In the navigation panel, click Manage Protection > Containers > Kubernetes.
2. In the Kubernetes page, click Manage clusters.
3. Take one of the following actions:
   • To manually register a cluster, click Add cluster.
   • To update existing cluster properties, in the list of host addresses, click the edit icon for the cluster host that you want to update.
4. Update the fields in the Application Properties section:

   Cluster Name

   The name of the cluster host or load balancer for the Container Backup Support container.

   The cluster name must match the value that is used for the cluster_name parameter in the baas-values-cr.yaml file. For more information, see Setup the installation variables for Container Backup Support.

   Host Address

   The host address for the cluster host or load balancer.

   If an Ingress controller is used on your Kubernetes cluster, specify the fully qualified domain name (FQDN) of the host that is specified in the Ingress resource. If NodePort is used, specify the FQDN of the node that is running the spp-agent pod.

   Port Number

   The port for the connection to the Container Backup Support agent container service.

   To obtain the port number, issue the following command on your cluster:

   kubectl get service -n baas | grep baas-rest-spp-agent

   The output for the baas-rest-spp-agent service contains the port number. If you are using Ingress for external connections between the IBM Spectrum Protect Plus server and the Container Backup Support agent, the port number is 443. If you are using NodePort, the port number is 31245.

   Use existing user

   Select this checkbox to use a previously entered username and password for the cluster host. Select a username from the Select user list.

   User ID

   If you do not use an existing user ID, enter the username for the application host. The username must match the value that you specified for the DATAMOVER_USERNAME installation variable in the baas-options.sh file. For more information, see Setup the installation variables for Container Backup Support.

   The credentials are added to the list of existing users. This field is not available if you are using an existing user.

   Password

   Enter the password for the application host. The password must match the value that you specified for the DATAMOVER_PASSWORD installation variable in the baas-options.sh file. For more information, see Setup the installation variables for Container Backup Support.

   The credentials are added to the list of existing users. This field is not available if you are using an existing user.

   Certificate

   Specify the certificate that you exported from your cluster by clicking Copy and paste. Enter a name for the certificate, such as baas-ca.crt. Paste the contents of the certificate to the Copy and paste certificate here field and click Create.

   For instructions on exporting and importing certificates, see Importing certificates on a Kubernetes cluster.

5. Optional: Set additional options in the Options section:

   Maximum concurrent PVCs

   Set the maximum number of PVC snapshots or copy backups to create concurrently. Cluster performance is impacted when you back up many PVCs concurrently, as each PVC uses multiple threads and consumes bandwidth when data is copied. Use this option to control the impact on cluster resources and minimize the impact on production operations.

   The default value is 10.

6. Click Save. IBM Spectrum Protect Plus confirms a network connection, adds the cluster to the IBM Spectrum Protect Plus database, and then catalogs the cluster resources, including namespaces and PVCs.
   If a message appears indicating that the connection is unsuccessful, review your entries. If your entries are correct and the connection is unsuccessful, contact a network administrator to review the connection.