Upgrading instances
Instances in IBM Cloud Pak® for Integration can be upgraded in the Platform UI or the CLI.
Before you begin
Review Upgrading from 2022.2 or Upgrading from 2023.4 before you upgrade an instance. Pay attention to the required order of all upgrades tasks for Cloud Pak for Integration.
You must be a Cloud Pak for Integration administrator to upgrade instances. For more information, see Cloud Pak roles and permissions (if using the Platform UI), or OpenShift roles and permissions (if using the CLI).
Upgrading by using the Platform UI
Complete the steps under "Upgrading instances" in Managing versions and upgrades by using the Platform UI to upgrade instances by using the Platform UI.
Upgrading by using the CLI
Log into your OpenShift cluster with your OpenShift user credentials:
oc login
Get the list of instances that are running on the OpenShift cluster you want to upgrade. For the value of
<custom-resource-kind>
that corresponds to your instance type, see the table at the end of this section:oc get <custom-resource-kind> --all-namespaces
For example:
oc get Dashboard
Identify the instance you want to upgrade so that you can edit the custom resource:
oc edit <custom-resource-kind> <instance-name>
For example:
oc edit Dashboard db-01-quickstart
This opens the custom resource in your default editor.
Enter values for the following:
spec.version
- the instance version to which you want to upgrade. Find the corresponding instance version for a given instance type fin Operator and instance versions for this release.Users can also identify what versions are available for a given instance by reviewing the
status.versions.available
section of the custom resource object.spec.license.license
- After you identify the version to which you want to upgrade, you might need to also update the license.Find the version to which you want to upgrade in the
status.versions.available
section of the custom resource. The licenses that are compatible with each version are also listed there. You can use any license that hasmatchesCurrentType: true
.For example, in the
Dashboard
custom resource, the following section specifies that theL-UAZF-8ZYQDD
license is compatible with the12.0.10
instance channel, and it hasmatchesCurrentType: true
:- name: 12.0.10 licenses: - displayName: IBM App Connect Enterprise 12.0.10.0 link: https://www.ibm.com/support/customer/csol/terms/?id=L-UAZF-8ZYQDD matchesCurrentType: true name: L-UAZF-8ZYQDD
For more information about specific licenses, see Licensing.
Save your changes. The instance begins upgrading.
Get the list of instances that are running on your OpenShift cluster so that you can track the status of the upgrade.
oc get <custom-resource-kind> --all-namespaces
For example:
oc get Dashboard --all-namespaces
Custom resource kinds for each instance type
Instance type | Custom resource kind |
---|---|
Platform UI | PlatformNavigator |
Automation assets | AssetRepository |
Assembly | IntegrationAssembly |
API Connect cluster | APIConnectCluster |
Event Manager | EventEndpointManagement |
Event Gateway | EventGateway |
Event Processing | EventProcessing |
Flink | FlinkDeployment |
Integration dashboard | Dashboard |
Integration design | DesignerAuthoring |
Integration runtime | IntegrationRuntime |
Queue manager | QueueManager |
Messaging server | MessagingServer |
Messaging queue | MessagingQueue |
Messaging channel | MessagingChannel |
Messaging user | MessagingUser |
Kafka cluster | EventStreams |
Kafka topic | KafkaTopic |
Kafka user | KafkaUser |
Kafka Connect runtime | KafkaConnect |
Kafka connector | KafkaConnector |
Enterprise gateway | DataPowerService |
High-speed transfer server | IbmAsperaHsts |
Additional information
While the previous instructions should address your needs around upgrading instances, you can get additional information about specific instance types in the following topics.
- Platform UI
- API Connect cluster
- Integration dashboard, Integration design, and Integration runtime
Upgrading or migrating from previous releases, in the IBM App Connect documentation
- Event Manager
Upgrading, in the IBM Event Endpoint Management documentation
- Event Gateway
Upgrading, in the IBM Event Endpoint Management documentation
- Event Processing
Upgrading, in the IBM Event Processing documentation
- Kafka cluster
Upgrading, in the IBM Event Streams documentation
- High-speed transfer server
- Queue manager
Upgrading the IBM MQ Operator and queue managers, in the IBM MQ documentation