Skip to content

docs: update snapshot component migration guidance#899

Merged
Muyan0828 merged 1 commit into
masterfrom
docs/snapshot-controller-migration
Jun 12, 2026
Merged

docs: update snapshot component migration guidance#899
Muyan0828 merged 1 commit into
masterfrom
docs/snapshot-controller-migration

Conversation

@Muyan0828

@Muyan0828 Muyan0828 commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • update the Volume Snapshot Component page for ACP 4.4 automatic snapshot component behavior
  • add a runbook for migrating from the legacy Snapshot Management cluster plugin
  • keep the migration guidance focused on user/admin operations and use patch-based commands

Validation

  • yarn lint

Summary by CodeRabbit

  • Documentation
    • Updated snapshot component deployment documentation to clarify prerequisite ordering and describe ACP 4.4+ automatic preparation behavior, with guidance for clusters using legacy Snapshot Management.
    • Added comprehensive migration guide for transitioning from legacy Snapshot Management to ACP 4.4+ snapshot component, including step-by-step procedures, rollback instructions, and troubleshooting.

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: be4ec1c3-125b-4203-ba8a-630c39815374

📥 Commits

Reviewing files that changed from the base of the PR and between 74a1f0a and 19b9713.

📒 Files selected for processing (2)
  • docs/en/configure/storage/functions/snapshot_con.mdx
  • docs/en/configure/storage/how_to/migrate_snapshot_controller_operator.mdx

Walkthrough

This PR adds documentation for migrating from the legacy Snapshot Management cluster plugin to the ACP 4.4+ snapshot component, and updates the component deployment page to reflect the new architecture and prerequisite ordering. A new comprehensive runbook provides step-by-step migration procedures with rollback and troubleshooting guidance.

Changes

Volume Snapshot Migration and Component Deployment Documentation

Layer / File(s) Summary
Component Deployment Documentation Updates
docs/en/configure/storage/functions/snapshot_con.mdx
The snapshot component deployment page emphasizes that the snapshot component must exist before users can create or restore snapshots. It describes ACP 4.4+ automatic component preparation, clarifies behavior when external Snapshot Controllers or existing snapshot CRDs are present, and adds a "Next steps" section with migration guidance for legacy-plugin deployments. Access mode compatibility table and related notes are retained.
Migration Runbook - Structure and Prerequisites
docs/en/configure/storage/how_to/migrate_snapshot_controller_operator.mdx
New migration runbook document with front matter, title, migration overview, scope, impact statement, and explicit warnings against deleting snapshot CRDs or custom resources. Prerequisites section lists admin access, ACP 4.4+ readiness, storage component installation, jq availability, and maintenance window. Includes pre-migration commands to record current snapshot state for post-migration comparison.
Migration Runbook - Execution and Verification
docs/en/configure/storage/how_to/migrate_snapshot_controller_operator.mdx
Step-by-step procedure to uninstall the legacy Snapshot Management plugin from the global cluster while preserving snapshot CRDs and resources, verify the legacy controller is gone, enable ACP snapshot management on the workload cluster via storagefoundation patch with jq-based JSON merging, wait for operator readiness, and verify all expected CRDs and previously recorded snapshot resources are retained.
Migration Runbook - Rollback and Troubleshooting
docs/en/configure/storage/how_to/migrate_snapshot_controller_operator.mdx
Rollback procedures to disable ACP snapshot management (preserving CRDs and resources) and conditionally reinstall the legacy plugin. Troubleshooting sections cover the Skipped snapshot status, pending operations when no Snapshot Controller runs, and the edge case where ACP was enabled while another controller was active. Concludes with related documentation links.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A bunny hops through docs with glee,
Old Snapshot ways meet ACP,
Step-by-step the path is clear,
Migration smooth from far and near!
With rollback notes and troubleshoots so bright, 📚✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: update snapshot component migration guidance' directly relates to the changeset, which updates documentation about snapshot component migration. It accurately reflects the main changes: updating the snapshot component documentation and adding a migration runbook.
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.

✏️ 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 docs/snapshot-controller-migration

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.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying alauda-container-platform with  Cloudflare Pages  Cloudflare Pages

Latest commit: 19b9713
Status: ✅  Deploy successful!
Preview URL: https://969a76d6.alauda-container-platform.pages.dev
Branch Preview URL: https://docs-snapshot-controller-mig.alauda-container-platform.pages.dev

View logs

@Muyan0828 Muyan0828 merged commit 38352d6 into master Jun 12, 2026
3 checks passed
@Muyan0828 Muyan0828 deleted the docs/snapshot-controller-migration branch June 12, 2026 08:52
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