Upgrading foundational services online

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

Supported upgrade paths

You can upgrade only the following supported paths:

Table 1. Upgrade paths
Upgrade from Upgrade to Description Steps
Version 4.x or later A newer continuous delivery version (4.x or later) Create new CatalogSource, and update channel and CatalogSource for operator's subscription Upgrading from version 4.x or later to the newer continuous delivery version (4.x or later)
Version 3.x or later A newer continuous delivery version (4.x or later) Migrate from foundational services version 3.x.x to version 4.x.x Migrating foundational services version 3.x to 4.x

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

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

Upgrading foundational services Cert-Manager and Licensing Service

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

  2. Update the ibm-licensing-catalog catalogsource for the most recent release version.

     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       name: ibm-licensing-catalog
       namespace: openshift-marketplace
     spec:
       displayName: ibm-licensing-4.1.0
       publisher: IBM
       sourceType: grpc
       image: icr.io/cpopen/ibm-licensing-catalog
       updateStrategy:
         registryPoll:
           interval: 45m
    
  3. Update the ibm-cert-manager-catalog catalogsource for the most recent release version.

     apiVersion: operators.coreos.com/v1alpha1
     kind: CatalogSource
     metadata:
       name: ibm-cert-manager-catalog
       namespace: openshift-marketplace
     spec:
       displayName: ibm-cert-manager-4.1.0
       publisher: IBM
       sourceType: grpc
       image: icr.io/cpopen/ibm-cert-manager-operator-catalog
       updateStrategy:
         registryPoll:
           interval: 45m
    
  4. Download the cp3pt0-deployment folder, from the installer_scripts folder in the CASE bundle. For information on downloading the scripts, see Downloading scripts for additional configuration from specific version CASE bundle.

    Go to your downloaded installer_scripts directory.

    cd ${installer_scripts}/cp3pt0-deployment
    
  5. Read the script usage instructions by passing the -h flag to the script.

     ./setup_singleton.sh -h
    

    Note: You can specify the required subscription channel v4.x as the command argument to upgrade Cert Manager or Licensing Service version to v4.x.x. For example, if you need to upgrade the Cert Manager or Licensing Service version to 4.1, specify -c v4.1 as the command argument.

  6. Run the script by passing the parameters.

    Note: You must provide the --license-accept parameters.

     ./setup_singleton.sh --license-accept \
       --enable-licensing \
       -c v4.1 \
    

Upgrading foundational services

You can upgrade the foundational services with one of the following methods:

Upgrading foundational services with the script

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

  2. 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
    
  3. Download the cp3pt0-deployment folder, from the installer_scripts folder in the CASE bundle. For information on downloading the scripts, see Downloading scripts for additional configuration from specific version CASE bundle.

    Go to your downloaded installer_scripts directory.

    cd ${installer_scripts}/cp3pt0-deployment
    
  4. Read the script usage instructions by passing the -h flag to the script.

     ./setup_tenant.sh -h
    

    Note: You can specify the required subscription channel v4.x as the command argument to upgrade Cert Manager or Licensing Service version to v4.x.x. For example, if you need to upgrade the Cert Manager or Licensing Service version to 4.1, specify -c v4.1 as the command argument.

  5. Run the script by passing the parameters.

    Note: You must provide the --license-accept and --operator-namespace parameters.

     ./setup_tenant.sh --license-accept \
       --enable-licensing \
       --operator-namespace <foundational-services-namespace> \
       -c v4.1 \
       -i Automatic \
       -s opencloud-operators \
       -n openshift-marketplace \
       -v 1
    

Upgrading foundational services with the console

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

  2. 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
    
  3. Click Operators > Installed Operators > IBM Cloud Pak foundational services > Subscription.

  4. Click Update channel and select the required subscription channel version to upgrade the foundational services.

    Note: You can specify the required subscription channel v4.x in the Update channel to upgrade the foundational services (ibm-common-service-operator) version to v4.x.x. For example, if you need to upgrade the foundational services version to 4.1, specify v4.1 in the Update channel.

Approval strategy for future upgrades

You can decide on the approval strategy for future upgrades by setting the InstallPlanApproval parameter in the custom resource to either Automatic or Manual, as 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.