Red Hat OpenShift

Storware Backup & Recovery supports backup for OpenShift using OADP in backup process.

Before adding Openshift as new Hypervisor Manager, you must install OADP operator at least version 1.3 from the operator hub in OpenShift Cluster.

Adding Openshift Hypervisor Manager

Log in to the web interface and add a new OpenShift Hypervisor Manager:

The Openshift Nodes should appear in Storware Backup & Recovery after indexing the cluster.


  • Please provide the URL to the Openshift API, credentials to the cluster and OADP project name when creating the OpenShift hypervisor manager in Storware Backup & Recovery WebUI. This is needed for Storware Backup & Recovery to have access to your cluster deployments.

  • Metadata is backed up using OADP operator. Openshift administrator should install this operator in the cluster. Name of the project where OADP was installed should be provided during configuration. In this project all of the OADP resources required during backups and restores will be created, such as: DataProtectionApplication, BackupStorageLocation, VolumeSnapshotLocation

  • Persistent volumes are primarily backed up using volume snapshots providing crash consistency.

  • Whether specific persistent volume can be snapshotted is determined by searching for existing VolumeSnapshotClass with a driver corresponding to the storage class of the persistent volume. Which means that if the storage class of the persistent volume does not use CSI driver or the proper volume snapshot class is not already present, export of this volume will be performed without snapshotting mechanism. Block volumes can be exported only with volume snapshots.

Persistent volumes restore/backup

There are two ways of restoring the volume content.

  • The user should deploy an automatic provisioner which will create persistent volumes dynamically. If Helm is installed, the setup is quick and easy

  • The user should manually create a pool of volumes. Storware Backup & Recovery will pick one of the available volumes to restore the content.

OpenShift troubleshooting

The user from the current context should have cluster-admin permissions.

oc adm policy add-cluster-role-to-user cluster-admin admin --as system:admin

In this case, you should stay logged in as admin for the connection to be successful.

If indexing/export fails because no Pods could be found, please make sure they have the app label assigned appropriately.

Red Hat Openshift Virtualization

Storware Backup & Recovery since version 6.0.0 supports backup of OpenShift Virtual Machines.

Red Hat OpenShift Virtualization is a feature of Red Hat OpenShift that allows you to run and manage virtual machine (VM) and container workloads side by side. Storware Backup and Recovery can inventory Virtual Machines and treat them as any other instance. They can be easily protected and recovered.

Metadata of Virtual Machines is exported using OADP operator, volume data is exported using side pod using custom OpenShift Virtualization Plugin docker image. Backup supports both full and incremental. Incremental backup use calculated checksums and does not require previous snapshots to remain in OpenShift.

Using own image registry

Storware Backup & Recovery use as default image registry for OpenShift Virtualization Plugin docker image. You can use your own registry to store the plugin image.

  1. Download OpenShift Virtualization Plugin from Storware repository.

  2. Upload it to your image registry host.

  3. Import image to your registry. Example:

    gunzip sbr-openshift-virtualization-plugin-jvm-x.x.x.x.tar.gz
    docker load -i sbr-openshift-virtualization-plugin-jvm-x.x.x.x.tar
  4. Edit /opt/vprotect/ file and change value for openshift.virtualization.sidepod.image parameter. Example:

    openshift.virtualization.sidepod.image=<Registry IP>:5000/sbr-openshift-virtualization-plugin:x.x.x.x
  5. Restart vprotect-node service.

    systemctl restart vprotect-node


  • Currently, we only support backups of Deployments/DeploymentConfigs/StatefulSets (persistent volumes and metadata).

  • All deployment pods will be paused during the backup operation - this is required to achieve consistent backup data.

  • For a successful backup, every object used by the Deployment/DeploymentConfig/StatefulSet should have a app label assigned appropriately.

  • Openshift Virtualization - Hot-plugged disks are not supported.

Last updated