Upgrading foundational services from an operator release

You can upgrade foundational services that were installed in a prior release.

Supported upgrade paths

You can upgrade only the following supported paths:

Note the following versions:

Table 1. Upgrade paths
Upgrade from Upgrade to Description Steps
Version 3.8.x or later A latest continuous delivery version (3.20.x or later) Run script to switch channel and add the ibm-operator-catalog tag of the version that you want to upgrade to. Upgrading from version 3.8.x or later to the latest continuous delivery version (3.20.x or later)
Version 3.8.x or later A specific continuous delivery version (3.19.x LTSR and prior version) Add the ibm-operator-catalog tag of the version that you want to upgrade to. For the tags that you can add, see the version-specific installation topic: Installing IBM Cloud Pak foundational services online.
Version 3.6.x or 3.7.x Latest continuous delivery version (3.20.x or later) From version 3.8.0 onwards, the catalog source is migrated to ibm-operator-catalog. You must update the current catalog source image and create the ibm-operator-catalog image with the latest tag.
Version 3.7.x 3.19.x LTSR From version 3.8.0 onwards, the catalog source is migrated to ibm-operator-catalog. You must update the current catalog source image and create the ibm-operator-catalog image with the latest tag. Upgrading from version 3.7.x to version 3.19.x (LTSR), and migrating to ibm-operator-catalog
Version EUS 3.6.x 3.19.x LTSR You can upgrade from 3.6.x to 3.19.x LTSR. Upgrading from EUS version 3.6.x to version 3.19.x (LTSR), and migrating to ibm-operator-catalog
Version 3.6.x Version 3.7.x If you had set the installer catalog source image tag to a specific version during installation, you must update the tag with the version set to 3.7.x. Upgrading from EUS version 3.6.x to continuous delivery version 3.7.x
Version 3.4.x or 3.5.x Version 3.6.x
  • If you installed foundational services version 3.4.x or 3.5.x on an Red Hat® OpenShift® Container Platform version 4.5 cluster, and had set the catalog source image tag as latest, the foundational services are automatically upgraded to installer version 3.6.x. No manual step is required for the upgrade.
  • If you had set the installer catalog source image tag to a specific version during installation, you must update the tag with the version that you want to upgrade to. Or, you can change the tag to latest to automatically complete future upgrades to the most current version.

Note: If you are upgrading to foundational services version 3.6.x and encounter an issue during the upgrade, see Operand Deployment Lifecycle Manager cannot update when upgrading to version 3.6.x.
Upgrading from version 3.4.x and 3.5.x to version 3.6.x
Version 1.1.0 Version 3.6.x If you installed foundational services version 1.1.0 on an Red Hat® OpenShift® Container Platform version 4.2 cluster, you must first upgrade the Red Hat® OpenShift® Container Platform version to 4.5 or 4.6. Foundational services version 3.6.x is supported on Red Hat® OpenShift® Container Platform 4.5 and 4.6 only. Upgrading from version 1.1.0 to version 3.6.x

During the upgrade process, you cannot access the services management console.

Note: After you upgrade the services, if you see multiple instances of a service, see the related Installer known issue.

Upgrading to the latest continuous delivery version, and migrating to ibm-operator-catalog

Note: When you migrate to ibm-operator-catalog, foundational services are upgraded to the latest continuous delivery version.

Note: After you upgrade from version 3.6.x or 3.7.x to 3.8.x or higher, some monitoring service resources might remain in your cluster. To manually remove these resources, see Monitoring resources not cleaned up.

Upgrading from version 3.8.x or later to the latest continuous delivery version (3.20.x or later)

  1. Log in to the cluster as an administrator by using the oc login command.

  2. Download the upgrade script online to your local device.

    https://raw.githubusercontent.com/IBM/ibm-common-service-operator/scripts/upgrade_common_services.sh
    
  3. Read the following script instructions:

    ✗ ./upgrade_common_services.sh -h
    Usage: upgrade_common_services.sh [OPTION]...
    Upgrade Common Services
    
    Options:
    Mandatory arguments to long options are mandatory for short options too.
        -h, --help                    display this help and exit
        -a                            enable to upgrade all Common Service instances in the cluster. By default it upgrades the common service only in ibm-common-services namespace
        -csNS                         specify the namespace where common service is installed. By default it is namespace ibm-common-services.
        -cloudpaksNS                  specify the namespace where cloud paks is installed. By default it would be same as csNS.
        -controlNS                    specify the namespace where singleton services are installed. By default it would be same as csNS.
        -c                            specify the subscription channel where common services switch. By default it is channel v3. 
        -sub                          specify the subscription name if it is not ibm-common-service-operator
    

    Note: You can specify these subscription channels for upgrade: v3 (default; this channel is version 3.19.x LTSR), v3.20, v3.21, v3.22, or v3.23.

    • For upgrading to version 3.23.x, specify v3.23
    • For upgrading to version 3.22.x, specify v3.22
    • For upgrading to version 3.21.x, specify v3.21
    • For upgrading to version 3.20.x, specify v3.20
  4. Check whether the following scenarios are applicable before running the script

    • If you installed foundational services by default, it is in IBM Cloud Paks and in the ibm-common-services namespace. Add all the namespaces flag and channel version to the command. If you want to upgrade foundational services to version {{site.data.keyword.cs_channel}}, run the following script:

       ./upgrade_common_services.sh -a -c {{site.data.keyword.cs_channel}}
      
      • If you installed foundational services in specific namespaces, add the namespaces and channel version to the command. For example, if you want to upgrade foundational services in a IBM Cloud Pak namespace cp4i and foundational services namespace cp4i-cs to version {{site.data.keyword.cs_channel}}, run the following command:

        ./upgrade_common_services.sh -cloudpaksNS cp4i -csNS cp4i-cs -c {{site.data.keyword.cs_channel}}
        
    • If you installed foundational services in multi-instances mode, and you want to upgrade one instance of foundational services, add the namespaces and channel version to the command. For example, if you want to upgrade foundational services in a IBM Cloud Pak namespace cp4i, foundational services namespace cp4i-cs, control Namespace for shared singleton services cs-control to version {{site.data.keyword.cs_channel}}, run the following command:

       ./upgrade_common_services.sh -cloudpaksNS cp4i -csNS cp4i-cs -controlNS cs-control -c {{site.data.keyword.cs_channel}}
      
  5. Add the ibm-operator-catalog tag of the version that you want to upgrade

    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: ibm-operator-catalog
      namespace: openshift-marketplace
    spec:
      displayName: ibm-operator-catalog
      publisher: IBM Content
      sourceType: grpc
      image: icr.io/cpopen/ibm-operator-catalog:latest
      updateStrategy:
        registryPoll:
          interval: 45m
    

Upgrading from version 3.7.x to the latest continuous delivery version (3.20.x or later), and migrating to ibm-operator-catalog

  1. Log in to the cluster as an administrator by using the oc login command.

  2. Download the upgrade script online to your local device.

    https://raw.githubusercontent.com/IBM/ibm-common-service-operator/scripts/upgrade_common_services.sh
    
  3. Read the following script instructions:

    ✗ ./upgrade_common_services.sh -h
    Usage: upgrade_common_services.sh [OPTION]...
    Upgrade Common Services
    
    Options:
    Mandatory arguments to long options are mandatory for short options too.
        -h, --help                    display this help and exit
        -a                            enable to upgrade all Common Service instances in the cluster. By default it upgrades the common service only in ibm-common-services namespace
        -csNS                         specify the namespace where common service is installed. By default it is namespace ibm-common-services.
        -cloudpaksNS                  specify the namespace where cloud paks is installed. By default it would be same as csNS.
        -controlNS                    specify the namespace where singleton services are installed. By default it would be same as csNS.
        -c                            specify the subscription channel where common services switch. By default it is channel v3
        -sub                          specify the subscription name if it is not ibm-common-service-operator
    

    Note: You can specify these subscription channels for upgrade: v3 (default; this channel is version 3.19.x LTSR), v3.20, v3.21, v3.22, or v3.23.

    • For upgrading to version 3.23.x, specify v3.23
    • For upgrading to version 3.22.x, specify v3.22
    • For upgrading to version 3.21.x, specify v3.21
    • For upgrading to version 3.20.x, specify v3.20
  4. Check whether the following scenarios are applicable before running the script:

    • If you installed foundational services by default, it is in IBM Cloud Paks and in the ibm-common-services namespace. Add all the namespaces flag and channel version to the command. If you want to upgrade foundational services to version {{site.data.keyword.cs_channel}}, run the following script:

       ./upgrade_common_services.sh -a -c {{site.data.keyword.cs_channel}}
      
      • If you installed foundational services in specific namespaces, add the namespaces and channel version to the command. For example, if you want to upgrade foundational services in a IBM Cloud Pak namespace cp4i and foundational services namespace cp4i-cs to version {{site.data.keyword.cs_channel}}, run the following command:

        ./upgrade_common_services.sh -cloudpaksNS cp4i -csNS cp4i-cs -c {{site.data.keyword.cs_channel}}
        
    • If you installed foundational services in multi-instances mode, and you want to upgrade one instance of foundational services, add the namespaces and channel version to the command. For example, if you want to upgrade foundational services in a IBM Cloud Pak namespace cp4i, foundational services namespace cp4i-cs, control Namespace for shared singleton services cs-control to version {{site.data.keyword.cs_channel}}, run the following command:

       ./upgrade_common_services.sh -cloudpaksNS cp4i -csNS cp4i-cs -controlNS cs-control -c {{site.data.keyword.cs_channel}}
      
  5. Update the opencloud-operator catalogsource to latest for the most recent release version.

    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: opencloud-operators
      namespace: openshift-marketplace
    spec:
      displayName: IBMCS Operators
      publisher: IBM
      sourceType: grpc
      image: icr.io/cpopen/ibm-common-service-catalog:latest
      updateStrategy:
        registryPoll:
          interval: 45m
    
  6. Create or update the ibm-operator-catalog source with the same version tag that you used in the previous step for the opencloud-operator catalogsource.

    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: ibm-operator-catalog
      namespace: openshift-marketplace
    spec:
      displayName: ibm-operator-catalog
      publisher: IBM Content
      sourceType: grpc
      image: icr.io/cpopen/ibm-operator-catalog:latest
      updateStrategy:
        registryPoll:
          interval: 45m
    
  7. After ibm-common-service-operator upgrades to the higher version, check the subscription of ibm-common-service-operator to verify that the catalog source is ibm-operator-catalog.

    oc -n ibm-common-services get subscription | grep ibm-common-service-operator
    

    If the catalog source is not ibm-operator-catalog, edit the subscription of ibm-common-service-operator to update the catalog source to ibm-operator-catalog.

    1. Get the ibm-common-service-operator subscription name.

      oc -n ibm-common-services get subscription | grep ibm-common-service-operator
      
    2. Update the catalog source to ibm-operator-catalog in the subscription of ibm-common-service-operator.

      oc -n ibm-common-services edit subscription <subscription name>
      
      ...
      source: ibm-operator-catalog
      ...
      
  8. To remove the opencloud-operators CatalogSource that you created in a previous version, run the following command:

    oc -n openshift-marketplace delete catalogsource opencloud-operators --ignore-not-found
    

Upgrading from EUS version 3.6.x to version 3.19.x (LTSR), and migrating to ibm-operator-catalog

Note: Migrating CatalogSource to ibm-operator-catalog is optional. Therefore, if you are not migrating to ibm-operator-catalog, you do not have to complete the steps that are marked Optional.

Note: To determine if a CatalogSource migration is required, check your specific IBM Cloud Pak documentation.

  1. Update the opencloud-operator catalogsource to latest for the most recent release version.

    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: opencloud-operators
      namespace: openshift-marketplace
    spec:
      displayName: IBMCS Operators
      publisher: IBM
      sourceType: grpc
      image: icr.io/cpopen/ibm-common-service-catalog:latest
      updateStrategy:
        registryPoll:
          interval: 45m
    
  2. Optional: Create or update the ibm-operator-catalog source with the same version tag that you used in the previous step for the opencloud-operator catalogsource.

    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: ibm-operator-catalog
      namespace: openshift-marketplace
    spec:
      displayName: ibm-operator-catalog
      publisher: IBM Content
      sourceType: grpc
      image: icr.io/cpopen/ibm-operator-catalog:latest
      updateStrategy:
        registryPoll:
          interval: 45m
    
  3. You can upgrade by using a script or by using OpenShift console.

    Upgrading by using a script

    1. Log in to the cluster as an administrator by using the oc login command.

    2. To upgrade to version 3.19.x, run the following script:

      curl -s https://raw.githubusercontent.com/IBM/ibm-common-service-operator/scripts/upgrade_to_continuous_delivery.sh | bash
      

      If you want to upgrade foundational services only in specific namespaces, add the namespaces to the command. For example, if you want to upgrade foundational services in cp4i and cp4mcm namespaces, you would run the following command:

      Note: Foundational services that are installed in the default namespace are always upgraded whether or not you add the default namespace to the command.

      curl -s https://raw.githubusercontent.com/IBM/ibm-common-service-operator/scripts/upgrade_to_continuous_delivery.sh | bash -s cp4i cp4mcm
      

      After the script successfully runs, the subscription of IBM Cloud Pak foundational services is updated to the v3 channel and the foundational services are automatically upgraded to installer version 3.19.x.

    Upgrading by using the OpenShift console

    1. Log in to your Red Hat® OpenShift® Container Platform console.

    2. Upgrade the subscription of IBM Cloud Pak foundational services operator that you created.

      1. From the navigation pane, click Home > Search. The Search window is displayed.
      2. In the Project field, type the name of the namespace where you installed the IBM Cloud Pak foundational services operator that you want to upgrade.
      3. In the Resource field, enter Subscription. The Subscription is displayed.
      4. Select the ibm-common-service-operator subscription, and switch to the YAML view.
      5. Change the spec.channel to v3.
      6. Delete the following line: spec.startingCSV, if it exists.
      7. Click Save.

      After a few minutes, the IBM Cloud Pak foundational services operator is upgraded in the specified namespace and in the default namespace. To view the installed operators, go to Installed Operators.

  4. Optional: After ibm-common-service-operator upgrades to the higher version, check the subscription of ibm-common-service-operator to verify that the catalog source is ibm-operator-catalog.

    oc -n ibm-common-services get subscription | grep ibm-common-service-operator
    

    If the catalog source is not ibm-operator-catalog, edit the subscription of ibm-common-service-operator to update the catalog source to ibm-operator-catalog.

    1. Get the ibm-common-service-operator subscription name.

      oc -n ibm-common-services get subscription | grep ibm-common-service-operator
      
    2. Update the catalog source to ibm-operator-catalog in the subscription of ibm-common-service-operator.

      oc -n ibm-common-services edit subscription <subscription name>
      
      ...
      source: ibm-operator-catalog
      ...
      
  5. Optional: To remove the opencloud-operators CatalogSource that you created in a previous version, run the following command:

    oc -n openshift-marketplace delete catalogsource opencloud-operators --ignore-not-found
    

Upgrading from EUS version 3.6.x to the latest continuous delivery version (3.20.x or later)

  1. Log in to the cluster as an administrator by using the oc login command.

  2. Download the upgrade script online to your local device:

    https://raw.githubusercontent.com/IBM/ibm-common-service-operator/scripts/upgrade_common_services.sh
    
  3. Read the following script instructions:

    ✗ ./upgrade_common_services.sh -h
    Usage: upgrade_common_services.sh [OPTION]...
    Upgrade Common Services
    
    Options:
    Mandatory arguments to long options are mandatory for short options too.
        -h, --help                    display this help and exit
        -a                            enable to upgrade all Common Service instances in the cluster. By default it upgrades the common service only in ibm-common-services namespace
        -csNS                         specify the namespace where common service is installed. By default it is namespace ibm-common-services.
        -cloudpaksNS                  specify the namespace where cloud paks is installed. By default it would be same as csNS.
        -controlNS                    specify the namespace where singleton services are installed. By default it would be same as csNS.
        -c                            specify the subscription channel where common services switch. By default it is channel v3
        -sub                          specify the subscription name if it is not ibm-common-service-operator
    

    Note: You can specify these subscription channels for upgrade: v3 (default; this channel is version 3.19.x LTSR), v3.20, v3.21, v3.22, or v3.23.

    • For upgrading to version 3.23.x, specify v3.23
    • For upgrading to version 3.22.x, specify v3.22
    • For upgrading to version 3.21.x, specify v3.21
    • For upgrading to version 3.20.x, specify v3.20
  4. Check whether the following scenarios are applicable before running the script:

    • If you installed foundational services by default, it is in IBM Cloud Paks and in the ibm-common-services namespace. Add all the namespaces flag and channel version to the command. If you want to upgrade foundational services to version {{site.data.keyword.cs_channel}}, run the following script:

       ./upgrade_common_services.sh -a -c {{site.data.keyword.cs_channel}}
      
      • If you installed foundational services in specific namespaces, add the namespaces and channel version to the command. For example, if you want to upgrade foundational services in a IBM Cloud Pak namespace cp4i and foundational services namespace cp4i-cs to version {{site.data.keyword.cs_channel}}, run the following command:

        ./upgrade_common_services.sh -cloudpaksNS cp4i -csNS cp4i-cs -c {{site.data.keyword.cs_channel}}
        
    • If you installed foundational services in multi-instances mode, and you want to upgrade one instance of foundational services, add the namespaces and channel version to the command. For example, if you want to upgrade foundational services in a IBM Cloud Pak namespace cp4i, foundational services namespace cp4i-cs, control Namespace for shared singleton services cs-control to version {{site.data.keyword.cs_channel}}, run the following command:

       ./upgrade_common_services.sh -cloudpaksNS cp4i -csNS cp4i-cs -controlNS cs-control -c {{site.data.keyword.cs_channel}}
      
  5. Update the opencloud-operator catalog source to latest.

     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       name: opencloud-operators
       namespace: openshift-marketplace
     spec:
       displayName: IBMCS Operators
       publisher: IBM
       sourceType: grpc
       image: icr.io/cpopen/ibm-operator-catalog:latest
       updateStrategy:
         registryPoll:
           interval: 45m
    
  6. Create or update the ibm-operator-catalog source to latest.

     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       name: ibm-operator-catalog
       namespace: openshift-marketplace
     spec:
       displayName: ibm-operator-catalog
       publisher: IBM Content
       sourceType: grpc
       image: icr.io/cpopen/ibm-operator-catalog:latest
       updateStrategy:
         registryPoll:
           interval: 45m
    
  7. After ibm-common-service-operator upgrades to the continuous delivery version, check the subscription of ibm-common-service-operator to verify that the catalog source is ibm-operator-catalog.

    oc -n ibm-common-services get subscription | grep ibm-common-service-operator
    

    If the catalog source is not ibm-operator-catalog, edit the subscription of ibm-common-service-operator to update the catalog source to ibm-operator-catalog.

    1. Get the ibm-common-service-operator subscription name.

      oc -n ibm-common-services get subscription | grep ibm-common-service-operator
      
    2. Update the catalog source to ibm-operator-catalog in the subscription of ibm-common-service-operator.

      oc -n ibm-common-services edit subscription <subscription name>
      
      ...
      source: ibm-operator-catalog
      ...
      
  8. To remove the opencloud-operators CatalogSource that you created in a previous version, run the following command:

    oc -n openshift-marketplace delete catalogsource opencloud-operators --ignore-not-found
    

Upgrading from version 3.7.x to version 3.19.x (LTSR), and migrating to ibm-operator-catalog

  1. Update the opencloud-operator catalogsource to latest for the most recent release version.

    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: opencloud-operators
      namespace: openshift-marketplace
    spec:
      displayName: IBMCS Operators
      publisher: IBM
      sourceType: grpc
      image: icr.io/cpopen/ibm-common-service-catalog:latest
      updateStrategy:
        registryPoll:
          interval: 45m
    
  2. Create or update the ibm-operator-catalog source with the same version tag that you used in the previous step for the opencloud-operator catalogsource.

    apiVersion: operators.coreos.com/v1alpha1
    kind: CatalogSource
    metadata:
      name: ibm-operator-catalog
      namespace: openshift-marketplace
    spec:
      displayName: ibm-operator-catalog
      publisher: IBM Content
      sourceType: grpc
      image: icr.io/cpopen/ibm-operator-catalog:latest
      updateStrategy:
        registryPoll:
          interval: 45m
    
  3. After ibm-common-service-operator upgrades to the higher version, check the subscription of ibm-common-service-operator to verify that the catalog source is ibm-operator-catalog.

    oc -n ibm-common-services get subscription | grep ibm-common-service-operator
    

    If the catalog source is not ibm-operator-catalog, edit the subscription of ibm-common-service-operator to update the catalog source to ibm-operator-catalog.

    1. Get the ibm-common-service-operator subscription name.

      oc -n ibm-common-services get subscription | grep ibm-common-service-operator
      
    2. Update the catalog source to ibm-operator-catalog in the subscription of ibm-common-service-operator.

      oc -n ibm-common-services edit subscription <subscription name>
      
      ...
      source: ibm-operator-catalog
      ...
      
  4. To remove the opencloud-operators CatalogSource that you created in a previous version, run the following command:

    oc -n openshift-marketplace delete catalogsource opencloud-operators --ignore-not-found
    

Upgrading from EUS version 3.6.x to continuous delivery version 3.7.x

From version 3.7.x onwards, Common services are renamed as Foundational services. The IBM Common Service Operator is also renamed as IBM Cloud Pak foundational services.

Important: Before you upgrade the foundational services installer version, make sure that the installer catalog source image has the correct tag. For more information, see Updating the installer catalog source image tag.

Foundational services version 3.6.x is the EUS version. For more information, see Extended Update Support (EUS) for IBM Cloud Pak foundational services.

You can upgrade from version 3.6.x to 3.7.x either by using a script or the OpenShift console.

Upgrading by using a script

Complete the following steps to upgrade to foundational services version 3.7.x by using a script:

  1. Log in to the cluster as an administrator by using the oc login command.

  2. To upgrade to version 3.7.x, run the following script.

    curl -s https://raw.githubusercontent.com/IBM/ibm-common-service-operator/scripts/upgrade_to_continuous_delivery.sh | bash
    

    If you want to upgrade foundational services only in specific namespaces, add the namespaces to the command. For example, if you want to upgrade foundational services in cp4i and cp4mcm namespaces, you would run the following command:

    Note: Foundational services that are installed in the default namespace are always upgraded whether or not you add the default namespace to the command.

    curl -s https://raw.githubusercontent.com/IBM/ibm-common-service-operator/scripts/upgrade_to_continuous_delivery.sh | bash -s cp4i cp4mcm
    
  3. After the script successfully runs, the subscription of IBM Cloud Pak foundational services is updated to the v3 channel and the foundational services are automatically upgraded to installer version 3.7.x.

Upgrading by using the OpenShift console

Complete the following steps to upgrade to version 3.7.x by using the OpenShift console:

  1. Log in to your Red Hat® OpenShift® Container Platform console.

  2. Upgrade the subscription of IBM Cloud Pak foundational services operator that you created.

    1. From the navigation pane, click Home > Search. The Search window is displayed.
    2. In the Project field, type the name of the namespace where you installed the IBM Cloud Pak foundational services operator that you want to upgrade.
    3. In the Resource field, enter Subscription. The Subscription is displayed.
    4. Select the ibm-common-service-operator subscription, and switch to the YAML view.
    5. Change the spec.channel to v3.
    6. Delete the following line: spec.startingCSV, if it exists.
    7. Click Save.

After a few minutes, the IBM Cloud Pak foundational services operator is upgraded in the specified namespace and in the default namespace. To view the installed operators, go to Installed Operators.

Upgrading from version 3.4.x and 3.5.x to version 3.6.x

Before you upgrade the foundational services installer version, make sure that the installer catalog source image has the correct tag.

To update the tag, complete the following actions.

  1. To update the catalog source image tag, run the following command.

    oc edit catalogsource opencloud-operators -n openshift-marketplace
    
  2. Update the image tag.

    • Change image tag to the specific version of 3.6.x. The 3.6.3 tag is used as an example here:

      spec:
        displayName: IBMCS Operators
        image: 'docker.io/ibmcom/ibm-common-service-catalog:3.6.3'
        publisher: IBM
        sourceType: grpc
        updateStrategy:
          registryPoll:
            interval: 45m
      
    • Change the image tag to latest to automatically upgrade to the most current version.

      spec:
        displayName: IBMCS Operators
        image: 'icr.io/cpopen/ibm-common-service-catalog:latest'
        publisher: IBM
        sourceType: grpc
        updateStrategy:
          registryPoll:
            interval: 45m
      
  3. To check whether the image tag is successfully updated, run the following command:

    oc get catalogsource opencloud-operators -n openshift-marketplace -o jsonpath='{.spec.image}{"\n"}{.status.connectionState.lastObservedState}'
    

    The following sample output has the image tag and its status:

    icr.io/cpopen/ibm-common-service-catalog:latest
    READY%
    

Post-upgrade

Note: These steps are required only if you are upgrading from version 3.4.x to version 3.6.2. If you are upgrading to version 3.6.3 or later, you do not need to complete these steps.

  1. Check whether the cp-console and cp-proxy routes exist in the ibm-common-services namespace by running the following command:

    oc get route -n ibm-common-services
    

    If the cp-proxy route is missing, you might see an Application not available error and be unable to access a IBM Cloud Pak® application. To add the missing route, delete the cp-console route. This action causes the ibm-management-ingress-operator to re-create both routes. To delete the cp-console route, run the following command:

    oc delete route cp-console -n ibm-common-services
    

    After the routes are re-created, you can access your IBM Cloud Pak® application.

Upgrading from version 1.1.0 to version 3.6.x

Important: Before you upgrade the foundational service installer version, make sure that the installer catalog source image has the correct tag. For more information, see Updating the installer catalog source image tag.

  1. Log in to your Red Hat® OpenShift® Container Platform console.

  2. Create a namespace that the installer version 3.6.x can use. For example, ibm-common-services.

  3. Install the IBM Cloud Pak foundational services operator.

    1. Switch to the namespace that you created in the previous step.
    2. From the navigation pane, click Operators > OperatorHub. The OperatorHub page is displayed.
    3. In the All Items field, enter IBM Cloud Pak foundational services. The IBM Cloud Pak foundational services operator is displayed.
    4. Click the IBM Cloud Pak foundational services tile. The IBM Cloud Pak foundational services operator window is displayed.
    5. Click Install. You see the Create Operator Subscription page.
    6. Set Installation Mode to the specific namespace that you created for the IBM Cloud Pak foundational services operator. For example, ibm-common-services.
    7. Set Update Channel to stable-v1.
    8. Set Approval Strategy to Automatic.
    9. Click Subscribe. After a few minutes, the IBM Cloud Pak foundational services operator and the Operand Deployment Lifecycle Manager Operator are installed, and you can see these operators on the Installed Operators page.
  4. Remove the operator source that you created in version 1.1.0.

    oc -n openshift-marketplace delete operatorsource opencloud-operators --ignore-not-found
    
  5. Create a catalog source for version 3.6.x. Use the following IBM Cloud Pak foundational services operator YAML definition.

     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       name: opencloud-operators
       namespace: openshift-marketplace
     spec:
       displayName: IBMCS Operators
       publisher: IBM
       sourceType: grpc
       image: docker.io/ibmcom/ibm-common-service-catalog:latest
       updateStrategy:
         registryPoll:
           interval: 45m
    

    Note: If you want to upgrade to a specific version of the foundational services, you can add the version tag to the catalog source image. For example, image: docker.io/ibmcom/ibm-common-service-catalog:3.6.8. For future upgrades, you can change the tag to the version that you are upgrading to, or set it to latest to always use the most current version.

The Operand Deployment Lifecycle Manager Operator, which you created in version 1.1.0 in the ibm-common-services namespace, updates the installed foundational services to the latest version or to the version that you specified.

Note: If you encounter an issue during the upgrade, see Operand Deployment Lifecycle Manager cannot update when upgrading to version 3.6.x.

Approval strategy for future upgrades

Starting from version 3.8.0, you can decide on the approval strategy for future upgrades by setting the InstallPlanApproval parameter in the custom resource to either Automatic or Manual, if required. For more information, see Configuring IBM Cloud Pak foundational services by using the CommonService custom resource.

Troubleshooting

If you encounter any issue during your upgrade, review the frequently encountered errors to help you troubleshoot your issue. For more information, see Troubleshooting IBM Cloud Pak foundational services install and upgrade and Troubleshooting IBM Cloud Pak foundational services upgrade.