Add documentation for addon deletion-orphan annotation #518
Conversation
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
This commit adds comprehensive documentation for the addon.open-cluster-management.io/deletion-orphan annotation that allows addon developers to preserve specific resources when an addon is deleted. Changes include: - New section "Orphaning manifests on addon deletion" explaining the deletion-orphan annotation - Usage examples and use cases for orphaning resources - Complete example with PersistentVolumeClaim preservation - Integration with addon template documentation showing the annotation can be used in AddOnTemplate manifests - Example in the AddOnTemplate YAML demonstrating the annotation This documentation is based on the implementation in addon-framework/pkg/addonmanager/controllers/agentdeploy/utils.go (getDeletionOrphaningRule function). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: zhujian <jiazhu@redhat.com>
✅ Deploy Preview for open-cluster-management ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
Author
|
/cc @zhiweiyin318 |
Member
|
/approve |
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiujian16, zhujian7 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Member
|
/lgtm |
openshift-merge-bot
bot
merged commit 127e478
into
open-cluster-management-io:main
7 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
This PR adds comprehensive documentation for the
addon.open-cluster-management.io/deletion-orphanannotation that allows addon developers to preserve specific resources when an addon is deleted.Changes
addon.open-cluster-management.io/deletion-orphanannotation usage and behaviorDocumentation Reference
The implementation is based on the
getDeletionOrphaningRulefunction in:https://github.com/open-cluster-management-io/addon-framework/blob/c2f5c52daf5a8057160233e3bfe12c94f3970d3b/pkg/addonmanager/controllers/agentdeploy/utils.go#L274-L311
Example usage in addon template:
https://github.com/open-cluster-management-io/ocm/blob/34cd9a25494b69097474fb5fd3c2add50692a4ae/test/e2e/manifests/addon/addon_template.yaml#L92-L93
🤖 Generated with Claude Code