Upgrade the NSX Application Platform

You can upgrade the NSX Application Platform to a later build version using the NSX Manager UI.

The upgrade process retains the form factor being used for the current platform deployment. If you deployed the platform using an Evaluation form factor and want to continue using an Evaluation form factor, but use a later platform version, you must delete your current NSX Application Platform deployment first. You then redeploy the platform using a later platform version.

Upgrading to a newer version of the NSX Application Platform involves multiple steps. You must first configure and deploy the Upgrade Coordinator before you can proceed with upgrading the platform and each of the currently activated NSX features. The Upgrade Coordinator orchestrates all of the upgrade steps, and the system provides status on the UI as it upgrades each component.

Important:

Beginning with NSX 3.2.3.1 release, the VMware-hosted NSX Application Platform registry and repository locations no longer support ChartMuseum-compatible private container registry, such as Harbor.

If you are currently using an NSX version prior to 3.2.3.1, consider upgrading to NSX version 3.2.3.1 before attempting to upgrade your current NSX Application Platform deployment.

If you are unable to access the public VMware-hosted NSX Application Platform registry and repository locations, work with your infrastructure administrator to upload the NSX Application Platform Helm chart and Docker images to your company's private Helm repository and Docker registry locations. Both privately-hosted locations must be accessible from the Kubernetes cluster and the NSX Manager appliance you are using for the NSX Application Platform deployment. If you need to continue using the ChartMuseum provided by Harbor, the Harbor version must be earlier than version 2.8.1. See Upload the NSX Application Platform Docker Images and Helm Charts to a Private Container Registry for details.

Prerequisites

Review the NSX Release Notes for any known upgrade issue and workaround documented for the NSX Application Platform.
Ensure that there are no open alarms detected on the NSX Application Platform.
Verify that you have met all of the prerequisites and system requirements listed in NSX Application Platform Deployment Prerequisites.
You must have Enterprise Admin privileges.

Procedure

From your browser, log in with Enterprise Admin privileges to an NSX Manager at https://<nsx-manager-ip-address>.
Navigate to System > Upgrade.
Deploy the Upgrade Coordinator.
1. In the NSX Application Platform card, click Upgrade.
  
  This step can take some time as the system obtains the information from the VMware-hosted Helm repository. When the information is obtained successfully, the Prepare for Upgrade tab is displayed with the text boxes prepopulated with the information obtained for Helm Repository, Docker Registry, and Platform Target Version, as illustrated in the following image. Note that the values shown in the image are the default values for the VMware-hosted Helm repository and Docker registry locations, and the latest available NSX Application Platform version.
2. (Optional) If you are using a private Helm repository and Docker registry location, provide the private locations of the required Helm charts and Docker images.
  Use the following information for the Helm Repository text box.
  - For OCI-compatible Helm private repository, use the format oci://<your-private-registry-server-fqdn>/<your-private-registry-name>/helm-charts.
  - For ChartMuseum-compatible Helm private repository, use the format https://<your-private-registry-server-fqdn>/chartrepo/<your-private-registry-name>.
  For the Docker Registry text box, use the format <your-private-registry-server-fqdn>/<your-private-registry-name>/clustering.
  
  Click Save URL.
3. In the Platform Target Version text box, verify that the build version that you want to use for the upgrade is selected.
4. Click Deploy Upgrade Coordinator.
  
  This step can also take some time as the system deploys the Upgrade Coordinator to your TKG Cluster on Supervisor pod or upstream Kubernetes pod.
After the Upgrade Coordinator deployment completes, the Prepare tab is displayed. The Status section displays the Success status.
In the Deploy Upgrade Coordinator section located in the upper half of the Prepare tab, verify that the values shown in Helm Repository, Docker Registry, and Platform Target Version text boxes are correct.

If you must modify any of the values, click Delete next to the Note located after the Status section and redeploy a new Upgrade Coordinator.
Review the Summary section located in the lower half of the Prepare tab.

The NSX Application Platform card displays the status information for the platform. The Upgrade Completed indicates that the Upgrade Coordinator has been upgraded with the target NSX Application Platform version successfully. The card shows the current version and the target version to which the platform will be upgraded. The card also shows the precheck status.

If other NSX features that are hosted on the NSX Application Platform are activated, those features are also checked and scheduled for the upgrade. A separate feature card for each activated feature is also displayed. For example, the NSX Intelligence feature card appears in the following image because it is currently an activated NSXfeature on the NSX Application Platform. The system upgrades the activated features after the platform upgrade finishes successfully.
If all the Upgrade Coordinator values are correct, click Run Pre-Checks and select All Prechecks from the drop-down menu.

To optionally precheck specific components only, click Run Prechecks and from the drop-down menu, select the name of the component that you want to precheck.

The system performs all the prechecks for all the components that are scheduled for the upgrade. The prechecks help detect and resolve potential problems early in the upgrade process, which can make the upgrade process run more smoothly. The system updates the component cards with their prechecks status.

If the system identifies any issues during the precheck, you can click Download Pre-check Results and use the information in the downloaded file to help investigate the reported issues.
Click Next.

The NSX Application Platform tab displays a grid of all the groups of components that comprise the platform. You can expand each row to see all of the units for each component group that will be upgraded.
Click Upgrade.
The system upgrades each group that comprise the NSX Application Platform. This step can take some time to finish. You can leave the Upgrade UI screen and return to it by navigating back to System > Upgrade page and clicking Continue With Upgrade.

There are multiple ways to track the progress of the upgrade.
1. To view the logs generated as the upgraded progresses, click Recent Logs.
2. To monitor the upgrade status for each component group, use the Group Status column.
3. To see the upgrade status for each item in a particular group, expand the grid row for that group and verify the status shown for each group item.
If an error occurs for a group upgrade, expand the row for the group and click the Failed link to see the reason for the failure. Use that information to resolve the reported problem and to work with your infrastructure administrator or VMware support. When you have resolved the cause of the failure, click Retry to try to complete the upgrade.
When the NSX Application Platform is successfully upgraded, click Next and in the tab for the NSX feature (for example, NSX Intelligence), click Update.

After this feature is successfully upgraded, repeat this step for each of the remaining NSX features that must be upgraded.
After you have upgraded all of the NSX features activated on the NSX Application Platform, navigate to System > NSX Application Platform. Verify the Platform Version and Feature Version details for each of the activated features are correct.