docs: update upgrade instructions for Observability Plane and modules#628
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe Observability Plane upgrade documentation now includes a pre-upgrade observer deployment strategy patch for sqlite backends and post-upgrade steps to synchronize Logs, Traces, and Metrics module versions to align with the target OpenChoreo Helm chart, including version-specific configuration flags. ChangesObservability Plane Upgrade Steps
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@CodeRabbit review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/platform-engineer-guide/upgrades.mdx (1)
141-191:⚠️ Potential issue | 🟠 Major | ⚡ Quick winAdd explicit multi-cluster context for module sync commands.
The new Logs/Traces/Metrics
helm upgrade --installcommands don’t include--kube-context, while the multi-cluster section does. In multi-cluster setups this can apply upgrades to the wrong cluster if the active context is not the observability cluster.Suggested doc patch
helm upgrade --install observability-logs-opensearch \ oci://ghcr.io/openchoreo/helm-charts/observability-logs-opensearch \ + --kube-context $OP_CONTEXT \ --create-namespace \ --namespace openchoreo-observability-plane \ --version 0.4.0 \ --reset-then-reuse-values \ --set openSearchSetup.openSearchSecretName="opensearch-admin-credentials" \ --set adapter.openSearchSecretName="opensearch-admin-credentials" @@ helm upgrade --install observability-traces-opensearch \ oci://ghcr.io/openchoreo/helm-charts/observability-tracing-opensearch \ + --kube-context $OP_CONTEXT \ --create-namespace \ --namespace openchoreo-observability-plane \ --version 0.4.1 \ --reset-then-reuse-values \ --set openSearch.enabled=false \ --set openSearchSetup.openSearchSecretName="opensearch-admin-credentials" @@ helm upgrade --install observability-metrics-prometheus \ oci://ghcr.io/openchoreo/helm-charts/observability-metrics-prometheus \ + --kube-context $OP_CONTEXT \ --create-namespace \ --namespace openchoreo-observability-plane \ --version 0.6.1 \ --reset-then-reuse-values \ --set adapter.image.tag=""🤖 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 `@docs/platform-engineer-guide/upgrades.mdx` around lines 141 - 191, The helm upgrade snippets for observability-logs-opensearch, observability-traces-opensearch, and observability-metrics-prometheus are missing the --kube-context flag, which can cause upgrades to run against the wrong cluster in multi-cluster setups; update each helm upgrade --install command (for observability-logs-opensearch, observability-traces-opensearch, and observability-metrics-prometheus) to accept and pass a context variable (e.g., --kube-context $OP_CONTEXT) consistent with the Multi Cluster Deployment examples so the commands explicitly target the observability cluster.
🤖 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 `@docs/platform-engineer-guide/upgrades.mdx`:
- Around line 124-125: Fix the typo in the sentence beginning "If you are using
the `sqlite` as the alert store backend..." in upgrades.mdx by replacing
"follwing" with "following" so the sentence reads "...execute the following
patch command before upgrading the observability plane to avoid Helm upgrade
failures:"; update the exact string in that paragraph.
---
Outside diff comments:
In `@docs/platform-engineer-guide/upgrades.mdx`:
- Around line 141-191: The helm upgrade snippets for
observability-logs-opensearch, observability-traces-opensearch, and
observability-metrics-prometheus are missing the --kube-context flag, which can
cause upgrades to run against the wrong cluster in multi-cluster setups; update
each helm upgrade --install command (for observability-logs-opensearch,
observability-traces-opensearch, and observability-metrics-prometheus) to accept
and pass a context variable (e.g., --kube-context $OP_CONTEXT) consistent with
the Multi Cluster Deployment examples so the commands explicitly target the
observability cluster.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: c88ec1b0-9d51-41a3-901a-c033db90c5fc
📒 Files selected for processing (1)
docs/platform-engineer-guide/upgrades.mdx
… modules Signed-off-by: Akila-I <akila.99g@gmail.com>
2 participants
Purpose
This pull request updates the upgrade documentation for the Observability Plane, adding important instructions to prevent Helm upgrade failures and ensuring compatibility with the latest OpenChoreo modules. The main changes provide guidance on patching deployments and upgrading observability modules.
Deployment strategy and upgrade instructions:
sqlitealert store backend.Module version upgrades:
Related Issues
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors