Upgrade Palette Management Appliance

tech preview

This is a Tech Preview feature and is subject to change. Upgrades from a Tech Preview deployment may not be available. Do not use this feature in production workloads.

Follow the instructions to upgrade the Palette Management Appliance using a content bundle. The content bundle is used to upgrade the Palette instance to a chosen target version.

info

The upgrade process will incur downtime for the Palette management cluster, but your workload clusters will remain operational.

Prerequisites

• A healthy Palette management cluster where you can access the Local UI of the leader node.

  • Verify that your local machine can access the Local UI, as airgapped environments may have strict network policies preventing direct access.

• If using an external registry, the Palette CLI must be installed on your local machine to upload the content to the external registry. Refer to the Palette CLI guide for installation instructions.

  • Ensure your local machine has network access to the external registry server and you have the necessary permissions to push images to the registry.

• Access to the Artifact Studio to download the content bundle for Palette.

  • Check that your upgrade path is supported by referring to the Supported Upgrade Paths.

Upgrade Palette

Internal Zot Registry

1. Navigate to the Artifact Studio through a web browser, and under Install Palette Enterprise, click on the drop-down menu and select the version you want to upgrade your Palette Management Appliance to.

2. Click Show Artifacts to display the Palette Enterprise Artifacts pop-up window. Click the Download button for the Content bundle (including Ubuntu).

3. Wait until the content bundle is downloaded to your local machine. The bundle is downloaded in .tar.zst format alongside a signature file in sig.bin format.

   tip

   Refer to the Artifact Studio guide for detailed guidance on how to verify the integrity of downloaded files using the provided signature file.

4. Log in to the Local UI of the leader host of the Palette management cluster. By default, Local UI is accessible at https://<node-ip>:5080. Replace <node-ip> with the IP address of the leader host.

5. From the left main menu, click Content.

6. Click Actions in the top right and select Upload Content from the drop-down menu.

7. Click the Upload icon to open the file selection dialog and select the content bundle file from your local machine. Alternatively, you can drag and drop the file into the upload area.

   The upload process starts automatically once the file is selected. You can monitor the upload progress in the Upload Content dialog.

   Wait for the File(s) uploaded successfully confirmation message or the green check mark to appear next to the upload progress bar.

8. On the Content page, wait for the content to finish syncing. This is indicated by the Syncing content: (N) items are pending banner that appears to the left of disk usage. The banner will disappear once the sync is complete. This can take several minutes depending on the size of the content bundle and your internal network speed.

9. From the left main menu, click Cluster and select the Configuration tab.

10. Click the Update drop-down menu and select Review Changes.

11. Review the changes for each profile carefully and ensure you are satisfied with the proposed updates. There may be changes to the profiles between versions that include the addition or removal of properties.

    warning

    Some upgrade paths require you to re-enter the configuration values you provided during the initial Palette installation. This includes the OCI Pack Registry Password and any other non-default settings.

    Click Confirm Changes once satisfied.

12. Click Update to start the upgrade process.

During the upgrade process, the Palette system and tenant consoles will be unavailable, and a warning message will be displayed when attempting to log in. You can monitor the upgrade progress in the Overview tab on the Cluster page.

External Registry

info

When using an external registry, you must upload the content bundle to both the external registry and the internal Zot registry as they both need to have the content for the upgrade process. The following steps include instructions for uploading the content bundle to both registries.

1. Navigate to the Artifact Studio through a web browser, and under Install Palette Enterprise, click on the drop-down menu and select the version you want to upgrade your Palette Management Appliance to.

2. Click Show Artifacts to display the Palette Enterprise Artifacts pop-up window. Click the Download button for the Content bundle (including Ubuntu).

3. Wait until the content bundle is downloaded to your local machine. The bundle is downloaded in .tar.zst format alongside a signature file in sig.bin format.

   tip

   Refer to the Artifact Studio guide for detailed guidance on how to verify the integrity of downloaded files using the provided signature file.

4. Open a terminal on your local machine and navigate to the directory where the content bundle file is located.

5. Use the Palette CLI to log in to your external registry. Replace <registry-dns-or-ip> with the DNS/IP address of your registry, <registry-port> with the port number of your registry (if applicable), <username> with your username, and <password> with your password.

   palette content registry-login \
   --registry https://<registry-dns-or-ip>:<registry-port> \
   --username <username> \
   --password <password>

6. Upload the file to your external registry using the Palette CLI. Replace <content-bundle-zst> with your downloaded content bundle file, <registry-dns-or-ip> with the DNS/IP address of your registry, and <registry-port> with the port number of your registry (if applicable). If you have changed the base content path from the default, replace spectro-content with the correct content path.

   If you are using custom TLS certificates or choosing to skip TLS, use the appropriate flags as shown in the following examples.

   Custom TLS Certificate

   palette content push \
   --registry <registry-dns-or-ip>:<registry-port>/spectro-content \
   --file <content-bundle-zst> \
   --ca-cert <path-to-ca-cert> \
   --tls-cert <path-to-tls-cert> \
   --tls-key <path-to-tls-key>

   Skip TLS

   palette content push \
   --registry <registry-dns-or-ip>:<registry-port>/spectro-content \
   --file <content-bundle-zst> \
   --insecure

   The following example output is expected when an upload is successful.

   Example output

   ...
   INFO[0366] successfully copied all artifacts from local bundle /root/tmp/bundle-extract/palette-enterprise-appliance-4.7.9.tar to remote bundle external.registry.com/spectro-content/bundle-definition:palette-enterprise-appliance-4.7.9
   -----------------------------
   Push Summary
   -----------------------------
   local bundle palette-enterprise-appliance-4.7.9 pushed to external.registry.com/spectro-content
   tip

   Be aware of the timeout period for the authentication token. If the authentication token expires, you will need to re-authenticate to the OCI registry and restart the upload process.

7. Log in to the Local UI of the leader host of the Palette management cluster. By default, Local UI is accessible at https://<node-ip>:5080. Replace <node-ip> with the IP address of the leader host.

8. From the left main menu, click Content.

9. Click Actions in the top right and select Upload Content from the drop-down menu.

10. Click the Upload icon to open the file selection dialog and select the content bundle file from your local machine. Alternatively, you can drag and drop the file into the upload area.

    The upload process starts automatically once the file is selected. You can monitor the upload progress in the Upload Content dialog.

    Wait for the File(s) uploaded successfully confirmation message or the green check mark to appear next to the upload progress bar.

11. On the Content page, wait for the content to finish syncing. This is indicated by the Syncing content: (N) items are pending banner that appears to the left of disk usage. The banner will disappear once the sync is complete. This can take several minutes depending on the size of the content bundle and your internal network speed.

12. From the left main menu, click Cluster and select the Configuration tab.

13. Click the Update drop-down menu and select Review Changes.

14. Review the changes for each profile carefully and ensure you are satisfied with the proposed updates. There may be changes to the profiles between versions that include the addition or removal of properties.

    warning

    Some upgrade paths require you to re-enter the configuration values you provided during the initial Palette installation. This includes the OCI Pack Registry Password and any other non-default settings.

    Click Confirm Changes once satisfied.

15. Click Update to start the upgrade process.

During the upgrade process, the Palette system and tenant consoles will be unavailable, and a warning message will be displayed when attempting to log in. You can monitor the upgrade progress in the Overview tab on the Cluster page.

Validate

1. Log in to the Local UI of the leader host of the Palette management cluster. By default, Local UI is accessible at https://<node-ip>:5080. Replace <node-ip> with the IP address of the leader host.

2. From the left main menu, click Cluster.

3. Check that the palette-mgmt-plane pack displays the upgraded version number and is in a Running status.

4. Verify that you can log in to the Palette system console and no warning message is displayed.

5. If you have configured a tenant, log in to the tenant console and verify that Palette displays the correct version number.