Preparing to install the IBM Spectrum Protect Plus operator from the IBM Entitled Registry

You must complete prerequisite tasks before you can install the IBM Spectrum® Protect Plus operator from an online registry such as the IBM® Entitled Registry.

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.

  1. Creating an image pull secret for IBM Spectrum Protect Plus
  2. Adding the catalog source for IBM Spectrum Protect Plus
  3. Creating a project for IBM Spectrum Protect Plus

Creating an image pull secret for IBM Spectrum Protect Plus

Create an image pull secret to enable the OpenShift cluster to authenticate with the IBM Entitled Registry. The image pull secret provides the credentials for pulling Docker images from the IBM Entitled Registry.

Before you begin

Before you can pull Docker images from the IBM Entitled Registry, you must obtain an entitlement key for accessing your container software. To obtain an entitlement key:

  1. Log in to the IBM Container software library with the IBMid and password that are associated with the entitled software.
  2. Click Get entitlement key.
  3. In the Access your container software page, click Copy key to copy the generated entitlement key.
  4. Save the key to a secure location for later use.

Procedure

To create an image pull secret, complete the following steps:

  1. Log on to the OpenShift web console as the cluster administrator.
  2. In the navigation pane, click Workloads > Secrets.
  3. On the Secrets page, click Create > Image Pull Secret.
  4. Ensure that the project is created in the openshift-marketplace project by clicking Project > openshift-marketplace.
  5. On the Create Image Pull Secret page, enter ibmspp-image-secret for the name of the secret.
  6. Create the image pull secret by using one of the following methods:
    • Upload a configuration file that contains the credentials for the IBM Entitled Registry:
      1. In the Authentication Type list, click Upload Configuration File.
      2. Browse and select an existing configuration file, or copy and paste the credentials from an existing configuration file into the text box.
      3. Click Create.
    • Manually enter the credentials for the IBM Entitled Registry:
      1. In the Authentication Type list, click Image Registry Credentials.
      2. In the Registry Server Address field, enter the address for the IBM Entitled Registry: cp.icr.io/cp/sppserver
      3. In the Username field, enter cp.
      4. In the Password field, enter the entitlement key that you obtained.
      5. Click Create.

Adding the catalog source for IBM Spectrum Protect Plus

Before you can install the IBM Spectrum Protect Plus operator, you must add the catalog source for the operator to the OpenShift web console.

Procedure

Apply the following configuration by using the command line or the OpenShift web console: 
apiVersion: operators.coreos.com/v1alpha1
kind: CatalogSource
metadata:
  name: ibm-spp-operator
  namespace: openshift-marketplace
spec:
  displayName: IBM SPP Operator
  image: 'image_path'
  publisher: IBM
  secrets:
    - ibmspp-image-secret
  sourceType: grpc
  updateStrategy:
    registryPoll:
      interval: 45m
where:
image_path
Specifies the location for the operator images. Ensure that the image path is enclosed in single quotation marks.
  • If you are installing the operator in a standard OpenShift cluster environment, specify: ibmcom/spp-operator-catalog:latest
  • If you are installing the operator in the IBM Cloud Pak for Multicloud Management environment, specify: ibmcom/ibm-mcm-spp-operator-catalog:latest
Tip: To add the catalog source at the command line, create a YAML file that contains the configuration. Then, issue the following command:
oc apply -f filename.yaml
where filename specifies the name of the YAML file that you created.

Creating a project for IBM Spectrum Protect Plus

You must create a project (namespace) for IBM Spectrum Protect Plus in the OpenShift web console. Then, create the image pull secret for IBM Spectrum Protect Plus (ibmspp-image-secret) in this project.

About this task

The project is where the operator and instance of the IBM Spectrum Protect Plus server will be installed.

Procedure

  1. Log on to the OpenShift web console as the cluster administrator.
  2. In the navigation pane, click Home > Projects > Create project.
  3. In the Create Project window, enter a name for the project.
  4. Optional: Enter a display name and description for the project.
  5. Click Create to create the project.
  6. Create the image pull secret for IBM Spectrum Protect Plus (ibmspp-image-secret) in this project. This secret is the same pull secret that you created in Creating an image pull secret for IBM Spectrum Protect Plus.
    1. In the navigation pane, click Workloads > Secrets.
    2. On the Secrets page, click Create > Image Pull Secret.
    3. Ensure that the project you created for IBM Spectrum Protect Plus is selected in the Project menu.
    4. On the Create Image Pull Secret page, enter ibmspp-image-secret for the name of the secret.
    5. Create the image pull secret by using the credentials for the IBM Entitled Registry.
      For more information, see Step 6 of Creating an image pull secret for IBM Spectrum Protect Plus.

Results

The IBM Spectrum Protect Plus operator is available in the OpenShift web console in the project that you created for IBM Spectrum Protect Plus.

What to do next

Install the IBM Spectrum Protect Plus operator. For instructions, see Installing the IBM Spectrum Protect Plus operator in an online environment.