From 1833ca6f1eee6ab4585d1daa1fd51caf39073cb7 Mon Sep 17 00:00:00 2001 From: deontaljaard <1593586+deontaljaard@users.noreply.github.com> Date: Thu, 13 Feb 2025 12:12:10 +0200 Subject: [PATCH 1/2] STAC-22163: draft release strategy --- setup/release-notes/README.md | 56 ++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/setup/release-notes/README.md b/setup/release-notes/README.md index 78b6b0869..849ec7d78 100644 --- a/setup/release-notes/README.md +++ b/setup/release-notes/README.md @@ -4,4 +4,58 @@ description: SUSE Observability Self-hosted # Release Notes -Check the release notes for the latest features, enhancements, and bug fixes in StackState. +Check the release notes for the latest features, enhancements, and bug fixes in SUSE Observability. + +# Release Strategy + +## Overview + +This section outlines the release strategy for SUSE Observability, including its core components: + +- SUSE Observability Platform (Helm Chart) +- SUSE Observability Agents (Helm Chart) +- SUSE Observability Rancher UI Extension + +The goal of this strategy is to ensure users always have access to the latest features, security updates, and +compatibility across all components. + +## Release Cadence + +Each component follows a rolling release model, with no fixed cadence: + +- SUSE Observability Platform: Regularly updated to introduce new features, enhancements, and stability improvements. +- SUSE Observability Agents: Released as frequently as necessary, especially for security patches and performance optimizations. +- SUSE Observability Rancher UI Extension: Updated alongside major platform releases (Rancher and SUSE Observability) to maintain compatibility and user experience. + +## Compatibility Guidelines + +- The latest SUSE Observability Agent is always recommended, as it includes critical security fixes and performance improvements. +- The latest Agent is compatible with all supported versions of the SUSE Observability Platform. +- Users should ensure they are running the recommended version of the SUSE Observability Rancher UI Extension + corresponding to their Platform version. + +## Upgrade Recommendations + +### SUSE Observability Agents + +- Always upgrade to the latest version to benefit from security fixes and performance enhancements. +- Agents are designed to be backward-compatible with all supported Platform versions. +- Review release notes for an overview of changes made before upgrading. + +### SUSE Observability Platform + +- Upgrade to newer versions as they become available to gain access to new features and stability improvements. +- Review release notes for potential breaking changes before upgrading. + +### SUSE Observability Rancher UI Extension + +- Ensure the UI extension version matches the recommended version for your Rancher deployment. +- Upgrades and compatibility are typically aligned with Rancher and SUSE Observability platform releases. + +## Support Policy + +- Latest SUSE Observability Agent versions are fully supported. +- Previous SUSE Observability Platform versions receive support for a defined period, typically covering the latest release and the two most recent patch versions. Upgrading to the latest version is strongly encouraged. +- Security patches will be prioritized for the latest releases of all components. + +For questions or upgrade guidance, please reach out to our support team. From dff6c07bb001c8611cb4966a501ca78a5ad11f1b Mon Sep 17 00:00:00 2001 From: deontaljaard <1593586+deontaljaard@users.noreply.github.com> Date: Tue, 25 Feb 2025 15:13:16 +0200 Subject: [PATCH 2/2] STAC-22163: add compat. matrix and link to it --- k8s-suse-rancher-prime.md | 7 +++++++ setup/release-notes/README.md | 1 + 2 files changed, 8 insertions(+) diff --git a/k8s-suse-rancher-prime.md b/k8s-suse-rancher-prime.md index 9b1f83040..33994a64d 100644 --- a/k8s-suse-rancher-prime.md +++ b/k8s-suse-rancher-prime.md @@ -220,6 +220,13 @@ sts service-token create --name suse-observability-extension --roles stackstate- ``` {% endcode %} +### SUSE Observability Rancher UI extension compatibility matrix + +| UI Extension Version | Supported Rancher Version | +|----------------------|---------------------------| +| 0.x.x | 2.8 | +| 1.x.x | 2.9 | +| 2.x.x | 2.10 | ## Installing the SUSE Observability Agent diff --git a/setup/release-notes/README.md b/setup/release-notes/README.md index 849ec7d78..92de53fe5 100644 --- a/setup/release-notes/README.md +++ b/setup/release-notes/README.md @@ -50,6 +50,7 @@ Each component follows a rolling release model, with no fixed cadence: ### SUSE Observability Rancher UI Extension - Ensure the UI extension version matches the recommended version for your Rancher deployment. + - See the UI extension and Rancher compatibility matrix [here](../../k8s-suse-rancher-prime.md#suse-observability-rancher-ui-extension-compatibility-matrix). - Upgrades and compatibility are typically aligned with Rancher and SUSE Observability platform releases. ## Support Policy