If necessary, you can use the IBM Spectrum® Protect
Plus user interface to manually register an OpenShift®
cluster or to modify the properties of a registered OpenShift cluster.
About this task
After Container Backup Support is installed, the
application host for the Container Backup Support container
is automatically registered upon startup of the cluster host in OpenShift. When a
cluster is registered with IBM Spectrum Protect
Plus, an
inventory of the resources in the cluster is automatically captured, enabling you to complete backup
and restore jobs, as well as run reports.
However, if the automatic registration was unsuccessful or if a registered cluster was
accidentally unregistered, you can manually register the cluster by using the IBM Spectrum Protect
Plus user interface.
You can also modify the properties of the registered cluster, such as changing the SSH port that
is used to connect to the Container Backup Support container
agent service.
For example, if you use a load balancer to distribute the workload in your cluster, you can edit
the load balancer to use the port number for the Container Backup Support agent container service. You can then
register the load balancer and port number with IBM Spectrum Protect
Plus so that you do not have to configure the port
number again.
Procedure
To manually register a cluster or to modify cluster properties, complete the following
steps:
-
In the navigation panel, click .
- In the OpenShift page, click Manage
clusters.
- 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.
- 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. You can enter a host name or IP
address.
- The cluster name must match the value that is used for the clusterName
parameter in the baas-values.yaml file.
- Host Address
- The host address for the cluster host. The cluster can be registered using any
one of the IP addresses in the cluster. Enter any IP address that is listed in the
clusterAPIServerips parameter in the baas-values.yaml
file. You can enter an IP address or a fully qualified domain name.
- Port Number
- The SSH port for the connection to the Container Backup Support agent container service.
- By default, the port is automatically assigned by OpenShift during installation of Container Backup Support. To obtain this port number, issue the following command at the oc command
line:
oc get service -n baas | grep baas-spp-agent
The output is similar to
the following
example:
baas-spp-agent NodePort 10.110.235.90 <none> 22:31299/TCP 111m
The
port number is the numerical string that follows
22:. In the example,
the port number is
31299.
- 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
- 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 Setting up the installation variables.
- The credentials will be 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 Setting up the installation variables.
- The credentials will be added to the list of existing users. This field is not available if you
are using an existing user.
- 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 copying data. Use this option to control the impact on cluster resources
and minimize the impact on production operations.
- The default value is 10.
- 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.
What to do next
To verify that the clusters are updated, review the job log. In the navigation panel, click
Jobs and Operations. Click the Running Jobs tab, and
look for the most recent Application Server Inventory log entry. You
can specify a filter to show only inventory jobs by clicking the filter icon, selecting
Inventory, and clicking Apply.
Completed jobs are shown on the Job History tab. You can use the
Sort By list to sort jobs based on start time, type, status, job name, or
duration. Use the Search by name field to search for jobs by name. You can
use asterisks as wildcard characters in the name. If the status of inventory job status is
Partial, click Job Log and review the log
entries to find the error.
Clusters must be detected to ensure that their resources can be backed up. You can run a manual
inventory at any time to detect updates in cluster resources. For instructions about running a
manual inventory, see Detecting OpenShift cluster resources. For instructions about
scheduling OpenShift backup jobs, see Backing up OpenShift container data.