LogoLogo
StackState.comDownloadSupportExplore playground
StackState v6.0
StackState v6.0
  • StackState docs!
  • Docs for all StackState products
  • 🚀Get started
    • Quick start guide
    • StackState walk-through
    • SUSE Rancher Prime
      • Air-gapped
      • Agent Air-gapped
  • 🦮Guided troubleshooting
    • What is guided troubleshooting?
    • YAML Configuration
    • Changes
    • Logs
  • 🚨Monitors and alerts
    • Monitors
    • Out of the box monitors for Kubernetes
    • Notifications
      • Configure notifications
      • Notification channels
        • Slack
        • Teams
        • Webhook
        • Opsgenie
      • Troubleshooting
    • Customize
      • Add a monitor using the CLI
      • Override monitor arguments
      • Write a remediation guide
  • 📈Metrics
    • Explore Metrics
    • Custom charts
      • Adding custom charts to components
      • Writing PromQL queries for representative charts
      • Troubleshooting custom charts
    • Advanced Metrics
      • Grafana Datasource
      • Prometheus remote_write
      • OpenMetrics
  • 📑Logs
    • Explore Logs
    • Log Shipping
  • 🔭Traces
    • Explore Traces
  • 📖Health
    • Health synchronization
    • Send health data over HTTP
      • Send health data
      • Repeat Snapshots JSON
      • Repeat States JSON
      • Transactional Increments JSON
    • Debug health synchronization
  • 🔍Views
    • Kubernetes views
    • Custom views
    • Component views
    • Explore views
    • View structure
      • Filters
      • Overview perspective
      • Highlights perspective
      • Topology perspective
      • Events perspective
      • Metrics perspective
      • Traces perspective
    • Timeline and time travel
  • 🕵️Agent
    • Network configuration
      • Proxy Configuration
    • Using a custom registry
    • Custom Secret Management
    • Request tracing
      • Certificates for sidecar injection
  • 🔭Open Telemetry
    • Getting started
    • Open telemetry collector
    • Languages
      • Generic Exporter configuration
      • Java
      • Node.js
      • .NET
      • Verify the results
    • Troubleshooting
  • CLI
    • StackState CLI
  • 🚀Self-hosted setup
    • Install StackState
      • Requirements
      • Kubernetes / OpenShift
        • Kubernetes install
        • OpenShift install
        • Required Permissions
        • Non-high availability setup
        • Small profile setup
        • Override default configuration
        • Configure storage
        • Exposing StackState outside of the cluster
      • Initial run guide
      • Troubleshooting
        • Logs
    • Configure StackState
      • Slack notifications
      • Stackpacks
    • Release Notes
      • v1.11.0 - 18/07/2024
      • v1.11.3 - 15/08/2024
      • v1.11.4 - 29/08/2024
      • v1.12.0 - 24/10/2024
      • v1.12.1 - 08/11/2024
    • Upgrade StackState
      • Steps to upgrade
      • Version-specific upgrade instructions
    • Uninstall StackState
    • Air-gapped
      • StackState air-gapped
      • StackState Kubernetes Agent air-gapped
    • Data management
      • Backup and Restore
        • Kubernetes backup
        • Configuration backup
      • Data retention
      • Clear stored data
    • Security
      • Authentication
        • Authentication options
        • File-based
        • LDAP
        • Open ID Connect (OIDC)
        • KeyCloak
        • Service tokens
      • RBAC
        • Role-based Access Control
        • Permissions
        • Roles
        • Scopes
      • Self-signed certificates
  • 🔐Security
    • Service Tokens
    • Ingestion API Keys
  • ☁️SaaS
    • User Management
  • Reference
    • StackState Query Language (STQL)
    • Chart units
Powered by GitBook
LogoLogo

Legal notices

  • Privacy
  • Cookies
  • Responsible disclosure
  • SOC 2/SOC 3
On this page
  • Overview
  • Before you upgrade
  • Steps to upgrade
  • Minor or maintenance StackState release
  • Major StackState release
  • Walkthrough of an upgrade
  • Create a backup
  • Upgrade StackState
  • Verify the new installation
  • See also
  1. Self-hosted setup
  2. Upgrade StackState

Steps to upgrade

StackState Self-hosted

PreviousUpgrade StackStateNextVersion-specific upgrade instructions

Last updated 10 months ago

Overview

This document describes the upgrade procedure for StackState.

Before you upgrade

When executing a StackState upgrade, be aware of the following:

Always read the before upgrading StackState.

When upgrading a StackPack, any changes you have made to configuration items from that StackPack will be overwritten. See for more information.

If there are hotfixes installed in your StackState installation, contact StackState technical support prior to upgrading.

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. 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.

A major upgrade consists of the following steps:

Walkthrough of an upgrade

Create a backup

Before upgrading StackState it's recommended to back up your configuration and topology data:

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.

Upgrade StackState

Be sure to check the release notes and any optional upgrade notes before running the upgrade.

  1. Get the latest helm chart by running helm repo update.

  1. Get the latest helm chart by running helm repo update.

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

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 .

Optional:

Optional:

Check the 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.

To upgrade, use the same helm command as for the . The new helm chart will pull newer versions of Docker images and handle the upgrade.

Check the 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.

file.

To upgrade, use the same helm command as for the . The new helm chart will pull newer versions of Docker images and handle the upgrade.

🚀
version-specific upgrade notes
Kubernetes backup
Configuration backup
version specific upgrade notes
version specific upgrade notes
Version-specific upgrade notes
Create a backup
Uninstall StackPacks
Upgrade StackState
Install StackPacks
Verify the new installation
version-specific upgrade notes
Create a backup
Upgrade StackState
Verify the new installation
Update the openshift-values.yaml
first time OpenShift installation
Configuration Locking
Manually upgrade a StackPack
first time Kubernetes installation