Upgrading the portal subsystem on Kubernetes

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

Before you begin

Review and complete all steps in:

About this task

Upgrade the portal subsystem by updating the version property in your portal CR. The API Connect operator detects this change and starts the upgrade.

Procedure

Update the portal CR for the new version of API Connect.
1. Run the following command to edit your portal CR:
```
kubectl -n <namespace> edit ptl
```
2. Set the spec.version property in the portal CR to your target version:
  For example:
```
version: 10.0.8.1
```
3. If you are upgrading to a version of API Connect that requires a new license, update spec.license.
  For example:
```
license: L-DZZQ-MGVN8V
```
  For the list of licenses, see API Connect licenses.
4. 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 known upgrade issues.
Run the following command to verify that the upgrade was successful:
```
kubectl -n <namespace> get apic
```
Example output after portal subsystem upgrade:
```
NAME                                                   READY   STATUS    VERSION    RECONCILED VERSION   MESSAGE          AGE
portalcluster.portal.apiconnect.ibm.com/portal         3/3     Running   <version>  <version>            Site Upgrades Executing:(1) Queued(5) Failed(0) Success(0)   22h
```
Note: After the portal subsystem upgrade is complete, each portal site is upgraded. You can monitor the site upgrade progress from the MESSAGE column in the kubectl get apic output. You can still use the portal while sites are upgrading, although a maintenance page is shown for any sites that are being upgraded. When the site upgrades are complete, the kubectl get apic output shows how many sites the portal is serving:
```
NAME     READY   STATUS    VERSION          RECONCILED VERSION   MESSAGE              AGE
portal   3/3     Running   <version>        <version>            Serving 2 sites      22h
```
On two data center disaster recovery deployments, the sites are not upgraded until both data centers are upgraded.
If the upgrade appears to be stuck, showing the status of Pending for a long time, then check the portal CR status for errors:
```
kubectl -n <namespace> get ptl -o yaml
```
Refer to Troubleshooting upgrades on Kubernetes, for known issues.