For OpenShift: Installing Container Backup Support by using the OpenShift web console

To prepare the OpenShift web console to pull Container Backup Support images from the IBM Helm Charts Repository that is linked to the IBM Entitled Registry, you must add the IBM Entitled Registry to your Helm repository.

1. Define the location of the IBM Helm Charts Repository by saving the following text to a YAML file called entitled-registry-repo.yaml:

   #--------------------------------------
   # Filename: entitled-registry-repo.yaml
   #--------------------------------------
   apiVersion: helm.openshift.io/v1beta1
   kind: HelmChartRepository
   metadata:
     name: entitledregistry
   spec:
     name: entitledregistry
     connectionConfig:
       url: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm

2. Apply the YAML file by issuing the following command:

   oc apply -f entitled-registry-repo.yaml

   The following message is displayed:

   helmchartrepository.helm.openshift.io/entitledregistry configured

   The Helm charts in the IBM Entitled Registry, including the Helm chart for IBM Spectrum Protect Plus Container Backup Support, are added to the Developer Catalog page of the OpenShift web console.

helm3 repo add ibm-helm https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
helm3 repo list
helm3 repo update
helm3 search repo spectrum
mkdir installer
cd installer
helm3 fetch ibm-helm/ibm-spectrum-protect-plus-prod --version "chart_version"
tar -xvf ibm-spectrum-protect-plus-prod-chart_version.tgz

You must create a project (namespace) for Container Backup Support called baas in the OpenShift web console.

1. Log on to the OpenShift web console as the cluster administrator.
2. Select the Developer view and click Project.
3. On the Project Details page, click the Create a project link.
4. In the Create Project window, enter baas in the Name field.
5. Optional: Enter a display name ad a description for the project.
6. Click Create.
   The baas project is created.

Create an image pull secret in the baas project that you created for Container Backup Support.

1. Log on to the OpenShift web console as the cluster administrator.
2. Select the Developer view and click Secrets.
3. Ensure that the baas project is selected.
   
4. On the Secrets page, click Create > Image Pull Secret.
5. On the Create Image Pull Secret page, complete the following fields:

   Secret Name

   Enter baas-registry-secret.

   Authentication Type

   Select Image Registry Credentials.

   Registry Server Address

   Specify the Docker registry where images are pulled. For example, enter the value for the DOCKER_REGISTRY_ADDRESS variable that you set up in the baas-options.sh file. For the IBM Entitled Registry, specify cp.icr.io/cp.

   Username

   Enter the Docker registry username that is associated with the DOCKER_REGISTRY_USERNAME value in the baas-options.sh file. For the IBM Entitled Registry, specify cp.

   Password

   Enter the entitlement key for the IBM Entitled Registry. For instructions on obtaining the entitlement key, see Obtain an entitlement key.

6. Click Create.

To store credentials for the baas project, you must create a secret named baas-secret.

1. Log on to the OpenShift web console as the cluster administrator.
2. Select the Developer view and click Secrets.
3. Ensure that the baas project is selected.
   
4. Create the credentials secret by manually entering credentials or by using a script.
   • Creating the credentials secret by invoking a script:
     1. On the Secrets page, click Create > From YAML. The Create Secret page is displayed.
     2. Go to the command line and issue the following commands to run the baas-prereqs-create-baas-secret-yaml.sh script:

        cd ~/installer/ibm-spectrum-protect-plus-prod/ibm_cloud_pak/pak_extensions/install
        ./baas-prereqs-create-baas-secret-yaml.sh

        The script extracts the values for the account credentials from the baas-options.sh file, converts the credentials into base64 encoding, and puts the credentials into a YAML format.

        The output is in the following format:

        apiVersion: v1
        kind: Secret
        metadata:
          name: baas-secret
          namespace: baas
        type: Opaque
        data:
          baasadmin: xxxxxxxxxxxx
          baaspassword: xxxxxxxxxxx=
          datamoveruser: xxxxxxxxxxx=
          datamoverpassword: xxxxxxxxxxx=
          miniouser: xxxxxxxxxxx=
          miniopassword: xxxxxxxxxxxxxxxx

     3. Copy the output and paste it to the YAML editor on the Create Secret page in the OpenShift web console.
     4. Click Create.
   • Creating the credentials secret by manually entering key-value pairs for the credentials:
     1. On the Secrets page, click Create > Key/Value Secret.
     2. In the Secret Name field, enter baas-secret.
     3. Create the following credentials by specifying the key-value pairs. Click Add Key/Value each to add a key-value pair and click Create to create the baas-secret secret.

        The following table lists the key-value pairs that you must provide:

        Table 1. Key-value pairs for the baas-secret secret

        Key	Value
        baasadmin	Specify the username for the IBM Spectrum Protect Plus containers administrator. Enter the value that is used for the SPP_ADMIN_USERNAME variable in the baas-options.sh file.
        baaspassword	Specify the password for the IBM Spectrum Protect Plus containers administrator. Enter the value that is used for the SPP_ADMIN_PASSWORD variable in the baas-options.sh file.
        datamoveruser	Specify the data mover username. Use the value that you specified for the DATAMOVER_USERNAME variable in the baas-options.sh file.
        datamoverpassword	Specify the password for the data mover. Use the value that you specified for the DATAMOVER_PASSWORD variable in the baas-options.sh file.
        miniouser	Specify the username for the minIO server. Use the value that you specified for the MINIO_USERNAME variable in the baas-options.sh file.
        miniopassword	Specify the password for the minIO user. Use the value that you specified for the MINIO_PASSWORD variable in the baas-options.sh file.

Before you can install Container Backup Support in the OpenShift web console, you must create custom resource definitions (CRDs) for Container Backup Support and Kafka.

1. Change to the installation directory by issuing the following command:

   cd ~/installer/ibm-spectrum-protect-plus-prod/ibm_cloud_pak/pak_extensions/install

2. Apply the CRDs by issuing the following command:

   ./baas-crd-apply.sh

After you set up your environment to pull images from the IBM Entitled Registry, created the baas project, and created image pull and credentials secrets, you can install Container Backup Support from the OpenShift web console.

1. Log on to the OpenShift web console as the cluster administrator.
2. Select the Developer perspective and click Add > Helm Chart.
3. Ensure that the baas project is selected in the Project list.
   
4. On the Developer Catalog page, click the IBM Spectrum Protect Plus Prod v1.2.1 tile.
   
5. On the IBM Spectrum Protect Plus Prod v1.2.1 description page, click Install Helm Chart.
6. On the Install Helm Chart page, provide the configuration values to use for the installation of Container Backup Support. You can use either the YAML view or Form view method:

   Method	Steps
   By using the YAML view	For best results, use the YAML view to paste the contents of your custom baas-values.yaml file. This method can be less error-prone than the Form view method. Click YAML view. Copy the contents of the baas-values.yaml file that you customized and paste the contents to the YAML editor. The following text block shows sample content from a baas-values.yaml file: license: true isOCP: true clusterName: example-cluster networkPolicy: clusterAPIServerips: - 198.51.100.1 - 198.51.100.2 - 198.51.100.3 clusterAPIServerport: 6443 clusterCIDR: 203.0.113.0/24 SPPips: 192.0.2.83 SPPport: 443 productLoglevel: INFO imageRegistry: cp.icr.io/cp imageRegistryNamespace: sppc minioStorageClass: example-csi-rbd veleroNamespace: spp-velero Tip: You can replace all the contents in the YAML editor with these statements. Any values that are not specified here will come from the values.yaml file. You can also add any other variables from the values.yaml file to the YAML editor. For information about the parameters that are used, see Table 2.
   By using the Form view	Manually enter the configuration values that you set up in the bass-values.yaml file by completing the following steps: Click Form view. To view the configuration values, expand the IBM Spectrum Protect Plus Container Backup Support twistie. The configuration values that are used for Container Backup Support are listed in hierarchical order. The listed values are a subset of all the values in the values.yam file. Review the configuration parameters and replace the listed values with the values that you customized in the baas-values.yaml file. Descriptions of the parameters are provided. To view a nested section, expand a twistie. To search for a parameter, expand all the twisties, press Ctrl+F and enter the search term. For more information about the configuration values in the baas-values.yaml file, see Table 2

7. Review your updates and click Install.

Results

You can review the status of the installation and manage Container Backup Support components by using the OpenShift web console. The following figure shows the topology view of the Container Backup Support containers as they are being installed.