-
Notifications
You must be signed in to change notification settings - Fork 13
Add upgrade oam plugin docs #96
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.
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
base: main
Are you sure you want to change the base?
Conversation
WalkthroughA new documentation file is added providing end-to-end instructions for upgrading the OAM Application Cluster Plugin in ACP-managed clusters, including webhook cleanup procedures and the violet tool-based upgrade workflow. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
Poem
Pre-merge checks✅ Passed checks (3 passed)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/en/solutions/How_to_Upgrade_OAM_Application_Cluster_Plugin.md (1)
154-158: Fix awkward verb repetition in upgrade instruction.Line 156 reads "Click Upgrade to Upgrade on the plugin details page," which has redundant verb usage. Rephrase for clarity.
🔎 Proposed wording improvement
-1. Click **Upgrade** to Upgrade on the plugin details page. +1. Click the **Upgrade** button on the plugin details page.Alternatively:
-1. Click **Upgrade** to Upgrade on the plugin details page. +1. Click **Upgrade** to proceed with the upgrade.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/en/solutions/How_to_Upgrade_OAM_Application_Cluster_Plugin.md
🔇 Additional comments (4)
docs/en/solutions/How_to_Upgrade_OAM_Application_Cluster_Plugin.md (4)
1-11: Clear document structure with appropriate frontmatter.The introduction and prerequisites sections are well-organized and clearly communicate the scope and preconditions for the upgrade process.
37-130: Webhook cleanup procedures are detailed and well-structured.The manual configuration update steps include clear backup commands, specific deletion scopes with YAML examples, and verification procedures. The explanation of why this action is necessary (lines 34-35) provides valuable context for administrators.
132-158: Upload and upgrade workflow is clear with well-documented commands.The violet tool usage is explained with specific syntax and parameter descriptions, making it straightforward for administrators to follow. The file naming convention with version placeholder is appropriately documented.
160-173: Comprehensive post-upgrade verification ensures successful completion.The verification procedures cover plugin state, pod health, and functional testing, providing administrators with concrete steps to confirm the upgrade success. The conclusion appropriately summarizes the upgrade outcome.
| Follow these steps to upgrade the OAM Application cluster plugin: | ||
|
|
||
| ### Step 1: Pre-Upgrade Check & Preparation | ||
| 1. Log in to the ACP web console. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Log in => Login
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.