Skip to content

[hotfix] docs(otel-collector-lerian): add v3.1 upgrade guide #1384

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.

Sign up for GitHub

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

Open
gandalf-at-lerian wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[hotfix] docs(otel-collector-lerian): add v3.1 upgrade guide #1384

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
67 changes: 67 additions & 0 deletions charts/otel-collector-lerian/docs/UPGRADE-3.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Helm Upgrade from v3.0.x to v3.1.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)**
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix the table of contents formatting.

All TOC items are concatenated on a single line without proper spacing or line breaks, making it hard to read. Each topic should be on its own line as a separate bullet point.

📝 Proposed fix for TOC formatting 
-- **[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`)**
+- **[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`)**
📝 Committable suggestion

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

Suggested change
- **[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`)**
- **[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`)**
🤖 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/otel-collector-lerian/docs/UPGRADE-3.1.md` at line 3, The table of
contents string currently concatenates all items on one line; split that single
line into separate markdown list items so each topic appears on its own line
(e.g., replace the combined line "- **[Overview](`#overview`)**- **[Version
changes](`#version-changes`)**..." with a newline-separated bullet list), ensuring
each entry uses a leading "- " (or "*" ) and has proper spacing and line breaks
so links like "**[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`)**", and
"**[Command to upgrade](`#command-to-upgrade`)**" are each on their own line.


## Overview
This guide covers the `otel-collector-lerian` chart upgrade from `3.0.0` to `3.1.0-beta.2`. 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 | `3.0.0` | `3.1.0-beta.2` |
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add a note about upgrading to a beta version.

The guide directs users to upgrade to 3.1.0-beta.2, which is a pre-release version. Consider adding a note or warning in the Overview or Version changes section to make users aware they are upgrading to a beta release, which may not have the same stability guarantees as a stable release.

🤖 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/otel-collector-lerian/docs/UPGRADE-3.1.md` at line 14, Update the
upgrade notes to warn users that `3.1.0-beta.2` is a pre-release: add a clear
one-sentence warning in the Overview and/or Version changes section stating that
`3.1.0-beta.2` is a beta release with potentially reduced stability and
recommend testing before production; specifically flag the table entry
`3.1.0-beta.2` with this note so readers upgrading from `3.0.0` see the beta
disclaimer.

| App version | `0.1.0` | `0.1.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/otel-collector-lerian/CHANGELOG.md`
- `charts/otel-collector-lerian/Chart.yaml`

## Migration steps

1. Read this guide and compare your custom values against `charts/otel-collector-lerian/values.yaml`.
2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings.
Comment on lines +48 to +49
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove inconsistent emphasis on unchanged settings.

Line 49 instructs users to pay special attention to "secrets, configmaps, probes, ingress, and service settings," but line 29 explicitly states "No image, env, secret, probe, ingress, service, port, or enablement changes detected in values.yaml." This creates confusion about whether these settings actually changed. Since no changes were detected, either remove the "especially" clause or make it generic.

📝 Proposed fix to remove inconsistent emphasis 
 1. Read this guide and compare your custom values against `charts/otel-collector-lerian/values.yaml`.
-2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings.
+2. Review your custom values to ensure compatibility with the new chart version.
 3. Render the chart locally with your production values and review the manifest diff.
 4. Apply the upgrade in a controlled environment before production.
🤖 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/otel-collector-lerian/docs/UPGRADE-3.1.md` around lines 48 - 49, The
instructions currently emphasize "secrets, configmaps, probes, ingress, and
service settings" while an earlier sentence states "No image, env, secret,
probe, ingress, service, port, or enablement changes detected in values.yaml",
creating a contradiction; edit the sentence containing the phrase "especially
secrets, configmaps, probes, ingress, and service settings" to either remove the
"especially ..." clause or replace it with a generic prompt such as "add any
required new values for your environment" so the guidance in the paragraph
consistently reflects that no changes were detected in values.yaml.

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 otel-collector-lerian ./charts/otel-collector-lerian \
--namespace <namespace> \
--values <your-values.yaml>
```

## Command to upgrade

```bash
helm upgrade otel-collector-lerian ./charts/otel-collector-lerian \
--namespace <namespace> \
--values <your-values.yaml>
```
Loading