[Veeam] Restore only a specified volume #7221

SadiJr · 2023-02-14T17:32:01Z

Description

Using VMWare with Veeam on ACS, when restoring a volume from a backup, ACS creates a new VM from the backup, detaches all volumes, and attaches the selected volume to the original VM.

Veeam allows restoring only the selected volume, which is faster and more performant than the current approach. This PR aims to improve the volume restore process using this native option of Veeam.

Also, when restoring and attaching one volume to one VM, the target VM needs to be stopped and then started. However, the entire process is manual; even Veeam allows the VM to be started automatically if the restore is successful. A new parameter, startvm, has been added to the API restoreVolumeFromBackupAndAttachToVM, allowing operators to specify whether or not the VM should be started automatically when volume restoration is complete.

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)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

How Has This Been Tested?

It was tested in a local lab:

I created a new VM and attached this VM to a Backup Offering;
I made some manual backups;
I restore some volume of this backups, without using the parameter startvm, and check if, in Veeam and vCenter, only the selected volume are restored, which results in success, but i had to start the VM manually;
Via cmk, I indicate the parameter startvm as true, and the VM is automatically started by Veeam when restore finishes.

codecov · 2023-02-14T18:30:44Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 4.18%. Comparing base (8806e44) to head (5120402).
Report is 58 commits behind head on main.

❗ Current head 5120402 differs from pull request most recent head cda1c45

Please upload reports for the commit cda1c45 to get more accurate results.

❗ There is a different number of reports uploaded between BASE (8806e44) and HEAD (5120402). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (8806e44) HEAD (5120402)

unittests 1 0

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #7221       +/-   ##
============================================
- Coverage     15.42%   4.18%   -11.24%     
============================================
  Files          5469     369     -5100     
  Lines        478292   30284   -448008     
  Branches      58134    5359    -52775     
============================================
- Hits          73775    1268    -72507     
+ Misses       396389   28872   -367517     
+ Partials       8128     144     -7984

Flag	Coverage Δ
uitests	`4.18% <ø> (ø)`
unittests	`?`

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.

sonarqubecloud · 2023-02-21T20:04:28Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
6 Code Smells

16.7% Coverage
0.0% Duplication

github-actions · 2023-04-04T07:24:51Z

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

vmware-base/src/test/java/com/cloud/hypervisor/vmware/mo/VirtualMachineDiskInfoBuilderTest.java

github-actions · 2023-06-21T13:46:37Z

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

harikrishna-patnala

Thanks @SadiJr, except the suggested few changes, the remaining code LGTM.

...a/org/apache/cloudstack/api/command/user/backup/RestoreVolumeFromBackupAndAttachToVMCmd.java

plugins/backup/veeam/src/main/java/org/apache/cloudstack/backup/VeeamBackupProvider.java

plugins/backup/veeam/src/main/java/org/apache/cloudstack/backup/veeam/VeeamClient.java

DaanHoogland · 2023-07-03T12:54:11Z

...a/org/apache/cloudstack/api/command/user/backup/RestoreVolumeFromBackupAndAttachToVMCmd.java

+    @Parameter(name = ApiConstants.START_VM,
+            type = CommandType.BOOLEAN,
+            required = false,
+            description = "start VM after the restore is finished")


Suggested change

@Parameter(name = ApiConstants.START_VM,

type = CommandType.BOOLEAN,

required = false,

description = "start VM after the restore is finished")

@Parameter(name = ApiConstants.START_VM,

type = CommandType.BOOLEAN,

required = false,

description = "start VM after the restore is finished",

since = "4.19.0")

this will power on the vm from veeam, looks like a out-of-band operation (the power state, host_id, etc are not managed by cloudstack).

@SadiJr
I think we should avoid it. cc @DaanHoogland

@weizhouapache when using the option to power on VM from Veeam, it will only start the VM in the last host the VM was allocated to. Also, there is a process in ACS that updates the VM state from time to time, according to what is collected from vCenter. Additionally, the HA process in VMWare is also not managed by ACS. Having said all that, I believe that if Veeam has this option, we should leave it up to the user to decide, not us.

@SadiJr
You can do lots of operations on vcenter or veeam, but cloudstack does not support OOB operations perfectly.

We should avoid the OOB operations as much as possible, unless it is really neccessary.
I think it is unnecessary to add the option. If you insist to support, I would rather starting the vm by invoking cloudstack methods/API (as cloudstack will check the proper host by available resources, affinity groups, and apply network rules, etc), than starting the vm via veeam.

Let me give you an example, if you stop a vm, and the network is shutdown (VR is stopped), when you start the vm in vcenter or veeam, the vm has no internet connection as the VR is still stopped.
We have actually faced several issues caused by OOB operations (start/migration), or DRS.

@weizhouapache I have removed this feature from this PR as it is not in the core of it. In the future I might open a PR to add it separately and we can discuss it further on that PR.

shwstppr · 2023-10-09T08:25:30Z

@SadiJr can you please check the review comments?

DaanHoogland · 2023-10-31T14:31:03Z

@SadiJr are you still looking to get this merged?

SadiJr · 2023-11-21T18:21:47Z

@shwstppr @DaanHoogland Sorry for the delay, I will check the suggestions and respond/work on this PR

SadiJr · 2023-12-15T12:23:19Z

@SadiJr can you please add some integration test cases ?

@weizhouapache sure, I'll try to add some integration tests

weizhouapache · 2024-01-10T13:19:18Z

I tested this PR with veeam 12.
The integration test added in #8241 has some failures, some functionalities are broken by this .

github-actions · 2024-02-05T18:58:35Z

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

…ed-volume

JoaoJandre · 2024-06-20T19:36:09Z

@blueorangutan package

JoaoJandre · 2024-06-20T19:36:44Z

@weizhouapache could we run the integration tests here so I can take a look at the errors you reported?

weizhouapache · 2024-06-20T21:06:05Z

@weizhouapache could we run the integration tests here so I can take a look at the errors you reported?

sure
@blueorangutan test rocky8 vmware-80

weizhouapache · 2024-06-20T21:07:42Z

@weizhouapache could we run the integration tests here so I can take a look at the errors you reported?

@JoaoJandre
#8241 requires a vmware/veeam environment. It will be skipped in the trillian test

blueorangutan · 2024-06-20T21:08:04Z

@weizhouapache a [SL] Trillian-Jenkins test job (rocky8 mgmt + vmware-80) has been kicked to run smoke tests

blueorangutan · 2024-06-21T11:44:19Z

[SF] Trillian test result (tid-10542)
Environment: vmware-80 (x2), Advanced Networking with Mgmt server r8
Total time taken: 50658 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr7221-t10542-vmware-80.zip
Smoke tests completed. 118 look OK, 3 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_02_balanced_drs_algorithm	`Error`	422.24	test_cluster_drs.py
test_01_browser_migrate_template	`Failure`	5.47	test_image_store_object_migration.py
test_01_unmanage_vm_cycle	`Error`	128.04	test_vm_lifecycle_unmanage_import.py

JoaoJandre · 2024-06-21T12:36:36Z

@weizhouapache could we run the integration tests here so I can take a look at the errors you reported?

@JoaoJandre #8241 requires a vmware/veeam environment. It will be skipped in the trillian test

@weizhouapache Ok, I'll try to test this and see if everything still looks good after merging with main.

github-actions · 2024-06-29T02:12:42Z

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

sureshanaparti · 2025-06-05T10:16:26Z

hi @SadiJr please check and resolve any conflicts in the branch.

SadiJr added 2 commits February 14, 2023 07:55

Restore only specified volume

42b219a

Fix checkstyle

8f3e253

boring-cyborg bot added component:api component:backup component:vmware labels Feb 14, 2023

SadiJr added 2 commits February 14, 2023 17:53

Add PowerOn parameter in Veeam volume restore

8ed918b

Fix import and override

03e9f5f

github-actions bot added the status:has-conflicts label Apr 4, 2023

Merge branch 'main' into veeam-restore-only-specified-volume

6a546fe

github-actions bot removed the status:has-conflicts label Jun 6, 2023

DaanHoogland reviewed Jun 7, 2023

View reviewed changes

vmware-base/src/test/java/com/cloud/hypervisor/vmware/mo/VirtualMachineDiskInfoBuilderTest.java Show resolved Hide resolved

github-actions bot added the status:has-conflicts label Jun 21, 2023

DaanHoogland added this to the 4.19.0.0 milestone Jun 22, 2023

rohityadavcloud requested a review from harikrishna-patnala June 27, 2023 11:42

harikrishna-patnala reviewed Jul 3, 2023

View reviewed changes

DaanHoogland reviewed Jul 3, 2023

View reviewed changes

Merge branch 'main' into veeam-restore-only-specified-volume

ce416a6

github-actions bot removed the status:has-conflicts label Aug 17, 2023

SadiJr added 2 commits August 31, 2023 13:51

Merge branch 'main' into veeam-restore-only-specified-volume

92ab581

Merge branch 'main' into veeam-restore-only-specified-volume

cfdc6ef

Merge branch 'main' into veeam-restore-only-specified-volume

324e8e2

DaanHoogland added the status:needs-work label Nov 15, 2023

DaanHoogland assigned SadiJr Nov 15, 2023

SadiJr marked this pull request as draft December 19, 2023 16:36

Merge branch 'main' into veeam-restore-only-specified-volume

5457f52

github-actions bot added the status:has-conflicts label Feb 5, 2024

JoaoJandre added 2 commits June 20, 2024 15:04

Merge remote-tracking branch 'origin' into veeam-restore-only-specifi…

f15f2a8

…ed-volume

fix logs

5120402

github-actions bot removed the status:has-conflicts label Jun 20, 2024

remove start on restore

cda1c45

sureshanaparti modified the milestones: 4.19.1.0, 4.19.2, 4.20.0.0 Jun 24, 2024

github-actions bot added the status:has-conflicts label Jun 29, 2024

JoaoJandre modified the milestones: 4.20.0.0, 4.21.0.0 Sep 10, 2024

JoaoJandre assigned JoaoJandre and unassigned SadiJr Nov 12, 2024

sureshanaparti added this to Apache CloudStack 4.21.0 Jun 5, 2025

sureshanaparti moved this to In Progress in Apache CloudStack 4.21.0 Jun 5, 2025

[Veeam] Restore only a specified volume #7221

Are you sure you want to change the base?

[Veeam] Restore only a specified volume #7221

Uh oh!

Conversation

SadiJr commented Feb 14, 2023 • edited 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

How Has This Been Tested?

Uh oh!

codecov bot commented Feb 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sonarqubecloud bot commented Feb 21, 2023

Uh oh!

github-actions bot commented Apr 4, 2023

Uh oh!

Uh oh!

github-actions bot commented Jun 21, 2023

Uh oh!

harikrishna-patnala left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DaanHoogland Jul 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weizhouapache Dec 12, 2023

Choose a reason for hiding this comment

Uh oh!

SadiJr Dec 15, 2023

Choose a reason for hiding this comment

Uh oh!

weizhouapache Dec 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JoaoJandre Jun 21, 2024

Choose a reason for hiding this comment

Uh oh!

shwstppr commented Oct 9, 2023

Uh oh!

DaanHoogland commented Oct 31, 2023

Uh oh!

SadiJr commented Nov 21, 2023

Uh oh!

SadiJr commented Dec 15, 2023

Uh oh!

weizhouapache commented Jan 10, 2024

Uh oh!

github-actions bot commented Feb 5, 2024

Uh oh!

JoaoJandre commented Jun 20, 2024

Uh oh!

JoaoJandre commented Jun 20, 2024

Uh oh!

weizhouapache commented Jun 20, 2024

Uh oh!

weizhouapache commented Jun 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

blueorangutan commented Jun 20, 2024

Uh oh!

blueorangutan commented Jun 21, 2024

Uh oh!

JoaoJandre commented Jun 21, 2024

Uh oh!

github-actions bot commented Jun 29, 2024

Uh oh!

sureshanaparti commented Jun 5, 2025

Uh oh!

Uh oh!

SadiJr commented Feb 14, 2023 •

edited

Loading

codecov bot commented Feb 14, 2023 •

edited

Loading

DaanHoogland Jul 3, 2023 •

edited

Loading

weizhouapache Dec 15, 2023 •

edited

Loading

weizhouapache commented Jun 20, 2024 •

edited

Loading