Monitoring and managing Backup & restore service from OpenShift Container Platform

You can monitor and manage Backup & restore service related operations from the OpenShift® Container Platform console.

In the OpenShift Container Platform console, go to Storage > Backup & Restore. The Backup & Restore page includes the following tabs:
  • Overview tab

    From this tab page, you can monitor storage consumption, backup storage activity, backup coverage, and backup and restore jobs.

  • Policies tab
    From this tab page, you can do the following operations:
    • Create a backup policy
    • Edit an existing policy
    • Delete an existing policy
  • Locations tab
    From this tab page, you can do the following operations:
    • Create a new backup storage location
    • Edit credentials of a backup location
    • Remove an existing backup location
  • Applications tab
    From this tab page, you can do the following operations:
    • Assign backup policy to applications
    • Restore backups of applications
  • Jobs tab
    From this tab page, you can do the following operations:
    • Delete backup jobs
    • Collect logs
    • View job summary

At any point in time, you can click Go to Fusion Backup & Restore to go to the Backup & restore page of the IBM Fusion user interface.

Prerequisites

  • Enable Backup & restore service in IBM Fusion.

    For the steps to enable Backup & restore service from IBM Fusion user interface, see Backup & Restore.

  • After IBM Fusion is installed, the following notification gets displayed in the OpenShift Container Platform console:
    Web console update is available
    Click Refresh web console link to refresh and view the Backup & restore service.
  • The user interface works only for the supported OpenShift Container Platform 4.16 and 4.17. Do not try to access that user interface on any older OpenShift Container Platform versions.

Overview tab

The Overview tab page is a dashboard view to monitor Backup & restore service details.
Section Description
Status The Status section includes Statuses of Backup location and Applications.

The Backup locations are either Active or inactive. The Active refers to the connected location status and inactive refers to not connected.

The Applications subsection includes the following details:
Backed up applications
Applications with assigned policies
Applications with recent backup
Applications that are backed up and the recent or latest backup was successful (Completed or PartiallyFailed).
Backup in progress
Applications with recent or latest ongoing backup.
Backup & Restore jobs summary
The Backup & Restore jobs summary includes the following details:
Queued jobs
It includes the number of in progress and number of pending jobs.
Success rate
Note: The Success rate and other fields are dependent on the frequency drop down.

The Success rate subsection displays the percentage of success rate and the number of jobs completed out of the total number of jobs. It also gives a break up of the number of completed, failed, and canceled jobs.

The All, Backup, and Restore options display the completed, canceled and failed jobs accordingly.

The Backup job count is also represented in a graph bar chart.

Backup summary The Backup coverage and Most recent backup are represented in a circular chart. It also shows a legend of the color representation. The Backup coverage includes the following details:
Backed up applications
Applications with assigned policies
Not backed up applications
Applications without assigned policies
The Most recent backup includes the following details:
Backup completed
Applications that are backed up and its recent or latest backup was successful (Completed or PartiallyFailed)
Backup failed
Applications that are backed up and recent or backup was not successful.
Storage consumption The Object storage section includes the amount of GiB used.
Backup & Restore activity The Backup & Restore activity lists ongoing and recent events related to application, backup, backup policy, backup storage location, policy assignment, and restore.

Policies tab

A backup policy defines a set of rules to backup application data. The following table describes the different sections and actions you can perform in the Policies tab page.
Section Description or action
Backup policies table The Backup policies table lists the policies with Name, Status, Location, Backup scheduled, Retention period, Application.

You can search a backup policy record by its name from the list.

Backup policy record actions From the ellipsis overflow menu of a policy record, you can do the following operations:
  • Edit backup policy
  • Edit YAML
  • Delete backup policy
Create backup policy
  1. Click Create backup policy.

    The Create BackupPolicy page is displayed.

  2. Enter the following details of the policy:
    • Enter the Policy name of the policy.
    • In the Backup location section, select whether you want In place snapshot or Object storage. If you select Object storage, then select the Location from the drop down list.
    • Select the Backup schedule for the backup. In Schedule, select the frequency. In At, select the time. In Time zone, select your zone.
    • In the Retention period, select number for Schedule and Duration in Days, Weeks, Months or Years. It is the duration to retain the backup.
  3. Click Create.

Locations tab

A backup location is a prerequisite to create a policy. You must configure at least one location to store your backed-up data. IBM Fusion supports a variety of object storage types. The following table describes the different sections and actions you can perform in the Backup locations tab page.
Element or section Description or action
Backup locations table The Backup locations table includes Name, Status, Location type, Policies, Used capacity, and Protected applications.
Actions performed on a backup location record From the ellipsis overflow menu of a backup location record, you can do the following operations:
  • Edit credentials
    1. Update Endpoint, Access key, or Secret key values.
    2. Click Save.
  • Edit YAML opens in YAML format. You can make changes and click Save.
  • Remove backup location

    In the confirmation window, click Remove to proceed with deletion.

Create a backup location

If you plan to use a certificate for a S3 compliant backup storage location, then as a prerequisite create a secret with the certificate as a prerequisite. For the procedure to create a secret, see Creating a secret.

Note: IBM does not support the creation of two backup storage locations that have both identical endpoint and bucket names.
  1. Click Create backup location.
  2. Enter the details about the backup location:
    • Enter the Name of the backup location.
    • Select the Location Type of the backup location.

      The different location types are IBM Cloud (IBM Object Storage), Azure (Microsoft Object Storage), AWS (Amazon Object Storage), Spectrum Protect, and S3Compliant (Any Object Storage).

      Enter the following credentials to connect IBM Fusion to your backup location: Endpoint, Path/Bucket, Access key, and Secret key.

      If the location is Amazon Web Services, then you must also enter the Region. If the location is Microsoft Azure (Microsoft Object Storage), then enter the Account name and Account key instead of Access key and Secret key.

    • In the Certificate setting (optional), enter the Secret name for certificate.

Applications tab

Applications contain resources, such as microservices, databases, and other stateful data distributed across projects. IBM Fusion provides ways to do application-centric backup, which provides data loss protection for your applications. The following table describes the different sections and actions you can perform in the Applications tab page.
Element or section Description or action
Applications table The Applications table includes Name, Backup status, Backup policy, Location, Used/Total capacity, Last back up on, and Success rate.

Here, the Backup status indicates the outcome of the most recent backup performed for an application. The Success rate indicates the number of successful backups performed for the application. It also indicates the availability of backup copies.

Actions performed on an application record From the ellipsis overflow menu of an application record, you can do the following operations:
  • Assign backup policy
  • Restore
    It opens a Restore window.
    1. In the Select a project destination section, select from the following options:
      Use the same project the application is already using
      Select the project in the current cluster where the application gets restored to. Restoring to an existing cluster delete the contents of the project and replaces it with the restored application.
      Use existing project
      Create new project
      If you select Create a new project, then enter a new project.
      Note: If you choose Existing project or Create new project, you can only specify a single namespace.You cannot restore multiple namespaces to a single alternate namespace.
    2. Select a backup from the available list of backups.
    3. Optionally, select Include missing etc resource to restore any etc resources that are not present in the existing OpenShift project.
    4. Select the PVCs. By default, all PVCs in the back are restored. If you want to restore only certain volumes, then you can select individual PVCs.
    5. Click Restore.
Assign backup policy

If you plan to use a certificate for a S3 compliant backup storage location, then as a prerequisite create a secret with the certificate as a prerequisite. For the procedure to create a secret, see Creating a secret.

Note: IBM does not support the creation of two backup storage locations that have both identical endpoint and bucket names.
  1. Click Assign backup policy. Alternatively, you can also click Assign backup policy from the ellipsis overflow menu of an application record.

    You can search for backup policy and filter records.

  2. Select one or more polices.
  3. If you want to initiate a backup right away, set the Run backup now toggle button to on.
  4. Click Assign.

If you set the Run backup now toggle button is set to on, the Backup status of the application in the Applications page is initially New. It then changes to Queued, Inventory in progress, Snapshot inprogress, and Complete. You can also check the Backup & Restore Jobs list in the Jobs tab page for similar status.

Jobs tab

The Jobs page displays the details of all the backup and restore jobs. The following table describes the different sections and actions you can perform in the Jobs tab page.
Element or section Description or action
Backup & Restore jobs table The Backup & Restore jobs table includes Name, Operation, Status, Start time, Completion time (Duration), Application, and Policy.

You can filter the records based on Status and Operation. The Operation values are Backup and Restore.

You can select a field and enter keywords in the Search to filter records.

You can also choose to view the list of jobs in last 24 hours, last 7 Days, or last 30 days.

Actions to perform on a jobs record The ellipsis overflow menu of a job record are as follows:
  • Delete backup job

    If you click Delete backup job, a confirmation window appears. If you are sure to delete the job, click Delete.

  • Collect logs

    Click Collect logs to go to the Jobs page of the IBM Fusion user interface. In the Jobs page, click Collect logs.

  • Job summary

    Click Jobs summary to go to the Jobs page of the IBM Fusion user interface. Here, you can view details like Summary (Inventory and Backup sequence) and Details (Duration, Created, Size, Policy, Application. Backup ID, Backup location).