Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

STAC-22163: draft release strategy #1580

Merged
merged 2 commits into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions k8s-suse-rancher-prime.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
57 changes: 56 additions & 1 deletion setup/release-notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,59 @@ 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.
- 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

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