From e595126682b200d0689f64d45da92d991709c7d9 Mon Sep 17 00:00:00 2001 From: Gandalf Date: Sat, 16 May 2026 12:27:54 -0300 Subject: [PATCH 1/2] docs(plugin-br-bank-transfer): add v1.5 upgrade guide Requested-by: @guimoreirar --- .../docs/UPGRADE-1.5.md | 68 +++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 charts/plugin-br-bank-transfer/docs/UPGRADE-1.5.md diff --git a/charts/plugin-br-bank-transfer/docs/UPGRADE-1.5.md b/charts/plugin-br-bank-transfer/docs/UPGRADE-1.5.md new file mode 100644 index 00000000..596e283e --- /dev/null +++ b/charts/plugin-br-bank-transfer/docs/UPGRADE-1.5.md @@ -0,0 +1,68 @@ +# Helm Upgrade from v1.4.x to v1.5.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 `plugin-br-bank-transfer` chart upgrade from `1.4.0` to `1.5.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 | `1.4.0` | `1.5.0-beta.1` | +| App version | `2.4.0` | `2.4.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/plugin-br-bank-transfer/Chart.yaml` +- `charts/plugin-br-bank-transfer/templates/deployment.yaml` +- `charts/plugin-br-bank-transfer/values.yaml` + +## Migration steps + +1. Read this guide and compare your custom values against `charts/plugin-br-bank-transfer/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 plugin-br-bank-transfer ./charts/plugin-br-bank-transfer \ + --namespace \ + --values +``` + +## Command to upgrade + +```bash +helm upgrade plugin-br-bank-transfer ./charts/plugin-br-bank-transfer \ + --namespace \ + --values +``` From b6482a272cc417f7c303902fd049e4094b6a149c Mon Sep 17 00:00:00 2001 From: Gandalf Date: Fri, 29 May 2026 11:48:39 -0300 Subject: [PATCH 2/2] docs(plugin-br-bank-transfer): align upgrade guide format Requested-by: @guimoreirar --- .../docs/UPGRADE-1.5.md | 129 +++++++++++++----- 1 file changed, 94 insertions(+), 35 deletions(-) diff --git a/charts/plugin-br-bank-transfer/docs/UPGRADE-1.5.md b/charts/plugin-br-bank-transfer/docs/UPGRADE-1.5.md index 596e283e..1a87e222 100644 --- a/charts/plugin-br-bank-transfer/docs/UPGRADE-1.5.md +++ b/charts/plugin-br-bank-transfer/docs/UPGRADE-1.5.md @@ -1,68 +1,127 @@ # Helm Upgrade from v1.4.x to v1.5.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](#overview)** +- **[Features](#features)** + - [1. Parameterized liveness and readiness probes](#1-parameterized-liveness-and-readiness-probes) + - [2. Default readiness probe path moved to /readyz](#2-default-readiness-probe-path-moved-to-readyz) +- **[Configuration Changes](#configuration-changes)** +- **[Migration Steps](#migration-steps)** +- **[Preview changes before upgrading](#preview-changes-before-upgrading)** +- **[Command to upgrade](#command-to-upgrade)** ## Overview -This guide covers the `plugin-br-bank-transfer` chart upgrade from `1.4.0` to `1.5.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. +This release moves the bank-transfer pod probes from hardcoded values to fully configurable Helm values, and aligns the default readiness probe path with the `/readyz` convention used by other Lerian charts. The application image is unchanged. -## Version changes +## Features -| Field | Previous | Current | -|-------|----------|---------| -| Chart version | `1.4.0` | `1.5.0-beta.1` | -| App version | `2.4.0` | `2.4.0` | +### 1. Parameterized liveness and readiness probes -## Configuration changes +The `bankTransfer` deployment template now reads every probe field from `values.yaml` instead of hardcoding them. Two new top-level keys are added with empty defaults so existing installations behave the same unless explicitly overridden: + +```yaml +bankTransfer: + # -- Readiness probe configuration. All fields override chart defaults. + readinessProbe: {} + # -- Liveness probe configuration. All fields override chart defaults. + livenessProbe: {} +``` -### Added values +The following fields are now overridable on both probes: + +| Field | Liveness default | Readiness default | +|-----------------------|------------------|-------------------| +| `path` | `/health/live` | `/readyz` | +| `initialDelaySeconds` | 15 | 5 | +| `periodSeconds` | 20 | 10 | +| `timeoutSeconds` | 5 | 5 | +| `successThreshold` | 1 | 1 | +| `failureThreshold` | 3 | 3 | + +Example override: + +```yaml +bankTransfer: + livenessProbe: + path: /health/live + initialDelaySeconds: 30 + failureThreshold: 5 + readinessProbe: + path: /readyz + initialDelaySeconds: 10 +``` -_No direct values.yaml key changes detected._ +### 2. Default readiness probe path moved to /readyz -### Removed values +The hardcoded readiness probe path `/health/ready` is replaced by a configurable value whose default is now `/readyz`. -_No direct values.yaml key changes detected._ +| Component | v1.4.0 | v1.5.0-beta.1 | +|---------------------------------|-----------------|---------------| +| readiness probe path (default) | /health/ready | /readyz | +| liveness probe path (default) | /health/live | /health/live | -### Changed operational values +If your application image already exposes `/readyz`, no action is required. If it only exposes `/health/ready`, set the readiness path back explicitly so the existing endpoint keeps being probed: -_No image, env, secret, probe, ingress, service, port, or enablement changes detected in values.yaml._ +```yaml +bankTransfer: + readinessProbe: + path: /health/ready +``` -## Template changes +> **Note:** This change only affects how Kubernetes probes the pod. It does not change the application binary, ports, or any environment variable. -### Added files +## Configuration Changes -- No chart files added. +The following table summarizes the value changes: -### Removed files +| Setting | v1.4.0 | v1.5.0-beta.1 | +|--------------------------------------------------|-----------------|---------------| +| Chart `version` | 1.4.0 | 1.5.0-beta.1 | +| Chart `appVersion` | 2.4.0 | 2.4.0 | +| `bankTransfer.livenessProbe` | _hardcoded_ | `{}` (overridable) | +| `bankTransfer.readinessProbe` | _hardcoded_ | `{}` (overridable) | +| readiness probe path (default) | `/health/ready` | `/readyz` | +| liveness probe path (default) | `/health/live` | `/health/live` | -- No chart files removed. +No keys are removed or renamed. All previous `values.yaml` overrides remain valid; the new probe blocks are additive and default to empty. -### Modified files +## Migration Steps -- `charts/plugin-br-bank-transfer/Chart.yaml` -- `charts/plugin-br-bank-transfer/templates/deployment.yaml` -- `charts/plugin-br-bank-transfer/values.yaml` +This upgrade requires no manual migration of persistent data. The Helm upgrade will trigger a rolling restart of the bank-transfer deployment with the new probe configuration. -## Migration steps +**Recommended upgrade process:** -1. Read this guide and compare your custom values against `charts/plugin-br-bank-transfer/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. +1. Confirm whether your application image exposes `/readyz`. If it does not, plan to set `bankTransfer.readinessProbe.path` to `/health/ready` (or whatever your image actually serves) in your overrides before upgrading. +2. Review the changes using the helm-diff plugin (see [Preview changes before upgrading](#preview-changes-before-upgrading)) +3. Ensure you have a recent backup of your data (if using chart-managed databases) +4. Run the upgrade command during a maintenance window +5. Verify all pods are running and healthy after the upgrade + +```bash +kubectl get pods -n +``` + +6. Check service logs for any startup or probe failures + +```bash +kubectl logs -n -l app.kubernetes.io/name=plugin-br-bank-transfer-helm --tail=50 +kubectl describe pod -n -l app.kubernetes.io/name=plugin-br-bank-transfer-helm | grep -E "Liveness|Readiness" +``` + +> **Note:** The upgrade will trigger a rolling restart of the bank-transfer pods. Depending on your replica count and readiness probe configuration, this may cause brief service interruptions. ## Preview changes before upgrading ```bash -helm diff upgrade plugin-br-bank-transfer ./charts/plugin-br-bank-transfer \ - --namespace \ - --values +helm diff upgrade plugin-br-bank-transfer oci://registry-1.docker.io/lerianstudio/plugin-br-bank-transfer-helm --version 1.5.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 plugin-br-bank-transfer ./charts/plugin-br-bank-transfer \ - --namespace \ - --values +helm upgrade plugin-br-bank-transfer oci://registry-1.docker.io/lerianstudio/plugin-br-bank-transfer-helm --version 1.5.0-beta.1 -n ```