Installing the IBM Spectrum Protect Plus operator in an air-gapped environment by using a CASE package

You can install the IBM Spectrum® Protect Plus operator in an air-gapped environment by using a Container Application Software for Enterprises (CASE) package. You can use this procedure in either a standard Red Hat® OpenShift® cluster environment or the IBM Cloud Pak® for Multicloud Management environment.

Before you begin

Ensure that prerequisites are met and preliminary tasks are completed:

Ensure that the following tools are installed and updated to the required version:
- IBM Cloud Pak command-line interface (cloudctl) v3.5.0 or later
- Kubernetes command-line tool (kubectl) v1.16.0 or later
- OpenShift command-line tool (oc) v4.5.0 or later
All commands must be run in the Linux® operating system.
For the IBM Cloud Pak for Multicloud Management environment, ensure that you complete the steps on the same hub cluster on which IBM Cloud Pak for Multicloud Management is installed.
Download the IBM Spectrum Protect Plus operator CASE package.
- For the IBM Cloud Pak for Multicloud Management environment, obtain the SPP_Vsppversion_FOR_OpenShift_MCM.tar.gz package from IBM® Passport Advantage® Online, where sppversion specifies the version of IBM Spectrum Protect Plus that you are installing, such as 10.1.10.
- For the standard Red Hat OpenShift environment, obtain the SPP_Vsppversion_FOR_OpenShift.tar.gz package from IBM Passport Advantage Online, where sppversion specifies the version of IBM Spectrum Protect Plus that you are installing, such as 10.1.10.
For the list of installation packages by component, and the links to the download site for the files, see technote 6552532.

About this task

You must prepare your cluster and then install the operator.

The following table shows the descriptions of the variables that you must set before you begin the procedure:

Table 1. Variables for installing the IBM Spectrum Protect Plus operator by using a CASE package
Variable	Description
$CASE_BUNDLE_DIRECTORY	The name of the CASE package directory. For IBM Cloud Pak for Multicloud Management, specify: ibm-spp-server-bundle For standard Red Hat OpenShift clusters, specify: ibm-spp-server-std-bundle
$CASE_BUNDLE_NAME	The name of the CASE package. For IBM Cloud Pak for Multicloud Management, specify: ibm-spp-server-case-bundle For standard Red Hat OpenShift clusters, specify: ibm-spp-server-std-case-bundle
$CASE_NAME	The CASE name. For IBM Cloud Pak for Multicloud Management, specify: ibm-spp-server For standard Red Hat OpenShift clusters, specify: ibm-spp-server-std
$SOURCE_REGISTRY	The environment variable for the IBM Entitled Registry address. The value must be set to `cp.icr.io/cp/sppserver`.
$SOURCE_REGISTRY_USER	The environment variable for the username for the IBM Entitled Registry. The value must be set to `cp`.
$SOURCE_REGISTRY_PASS	The environment variable for the entitlement key that you obtained from the IBM Container software library.
$TARGET_REGISTRY	The environment variable for the private Docker registry where images are loaded.
$TARGET_REGISTRY_USER	The environment variable for the username for the private Docker registry.
$TARGET_REGISTRY_PASS	The environment variable for the private Docker registry password.
`project_name`	The project that you created for IBM Spectrum Protect Plus.

Procedure

To install the IBM Spectrum Protect Plus operator by using a CASE package in an air-gapped environment, complete the following steps:

Log in to the IBM Cloud Pak environment. Issue the following cloudctl command to log in to your cluster:
```
cloudctl login -a cluster_url -u username -p password -n kube-system --skip-ssl-validation
```
Create a project for IBM Spectrum Protect Plus by issuing the following command:
```
oc new-project project_name
```
where project_name is the name of the project where the operator and instance of the IBM Spectrum Protect Plus server will be installed.

Save the CASE package. Prepare the CASE package for installation by issuing the following commands:

cd $CASE_BUNDLE_DIRECTORY/stable/$CASE_BUNDLE_NAME
cloudctl case save --case case/$CASE_NAME/ --outputdir /tmp/ibm-spp-server-case

Configure the credentials for the source registry from which images are pulled. Add the registry credentials for the source registry by issuing the following commands:

cd $CASE_BUNDLE_DIRECTORY/stable/$CASE_BUNDLE_NAME
cloudctl case launch --case case/$CASE_NAME/ --namespace project_name --inventory sppserverSetup --action configure-creds-airgap --args "--registry $SOURCE_REGISTRY --user $SOURCE_REGISTRY_USER --pass $SOURCE_REGISTRY_PASS"

Configure the credentials for the target registry where images are loaded. Add the registry credentials for the target registry by issuing the following commands:

cd $CASE_BUNDLE_DIRECTORY/stable/$CASE_BUNDLE_NAME
cloudctl case launch --case case/$CASE_NAME/ --namespace project_name --inventory sppserverSetup --action configure-creds-airgap --args "--registry $TARGET_REGISTRY --user $TARGET_REGISTRY_USER --pass $TARGET_REGISTRY_PASS"

Mirror the images from the source registry to the target registry by issuing the following commands:

cd $CASE_BUNDLE_DIRECTORY/stable/$CASE_BUNDLE_NAME
cloudctl case launch --case case/$CASE_NAME/ --namespace project_name --inventory sppserverSetup --action mirror-images --args "--registry $TARGET_REGISTRY --inputDir /tmp/ibm-spp-server-case"

Configure your cluster for an air-gapped installation by adding a global pull secret and setting an image content source policy. Issue the following commands:

cd $CASE_BUNDLE_DIRECTORY/stable/$CASE_BUNDLE_NAME
cloudctl case launch --case case/$CASE_NAME/ --namespace project_name --inventory sppserverSetup --action configure-cluster-airgap --args "--registry $TARGET_REGISTRY --inputDir /tmp/ibm-spp-server-case --dryRun"

Install the IBM Spectrum Protect Plus operator by completing the following steps:
1. Make the IBM Spectrum Protect Plus operator available for installation by adding the catalog source. Issue the following commands:
```
> cd $CASE_BUNDLE_DIRECTORY/stable/$CASE_BUNDLE_NAME
> cloudctl case launch --case case/$CASE_NAME/ --namespace openshift-marketplace --inventory sppserverSetup --action installCatalog \
    --args "--registry registry_server --secret pull_secret_name"
```
  where registry_server is the registry server address for the IBM Entitled Registry (cp.icr.io/cp/sppserver) and pull_secret_name is the name of the image pull secret that you created.
2. Install the IBM Spectrum Protect Plus operator by issuing the following commands:
```
> cd $CASE_BUNDLE_DIRECTORY/stable/$CASE_BUNDLE_NAME
> cloudctl case launch --case case/$CASE_NAME/ --namespace project_name --inventory sppserverSetup --action installOperator
```
  where project_name is the project that you created for IBM Spectrum Protect Plus.

What to do next

Create an instance of the IBM Spectrum Protect Plus server by using the Red Hat OpenShift web console. For instructions, see Creating an IBM Spectrum Protect Plus instance.