Skip to main content

Upgrade Palette VerteX Installed on VMware vSphere

This guide takes you through the process of upgrading a self-hosted Palette VerteX instance installed on VMware vSphere.

Upgrade Notes​

All Versions​

  • Before upgrading Palette VerteX to a new major version, you must first update it to the latest patch version of the latest minor version available. Refer to the Supported Upgrade Paths section for details.

  • If your setup includes a PCG, you must also allow the PCG to upgrade automatically before each major or minor Palette VerteX upgrade.

Specific Versions​

  • (4.8.x to 4.9.23+) Direct upgrades from any 4.8.x release to 4.9.23 or later are not supported, because they skip a Kubernetes minor version. Upgrade to a 4.9.x release on Kubernetes 1.33.10 first (we recommend 4.9.14), then upgrade to your target 4.9.23 or later release. Refer to the Kubernetes Version Constraint section for details.

  • (pre-4.8.47 to 4.9.14+) If you are upgrading from a version of Palette VerteX earlier than 4.8.47 to 4.9.14 or later, you must update your DNS records after upgrading. Beginning with version 4.8.47, Traefik replaced Ingress Nginx as the primary ingress controller. The upgrade creates a new service of type LoadBalancer in the ingress-traefik namespace with a new external IP address or hostname. If you do not update your DNS records, Palette VerteX will be unreachable at its custom domain.

    Use the following command to retrieve the new Traefik load balancer address.

    kubectl get service traefik-ingress-controller --namespace ingress-traefik \
    --output jsonpath='{.status.loadBalancer.ingress[0].ip}{.status.loadBalancer.ingress[0].hostname}'

    Update your DNS records for your Palette VerteX domain to resolve to the address returned by the previous command. The specific steps to update DNS records depend on your DNS provider. After updating DNS, verify that your domain resolves to the new address.

    nslookup <your-palette-domain>

  • (4.7.x to 4.8.x) If the MongoDB data for your clusters was first created on Palette VerteX 4.5.x through 4.6.9, the MongoDB Feature Compatibility Version (FCV) might be at 6.0, which causes the upgrade to fail. Your current Palette VerteX version does not indicate whether this applies to your cluster; you must check the FCV directly. You must raise the FCV to 7.0 before upgrading because Palette VerteX 4.8 uses MongoDB 8.0.

    To learn how to check the FCV version and upgrade to FCV 7.0 if necessary, refer to Scenario - MongoDB Feature Compatibility Version Mismatch after Palette Upgrade.

  • (pre-4.4.14 to 4.4.14+) If you are upgrading from a Palette VerteX version that is older than 4.4.14, ensure that you have executed the utility script to make the CNS mapping unique for the associated PVC. For more information, refer to the Troubleshooting guide.

Prerequisites​

  • Access to the Palette VerteX system console.
  • A diff or text comparison tool of your choice.

Upgrade​

  1. Log in to the Palette VerteX system console.

  2. From the left Main Menu, select Enterprise Cluster and then select the Profile tab.

  3. Copy the configurations for your CSI, CNI, and Kubernetes layers to an external location for backup.

    tip

    If your Enterprise Cluster profile has configuration changes or additions, make sure to back up all the customized values to preserve them after the upgrade.

    Self-hosted Palette VerteX system console with the highlighted Enterprise Cluster profile configuration values.

  4. From the left Main Menu, select Update Management and click Update.

    Self-hosted Palette VerteX system console with Update Management open and the Update button highlighted.

  5. In the Palette version update preview modal, from the left menu, select the Kubernetes layer. The Incoming changes pane displays the changes that the upgrade introduces. The Current configuration pane displays your current layer configuration.

    info

    To complete the Palette VerteX upgrade, we recommend using an external diff or text comparison tool. Proceed with the following steps once you have the comparison tool available next to the Palette VerteX system console.

  6. Copy the configurations from both Incoming changes and Current configuration panes to your comparison tool.

  7. From your current configuration, transfer only those differences that are custom to your self-hosted Palette VerteX instance (for example, the podCIDR and serviceClusterIpRange values). Do not override any other changes or upgrades.

    Self-hosted Palette VerteX system console with the upgrade preview pane.

  8. After you finish merging the configurations, copy the resulting configuration, and then paste it to the Current configuration pane in the Palette VerteX system console.

    Self-hosted Palette VerteX system console with the upgrade preview pane.

  9. Repeat steps six through eight for each Enterprise Cluster profile layer.

  10. In the bottom-right corner of the Palette version update preview modal, select Confirm.

    The system console locks for a couple of minutes while the upgrade is applied.

Validate​

  1. Log in to the Palette VerteX system console.

  2. On the Summary page, Palette VerteX should display messages that state You are using the latest version of Palette VerteX and On-prem system console is healthy.