Upgrading from 2022.2
Upgrade IBM Cloud Pak® for Integration from version 2022.2 to 16.1.0 by generating an upgrade plan. To upgrade, you must be a cluster administrator. For more information, see OpenShift Roles and permissions.
- AI test generation is temporarily removed in Cloud Pak for Integration 16.1.0. If you already have AI test generation deployed and you upgrade Cloud Pak for Integration, you will no longer be able to use the feature. You may want to delay upgrade until it becomes available.
- Upgrading to 16.1.0 removes the Grafana instance that is installed by Cloud Pak foundational services. For more information, see Product changes on the 2023.4 "What's new" page.
Before you begin
Upgrading to Cloud Pak for Integration 16.1.0 requires that your installation is already at version 2022.2 or 2023.4. Follow the applicable path for your current version:
Earlier than 2022.2: On the Upgrading page for 2022.2, click the page link for the version from which you are upgrading and follow the procedure. Next, upgrade from 2022.2 to 16.1.0 as described in this topic.
2022.2: Continue with the next section in this topic.
2022.4 and later: Do not use this topic. For instructions, see the "Before you begin" section in Upgrading from 2023.4.
Generating an upgrade plan
Begin the upgrade process by generating an upgrade plan, which guides you through the upgrade of your Cloud Pak for Integration installation to a target version. Initially, use the procedure in Generating an upgrade plan by using the CLI.
- To ensure a successful upgrade, complete all tasks in the order that is provided by the upgrade plan. After you complete each upgrade step, regenerate the upgrade plan to get updated guidance and to validate that you can proceed to the next step.
- Upgrading Cloud Pak for Integration installs the new identity and access management system in Keycloak. The upgrade process does not automatically migrate users from the previous identity and access management system to Keycloak, so you must re-create users as part of the "Configuring the new identity and access management system" step.
When the upgrade plan generation is complete, you get a sequence of tasks (the upgrade plan) that are required for upgrading the Cloud Pak for Integration installation to 16.1.0 . These tasks can include:
Removing integration tracing
Applying the correct fix pack for the 2022.2 release
Upgrading OpenShift to 4.12
Installing the IBM Cloud Pak for Integration operator
Installing the certificate manager
Upgrading the catalog sources and mirroring images for the 16.1.0 release
Upgrading the operators
Upgrading the Cloud Pak foundational services
Upgrading the Platform UI
Configuring the new identity and access management system
Upgrading the instances
Upgrading OpenShift beyond 4.12 (optional)
Cleaning up Cloud Pak foundational services resources
Although the upgrade plan itself provides guidance on completing these tasks, additional information is available in Reference for steps in an upgrade plan.
Generating an upgrade plan by using the CLI
Log in to the Red Hat OpenShift CLI.
oc login
Set the
OPERATOR_NAMESPACE
variable. For<namespace>
, enter the namespace where the operators are installed. When installing in All namespaces on the cluster mode, this namespace will beopenshift-operators
:export OPERATOR_NAMESPACE=<namespace>
For example:
export OPERATOR_NAMESPACE=openshift-operators
Start a local image. The
docker
command runs a check of the specific Cloud Pak for Integration installation and compares the current installed versions of components with the versions that are part of the target version:docker run --platform linux/amd64 --pull=always \ -it -v ${KUBECONFIG:-~/.kube/config}:/kube/config \ --env KUBECONFIG=/kube/config icr.io/cpopen/ibm-integration-upgrade-must-gather:v4 \ --namespace ${OPERATOR_NAMESPACE} \ --to 16.1.0 \ --debug
If you have installed operators in A specific namespace on the cluster mode, go back to the previous step and set the
OPERATOR_NAMESPACE
variable to the namespace for any other A specific namespace on the cluster installation in this cluster. Repeat the command as needed.After you complete each upgrade step, regenerate the upgrade plan to get updated guidance and validate that you can proceed to the next step.
Generating an upgrade plan by using the Platform UI
After you complete the step to upgrade the Platform UI, you can use the Platform UI to regenerate your upgrade plan. Follow the steps in the "Generating an upgrade plan" section of Managing versions and upgrades by using the Platform UI.
Reference for steps in an upgrade plan
While many of the steps that are returned in your upgrade plan provide a direct link to the applicable procedure or provide additional details, you may find it helpful to review the following sections while working through the process.
Removing integration tracing
Effective with Cloud Pak for Integration 16.1.0 , integration tracing (Cloud Pak for Integration Operations Dashboard) is removed. No further updates will be provided. If you have integration tracing deployed, removing it is your first task in the upgrade process.
To remove integration tracing, you need to remove all of the following:
the integration tracing configuration from any integration instance
the integration tracing instance
the Cloud Pak for Integration Operations Dashboard operator.
For instructions on removing these required elements (configuration, instance, and operator), see the upgrade plan that you generated in the "Generating an upgrade plan" step. The upgrade plan confirms that integration tracing is being used and then provides you with the correct sequence of CLI commands to remove it.
Applying the correct fix pack for the 2022.2 release
Apply a fix pack for the 2022.2 release that supports the upgrade process. The upgrade plan explains what the appropriate fix packs are and whether the Cloud Pak for Integration installation meets the requirements. For more information on applying 2022.2 fix packs, see Applying fix packs between major releases.
Installing the IBM Cloud Pak for Integration operator
If your current installation of Cloud Pak for Integration does not have the IBM Cloud Pak for Integration operator, and you have any deployed instance type that uses IBM Cloud Pak foundational services identity and access management, you must install this operator. Follow the procedure in Installing the operators by using the Red Hat OpenShift console.
The upgrade plan confirms whether or not you need to install the operator.
Installing the certificate manager
If you are using API management, install the cert-manager Operator for Red Hat OpenShift, in the cert-manager-operator
namespace (project). For more information, see Installing the cert-manager Operator for Red Hat OpenShift.
Upgrading the catalog sources and mirroring images for the 16.1.0 release
If you have an online installation and are using the IBM Operator Catalog, you can skip this step, because the IBM Operator Catalog polls every 45 minutes.
If you are not using the IBM Operator Catalog (some online installations and all air-gapped installations), update the catalog sources and images for the 16.1.0 release. Complete all tasks in Adding catalog sources to a cluster that are applicable for your environment. When the catalog sources and images are updated with the latest 16.1.0 content, regenerate the upgrade plan to get the next step.
Configuring the new identity and access management system
So that user migration can occur, use one of the following methods for triggering Keycloak installation:
If you already have the Platform UI deployed, and you upgraded it when prompted by the upgrade plan, you have completed this step. The Platform UI triggers the installation of Keycloak automatically during upgrade.
If you do not currently have the Platform UI, deploy it when the upgrade plan prompts you to upgrade users (the "Configuring the new identity and access management system" step). The compute resources of the Platform UI are minimal. The Platform UI automatically triggers the installation of Keycloak when you upgrade Cloud Pak for Integration by using the upgrade plan in Upgrading from 2023.4 or Upgrading from 2022.2. For more information, see Deploying the Platform UI.
Initiate the installation of Keycloak manually. For more information, see Installing the identity and access management system when the Platform UI is not installed.
Migrate your identity and access management configuration. For more information, see Migrating users from IAM to Keycloak.
Important: If you are using API management (IBM API Connect), make sure that the usernames from the identity provider that is used with the previous identity and access management system are preserved correctly when configuring Keycloak. For more information, see the topics on configuring identity providers under Managing users and groups.
Validating that the License Service is still installed
Depending on how you previously installed the License Service, it might have been uninstalled during the upgrade.
Confirm whether or not License Service is still installed:
oc get IBMLicensing -A
If nothing is returned, redeploy by following the instructions in Deploying License Service.
Additional reference
The following topics may be helpful if you need additional detail while completing the steps in the upgrade plan.
Parent topic: