From 58891cb2de7249935dbef463e4e69af0f1c17109 Mon Sep 17 00:00:00 2001 From: Gandalf Date: Sat, 16 May 2026 12:28:43 -0300 Subject: [PATCH 1/2] docs(reporter): add v2.3 upgrade guide Requested-by: @guimoreirar --- charts/reporter/docs/UPGRADE-2.3.md | 69 +++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 charts/reporter/docs/UPGRADE-2.3.md diff --git a/charts/reporter/docs/UPGRADE-2.3.md b/charts/reporter/docs/UPGRADE-2.3.md new file mode 100644 index 00000000..150a279f --- /dev/null +++ b/charts/reporter/docs/UPGRADE-2.3.md @@ -0,0 +1,69 @@ +# Helm Upgrade from v2.2.x to v2.3.x +## Topics +- **[Overview](#overview)**- **[Version changes](#version-changes)**- **[Configuration changes](#configuration-changes)**- **[Template changes](#template-changes)**- **[Migration steps](#migration-steps)**- **[Preview changes before upgrading](#preview-changes-before-upgrading)**- **[Command to upgrade](#command-to-upgrade)** + +## Overview +This guide covers the `reporter` chart upgrade from `2.2.1-beta.1` to `2.3.0-beta.1`. It was generated retroactively from the chart history and focuses on minor version changes; patch-only releases are intentionally ignored. + +Because this is a minor upgrade, the expected path is an in-place Helm upgrade after reviewing new values and changed defaults. + +## Version changes + +| Field | Previous | Current | +|-------|----------|---------| +| Chart version | `2.2.1-beta.1` | `2.3.0-beta.1` | +| App version | `1.2.0` | `1.2.0` | + +## Configuration changes + +### Added values + +_No direct values.yaml key changes detected._ + +### Removed values + +_No direct values.yaml key changes detected._ + +### Changed operational values + +_No image, env, secret, probe, ingress, service, port, or enablement changes detected in values.yaml._ + +## Template changes + +### Added files + +- No chart files added. + +### Removed files + +- No chart files removed. + +### Modified files + +- `charts/reporter/CHANGELOG.md` +- `charts/reporter/Chart.yaml` +- `charts/reporter/templates/manager/deployment.yaml` +- `charts/reporter/templates/worker/deployment.yaml` + +## Migration steps + +1. Read this guide and compare your custom values against `charts/reporter/values.yaml`. +2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings. +3. Render the chart locally with your production values and review the manifest diff. +4. Apply the upgrade in a controlled environment before production. + +## Preview changes before upgrading + +```bash +helm diff upgrade reporter ./charts/reporter \ + --namespace \ + --values +``` + +## Command to upgrade + +```bash +helm upgrade reporter ./charts/reporter \ + --namespace \ + --values +``` From d94ad8131dff93518ebf30b3d38906a35d7454a7 Mon Sep 17 00:00:00 2001 From: Gandalf Date: Fri, 29 May 2026 11:58:52 -0300 Subject: [PATCH 2/2] docs(reporter): align upgrade guide format Requested-by: @guimoreirar --- charts/reporter/docs/UPGRADE-2.3.md | 152 +++++++++++++++++++++------- 1 file changed, 117 insertions(+), 35 deletions(-) diff --git a/charts/reporter/docs/UPGRADE-2.3.md b/charts/reporter/docs/UPGRADE-2.3.md index 150a279f..ebe5a6f5 100644 --- a/charts/reporter/docs/UPGRADE-2.3.md +++ b/charts/reporter/docs/UPGRADE-2.3.md @@ -1,69 +1,151 @@ # Helm Upgrade from v2.2.x to v2.3.x + ## Topics -- **[Overview](#overview)**- **[Version changes](#version-changes)**- **[Configuration changes](#configuration-changes)**- **[Template changes](#template-changes)**- **[Migration steps](#migration-steps)**- **[Preview changes before upgrading](#preview-changes-before-upgrading)**- **[Command to upgrade](#command-to-upgrade)** -## Overview -This guide covers the `reporter` chart upgrade from `2.2.1-beta.1` to `2.3.0-beta.1`. It was generated retroactively from the chart history and focuses on minor version changes; patch-only releases are intentionally ignored. +- **[Overview](#overview)** +- **[Features](#features)** + - [1. Manager readiness path now defaults to /readyz](#1-manager-readiness-path-now-defaults-to-readyz) + - [2. Worker readiness path now defaults to /readyz](#2-worker-readiness-path-now-defaults-to-readyz) + - [3. Manager and worker probe paths are now configurable](#3-manager-and-worker-probe-paths-are-now-configurable) +- **[Configuration Changes](#configuration-changes)** +- **[Migration Steps](#migration-steps)** +- **[Preview changes before upgrading](#preview-changes-before-upgrading)** +- **[Command to upgrade](#command-to-upgrade)** -Because this is a minor upgrade, the expected path is an in-place Helm upgrade after reviewing new values and changed defaults. +## Overview -## Version changes +This is a minor maintenance release that aligns the `manager` and `worker` readiness probes with the platform-wide `/readyz` convention and exposes both probe paths through `values.yaml`. The application version is unchanged. -| Field | Previous | Current | -|-------|----------|---------| +| Field | v2.2.x | v2.3.x | +|-------|--------|--------| | Chart version | `2.2.1-beta.1` | `2.3.0-beta.1` | | App version | `1.2.0` | `1.2.0` | -## Configuration changes +## Features + +### 1. Manager readiness path now defaults to /readyz + +The `manager` deployment readiness probe HTTP path default has changed from `/health` to `/readyz`. The liveness probe default path remains `/health`. + +| Probe | v2.2.x default | v2.3.x default | +|-------|----------------|----------------| +| `manager.readinessProbe.path` | `/health` (hardcoded) | `/readyz` | +| `manager.livenessProbe.path` | `/health` (hardcoded) | `/health` | + +Rendered probe block in v2.3.x: + +```yaml +readinessProbe: + httpGet: + path: /readyz + port: +livenessProbe: + httpGet: + path: /health + port: +``` + +### 2. Worker readiness path now defaults to /readyz + +The `worker` deployment readiness probe HTTP path default has changed from `/ready` to `/readyz`. The liveness probe default path remains `/health`. + +| Probe | v2.2.x default | v2.3.x default | +|-------|----------------|----------------| +| `worker.readinessProbe.path` | `/ready` (hardcoded) | `/readyz` | +| `worker.livenessProbe.path` | `/health` (hardcoded) | `/health` | -### Added values +Rendered probe block in v2.3.x: -_No direct values.yaml key changes detected._ +```yaml +readinessProbe: + httpGet: + path: /readyz + port: +livenessProbe: + httpGet: + path: /health + port: +``` + +### 3. Manager and worker probe paths are now configurable + +Both manager and worker deployments now read the probe `path` from `values.yaml`, alongside the timing fields that were already configurable. No new top-level keys are introduced; the existing `manager.readinessProbe`, `manager.livenessProbe`, `worker.readinessProbe`, and `worker.livenessProbe` blocks now also accept `path`. + +| Key | v2.2.x | v2.3.x | +|-----|--------|--------| +| `manager.readinessProbe.path` | not honored (hardcoded `/health`) | overridable, defaults to `/readyz` | +| `manager.livenessProbe.path` | not honored (hardcoded `/health`) | overridable, defaults to `/health` | +| `worker.readinessProbe.path` | not honored (hardcoded `/ready`) | overridable, defaults to `/readyz` | +| `worker.livenessProbe.path` | not honored (hardcoded `/health`) | overridable, defaults to `/health` | + +Example override to keep prior behavior: + +```yaml +manager: + readinessProbe: + path: /health +worker: + readinessProbe: + path: /ready +``` -### Removed values +## Configuration Changes -_No direct values.yaml key changes detected._ +No `values.yaml` keys were added, removed, or renamed. The change is in template defaults only. If your `values.yaml` does not pin probe paths, the readiness path will switch to `/readyz` automatically on upgrade. -### Changed operational values +| Setting | v2.2.x | v2.3.x | Notes | +|---------|--------|--------|-------| +| `manager.readinessProbe.path` (default) | `/health` (hardcoded) | `/readyz` | Override to `/health` if your image does not serve `/readyz` | +| `manager.livenessProbe.path` (default) | `/health` (hardcoded) | `/health` | Now overridable via values | +| `worker.readinessProbe.path` (default) | `/ready` (hardcoded) | `/readyz` | Override to `/ready` if your image does not serve `/readyz` | +| `worker.livenessProbe.path` (default) | `/health` (hardcoded) | `/health` | Now overridable via values | -_No image, env, secret, probe, ingress, service, port, or enablement changes detected in values.yaml._ +## Migration Steps -## Template changes +This upgrade requires no mandatory values changes. The Helm upgrade will roll the manager and worker deployments and update probe paths. -### Added files +**Recommended upgrade process:** -- No chart files added. +1. Review the changes using the helm-diff plugin (see [Preview changes before upgrading](#preview-changes-before-upgrading)). +2. Confirm that the deployed `reporter-manager` and `reporter-worker` images expose `/readyz`. If they do not, pin the prior paths in your values: -### Removed files + ```yaml + manager: + readinessProbe: + path: /health + worker: + readinessProbe: + path: /ready + ``` -- No chart files removed. +3. Run the upgrade command during a maintenance window. +4. Verify all pods are running and healthy after the upgrade: -### Modified files +```bash +kubectl get pods -n +``` -- `charts/reporter/CHANGELOG.md` -- `charts/reporter/Chart.yaml` -- `charts/reporter/templates/manager/deployment.yaml` -- `charts/reporter/templates/worker/deployment.yaml` +5. Check probe behavior for both components: -## Migration steps +```bash +kubectl logs -n -l app.kubernetes.io/name=reporter-manager --tail=50 +kubectl logs -n -l app.kubernetes.io/name=reporter-worker --tail=50 +kubectl describe pod -n -l app.kubernetes.io/name=reporter-manager | grep -A2 -E "Liveness|Readiness" +kubectl describe pod -n -l app.kubernetes.io/name=reporter-worker | grep -A2 -E "Liveness|Readiness" +``` -1. Read this guide and compare your custom values against `charts/reporter/values.yaml`. -2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings. -3. Render the chart locally with your production values and review the manifest diff. -4. Apply the upgrade in a controlled environment before production. +> **Note:** The upgrade triggers a rolling restart of both the manager and worker deployments. If a new readiness path returns non-2xx, pods will not become Ready and the rollout will pause. ## Preview changes before upgrading ```bash -helm diff upgrade reporter ./charts/reporter \ - --namespace \ - --values +helm diff upgrade reporter oci://registry-1.docker.io/lerianstudio/reporter-helm --version 2.3.0-beta.1 -n ``` +> **Note:** Requires the [helm-diff plugin](https://github.com/databus23/helm-diff). Install with: `helm plugin install https://github.com/databus23/helm-diff` + ## Command to upgrade ```bash -helm upgrade reporter ./charts/reporter \ - --namespace \ - --values +helm upgrade reporter oci://registry-1.docker.io/lerianstudio/reporter-helm --version 2.3.0-beta.1 -n ```