docs: add migration note for default-httplistenerpolicy Helm ownership conflict#751
Open
kavix wants to merge 1 commit into
Open
Conversation
…p conflict Signed-off-by: kavix <kavix@yahoo.com>
Contributor
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR adds a new "Known Migration Issues" section to the platform engineer upgrade guide, documenting a Helm ownership conflict for the ChangesUpgrade Documentation Update
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 89-100: The ownership-transfer commands in the upgrades guide omit
the target namespace, so they can annotate/label the wrong httplistenerpolicy.
Update the kubectl annotate and kubectl label examples to include the Data
Plane/release namespace explicitly, while keeping the existing resource name
default-httplistenerpolicy and Helm metadata keys in the same upgrade
instructions section.
🪄 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: 5508eeda-3433-4bd3-8659-0573244cf0cb
📒 Files selected for processing (1)
docs/platform-engineer-guide/upgrades.mdx
Comment on lines
+89
to
+100
| To resolve this, transfer ownership of the resource to Helm **before** running `helm upgrade` by applying the following annotation and label: | ||
|
|
||
| ```bash | ||
| # Replace <release-name> and <release-namespace> with your actual values | ||
| kubectl annotate httplistenerpolicy default-httplistenerpolicy \ | ||
| meta.helm.sh/release-name=<release-name> \ | ||
| meta.helm.sh/release-namespace=<release-namespace> \ | ||
| --overwrite | ||
|
|
||
| kubectl label httplistenerpolicy default-httplistenerpolicy \ | ||
| app.kubernetes.io/managed-by=Helm \ | ||
| --overwrite |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Add an explicit namespace to the ownership-transfer commands.
Right now kubectl annotate / kubectl label will run against whatever namespace is active in the current context, which makes these instructions easy to apply to the wrong object. Please include the Data Plane/release namespace in both commands so the Helm ownership metadata is written to the existing default-httplistenerpolicy resource.
Suggested fix
-kubectl annotate httplistenerpolicy default-httplistenerpolicy \
+kubectl annotate -n <release-namespace> httplistenerpolicy default-httplistenerpolicy \
meta.helm.sh/release-name=<release-name> \
meta.helm.sh/release-namespace=<release-namespace> \
--overwrite
-kubectl label httplistenerpolicy default-httplistenerpolicy \
+kubectl label -n <release-namespace> httplistenerpolicy default-httplistenerpolicy \
app.kubernetes.io/managed-by=Helm \
--overwrite📝 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
| To resolve this, transfer ownership of the resource to Helm **before** running `helm upgrade` by applying the following annotation and label: | |
| ```bash | |
| # Replace <release-name> and <release-namespace> with your actual values | |
| kubectl annotate httplistenerpolicy default-httplistenerpolicy \ | |
| meta.helm.sh/release-name=<release-name> \ | |
| meta.helm.sh/release-namespace=<release-namespace> \ | |
| --overwrite | |
| kubectl label httplistenerpolicy default-httplistenerpolicy \ | |
| app.kubernetes.io/managed-by=Helm \ | |
| --overwrite | |
| To resolve this, transfer ownership of the resource to Helm **before** running `helm upgrade` by applying the following annotation and label: | |
🤖 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 89 - 100, The
ownership-transfer commands in the upgrades guide omit the target namespace, so
they can annotate/label the wrong httplistenerpolicy. Update the kubectl
annotate and kubectl label examples to include the Data Plane/release namespace
explicitly, while keeping the existing resource name default-httplistenerpolicy
and Helm metadata keys in the same upgrade instructions section.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Adds a Known Migration Issues section to the upgrade guide documenting the
HTTPListenerPolicy(default-httplistenerpolicy) ownership conflict that affects users who followed older README setup instructions for the Data Plane.When upgrading OpenChoreo after the change in openchoreo/openchoreo#4080 (which moved
default-httplistenerpolicyinto theopenchoreo-data-planeHelm chart), users who previously created this resource manually will encounter:The new section explains how to resolve this by transferring ownership to Helm using
kubectl annotateandkubectl labelbefore runninghelm upgrade.Related Issues
Checklist
sidebars.tsif adding a new documentation page (not applicable — no new page)npm run startto preview the changes locallynpm run buildto ensure the build passes without errors