Upgrade the API Connect Gateway subsystem on the Linux x86_64 cluster for use in IBM Cloud Pak® for Integration.
Before you begin
This task applies only to deployments where the Management and Portal subsystems were installed
as the API Connect instance on Linux for IBM Z. If you installed all subsystems on Linux x86_64,
follow the instructions in Upgrading all API Management subsystems on Linux x86_64 instead.
About this task
Table 1. API Connect versions and operators for Cloud Pak for
Integration
Cloud Pak for Integration |
API Connect (operand) |
API Connect Operator channel version |
Highest API Connect Operator version |
DataPower Operator channel |
2022.4.1 |
10.0.5.2 |
v3.2 |
3.2.0 |
v1.6.3 |
2022.2.1 |
10.0.5.1 |
v3.1 |
3.1.0 |
v1.6.2 |
2022.2.1 |
10.0.5.0 |
v3.0 |
3.0.0 |
v1.6 |
Procedure
- Run the API Connect pre-upgrade health check:
- Verify that the
apicops
utility is installed by running the following
command to check the current version of the utility:
- Run the following command to set the KUBECONFIG environment.
export KUBECONFIG=/<path>/kubeconfig
- Run the following command to execute the pre-upgrade
script:
apicops version:pre-upgrade -n <APIC_namespace>
If the system is healthy, the results will not include any errors.
- Use the OpenShift web console to upgrade the API Connect operator by
changing the subscription channel to the v3.2
version.
Attention: The operator must be fully upgraded before you proceed to the next
step.
- Get the gateway cluster CR's name by running the following command:
oc get gatewaycluster -n <APIC_namespace>
Note the CR's name in the NAME column of the response; for example:
NAME READY STATUS VERSION RECONCILED VERSION AGE
production-gw 2/2 Running 10.0.5.2 10.0.5.2-3522 20h
-
Update the CR with the new API Connect
license
and
version
.
- Edit the CR by running the following command:
oc edit gatewaycluster CR_name -n <APIC_namespace>
- Update the
license
value and API Connect version
;
for example:
apiVersion: gateway.apiconnect.ibm.com/v1beta1
kind: GatewayCluster
metadata:
name: production-gw
labels:
app.kubernetes.io/instance: gateway
app.kubernetes.io/managed-by: ibm-apiconnect
app.kubernetes.io/name: gateway
spec:
license:
accept: true
license: L-GVEN-GFUPVE
use: nonproduction
apicGatewayServiceTLS:
secretName: gateway-service
profile: n3xc4.m8
apicGatewayPeeringTLS:
secretName: gateway-peering
version: 10.0.5.2
tokenManagementService:
enabled: true
storage:
storageClassName: <block_storage>
volumeSize: 30Gi
gatewayEndpoint:
annotations:
cert-manager.io/issuer: <apiconnectCluster_name>-ingress-issuer
apicGatewayServiceV5CompatibilityMode: false
adminUser:
secretName: admin-secret
datapowerLogLevel: 5
gatewayManagerEndpoint:
annotations:
cert-manager.io/issuer: <apiconnectCluster_name>-ingress-issuer
- Save the modified CR and wait for the upgrade to complete.
- Run the following command to verify that the gateway cluster reports all services as
READY:
oc get gatewaycluster -n <APIC_namespace>