Online upgrade of Infrastructure Automation

This procedure can be used on an online deployment of Infrastructure Automation, and can still be used if the deployment has had hotfixes applied. If you have an offline deployment, follow the instructions in Offline upgrade of Infrastructure Automation.

There are restrictions on which releases you can upgrade from. For more information, see Upgrade paths.

• Ensure that you are logged in to your Red Hat OpenShift Container Platform cluster with oc login for any steps that use the Red Hat OpenShift Container Platform command-line interface (CLI).
• Red Hat OpenShift requires a user with cluster-admin privileges for the Update the operator subscription step.
• The upgrade cannot be removed or rolled back.
• Ensure that you back up the CAM (Cloud Automation Manager). This must specifically include a backup of cam-mongo.
• If you have set up IBM Infrastructure Management integrations, follow these steps to upgrade.
  1. Run the following commands:

     oc project <installed_namespace>
     
     oc scale deploy aiops-connector --replicas=0

  2. The upgrade takes a few minutes to complete. When the upgrade completes, run the following command.

     oc scale deploy aiops-connector --replicas=1

Follow these steps to upgrade your online Infrastructure Automation deployment.

1. Verify cluster readiness
2. Configure the new catalogs
3. Update the operator subscription
4. Verify the deployment
5. Post upgrade actions

1. Ensure that your cluster still meets all the prerequisites for deployment. For more information, see Planning.

2. Run the following command to set the environment variable that you need for upgrade.

   export PROJECT_IA=<project>
   

   Where <project> is the namespace (project) that Infrastructure Automation is deployed in.

From Infrastructure Automation 4.13.0, the ibm-operator-catalog is no longer used. IBM Cloud Pak foundational services Cert Manager and License Service are deployed using their own independent catalogs, and a new catalog called ibm-aiops-ia-catalog is used for the remaining Infrastructure Automation operators. For more information, see Whats New.

1. Run the following command to create the new Infrastructure Automation and IBM Cloud Pak foundational services Cert Manager and License Service catalog sources in the openshift_marketplace namespace.

   cat << EOF | oc apply -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: ibm-aiops-ia-catalog
     namespace: openshift-marketplace
   spec:
     displayName: ibm-aiops-ia-catalog
     publisher: IBM Content
     sourceType: grpc
     image: icr.io/cpopen/ibm-aiops-ia-catalog@sha256:18320b689a5f779a8ca3eafae5ce068a0d27d9883d71069df8a6258394d6116a
   ---
   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: ibm-cert-manager-catalog
     namespace: openshift-marketplace
   spec:
     displayName: ibm-cert-manager
     publisher: IBM
     sourceType: grpc
     image: icr.io/cpopen/ibm-cert-manager-operator-catalog@sha256:97610d00d5b46b4de8d3c98233591cc554b7211d96f3d30ed935a84f076e3b65
   ---
   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: ibm-licensing-catalog
     namespace: openshift-marketplace
   spec:
     displayName: IBM License Service Catalog
     publisher: IBM
     sourceType: grpc
     image: icr.io/cpopen/ibm-licensing-catalog@sha256:734017cedb6605a4aba3a2de54c0ccb8e314e7b533ec0e30a362fa315ef8e1dd
   EOF
   

2. Verify that the ibm-aiops-ia-catalog, ibm-cert-manager-catalog and ibm-licensing-catalog CatalogSource objects are in the output that is returned by the following command:

   oc get CatalogSources -n openshift-marketplace

   Example output:

   oc get CatalogSources -n openshift-marketplace
   NAME                     DISPLAY                      TYPE   PUBLISHER   AGE
   ibm-aiops-ia-catalog     ibm-aiops-ia-catalog         grpc   IBM         2m 
   ibm-cert-manager-catalog ibm-cert-manager             grpc   IBM         2m 
   ibm-licensing-catalog    IBM License Service Catalog  grpc   IBM         2m 
   

3. Migrate your subscriptions to use the new catalogs.

   Run the following script from the command line:

   #!/bin/bash
   CLI="oc"
   IA_SUB_PACKAGES=(
       "ibm-infrastructure-automation-operator"
       "ibm-management-im-install"
       "ibm-management-cam-install"
       "ibm-common-service-operator"
       "cloud-native-postgresql"
       "ibm-events-operator"
       "ibm-commonui-operator-app"
       "ibm-iam-operator"
       "ibm-zen-operator"
       "ibm-odlm"
   )         
        
   IA_SUBS=($(${CLI} get subscriptions.operators.coreos.com -n "${PROJECT_IA}" --no-headers=true -o jsonpath="{.items[*].metadata.name}"))
   
   # Update Infrastructure Automation
   for sub in "${IA_SUBS[@]}"; do
       sub_package="$(${CLI} get subscriptions.operators.coreos.com -n "${PROJECT_IA}" "${sub}" -o jsonpath="{.spec.name}")"
       if [[ " ${IA_SUB_PACKAGES[*]} " =~ [[:space:]]${sub_package}[[:space:]] ]]; then
           ${CLI} patch subscriptions.operators.coreos.com -n "${PROJECT_IA}" "${sub}" --type='json' -p='[{"op": "replace", "path": "/spec/source", "value": "'ibm-aiops-ia-catalog'"}]'
       fi
   done
      
   # Update Cert Manager   
   ${CLI} patch subscriptions.operators.coreos.com -n "ibm-cert-manager" "ibm-cert-manager-operator" --type='json' -p='[{"op": "replace", "path": "/spec/source", "value": "'ibm-cert-manager-catalog'"}]'
      
   # Update License Service    
   ${CLI} patch subscriptions.operators.coreos.com -n "ibm-licensing" "ibm-licensing-operator-app" --type='json' -p='[{"op": "replace", "path": "/spec/source", "value": "'ibm-licensing-catalog'"}]'
   

1. Update the spec.channel value of the Infrastructure Automation operator to v4.13.

   oc patch sub ibm-infrastructure-automation-operator -n ${PROJECT_IA} --type=json -p='[{'op': 'replace', 'path': '/spec/channel', 'value': 'v4.13'}]'

   Important: Do not update the Infrastructure Management or Managed Services subscriptions (ibm-management-im-install and ibm-management-cam-install).

2. Run the following command to check the status of the ibm-infrastructure-automation-operator upgrade.

   oc -n ${PROJECT_IA} get csv | grep ibm-infrastructure-automation-operator.v4.13.0

   Example output if you are upgrading from Infrastructure Automation 4.12.0:

   ibm-infrastructure-automation-operator.v4.13.0   IBM Infrastructure Automation                    4.13.0    ibm-infrastructure-automation-operator.v4.12.0   Succeeded

   Example output if you are upgrading from Infrastructure Automation 4.11.0 or 4.11.1:

   ibm-infrastructure-automation-operator.v4.13.0   IBM Infrastructure Automation                    4.13.0    ibm-infrastructure-automation-operator.v4.11.0   Succeeded

   or

   ibm-infrastructure-automation-operator.v4.13.0   IBM Infrastructure Automation                    4.13.0    ibm-infrastructure-automation-operator.v4.11.1   Succeeded

3. Run the following command to check the status of the zenservice upgrade.

   oc -n ${PROJECT_IA} describe zenservice | grep -iE 'version|progress' | grep -v "API Version" | grep -v "Resource Version"

   Example output for the zenservice upgrade if you are upgrading from Infrastructure Automation 4.12.0:

   Current Version:             6.2.2
   Progress:                    4%
   Progress Message:            Finished Configure Variables
   Supported Operand Versions:  6.4.0
   Zen Status:                  InProgress

   Example output when the zenservice upgrade is in progress from Infrastructure Automation 4.11.0 or 4.11.1:

   Current Version:             5.1.17
   Progress:                    4%
   Progress Message:            Finished Configure Variables
   Supported Operand Versions:  6.4.0
   Zen Status:                  InProgress

   Example output when the zenservice upgrade is complete from Infrastructure Automation 4.11.0, 4.11.1, or 4.12.0:

   Current Version:   6.4.0
   Progress:          100%
   Progress Message:  The Current Operation Is Completed
   Supported Operand Versions:  6.4.0

   Do not proceed until Current Version is 6.4.0 and Progress is 100%.

1. Clear your browser cache. Failure to do so will result in the error 502 Bad Gateway when viewing the Library, Instances, and Manage pages.

2. If you previously setup backup or restore on your deployment, then you must follow the instructions in Upgrading Infrastructure Automation backup and restore artifacts.