Upgrading your instances
After upgrading to the latest Continuous Delivery (CD) version of the IBM® App Connect Operator, follow these instructions if you need to manually upgrade existing instances of the App Connect Dashboard, App Connect Designer Authoring, Switch Server, Integration Server, and Integration Runtime custom resources. You can generally upgrade by using the Red Hat® OpenShift® web console or CLI, or from the IBM Cloud Pak Platform UI in your IBM Cloud Pak for Integration deployment.
Before you begin
- Ensure that you have cluster administrator authority or have been granted the appropriate role-based access control (RBAC).
- If you are upgrading from a 4.2.0 or earlier Continuous Delivery (CD) release, or a 1.1.x Extended Update Support (EUS) release, review the Upgrade considerations for the Operator for Apache CouchDB and App Connect Designer.
- Review the Upgrade considerations for IBM App Connect instances.
- Review the Upgrade considerations for channels, versions, licenses, Red Hat OpenShift, and IAM.
Close any existing App Connect Dashboard or App Connect Designer instance that is currently open in your browser before you attempt this upgrade.
If an existing instance is currently open in a browser during an upgrade to the latest (fully qualified) operand version, you will observe an error when you try to refresh the Dashboard or Designer page in the browser. As a workaround, reload the Dashboard or Designer instance by using the URL that is presented in the custom resource (CR).
About this task
After the IBM App Connect Operator is upgraded, you must manually upgrade your existing instances if you want to apply custom resources from the latest Operator version. To allow the upgrade to proceed, you must update the version and license settings as follows:
- Ensure that the spec.version value is set to subscribe to the
12.0
or12.0.12
custom resource channel, or is set to a fully qualified version of12.0.12.2-rX
. - Update the spec.license.licence value to an appropriate licence for the Operator version.
Unable to load integrationservers from the cluster: ...
Unable to load integrationruntimes from the cluster: ...
- If you are upgrading to IBM App Connect Operator 7.1.0 or later, the Red Hat OpenShift version that you upgrade to determines which channels or versions are supported for your App Connect Dashboard, App Connect Designer, switch server, integration server, and integration runtime instances. For more information, see Implications for the installed Red Hat OpenShift version.
- If you are using the
AppConnectEnterpriseNonProduction
license entitlement with any of your existing instances that you want to upgrade, you will need to switch to one of the supported12.0.12.2-rX
license entitlements.The IBM App Connect Enterprise Developer Edition license entitlement is not valid for use with channels or versions that resolve to
12.0.12.2-rX
, so if spec.license.use is currently set toAppConnectEnterpriseNonProduction
, you will need to overwrite it with a valid value for12.0.12.2-rX
.The
AppConnectEnterpriseNonProduction
license is valid only for instances at a 12.0.4.0-r2 or earlier version that is supported in the IBM App Connect Operator 6.2.0 or earlier release.
You can upgrade any of your existing App Connect Dashboard, App Connect Designer, integration server, integration runtime, and switch server instances by using the Red Hat OpenShift web console or CLI. You can also upgrade integration servers and integration runtimes directly from the App Connect Dashboard. From the IBM Cloud Pak Platform UI, you can directly upgrade only App Connect Dashboard and App Connect Designer instances.
When you try to upgrade your 12.0.10.0-r1 or earlier Designer and Dashboard instances to 12.0.10.0-r2 or later, depending on the license and IAM settings in the existing CRs, you might need to manually update the CRs to allow the upgrade to proceed. For more information, see IAM implications for upgrading App Connect Designer and App Connect Dashboard instances to 12.0.10.0-r2 or later.
- Upgrading your instances from the Red Hat OpenShift CLI
- Upgrading your instances from the Red Hat OpenShift web console
- Upgrading the Dashboard or Designer from the IBM Cloud Pak Platform UI
- Upgrading integration servers or integration runtimes directly from the App Connect Dashboard
- Useful commands for checking or verifying your versions and license values
Upgrading your instances from the Red Hat OpenShift CLI
Procedure
To upgrade your instances, complete the following steps:
Upgrading your instances from the Red Hat OpenShift web console
Procedure
To upgrade your instances, complete the following steps:
Upgrading the Dashboard or Designer from the IBM Cloud Pak Platform UI
Procedure
To upgrade your App Connect Dashboard and App Connect Designer instances, complete the following steps:
Upgrading integration servers or integration runtimes directly from the App Connect Dashboard
From your App Connect Dashboard instance, you can change the
versions of your integration servers or integration runtimes from the options menu on the tile if
required. This capability provides a way for you to upgrade your integration servers or integration
runtimes after the IBM App Connect Operator has been upgraded.
For more information, see Changing the version of a deployed integration server.
Useful commands for checking or verifying your versions and license values
Use these commands to check your versions and license values if required before upgrading, or to verify that your intended values have been applied after the upgrade.
Example
In these commands, the value of kind can be any of:
Dashboard
, DesignerAuthoring
, SwitchServer
,
IntegrationServer
, or IntegrationRuntime
. (These values are not
case sensitive.) The instanceName variable denotes the name of the instance that
is specified as the metadata.name value.
If necessary, include the -n namespace
setting.
- This command lists existing instances of a specific kind and shows which App Connect versions are running.
The output displays the running App Connect versions in the
RESOLVEDVERSION
column.oc get kind
Examples:
oc get IntegrationServer NAME RESOLVEDVERSION REPLICAS AVAILABLEREPLICAS CUSTOMIMAGES STATUS AGE is-01-quickstart 12.0.5.0-r4 1 1 false Ready 8d des-ma-johndoe-designer 12.0.5.0-r4 1 1 false Ready 5d4h des-leemajor-designer 12.0.5.0-r4 1 1 false Ready 2d1h designer-josie-designer 12.0.5.0-r4 1 1 false Ready 7d3h baton-test-upgrade-server 12.0.5.0-r1-lts 1 1 false Ready 20d
oc get dashboard NAME RESOLVEDVERSION REPLICAS CUSTOMIMAGES STATUS URL AGE db-01-quickstart 12.0.6.0-r1 1 false Ready https://cpd-cp4i.apps.acecc-cd.acme.com/integration/run/integrations/ace-fiona/db-01-quickstart/ 5d7h db-02-quickstart 12.0.6.0-r1 1 false Ready https://cpd-cp4i.apps.acecc-cd.acme.com/integration/run/integrations/ace-fiona/db-02-quickstart/ 4d23h
- This command lists the spec and status settings of an
existing instance and shows what versions can be chosen, and which one is active:
oc get kind instanceName -o yaml
In the output, status.versions.available identifies the available channels and fully qualified versions as well as licensing details, and status.reconciled identifies the App Connect version that is running.
Example:
oc get integrationserver is-01-quickstart -o yaml -n ace-dhruv2 apiVersion: appconnect.ibm.com/v1beta1 kind: IntegrationServer metadata: creationTimestamp: "2022-10-26T09:40:51Z" generation: 1 managedFields: - apiVersion: appconnect.ibm.com/v1beta1 fieldsType: FieldsV1 ... time: "2022-10-26T09:40:51Z" name: is-01-quickstart namespace: ace-dhruv2 resourceVersion: "15831068" uid: b3cb817b-1af9-4a62-98ab-d98fc32831e5 spec: adminServerSecure: true barURL: https://db-01-quickstart-dash:3443/v1/directories/Schedular-1?1989666c-5de3-42f4-b790-ec7be16a61eb configurations: [] createDashboardUsers: true designerFlowsOperationMode: local designerFlowsType: event-driven-or-api-flows enableMetrics: true license: accept: true license: L-APEH-CFZE47 use: AppConnectEnterpriseProduction pod: containers: runtime: resources: limits: cpu: 300m memory: 368Mi requests: cpu: 300m memory: 368Mi replicas: 1 router: timeout: 120s service: endpointType: http version: "12.0" status: availableReplicas: 1 conditions: - lastTransitionTime: "2022-10-31T17:29:23Z" message: integrationserver is ready reason: Deployed status: "True" type: Ready customImages: false endpoints: - name: http endpoint type: api uri: http://is-01-quickstart-http-ace-dhruv2.apps.acecc-cd-410.acme.com - name: https endpoint type: api uri: https://is-01-quickstart-https-ace-dhruv2.apps.acecc-cd-410.acme.com labelSelector: release=is-01-quickstart phase: Ready replicas: 1 supportsTraceCustomResource: true traceEnabled: {} versions: available: channels: - licenses: - displayName: IBM App Connect Enterprise 12.0.6.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CFZE47) matchesCurrentType: true name: L-APEH-CFZE47 name: "12.0" - licenses: - displayName: IBM App Connect Enterprise 12.0.6.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CFZE47) matchesCurrentType: true name: L-APEH-CFZE47 name: 12.0.6 - licenses: - displayName: IBM App Connect Enterprise 12.0.6.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CFZE47) matchesCurrentType: true name: L-APEH-CFZE47 name: 12.0-lts - licenses: - displayName: IBM App Connect Enterprise 12.0.6.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CFZE47) matchesCurrentType: true name: L-APEH-CFZE47 name: 12.0.6-lts - licenses: - displayName: IBM App Connect Enterprise 12.0.5.0 - Sept 2022 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CCHL5W) matchesCurrentType: true name: L-KSBM-CJ2KWU name: 12.0.5 - licenses: - displayName: IBM App Connect Enterprise 12.0.5.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CCHL5W) matchesCurrentType: true name: L-APEH-CCHL5W name: 12.0.5-lts - licenses: - displayName: IBM App Connect Enterprise for Developers 12.0.4.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-C9NCDM) name: L-APEH-C9NCDM - displayName: IBM App Connect Enterprise 12.0.4.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-C9NCK6) matchesCurrentType: true name: L-APEH-C9NCK6 name: 12.0.4 - licenses: - displayName: IBM App Connect Enterprise for Developers 11.0.0.18 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CEKEQ6) name: L-APEH-CEKEQ6 - displayName: IBM App Connect Enterprise 11.0.0.18 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CEKET7) matchesCurrentType: true name: L-APEH-CEKET7 name: 11.0.0-eus - licenses: - displayName: IBM App Connect Enterprise for Developers 11.0.0.18 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CEKEQ6) name: L-APEH-CEKEQ6 - displayName: IBM App Connect Enterprise 11.0.0.18 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CEKET7) matchesCurrentType: true name: L-APEH-CEKET7 name: 11.0.0.18-eus versions: - licenses: - displayName: IBM App Connect Enterprise 12.0.6.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CFZE47) matchesCurrentType: true name: L-APEH-CFZE47 name: 12.0.6.0-r1 - licenses: - displayName: IBM App Connect Enterprise 12.0.6.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CFZE47) matchesCurrentType: true name: L-APEH-CFZE47 name: 12.0.6.0-r1-lts - licenses: - displayName: IBM App Connect Enterprise 12.0.5.0 - Sept 2022 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CCHL5W) matchesCurrentType: true name: L-KSBM-CJ2KWU name: 12.0.5.0-r4 - licenses: - displayName: IBM App Connect Enterprise 12.0.5.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CCHL5W) matchesCurrentType: true name: L-APEH-CCHL5W name: 12.0.5.0-r3 - licenses: - displayName: IBM App Connect Enterprise 12.0.5.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CCHL5W) matchesCurrentType: true name: L-APEH-CCHL5W name: 12.0.5.0-r2 - licenses: - displayName: IBM App Connect Enterprise 12.0.5.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CCHL5W) matchesCurrentType: true name: L-APEH-CCHL5W name: 12.0.5.0-r1-lts - licenses: - displayName: IBM App Connect Enterprise for Developers 12.0.4.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-C9NCDM) name: L-APEH-C9NCDM - displayName: IBM App Connect Enterprise 12.0.4.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-C9NCK6) matchesCurrentType: true name: L-APEH-C9NCK6 name: 12.0.4.0-r2 - licenses: - displayName: IBM App Connect Enterprise for Developers 12.0.4.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-C9NCDM) name: L-APEH-C9NCDM - displayName: IBM App Connect Enterprise 12.0.4.0 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-C9NCK6) matchesCurrentType: true name: L-APEH-C9NCK6 name: 12.0.4.0-r1 - licenses: - displayName: IBM App Connect Enterprise for Developers 11.0.0.18 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CEKEQ6) name: L-APEH-CEKEQ6 - displayName: IBM App Connect Enterprise 11.0.0.18 link: https://www-03.ibm.com/software/sla/sladb.nsf/searchlis/?searchview&searchorder=4&searchmax=0&query=(L-APEH-CEKET7) matchesCurrentType: true name: L-APEH-CEKET7 name: 11.0.0.18-r1-eus reconciled: 12.0.6.0-r1