Registering a Red Hat OpenShift cluster

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

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

1. In the navigation panel, click Manage Protection > Containers > OpenShift.
2. In the OpenShift 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 same cluster name that is used as the value for the cluster_name parameter in the baas-values-cr.yaml file.

   Host Address

   • For the environments where IBM Spectrum Protect Plus and the Container Backup Support agent are deployed in the same Red Hat OpenShift cluster, the host address will be the full name of the Red Hat OpenShift service. The value is always set to baas-rest-spp-agent.baas.svc

   • For the environments where IBM Spectrum Protect Plus server and the Container Backup Support agent are not deployed in the same Red Hat OpenShift cluster, or IBM Spectrum Protect Plus server is not in any cluster, read the following instructions:

     The fully qualified domain name (FQDN) address of the Red Hat OpenShift route. The route object and its FQDN address are available in the Red Hat OpenShift web console. You can also issue the following command to obtain the route FQDN:

     oc get route --namespace baas

     The route FQDN is listed in the HOST/PORT column in the command output. The DNS address is similar to the following example:

     baas-spp-agent-route-baas.example.com

     Important: Ensure that the IBM Spectrum Protect Plus server's DNS address resolves to the FQDN address of the Red Hat OpenShift cluster. If the Red Hat OpenShift FQDN is not used by IBM Spectrum Protect Plus, you must change the DNS settings in the IBM Spectrum Protect Plus administrative console by taking the following steps:

     1. From a supported web browser, access the administrative console by entering the following address:

        https://hostname:8090/

     2. Log on to the administrator console by using the credentials for the system user (serveradmin).
     3. Click Network Configuration.
     4. In the Update Network Configuration section, locate the IP addresses in the DNS Servers field. Change the first IP address to the Red Hat OpenShift FQDN address and click Configure.

     The IBM Spectrum Protect Plus server restarts, which might take a significant amount of time.

   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:

   oc 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.

   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

   A certificate is required to ensure secure communication between the Container Backup Support container agent and the IBM Spectrum Protect Plus server. For instructions on exporting and importing certificates, see Importing certificates in a Red Hat OpenShift environment.

   In environments where the IBM Spectrum Protect Plus server and the Container Backup Support container agent are deployed in the same OpenShift cluster, you must select Use cluster certificate.

   In environments where the IBM Spectrum Protect Plus server and the Container Backup Support container agent are not deployed in the same OpenShift cluster, select one of the following options:

   Use existing certificate

   Select an existing certificate from the Select a certificate list.

   Copy and paste

   Enter a name for the certificate, such as baas-ca.crt. Paste the contents of the certificate in the Copy and paste certificate here field and click Create.

   Upload

   Click Choose file to select a certificate to upload.

5. Optional: Populate the field 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 projects 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.