Skip to content

<feature>[zbs]: ZSV-12579 support whole-VM backup#4558

Open
ZStack-Robot wants to merge 1 commit into
feature-zsv-5.1.0-encryptionfrom
sync/zstackio/zbs-volume-encryption-backup@@2
Open

<feature>[zbs]: ZSV-12579 support whole-VM backup#4558
ZStack-Robot wants to merge 1 commit into
feature-zsv-5.1.0-encryptionfrom
sync/zstackio/zbs-volume-encryption-backup@@2

Conversation

@ZStack-Robot

Copy link
Copy Markdown
Collaborator

Summary

Support ZBS whole-VM backup restore on the existing VolumeBackup/ImageStore flow. Plain backup disks can be restored as encrypted ZBS disks through temporary cache conversion; the backup encryption property is not changed.

Changes

  • Add ordered external-primary-storage image download hooks and restore context.
  • Carry ZBS logical/backing size information through encrypted restore.
  • Keep the existing native clone and resize flow for encrypted cache snapshots.

Testing

  • cbok Groovy case: 1 test, 0 failures/errors/skips
  • Full/auto whole-VM backup, revert, three-disk restore matrix, and rollback injection coverage
  • cbok compile/deploy to 172.24.247.15
  • MN/UI status Running
  • CI pipeline

Resolves: ZSV-12579

sync from gitlab !10522

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 4 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 3e3e145e-9e12-4f04-b0ce-199b573ea654

📥 Commits

Reviewing files that changed from the base of the PR and between 937c249 and 2777526.

📒 Files selected for processing (6)
  • header/src/main/java/org/zstack/header/storage/addon/primary/CreateVolumeSpec.java
  • header/src/main/java/org/zstack/header/storage/addon/primary/ExternalPrimaryStorageImageDownloadContext.java
  • header/src/main/java/org/zstack/header/storage/addon/primary/ExternalPrimaryStorageImageDownloadExtensionPoint.java
  • storage/src/main/java/org/zstack/storage/addon/primary/ExternalPrimaryStorage.java
  • storage/src/main/java/org/zstack/storage/encrypt/ZbsEncryptedEmptyVolumeCreator.java
  • storage/src/main/java/org/zstack/storage/encrypt/ZbsVolumeEncryptionMaterialFactory.java

Walkthrough

新增外部主存储镜像下载上下文和扩展点接口,并将扩展选择、前置处理、加密下载及回滚逻辑接入 ExternalPrimaryStorage 的镜像下载流程。

Changes

外部主存储镜像下载

Layer / File(s) Summary
下载扩展契约
header/src/main/java/org/zstack/header/storage/addon/primary/ExternalPrimaryStorageImageDownloadContext.java, header/src/main/java/org/zstack/header/storage/addon/primary/ExternalPrimaryStorageImageDownloadExtensionPoint.java
新增下载上下文 DTO 及扩展点接口,定义前置处理、能力判断、异步下载和回滚方法。
下载流程接入
storage/src/main/java/org/zstack/storage/addon/primary/ExternalPrimaryStorage.java
构建下载上下文并调用扩展生命周期方法;加密镜像改由支持的扩展执行,非加密镜像跳过该流程。

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

sequenceDiagram
  participant ExternalPrimaryStorage
  participant DownloadExtension
  participant VolumeController
  ExternalPrimaryStorage->>DownloadExtension: beforeDownload(...)
  ExternalPrimaryStorage->>VolumeController: createVolume(...)
  ExternalPrimaryStorage->>DownloadExtension: supportsDownload(context)
  ExternalPrimaryStorage->>DownloadExtension: download(context, completion)
  ExternalPrimaryStorage->>DownloadExtension: rollbackDownload(context)
Loading

Poem

小兔抱着下载包,
扩展接口搭新桥。
加密镜像走新径,
失败回滚不乱跳。
代码蹦蹦更灵巧。

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed 标题概括了全量 VM 备份支持这一主要方向,和本次 ZBS 全量 VM 备份恢复改动相关。
Description check ✅ Passed 描述与本次改动一致,准确说明了全量 VM 备份恢复、外部主存储下载钩子和加密恢复流程。
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
  • Commit unit tests in branch sync/zstackio/zbs-volume-encryption-backup@@2

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

@MatheMatrix MatheMatrix force-pushed the sync/zstackio/zbs-volume-encryption-backup@@2 branch 7 times, most recently from 783e073 to 937c249 Compare July 14, 2026 10:37

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
storage/src/main/java/org/zstack/storage/addon/primary/ExternalPrimaryStorage.java (1)

1378-1401: 🩺 Stability & Availability | 🟠 Major | ⚡ Quick win

扩展异常会阻断 rollback 中的资源清理。

rollback() 先无条件遍历所有 ExternalPrimaryStorageImageDownloadExtensionPoint 调用 rollbackDownload(context),再判断 volume == null 执行 directDeleteBits。若任一扩展的 rollbackDownload 抛出未捕获异常,循环会中断,导致后面的 volume 清理逻辑永远不会执行,造成主存储上卷资源泄漏。

建议将扩展通知包裹在异常隔离中(逐个 try/catch 并记录日志),确保核心清理逻辑始终执行。

🛡️ 建议修复
                     public void rollback(FlowRollback trigger, Map data) {
                         ExternalPrimaryStorageImageDownloadContext context = buildDownloadContext();
                         context.setVolume(volume);
                         context.setRemoteTarget(remoteTarget);
                         for (ExternalPrimaryStorageImageDownloadExtensionPoint ext : pluginRgty.getExtensionList(ExternalPrimaryStorageImageDownloadExtensionPoint.class)) {
-                            ext.rollbackDownload(context);
+                            try {
+                                ext.rollbackDownload(context);
+                            } catch (Throwable t) {
+                                logger.warn(String.format("rollbackDownload failed for extension[%s]", ext.getClass().getName()), t);
+                            }
                         }
                         if (volume == null) {
                             trigger.rollback();
                             return;
                         }
🤖 Prompt for 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.

In
`@storage/src/main/java/org/zstack/storage/addon/primary/ExternalPrimaryStorage.java`
around lines 1378 - 1401, Update the rollback method to isolate each
rollbackDownload call in its own try/catch, log any extension exception, and
continue notifying remaining extensions. Ensure the existing volume null check
and directDeleteBits cleanup always execute regardless of extension failures.
🧹 Nitpick comments (1)
header/src/main/java/org/zstack/header/storage/addon/primary/ExternalPrimaryStorageImageDownloadExtensionPoint.java (1)

6-15: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

接口方法缺少 Javadoc 注释。

beforeDownload/supportsDownload/download/rollbackDownload 均未添加 Javadoc,不利于扩展点实现者理解各生命周期方法的调用时机、参数含义及回调契约(例如 rollbackDownload 是否保证只在 download 被调用后才触发)。

As per path instructions: "接口方法不应有多余的修饰符(例如 public),且必须配有有效的 Javadoc 注释。"

🤖 Prompt for 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.

In
`@header/src/main/java/org/zstack/header/storage/addon/primary/ExternalPrimaryStorageImageDownloadExtensionPoint.java`
around lines 6 - 15, 为接口 ExternalPrimaryStorageImageDownloadExtensionPoint 的
beforeDownload、supportsDownload、download 和 rollbackDownload 添加有效
Javadoc,说明各生命周期方法的调用时机、参数含义及 Completion 回调契约,明确 rollbackDownload 是否仅在 download
调用后触发;同时保持接口方法无多余的 public 等修饰符。

Source: Path instructions

🤖 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.

Outside diff comments:
In
`@storage/src/main/java/org/zstack/storage/addon/primary/ExternalPrimaryStorage.java`:
- Around line 1378-1401: Update the rollback method to isolate each
rollbackDownload call in its own try/catch, log any extension exception, and
continue notifying remaining extensions. Ensure the existing volume null check
and directDeleteBits cleanup always execute regardless of extension failures.

---

Nitpick comments:
In
`@header/src/main/java/org/zstack/header/storage/addon/primary/ExternalPrimaryStorageImageDownloadExtensionPoint.java`:
- Around line 6-15: 为接口 ExternalPrimaryStorageImageDownloadExtensionPoint 的
beforeDownload、supportsDownload、download 和 rollbackDownload 添加有效
Javadoc,说明各生命周期方法的调用时机、参数含义及 Completion 回调契约,明确 rollbackDownload 是否仅在 download
调用后触发;同时保持接口方法无多余的 public 等修饰符。

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e8b81ac8-8ffb-400f-9188-096a051e6bed

📥 Commits

Reviewing files that changed from the base of the PR and between 61897a2 and 937c249.

📒 Files selected for processing (3)
  • header/src/main/java/org/zstack/header/storage/addon/primary/ExternalPrimaryStorageImageDownloadContext.java
  • header/src/main/java/org/zstack/header/storage/addon/primary/ExternalPrimaryStorageImageDownloadExtensionPoint.java
  • storage/src/main/java/org/zstack/storage/addon/primary/ExternalPrimaryStorage.java

Add external primary storage download context and rollback hook.

Use the encrypted download flow to own extension cleanup.

Tests: git diff --cached --check.

Resolves: ZSV-12666

Change-Id: I7a0f3c2d91e4b58a6c01f92d3e84a6b77c9d0e12
@MatheMatrix MatheMatrix force-pushed the sync/zstackio/zbs-volume-encryption-backup@@2 branch from 937c249 to 2777526 Compare July 14, 2026 11:32
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