For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update to a new version

Updating your CARTO Self-Hosted deployment

Support lifecycle policy

At CARTO, we are committed to providing reliable, secure, and high-quality support for all our users. To ensure the best experience, our support services are available only for CARTO Self-hosted versions released within the past 12 months.

Maintaining your installation on an up-to-date version is essential to:

  • Guarantee optimal performance of the platform.

  • Ensure security and compliance through the latest patches.

  • Benefit from continuous improvements, including new features and resolved issues.

Keeping your environment current is the best way to maximize the value of your CARTO deployment while ensuring stability, security, and a seamless user experience.

Upgrade Selfhosted version

Follow the steps below if you're using an Orchestrated container deployment in Kubernetes.

Pre-upgrade requirements

Important: Always Back Up Your Databases Before Upgrading

Before performing any upgrade to a new CARTO Self-Hosted version, you must create a backup of your databases:

  1. Backup the following databases:

    • carto / metadata - Main CARTO metadata database (PostgreSQL) - Required

    • aiproxy - AI Proxy database (PostgreSQL) - Only if AI features are enabled

  2. Verify backups are complete and restorable before proceeding with the upgrade.

  3. Document the current chart version (helm list -n <namespace>) in case you need to reinstall.

This is your only recovery path if an upgrade fails. Without a pre-upgrade backup, rolling back to a previous working state is not possible.

Download customer package (Helm)

This section only applies to advanced Orchestrated container deployments using Kubernetes and Helm.

Once a new release is available, you will need to download the latest customer package.

Clone the CARTO Self-Hosted github repo:

Checkout to the latest stable release:

You should Install the following packages on your machine:yq, jq and gcloud.

Run the script passing the following arguments:

flag
description

-d

Directory containing the existing customer package files.

-s

Carto selfhosted installation mode. Possible values for mode are docker (Single VM deployment) and k8s(Orchestrated container deployment)

Example output:

Install upgrade

Kots

Upgrade Single VM deployment

To upgrade your CARTO Self-Hosted deployment, simply access the Admin Console and check for any available updates.

  1. Login to the Admin Console.

  2. Click on "Check for Updates" link.

  3. If there are new SelfHosted version availabile, you will see it in the "New version available" section in the Admin Console.

  4. Wait for the Preflight Checks to Complete.

  1. Click on the blue "Deploy" button to deploy your new version.

  2. Monitor the progres in the "Details" section.

Once the update has been downloaded and all the preflight checks have completed successfully, initiate the upgrade process by clicking the "Deploy" button. Upon completion of the deployment, your single VM deployment will be successfully updated to the latest version.

Upgrade Orchestrated container deployment (Kots in K8s)

Follow the steps below if you're using an Orchestrated container deployment in Kubernetes.

  1. Login to the Admin Console.

  2. Click on "Check for Updates" link.

  3. If there are new SelfHosted version availabile, you will see it in the "New version available" section in the Admin Console.

  4. Wait for the Preflight Checks to Complete.

  1. Click on the blue "Deploy" button to deploy your new version.

  2. Monitor the progres in the "Details" section.

Once the update has been downloaded and all the preflight checks have completed successfully, initiate the upgrade process by clicking the "Deploy" button. Upon completion of the deployment, your CARTO Deployment i K8s with Kots will be successfully updated to the latest version.

(Optional) Upgrade Kots admin-console

In some cases, you may need to update the KOTS Admin Console to ensure compatibility with the latest CARTO Self-Hosted release or to receive important fixes. This process should always be performed independently of the CARTO upgrade to avoid conflicts or delays.

When should I upgrade KOTS?

  • When required by the Admin Console during the upgrade process: If your Kots version is below our minimum version you'll have to upgrade the Admin Console version before upgrading CARTO. You can view our minKotsVersion value here.

  • Release notes notification: We recommend upgrade KOTS when explicitly required in the CARTO release notes. These notes will clearly specify the exact version of KOTS that has been validated by CARTO.

  • Do not upgrade on your own: Avoid upgrading KOTS independently (e.g., every X months). Running unvalidated versions may introduce incompatibilities.

Steps to upgrade KOTS:

  1. Update the Kots version in your local machine to match the one specified in the release notes:

  1. Update the Kots version in the cluster:

Post-change verification

After applying an update, confirm the deployment is healthy:

Last updated

Was this helpful?