Skip to content

docs: add migration note for default-httplistenerpolicy Helm ownership conflict - #751

Open
kavix wants to merge 1 commit into
openchoreo:mainfrom
kavix:docs/httplistenerpolicy-helm-ownership-upgrade-note
Open

docs: add migration note for default-httplistenerpolicy Helm ownership conflict#751
kavix wants to merge 1 commit into
openchoreo:mainfrom
kavix:docs/httplistenerpolicy-helm-ownership-upgrade-note

Conversation

@kavix

@kavix kavix commented Jul 8, 2026

Copy link
Copy Markdown

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-httplistenerpolicy into the openchoreo-data-plane Helm chart), users who previously created this resource manually will encounter:

Error: UPGRADE FAILED: rendered manifests contain a resource that already exists.
Unable to continue with update: HTTPListenerPolicy "default-httplistenerpolicy" in namespace "..." exists and cannot be imported into the current release.

The new section explains how to resolve this by transferring ownership to Helm using kubectl annotate and kubectl label before running helm upgrade.

Related Issues

Checklist

  • Updated sidebars.ts if adding a new documentation page (not applicable — no new page)
  • Run npm run start to preview the changes locally
  • Run npm run build to ensure the build passes without errors
  • Verified all links are working (no broken links)

@coderabbitai

coderabbitai Bot commented Jul 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 22 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: openchoreo/openchoreo.github.io/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 2a69f956-f967-41ad-a4d2-cb67c737a37c

📥 Commits

Reviewing files that changed from the base of the PR and between b11e164 and a9a1dc4.

⛔ Files ignored due to path filters (2)
  • versioned_docs/version-v1.2.x/platform-engineer-guide/upgrades/v1.1-to-v1.2.mdx is excluded by !versioned_docs/**
  • versioned_docs/version-v1.3.x/platform-engineer-guide/upgrades/v1.1-to-v1.2.mdx is excluded by !versioned_docs/**
📒 Files selected for processing (1)
  • docs/platform-engineer-guide/upgrades/v1.1-to-v1.2.mdx
📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added a new “Known Migration Issues” section to the upgrade guide.
    • Documented a Helm ownership conflict that can block upgrades for an existing HTTPListenerPolicy.
    • Included step-by-step commands to transfer Helm ownership before continuing with the standard upgrade process.

Walkthrough

This PR adds a new "Known Migration Issues" section to the platform engineer upgrade guide, documenting a Helm ownership conflict for the default-httplistenerpolicy resource and providing kubectl annotate/kubectl label commands to resolve it before upgrading.

Changes

Upgrade Documentation Update

Layer / File(s) Summary
Known Migration Issues section
docs/platform-engineer-guide/upgrades.mdx		 Documents a Helm ownership conflict for default-httplistenerpolicy and provides kubectl annotate/kubectl label commands to transfer ownership prior to upgrade.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change and the Helm ownership conflict it addresses.
Description check ✅ Passed The description matches the template with Purpose, Related Issues, and a completed Checklist, including the relevant issue reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

coderabbitai[bot]
coderabbitai Bot reviewed Jul 8, 2026
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between f4de773 and b11e164.

📒 Files selected for processing (1)
  • docs/platform-engineer-guide/upgrades.mdx

Comment thread docs/platform-engineer-guide/upgrades.mdx Outdated
@kavix
kavix force-pushed the docs/httplistenerpolicy-helm-ownership-upgrade-note branch 2 times, most recently from 6673314 to 11625de Compare October 1, 2026 10:08
@kavix
kavix force-pushed the docs/httplistenerpolicy-helm-ownership-upgrade-note branch from 11625de to a9a1dc4 Compare October 1, 2026 10:14
@kavix

kavix commented Oct 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Author

Hi @chathuranga95,

I've rebased onto main to resolve the merge conflict and addressed the CodeRabbit review feedback (added explicit -n <release-namespace> and documented both delete and transfer ownership options). All checks and build pass.

Could you please review this when you have a moment? Thanks!

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@kavix