IBM Support

IBM Spectrum Protect Plus: OpenShift install guide

How To


Summary

An overview of the Red Hat® OpenShift® Container Storage environment and the installation of the components needed for backing up containers are introduced. Links to the the installation instructions are provided.

Objective

To help users install the components that are required to protect their containers in Red Hat OpenShift Container Platform (OCP) IBM Spectrum Protect Plus.

 

Environment

The following components are required in your environment:
 
  • Red Hat OpenShift Container Platform
  • Red Hat OpenShift Container Storage
  • Red Hat API for Data Protection (OADP)
  • IBM Spectrum Protect Plus
  • Helm
  • Velero

For more details, see Container backup and restore requirements: IBM Spectrum Protect Plus V10.1.7
 

Steps

IBM Spectrum Protect Plus and Red Hat OpenShift Container Storage Deployment Guide

This guide details how to install the components that are required to create snapshot and copy backups in an OpenShift environment. Installation instructions for the following components are provided:

  • Red Hat OpenShift Container Storage (OCS)
  • OpenShift APIs for Data Protection (OADP)
  • IBM Spectrum® Protect Plus Operator
  • Backup Container Support (BaaS)

Container Backup Support leverages the container storage interface (CSI) to create snapshots using OpenShift Container Storage.

 

Many data protection vendors use proprietary technology to facilitate container-based backup and recovery solutions. In contrast, IBM Spectrum Protect Plus uses open and standard technology to integrate with Red Hat OpenShift and OpenShift Container Storage, including:

  • Container storage interface (CSI) snapshots. CSI snapshots provide a way to capture the state of a storage volume in a Red Hat OpenShift cluster at a particular point in time. Cluster administrators use CSI snapshots through IBM Spectrum Protect Plus to back up and restore persistent volumes (PVs). Application developers can use volume snapshots in a Development or Test context, and rapidly roll back to previous versions.
  • OpenShift APIs for Data Protection (OADP). OADP is an operator that provides Velero backup and restore APIs in the OpenShift cluster. IBM Spectrum Protect Plus uses OADP to back up and restore OpenShift cluster resources (YAML files), internal images, and persistent volume data. By using OADP, IBM Spectrum Protect Plus can back up an entire container-based application, including all of its resources, metadata, and PVs, allowing fully functional applications to be cloned to other Red Hat OpenShift clusters for disaster recovery or development purposes.

Ensure that you complete the deployment of the full solution in the order that is shown in the following sections.


 

OpenShift Container Storage Planning 

Red Hat OpenShift Container Storage runs on Red Hat OpenShift Container Platform on many infrastructures as shown in this diagram.


 

OpenShift Container Storage version 4.6 or later, is required for integration with IBM Spectrum Protect Plus and Container Backup Support. The following planning guide and sizing tool provide critical information on how to plan for your OpenShift Container Storage 4.6 installation on Red Hat OpenShift 4.5 (or later).

Planning your OpenShift Container Storage deployment
OpenShift Container Storage 4.6 Sizing Tool (Beta)

 

OpenShift Container Storage Deployment 

You can install the Red Hat OpenShift Container Storage operator by using the Red Hat OpenShift Container Platform OperatorHub for all infrastructures. The following provides deployment guides based on your infrastructure either on-premises or in a cloud environment.

Installing OpenShift Container Storage

 

IBM Spectrum Protect Plus Virtual Appliance Deployment

An existing instance of the IBM Spectrum Protect Plus virtual appliance can be used with the Container Backup Support (BaaS) component deployed on Red Hat OpenShift.

Either the IBM Appliance Spectrum Protect Plus deployment instructions OR the IBM Spectrum Protect Plus OpenShift Spectrum Protect Plus Operator Deployment instructions need to be followed for a containerized installation. The two methods will both work but only one is required.

Before you install IBM Spectrum Protect Plus as a virtual appliance, understand the components that are deployed, the prerequisites, and the installation procedure.  The steps in the following link create a IBM Spectrum Protect Plus Server outside of the OCP environment.

Installing Spectrum Protect Plus as an Appliance

 

IBM OpenShift Spectrum Protect Plus Operator Deployment

This deployment applies to users who want to install the IBM Spectrum Protect Plus server installed in Red Hat OpenShift as an operator.

Either the IBM Appliance Spectrum Protect Plus deployment instructions OR the IBM Spectrum Protect Plus OpenShift Spectrum Protect Plus Operator Deployment instructions need to be followed for a containerized installation. The two methods will both work but only one is required.

Before you install IBM Spectrum Protect Plus on Red Hat OpenShift Container Platform, review the components to be deployed, the prerequisites, and the installation procedure. Use the steps in the following link to create a containerized IBM Spectrum Protect Plus Server running in a Red Hat OpenShift environment:

Installing Spectrum Protect Plus on Red Hat OpenShift

 

IBM Spectrum Protect Plus vSnap Server Deployment

Every installation of IBM Spectrum Protect Plus requires at least one vSnap server, which is the primary backup destination outside of Red Hat OpenShift.

Installing the vSnap server

 

OpenShift API for Data Protection (OADP) Deployment

To protect cluster-scoped resources and namespace-scoped resources, you must install and configure OADP in a dedicated namespace. The suggested Red Hat OpenShift project name for the IBM Spectrum Protect Plus OADP deployment is spp-velero.

Installing OADP and Velero resources on Red Hat OpenShift

 

Container Backup Support (BaaS) Deployment

To protect persistent volumes (PVs) used by containers and cluster-scoped and namespace-scoped Red Hat OpenShift resources, you must install and configure IBM Spectrum Protect Plus Container Backup Support in a Red Hat OpenShift environment.

As a prerequisite an instance of the IBM Spectrum Protect Plus server must be installed and configured either in Red Hat OpenShift as a containerized operator deployment or as a virtual appliance.

Installing BaaS on OpenShift

 

Video for How to Back up and Restore Wordpress using IBM Spectrum Protect Plus

This video shows how to use IBM Spectrum Protect Plus V10.1.7 to back up and recover Red Hat OpenShift cluster persistent volume claims (PVCs) and resources.
The video contains the following demos:

  1. How to configure a service level agreement (SLA) for backups and then run an on-demand snapshot backup of both PVCs and resources.
  2. How to run a vSnap copy and restore of both the PVCs and resources to a second OpenShift cluster. These steps emulate the cloning or migration of an application to an alternate cluster.


 

Additional Information

Red Hat®, OpenShift® are trademarks or registered trademarks of Red Hat, Inc. or its subsidiaries in the United States and other countries. 

 

Document Location

Worldwide

[{"Line of Business":{"code":"LOB26","label":"Storage"},"Business Unit":{"code":"BU054","label":"Systems w/TPS"},"Product":{"code":"SSNQFQ","label":"IBM Spectrum Protect Plus"},"ARM Category":[{"code":"a8m50000000L3D0AAK","label":"Planning"}],"ARM Case Number":"","Platform":[{"code":"PF016","label":"Linux"}],"Version":"10.1.7"}]

Product Synonym

SPP;OCP;OCS;Spectrum Protect Plus;Velero;OpenShift;Storage

Document Information

Modified date:
27 January 2021

UID

ibm16398730