Skip to content

add troubleshooting for upgrading#181

Open
davidwtf wants to merge 3 commits intomasterfrom
fix/AI-24313
Open

add troubleshooting for upgrading#181
davidwtf wants to merge 3 commits intomasterfrom
fix/AI-24313

Conversation

@davidwtf
Copy link
Copy Markdown
Contributor

@davidwtf davidwtf commented Apr 10, 2026

Summary by CodeRabbit

  • Documentation
    • Updated upgrade guide target to version 2.3.
    • Simplified plugin naming in upgrade instructions (MLflow and Volcano now referenced without vendor prefix; Workbench unchanged).
    • Added ACP 4.0.x troubleshooting to manually trigger cluster plugin upgrades when new versions don't appear in the Web Console.
    • Plugin identifier table now includes Kubeflow Training Operator (kftraining).

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 10, 2026

Walkthrough

Updated upgrade guide: bumped exported curVer from 2.2 → 2.3, removed the "Alauda AI" prefix from MLflow and Volcano plugin names, added Kubeflow Training Operator identifier, and added an ACP 4.0.x troubleshooting subsection describing a kubectl ModuleInfo read/patch workaround for plugin version visibility.

Changes

Cohort / File(s) Summary
Upgrade Documentation
docs/en/upgrade/upgrade-from-previous-version.mdx
Bumped export const curVer from '2.2' to '2.3'. Removed "Alauda AI" prefix for MLflow and Volcano in upgrade guidance and checklist. Added kftraining (Kubeflow Training Operator) to plugin identifier table. Added "Troubleshooting / New version not visible after upload (ACP 4.0.x)" with steps: use global-cluster kubectl to find ModuleInfo by label, read ModulePlugin.status.latestVersion, then patch ModuleInfo.spec.version to force plugin upgrade when Web Console doesn't show the new version.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Poem

🐰 I hopped from two point two up to three,
Trimmed names like leaves from the plugin tree,
Found a hidden version? I tug and I patch,
With kubectl nudge, the upgrades attach,
Tiny paws, big help — hop, deploy, and glee! 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: adding troubleshooting guidance for upgrading cluster plugins, particularly a new 'Troubleshooting / New version not visible after upload' subsection.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/AI-24313

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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/en/upgrade/upgrade-from-previous-version.mdx`:
- Around line 102-111: The docs use mixed plugin names; normalize them by
replacing the occurrences of "Alauda AI MLflow" and "Alauda AI Volcano" (and any
other "Alauda AI ..." variants) so they consistently use the chosen convention
used in this section — e.g., change those two instances to "MLflow" and
"Volcano" to match the rest of the page (also scan the document for any other
"Alauda AI Workbench"/"Alauda AI ..." variants and make them consistent).
- Around line 147-155: Add a validation step after the ModuleInfo lookup (the
kubectl get moduleinfoes ... -o jsonpath='{.items[*].metadata.name}') to ensure
exactly one result is returned before running the kubectl patch moduleinfoes
<ModuleInfo Name> --type merge -p '{"spec":{"version":"<New Version>"}}';
specifically, capture the jsonpath output into a variable, split/count the
names, exit with an explanatory error if the count is 0 or >1, and only proceed
to call kubectl patch with the single validated ModuleInfo Name when the count
is exactly 1.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9f08a219-3070-4de4-af67-0c6f8723941e

📥 Commits

Reviewing files that changed from the base of the PR and between 3a6fd32 and 57e729a.

📒 Files selected for processing (1)
  • docs/en/upgrade/upgrade-from-previous-version.mdx

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Apr 10, 2026

Deploying alauda-ai with  Cloudflare Pages  Cloudflare Pages

Latest commit: eab0589
Status: ✅  Deploy successful!
Preview URL: https://48c460b7.alauda-ai.pages.dev
Branch Preview URL: https://fix-ai-24313.alauda-ai.pages.dev

View logs

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/en/upgrade/upgrade-from-previous-version.mdx (1)

131-131: Use a concrete ACP version boundary instead of “newer releases.”

If available, replace the vague phrase with an explicit fixed version range (for example, “fixed in ACP >= X.Y.Z”) so operators can decide whether the workaround is still needed.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/en/upgrade/upgrade-from-previous-version.mdx` at line 131, Replace the
vague phrase "newer ACP releases" in the sentence that starts "On Alauda
Container Platform (ACP) 4.0.x, the Web Console may fail..." with an explicit
version boundary such as "fixed in ACP >= X.Y.Z"; update the sentence to read
e.g. "This behavior is a known ACP limitation; it was fixed in ACP >= X.Y.Z."
and ensure you choose and insert the actual fixed ACP version number (replace
X.Y.Z) so operators know the exact cutoff.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/en/upgrade/upgrade-from-previous-version.mdx`:
- Around line 137-143: The docs add "Kubeflow Training Operator" (`kftraining`)
to the troubleshooting mapping but omit it from the "required plugins" list and
the final verification checklist; update the "required plugins" section (the
list around Line 102) to include Kubeflow Training Operator (`kftraining`) and
add the same plugin/identifier to the final verification list (the verification
items around Line 259 onward) so the plugin is consistently required and
verified during upgrade.

---

Nitpick comments:
In `@docs/en/upgrade/upgrade-from-previous-version.mdx`:
- Line 131: Replace the vague phrase "newer ACP releases" in the sentence that
starts "On Alauda Container Platform (ACP) 4.0.x, the Web Console may fail..."
with an explicit version boundary such as "fixed in ACP >= X.Y.Z"; update the
sentence to read e.g. "This behavior is a known ACP limitation; it was fixed in
ACP >= X.Y.Z." and ensure you choose and insert the actual fixed ACP version
number (replace X.Y.Z) so operators know the exact cutoff.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 14eb01aa-16e5-4b90-ba60-0827bd32fe23

📥 Commits

Reviewing files that changed from the base of the PR and between d2eb7e0 and eab0589.

📒 Files selected for processing (1)
  • docs/en/upgrade/upgrade-from-previous-version.mdx

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant