# Steps to upgrade ## Overview This document describes the upgrade procedure for StackState. ## Before you upgrade When executing a StackState upgrade, be aware of the following: {% hint style="warning" %} **Always read the** [**version-specific upgrade notes**](/self-hosted-setup/upgrade-stackstate/version-specific-upgrade-instructions.md) **before upgrading StackState.** {% endhint %} {% hint style="warning" %} When upgrading a StackPack, **any changes you have made to configuration items from that StackPack will be overwritten**. See [Configuration Locking](/self-hosted-setup/configure-stackstate/about-stackpacks.md#locked-configuration-items) for more information. {% endhint %} {% hint style="danger" %} If there are **hotfixes** installed in your StackState installation, contact StackState technical support prior to upgrading. {% endhint %} ## Steps to upgrade ### Minor or maintenance StackState release A minor release of StackState is indicated by a change in the second digit of the version number, for example 4.1.0. Maintenance releases are identified by a change in the third digit of the version number, for example 4.1.1. If you are upgrading to a new **minor** StackState release or a **maintenance** release, StackState itself and the StackPacks will be compatible with the current installation. A minor upgrade consists of the following steps: 1. [Create a backup](#create-a-backup) 2. [Upgrade StackState](#upgrade-stackstate) 3. [Verify the new installation](#verify-the-new-installation) 4. Check if any installed StackPacks require an upgrade ### Major StackState release A major release of StackState is indicated by a change in the first digit of the version number, for example 4.0.0. If you upgrade to a new **major** StackState release, StackState and the installed StackPacks may be incompatible with the current installation. For details, check the [version-specific upgrade notes](/self-hosted-setup/upgrade-stackstate/version-specific-upgrade-instructions.md). A major upgrade consists of the following steps: 1. [Create a backup](#create-a-backup) 2. Optional: [Uninstall StackPacks](#uninstall-stackpacks-optional) 3. [Upgrade StackState](#upgrade-stackstate) 4. Optional: [Install StackPacks](#install-stackpacks-optional) 5. [Verify the new installation](#verify-the-new-installation) ## Walkthrough of an upgrade ### Create a backup Before upgrading StackState it's recommended to back up your configuration and topology data: * [Kubernetes backup](/self-hosted-setup/data-management/backup_restore/kubernetes_backup.md) * [Configuration backup](/self-hosted-setup/data-management/backup_restore/configuration_backup.md) {% hint style="info" %} Note that it won't be possible to restore the backup on the upgraded version of StackState. The StackState backup can only be restored in the StackState version before the upgrade. {% endhint %} ### Upgrade StackState Be sure to check the release notes and any optional upgrade notes before running the upgrade. {% tabs %} {% tab title="Kubernetes" %} 1. Get the latest helm chart by running `helm repo update`. 2. Check the [version specific upgrade notes](/self-hosted-setup/upgrade-stackstate/version-specific-upgrade-instructions.md) for all changes between your current version and the version that you will upgrade to. If there have been changes made to configuration items specified in your `values.yaml` file, the file should be updated. 3. To upgrade, use the same helm command as for the [first time Kubernetes installation](/self-hosted-setup/install-stackstate/kubernetes_openshift/kubernetes_install.md#deploy-stackstate-with-helm). The new helm chart will pull newer versions of Docker images and handle the upgrade. {% endtab %} {% tab title="OpenShift" %} 2\. Get the latest helm chart by running `helm repo update`. 3\. Check the [version specific upgrade notes](/self-hosted-setup/upgrade-stackstate/version-specific-upgrade-instructions.md) for all changes between your current version and the version that you will upgrade to. If there have been changes made to configuration items specified in your `values.yaml` file, the file should be updated. 4\. [Update the `openshift-values.yaml`](/self-hosted-setup/install-stackstate/kubernetes_openshift/openshift_install.md#additional-openshift-values-file) file. 5\. To upgrade, use the same helm command as for the [first time OpenShift installation](/self-hosted-setup/install-stackstate/kubernetes_openshift/openshift_install.md#deploy-stackstate-with-helm). The new helm chart will pull newer versions of Docker images and handle the upgrade. {% endtab %} {% endtabs %} ### Verify the new installation Once StackState has been upgraded and started, verify that the new installation of StackState is reachable and that the application is running. ## See also * [Manually upgrade a StackPack](/self-hosted-setup/configure-stackstate/about-stackpacks.md#upgrade-a-stackpack) * [Version-specific upgrade notes](/self-hosted-setup/upgrade-stackstate/version-specific-upgrade-instructions.md) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://archivedocs.stackstate.com/self-hosted-setup/upgrade-stackstate/steps-to-upgrade.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.