Support timeout configuration for Create and Restore NAS backup by abh1sar · Pull Request #12964 · apache/cloudstack

abh1sar · 2026-04-06T11:48:25Z

Description

Create and Restore NAS backup used to take the timeout configuration set via "commands.timeout" config or the default cmds.timeout (7200s) in agent.properties.

This might not be enough for large images and slow networks.

Eg. the config "commands.timeout" can be set to "RestoreBackupCommand=14400, TakeBackupCommand=14400"

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Decreased timeout to 10s
Backup failed
Increased timeout to 300
Backup was taken successfully

How did you try to break this feature and the system with this change?

codecov · 2026-04-06T11:57:20Z

Codecov Report

❌ Patch coverage is 40.00000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.60%. Comparing base (03de62b) to head (c90a3e6).
⚠️ Report is 8 commits behind head on 4.22.

Files with missing lines	Patch %	Lines
...ource/wrapper/LibvirtTakeBackupCommandWrapper.java	0.00%	2 Missing ⚠️
...ce/wrapper/LibvirtRestoreBackupCommandWrapper.java	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.22   #12964   +/-   ##
=========================================
  Coverage     17.60%   17.60%           
- Complexity    15674    15677    +3     
=========================================
  Files          5918     5918           
  Lines        531727   531728    +1     
  Branches      65016    65018    +2     
=========================================
+ Hits          93595    93614   +19     
+ Misses       427570   427552   -18     
  Partials      10562    10562

Flag	Coverage Δ
uitests	`3.70% <ø> (ø)`
unittests	`18.67% <40.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

abh1sar · 2026-04-06T12:17:41Z

@blueorangutan package

blueorangutan · 2026-04-06T12:20:04Z

@abh1sar a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

sureshanaparti · 2026-04-06T12:34:28Z

plugins/backup/nas/src/main/java/org/apache/cloudstack/backup/NASBackupProvider.java

@@ -211,6 +212,7 @@ public Pair<Boolean, Backup> takeBackup(final VirtualMachine vm, Boolean quiesce
        command.setBackupRepoAddress(backupRepository.getAddress());
        command.setMountOptions(backupRepository.getMountOptions());
        command.setQuiesce(quiesceVM);
+        command.setTimeout(NASBackupCreateBackupTimeout.value());


@abh1sar can this be addressed with the value 'TakeBackupCommand=14400' in commands.timeout global config? if so, we can document it and skip this new timeout config?

Thanks @sureshanaparti . I'll test with commands.timeout and update

@sureshanaparti made the change to use commands.timeout. default value is taken from libvirtComputingResource.getCmdsTimeout() if commands.timeout is not set, as before.

blueorangutan · 2026-04-06T13:13:20Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17365

sureshanaparti

clgtm

sureshanaparti · 2026-04-07T06:28:06Z

@blueorangutan package

blueorangutan · 2026-04-07T06:30:05Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a configurable timeout for KVM NAS backup/restore operations by deriving a per-command timeout (with fallback to the agent default), and updates unit tests accordingly.

Changes:

Compute an effective timeout from command.getWait() (fallback to cmds.timeout) for TakeBackupCommand.
Apply the same effective timeout strategy to restore flows and propagate it to rsync and qemu-img execution.
Adjust LibvirtRestoreBackupCommandWrapperTest static script stubbing to better simulate rsync outcomes.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File	Description
plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtTakeBackupCommandWrapper.java	Uses per-command timeout (from `wait`) when executing piped backup commands.
plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java	Applies per-command timeout to `rsync` and `qemu-img` restore operations.
plugins/hypervisors/kvm/src/test/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapperTest.java	Updates script mocks to model different exit codes (e.g., `rsync` failure) and simplifies one test’s stubbing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

...src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtTakeBackupCommandWrapper.java

.../main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java

...t/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapperTest.java

blueorangutan · 2026-04-07T07:32:24Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17382

abh1sar · 2026-04-08T09:40:17Z

@blueorangutan test

blueorangutan · 2026-04-08T09:42:04Z

@abh1sar a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

github-actions · 2026-04-08T13:04:38Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

blueorangutan · 2026-04-09T02:12:01Z

[SF] Trillian test result (tid-15823)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 56221 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr12964-t15823-kvm-ol8.zip
Smoke tests completed. 149 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

sureshanaparti · 2026-04-09T03:58:32Z

@blueorangutan package

sureshanaparti · 2026-04-09T05:32:26Z

@blueorangutan package

blueorangutan · 2026-04-09T05:34:04Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-09T06:30:24Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17415

rajujith

LGTM
Tested

boring-cyborg bot added component:backup component:kvm labels Apr 6, 2026

abh1sar added this to the 4.22.1 milestone Apr 6, 2026

sureshanaparti reviewed Apr 6, 2026

View reviewed changes

abh1sar changed the base branch from main to 4.22 April 6, 2026 12:57

sureshanaparti approved these changes Apr 7, 2026

View reviewed changes

sureshanaparti added this to Apache CloudStack 4.22.1 Apr 7, 2026

github-project-automation bot moved this to Todo in Apache CloudStack 4.22.1 Apr 7, 2026

sureshanaparti moved this from Todo to In Progress in Apache CloudStack 4.22.1 Apr 7, 2026

sureshanaparti added the status:needs-testing label Apr 7, 2026

sureshanaparti requested a review from Copilot April 7, 2026 06:35

Copilot AI reviewed Apr 7, 2026

View reviewed changes

Copilot started reviewing on behalf of sureshanaparti April 7, 2026 06:43 View session

github-actions bot added the status:has-conflicts label Apr 8, 2026

abh1sar added 4 commits April 9, 2026 09:08

Introduce configurable timeout to Create NAS backup

b958300

use timeout set via "commands.timeout"

dad9f5e

fix test failures

1912880

review comments

c90a3e6

abh1sar force-pushed the backup-timeout branch from 21b8b1a to c90a3e6 Compare April 9, 2026 03:49

sureshanaparti requested a review from rajujith April 9, 2026 03:58

github-actions bot removed the status:has-conflicts label Apr 9, 2026

rajujith approved these changes Apr 10, 2026

View reviewed changes

rajujith removed the status:needs-testing label Apr 10, 2026

sureshanaparti added the enhancement label Apr 10, 2026

sureshanaparti changed the title ~~Introduce configurable timeout to Create NAS backup~~ Support to consider cmds timeout to Create and Restore NAS backup Apr 10, 2026

sureshanaparti changed the title ~~Support to consider cmds timeout to Create and Restore NAS backup~~ Support to consider cmds timeout (set via "commands.timeout" config) to Create and Restore NAS backup Apr 10, 2026

sureshanaparti changed the title ~~Support to consider cmds timeout (set via "commands.timeout" config) to Create and Restore NAS backup~~ Support timeout configuration for Create and Restore NAS backup Apr 10, 2026

sureshanaparti merged commit 68bd056 into apache:4.22 Apr 10, 2026
25 of 26 checks passed

github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.22.1 Apr 10, 2026

sureshanaparti deleted the backup-timeout branch April 10, 2026 04:42

Conversation

abh1sar commented Apr 6, 2026 • edited by sureshanaparti Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented Apr 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

abh1sar commented Apr 6, 2026

Uh oh!

blueorangutan commented Apr 6, 2026

Uh oh!

sureshanaparti Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

abh1sar Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

abh1sar Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Apr 6, 2026

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Apr 7, 2026

Uh oh!

blueorangutan commented Apr 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blueorangutan commented Apr 7, 2026

Uh oh!

abh1sar commented Apr 8, 2026

Uh oh!

blueorangutan commented Apr 8, 2026

Uh oh!

github-actions bot commented Apr 8, 2026

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

sureshanaparti commented Apr 9, 2026

Uh oh!

sureshanaparti commented Apr 9, 2026

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

blueorangutan commented Apr 9, 2026

Uh oh!

rajujith left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

abh1sar commented Apr 6, 2026 •

edited by sureshanaparti

Loading

codecov bot commented Apr 6, 2026 •

edited

Loading