Upgrading the management subsystem on Kubernetes

Upgrade the management subsystem to a newer version of API Connect on Kubernetes.

1. Update the management CR for the new version of API Connect.
   1. Run the following command to edit the management CR:

      kubectl -n <namespace> edit mgmt

   2. Update spec.version in the management CR to your target version:

      For example:

      version: 10.0.9.0

   3. If you are upgrading to a version of API Connect that requires a new license, update spec.license.

      For example:

      license: L-WPTV-3V8RK2

      For the list of licenses, see API Connect licenses.

   4. If you have a two data center disaster recovery installation, and are upgrading the warm-standby, then add the annotation:

      apiconnect-operator/dr-warm-standby-upgrade-data-deletion-confirmation: "true"

      For more information about two data center disaster recovery upgrade, see Upgrading a 2DCDR deployment on Kubernetes and OpenShift from V10.0.8.
   5. If you are upgrading from V10.0.5 and you generated your internal certificates with the custom-certs-internal.yaml file when you installed API Connect (following these steps Generating custom certificates using cert-manager), then add the new db-client-replication certificate in the customCertificates section:

      customCertificates:
         ...
         - name: dbClientReplicator
           secretName: db-client-replication

   6. Run the following command to save and apply the CR: wq

      When you save the updated CR, the upgrade starts automatically.

      Troubleshooting: If you see an error message when you attempt to save the CR, see the Troubleshooting upgrades on Kubernetes.

2. Run the following command to verify that the upgrade was successful:

   kubectl -n <namespace> get apic

   Example output after management subsystem upgrade:

   NAME                                                 READY   STATUS    VERSION              RECONCILED VERSION      AGE
   managementcluster.management.apiconnect.ibm.com/m1   16/16   Running   <version>   <version-build>   162m
   
   NAME                                                                    STATUS    MESSAGE                                              AGE
   managementdbupgrade.management.apiconnect.ibm.com/management-up-8c28g   Running   Upgrade is running (DB Schema/data are up-to-date)   13m

   If the upgrade appears to be stuck, showing the status of Pending for a long time, then check the management CR status for errors:

   kubectl -n <namespace> get mgmt -o yaml

   Refer to Troubleshooting upgrades on Kubernetes, for known issues.