docs(lerian-notification): add v1.0 upgrade guide#1382
Conversation
WalkthroughThis PR adds upgrade documentation for the lerian-notification Helm chart, guiding users from version 0.1.0 to 1.0.0-beta.3. The guide includes configuration changes, affected templates, breaking changes, and step-by-step migration instructions with example Helm commands. ChangesHelm Chart Upgrade Documentation
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@charts/lerian-notification/docs/UPGRADE-1.0.md`:
- Around line 39-41: The "Changed operational values" section contradicts the
values list because secrets.DATABASE_URL is newly added; update the upgrade
notes so they are consistent by either removing secrets.DATABASE_URL from the
earlier "new values" list or by updating the "Changed operational values"
paragraph to mention that secrets.DATABASE_URL was added and requires operator
attention (e.g., provide guidance to set the new secret); locate references to
"secrets.DATABASE_URL" and the "Changed operational values" heading and make the
text consistent.
- Line 3: The single-line Topics list in UPGRADE-1.0.md is concatenating
multiple links into one bullet; split that long line into separate list items so
each link gets its own bullet (e.g., replace the combined string
"**[Overview](`#overview`)**- **[Version changes](`#version-changes`)**..." with
separate lines like "- **[Overview](`#overview`)**", "- **[Version
changes](`#version-changes`)**", etc.) to restore proper markdown list formatting
and readability.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9982c7b7-f5d8-447c-84e1-6e63b21ed294
📒 Files selected for processing (1)
charts/lerian-notification/docs/UPGRADE-1.0.md
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@charts/lerian-notification/docs/UPGRADE-1.0.md`:
- Line 133: Update the Helm preview and upgrade commands in UPGRADE-1.0.md to
include a values file reference or call out that users must supply
configuration; specifically modify the shown helm diff/upgrade command examples
(the lines containing "helm diff upgrade lerian-notification ..." and the
corresponding upgrade command at the later occurrence) to either append "-f
values.yaml" (or "-f <path/to/values.yaml>") or add a preceding note: "Note:
Replace values.yaml with your values file path, or use --set flags to override
individual values (you must set secrets.DATABASE_URL)". Ensure the change is
made for both occurrences referenced in the comment.
- Line 43: The DATABASE_URL example currently uses an insecure query parameter
("sslmode=disable"); update the example value (the DATABASE_URL secret string)
to use a secure SSL mode such as "sslmode=require" or "sslmode=verify-full", or,
if keeping "sslmode=disable" for local/dev only, add an explicit inline warning
comment alongside the DATABASE_URL example stating it is for local development
only and must not be used in production.
- Line 21: The document title in UPGRADE-1.0.md currently reads "v1.x" but the
body targets "1.0.0-beta.3"; update the title string "v1.x" to "v1.0.0-beta.3"
so it matches the overview line and all version references (search for the title
header and replace it), ensuring consistency with the documented destination
version throughout the file; alternatively, if the intended target is a stable
release, change all occurrences of "1.0.0-beta.3" in the document (overview,
version table, and upgrade commands) to "1.0.0" instead—pick one approach and
apply it consistently.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 0a6d096b-8fe3-4b28-b425-7e806e4fe7ad
📒 Files selected for processing (1)
charts/lerian-notification/docs/UPGRADE-1.0.md
|
|
||
| ## Overview | ||
|
|
||
| This guide covers the `lerian-notification` chart upgrade from `0.1.0` to `1.0.0-beta.3`. The application image (`appVersion: 0.1.0`) is unchanged, but the chart is now production-shaped: the migrations Job is rewritten for distroless, the security context defaults align with the Kubernetes Pod Security Standards restricted profile, and several rendering bugs (HPA, PDB, Redis defaults) are fixed. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if stable 1.0.0 is published in the OCI registry
helm show chart oci://registry-1.docker.io/lerianstudio/lerian-notification-helm --version 1.0.0 2>&1 || echo "Stable 1.0.0 not found"
helm show chart oci://registry-1.docker.io/lerianstudio/lerian-notification-helm --version 1.0.0-beta.3 2>&1 || echo "Beta 1.0.0-beta.3 not found"Repository: LerianStudio/helm
Length of output: 198
🏁 Script executed:
#!/bin/bash
set -euo pipefail
FILE="charts/lerian-notification/docs/UPGRADE-1.0.md"
if [ ! -f "$FILE" ]; then echo "Missing $FILE"; exit 1; fi
nl -ba "$FILE" | sed -n '1,220p'Repository: LerianStudio/helm
Length of output: 104
🌐 Web query:
lerianstudio l erian-notification-helm 1.0.0 chart version
💡 Result:
Chart version for lerianstudio/lerian-notification-helm 1.0.0: 1.0.0. Lerian’s Helm chart version compatibility documentation shows that Helm chart version 1.0.0 corresponds to appVersion 1.0.0 (i.e., chart version and app version are the same for 1.0.0) [1].
Citations:
🌐 Web query:
oci://registry-1.docker.io/lerianstudio/lerian-notification-helm versions 1.0.0
💡 Result:
There is no publicly available evidence of a Helm chart named oci://registry-1.docker.io/lerianstudio/lerian-notification-helm [1][2][3]. While Lerian Studio maintains a repository of OCI-based Helm charts for their platform—including components like Midaz, plugins, and infrastructure tools like tracer-helm and reporter-helm [1][2][3][4][5]—the specific chart path provided does not appear in their official documentation or public registries [2][3][5]. If you are looking for a notification-related component within the Lerian ecosystem, it is recommended to check their official documentation index at https://docs.lerian.studio/en/platform/helm/helm-overview or consult the version compatibility matrix provided in their platform documentation [2][3][4].
Citations:
- 1: https://github.com/LerianStudio/helm?tab=readme-ov-file
- 2: https://docs.lerian.studio/en/platform/helm/helm-version-compatibility
- 3: https://docs.lerian.studio/en/platform/helm/helm-overview
- 4: https://docs.lerian.studio/en/platform/helm/reporter/reporter-helm
- 5: https://docs.lerian.studio/en/platform/helm/infrastructure/infrastructure-helm
🌐 Web query:
lerian-notification-helm 1.0.0-beta.3 release
💡 Result:
I could not find any authoritative release information for “lerian-notification-helm” version “1.0.0-beta.3”. The closest matches in search results are: 1) A GitHub release tag “v1.0.0-beta.3” under the unrelated repository “LerianStudio/lib-observability” (published 2026-05-13) [1]. 2) Lerian’s Helm chart docs and repo overview pages, which describe Lerian’s Helm chart distribution (OCI registry) and versioning scheme, but do not mention a chart named “lerian-notification-helm” or a “1.0.0-beta.3” release for it [2][3]. 3) A Lerian Helm charts repository readme that shows chart version mappings for various products/plugins, but again no “lerian-notification-helm” chart name or the specific beta release tag appears in the surfaced material [4]. If you can share the exact chart repository/OCI path (e.g., something like oci://registry-1.docker.io/lerianstudio/) or a link to the release page you mean, I can precisely pull the “1.0.0-beta.3” release notes/artifacts and summarize them.
Citations:
- 1: https://github.com/LerianStudio/lib-observability/releases/tag/v1.0.0-beta.3
- 2: https://docs.lerian.studio/en/platform/helm/helm-version-compatibility
- 3: https://docs.lerian.studio/en/platform/helm/helm-overview
- 4: https://github.com/LerianStudio/helm?tab=readme-ov-file
🏁 Script executed:
#!/bin/bash
set -euo pipefail
FILE="charts/lerian-notification/docs/UPGRADE-1.0.md"
test -f "$FILE" || { echo "Missing $FILE"; exit 1; }
echo "=== Title & first 120 lines (with line numbers) ==="
awk '{printf "%5d %s\n", NR, $0}' "$FILE" | sed -n '1,120p'
echo
echo "=== Version-related references ==="
rg -n "beta|1\.0\.0|v1\.x|v0\.x" "$FILE" || trueRepository: LerianStudio/helm
Length of output: 9821
Align the upgrade target/version in UPGRADE-1.0.md title with the documented destination
The guide title says v1.x (line 1), but the content consistently targets 1.0.0-beta.3 (overview line 21, version table line 83, and upgrade commands lines 133/141). Update the title to v1.0.0-beta.3 (or switch all 1.0.0-beta.3 references to 1.0.0 if that’s the intended stable target).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@charts/lerian-notification/docs/UPGRADE-1.0.md` at line 21, The document
title in UPGRADE-1.0.md currently reads "v1.x" but the body targets
"1.0.0-beta.3"; update the title string "v1.x" to "v1.0.0-beta.3" so it matches
the overview line and all version references (search for the title header and
replace it), ensuring consistency with the documented destination version
throughout the file; alternatively, if the intended target is a stable release,
change all occurrences of "1.0.0-beta.3" in the document (overview, version
table, and upgrade commands) to "1.0.0" instead—pick one approach and apply it
consistently.
|
|
||
| ```yaml | ||
| secrets: | ||
| DATABASE_URL: "postgres://USER:URLENCODED_PW@HOST:PORT/DB?sslmode=disable" |
There was a problem hiding this comment.
Use a secure SSL mode in the DATABASE_URL example.
The example shows sslmode=disable, which disables encryption for database connections and is inappropriate for production. Update the example to use sslmode=require or sslmode=verify-full, or add an explicit warning that the shown mode is for local development only.
🔒 Proposed fix for secure default
- DATABASE_URL: "postgres://USER:URLENCODED_PW@HOST:PORT/DB?sslmode=disable"
+ DATABASE_URL: "postgres://USER:URLENCODED_PW@HOST:PORT/DB?sslmode=require"Or add a warning if the insecure mode is intentional for the example:
+> **Security:** The example shows `sslmode=disable` for simplicity. Production deployments should use `sslmode=require` or `sslmode=verify-full`.
+
```yaml
secrets:
DATABASE_URL: "postgres://USER:URLENCODED_PW@HOST:PORT/DB?sslmode=disable"</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
DATABASE_URL: "postgres://USER:URLENCODED_PW@HOST:PORT/DB?sslmode=require"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@charts/lerian-notification/docs/UPGRADE-1.0.md` at line 43, The DATABASE_URL
example currently uses an insecure query parameter ("sslmode=disable"); update
the example value (the DATABASE_URL secret string) to use a secure SSL mode such
as "sslmode=require" or "sslmode=verify-full", or, if keeping "sslmode=disable"
for local/dev only, add an explicit inline warning comment alongside the
DATABASE_URL example stating it is for local development only and must not be
used in production.
| ## Preview changes before upgrading | ||
|
|
||
| ```bash | ||
| helm diff upgrade lerian-notification oci://registry-1.docker.io/lerianstudio/lerian-notification-helm --version 1.0.0-beta.3 -n lerian-notification |
There was a problem hiding this comment.
Add values file reference to Helm commands.
Both the preview and upgrade commands omit -f values.yaml, but Migration Step 1 requires setting secrets.DATABASE_URL. Add the values file flag or include a note reminding users to supply their configuration.
📝 Proposed fix
-helm diff upgrade lerian-notification oci://registry-1.docker.io/lerianstudio/lerian-notification-helm --version 1.0.0-beta.3 -n lerian-notification
+helm diff upgrade lerian-notification oci://registry-1.docker.io/lerianstudio/lerian-notification-helm --version 1.0.0-beta.3 -f values.yaml -n lerian-notification-helm upgrade lerian-notification oci://registry-1.docker.io/lerianstudio/lerian-notification-helm --version 1.0.0-beta.3 -n lerian-notification
+helm upgrade lerian-notification oci://registry-1.docker.io/lerianstudio/lerian-notification-helm --version 1.0.0-beta.3 -f values.yaml -n lerian-notificationOr add a note before the commands:
> **Note:** Replace `values.yaml` with your values file path, or use `--set` flags for individual overrides.Also applies to: 141-141
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@charts/lerian-notification/docs/UPGRADE-1.0.md` at line 133, Update the Helm
preview and upgrade commands in UPGRADE-1.0.md to include a values file
reference or call out that users must supply configuration; specifically modify
the shown helm diff/upgrade command examples (the lines containing "helm diff
upgrade lerian-notification ..." and the corresponding upgrade command at the
later occurrence) to either append "-f values.yaml" (or "-f
<path/to/values.yaml>") or add a preceding note: "Note: Replace values.yaml with
your values file path, or use --set flags to override individual values (you
must set secrets.DATABASE_URL)". Ensure the change is made for both occurrences
referenced in the comment.
guimoreirar
changed the title
2 participants
Summary
Requested by: @guimoreirar