Upgrading your instances
Use these instructions if you need to manually upgrade existing instances of the App Connect Dashboard, App Connect Designer Authoring, App Connect Switch Server, and App Connect Integration Server custom resources. You can upgrade by using the Red Hat® OpenShift® web console or CLI, or from the IBM® Cloud Pak for Integration Platform Navigator.
Before you begin
- Ensure that you have cluster administrator authority or have been granted the appropriate role-based access control (RBAC).
- Review the Upgrade considerations for channels, versions, and licenses.
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 spec.version value to a
channel or fully qualified version that is suffixed with -eus
, and update the
spec.license.licence value to an appropriate licence for the Operator version.
If you have existing instances of App Connect Dashboard, App Connect Designer, integration servers, and switch servers, you can upgrade any of them by using the Red Hat OpenShift web console or CLI. From the Platform Navigator, you can directly upgrade only App Connect Dashboard and App Connect Designer instances.
Upgrading from the Red Hat OpenShift CLI
Procedure
To upgrade your instances, complete the following steps:
Upgrading from the Red Hat OpenShift web console
Procedure
To upgrade your instances, complete the following steps:
Upgrading from the IBM Cloud Pak for Integration Platform Navigator
Procedure
To upgrade your App Connect Dashboard and App Connect Designer instances, complete the following steps:
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
, or
IntegrationServer
. (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
For example:
oc get IntegrationServer NAME RESOLVEDVERSION REPLICAS AVAILABLEREPLICAS CUSTOMIMAGES STATUS AGE demo-designer-designer 11.0.0.10-r1 1 1 false Ready 8d des-ma-johndoe-designer 11.0.0.10-r1 1 1 false Ready 5d4h des-leemajor-designer 11.0.0.10-r1 1 1 false Ready 2d1h designer-josie-designer 11.0.0.10-r1 1 1 false Ready 7d3h baton-test-upgrade-server 11.0.0.9-r3 1 1 false Ready 24m
- 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, and status.reconciled identifies the App Connect version that is running.
Example 1:
oc get IntegrationServer baton-test-upgrade-server -o yaml ... spec: adminServerSecure: false barURL: "" designerFlowsOperationMode: disabled license: accept: true license: L-AMYG-BQ2E4U use: AppConnectEnterpriseProduction replicas: 1 router: timeout: 120s service: endpointType: http useCommonServices: false version: 11.0.0.9 status: availableReplicas: 1 conditions: - lastTransitionTime: "2020-09-23T15:41:03Z" message: integrationserver is ready reason: Deployed status: "True" type: Ready customImages: false endpoints: - name: http endpoint type: api uri: http://baton-test-upgrade-server-http-ace-demo.apps.acecc-demo.abc.com - name: https endpoint type: api uri: https://baton-test-upgrade-server-https-ace-demo.apps.acecc-demo.abc.com phase: Ready replicas: 1 versions: available: channels: - name: 11.0.0 - name: 11.0.0.10 - name: 11.0.0.9 versions: - name: 11.0.0.10-r1 - name: 11.0.0.9-r3 - name: 11.0.0.9-r2 - name: 11.0.0.9-r1 reconciled: 11.0.0.9-r3
Example 2:
oc get IntegrationServer des-quickstart-cs-sx-designer -o yaml ... spec: license: accept: true license: L-APEH-BTHFYQ use: AppConnectEnterpriseProduction tracing: {} ... adminServerSecure: true router: timeout: 120s customContentServer: true defaultAppName: DefaultApplication useCommonServices: true designerFlowsOperationMode: local disableRoutes: false designerFlowsType: event-driven-or-api-flows service: endpointType: http version: 11.0.0-eus logFormat: basic replicas: 1 configurations: - des-quickstart-cs-sx-designer-pp - des-quickstart-cs-sx-designer-sc - des-quickstart-cs-sx-designer-sdbp - des-quickstart-cs-sx-designer-ks - des-quickstart-cs-sx-designer-acc - des-quickstart-cs-sx-designer-ssl status: availableReplicas: 1 conditions: - lastTransitionTime: '2020-11-16T14:41:34Z' message: integrationserver is ready reason: Deployed status: 'True' type: Ready customImages: false endpoints: - name: http endpoint type: api uri: >- http://des-quickstart-cs-sx-designer-http-ace-shanna.apps.acecc-staging.icp4i.com - name: https endpoint type: api uri: >- https://des-quickstart-cs-sx-designer-https-ace-shanna.apps.acecc-staging.icp4i.com labelSelector: release=des-quickstart-cs-sx-designer phase: Ready replicas: 1 versions: available: channels: - name: 11.0.0 - name: 11.0.0.10 - name: 11.0.0.9 versions: - name: 11.0.0.10-r3-eus - name: 11.0.0.10-r2 - name: 11.0.0.10-r1 - name: 11.0.0.9-r3 - name: 11.0.0.9-r2 - name: 11.0.0.9-r1 reconciled: 11.0.0.10-r3-eus