Create new Instance from VM backup #10140

abh1sar · 2024-12-25T05:12:50Z

Doc PR: apache/cloudstack-documentation#474

Description

This PR adds the ability to create a new Instance from a VM backup for Dummy, NAS and Veeam backup Providers.
This will still work if the original Instance used to create the backup was expunged.

New API

createVmFromBackup extends baseDeployVIrtualMachine
new arguments : backupId, preserveip
User can just specify the backupId and a new instance will be created by getting the VM and volumes' configuration stored in backup_details table.
User can also choose to configure the details themselves using the parameters present in deployVIrtualMachine cmd
If the original instance from which the backup was taken is deleted, user can choose to reuse the same IP addresses if they are available using the preserveip argument.

UI

New action button in backups list view - 'Create Instance from Backup'
User can choose to directly create the VM or configure VM parameters before creating it.

DB changes

New backup_details table
- to store vm config data such as serviceOfferingUuid, networkUuids, ipAddresses
- to store volumes config data such as diskOfferingUuids, size, miniops and maxiops for custom disk offerings.

Other Changes

Added new parameter Map datadisksdetails to deployVirtualMachine api to create multiple data volumes at the time of instance creation.

Plugins related changes

NAS and Veeam plugin changes to restore backup to a new VM and miscellaneous fixes around handling backups of expunged Instances.

Other Miscellaneous changes

Add Name and description column to backup
Show Interval type in UI for backups
Support cephFS for NAS backup provider
Add Backup Storage Capacity Tracking and Alerts Infrastructure
Backup Storage (used and available) is shown on the Capacity dashboard and tracks the alerts if supported by the plugin
(Currently only NAS BnR plugin supports it)
Add Object Storage Capacity Tracking and Alerts Infrastructure
Object Storage (allocated and available) is shown on the Capacity dashboard and tracked for alerts.

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?

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

codecov · 2024-12-25T05:20:17Z

Codecov Report

Attention: Patch coverage is 34.99189% with 1202 lines in your changes missing coverage. Please review.

Project coverage is 16.69%. Comparing base (96b8e23) to head (1b10b3b).

Files with missing lines	Patch %	Lines
...loudstack/api/command/user/vm/BaseDeployVMCmd.java	15.80%	289 Missing and 36 partials ⚠️
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	42.24%	97 Missing and 37 partials ⚠️
...rg/apache/cloudstack/backup/BackupManagerImpl.java	69.91%	66 Missing and 36 partials ⚠️
...ack/api/command/user/vm/CreateVMFromBackupCmd.java	6.15%	60 Missing and 1 partial ⚠️
...rg/apache/cloudstack/backup/dao/BackupDaoImpl.java	37.33%	41 Missing and 6 partials ⚠️
.../apache/cloudstack/backup/DummyBackupProvider.java	0.00%	42 Missing ⚠️
...rg/apache/cloudstack/backup/NASBackupProvider.java	42.25%	38 Missing and 3 partials ⚠️
...che/cloudstack/backup/NetworkerBackupProvider.java	0.00%	34 Missing ⚠️
.../apache/cloudstack/backup/VeeamBackupProvider.java	6.06%	31 Missing ⚠️
...a/org/apache/cloudstack/backup/BackupDetailVO.java	18.91%	29 Missing and 1 partial ⚠️
... and 41 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #10140      +/-   ##
============================================
+ Coverage     16.52%   16.69%   +0.16%     
- Complexity    13802    13984     +182     
============================================
  Files          5717     5729      +12     
  Lines        506302   508662    +2360     
  Branches      61440    61861     +421     
============================================
+ Hits          83690    84941    +1251     
- Misses       413235   414142     +907     
- Partials       9377     9579     +202

Flag	Coverage Δ
uitests	`3.83% <ø> (-0.14%)`	⬇️
unittests	`17.62% <34.99%> (+0.21%)`	⬆️

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.

leo79901 · 2024-12-31T06:52:13Z

Yes, we need this !

…d data volumes before restore.

abh1sar · 2025-01-06T12:00:02Z

@blueorangutan package

blueorangutan · 2025-01-06T12:02:04Z

@abh1sar 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 · 2025-01-06T13:19:25Z

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

github-actions · 2025-01-08T14:37:51Z

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

blueorangutan · 2025-05-13T03:46:03Z

@abh1sar 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 · 2025-05-13T05:07:59Z

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

github-actions · 2025-05-13T12:32:41Z

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

github-actions · 2025-05-13T14:17:07Z

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

abh1sar · 2025-05-15T01:59:35Z

@blueorangutan package

blueorangutan · 2025-05-15T02:00:04Z

@abh1sar 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 · 2025-05-15T02:54:19Z

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

abh1sar · 2025-05-15T03:12:46Z

@blueorangutan package

blueorangutan · 2025-05-15T03:14:03Z

@abh1sar 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 · 2025-05-15T04:10:36Z

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

abh1sar · 2025-05-16T16:25:59Z

@blueorangutan test

blueorangutan · 2025-05-16T16:28:04Z

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

blueorangutan · 2025-05-17T07:37:48Z

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

Test	Result	Time (s)	Test File
test_attach_and_distribute_multiple_volumes	`Error`	29.44	test_attach_multiple_volumes.py
test_attach_multiple_volumes	`Failure`	3.50	test_attach_multiple_volumes.py
test_attach_multiple_volumes	`Error`	3.50	test_attach_multiple_volumes.py
ContextSuite context=TestMultipleVolumeAttach>:teardown	`Error`	4.64	test_attach_multiple_volumes.py
ContextSuite context=TestNASBackupAndRecovery>:setup	`Error`	0.00	test_backup_recovery_nas.py
test_01_deployVMInSharedNetwork	`Failure`	70.26	test_network.py
ContextSuite context=TestSharedNetworkWithConfigDrive>:teardown	`Error`	71.38	test_network.py

github-actions · 2025-05-19T09:03:14Z

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

abh1sar · 2025-05-20T09:12:42Z

@blueorangutan package

blueorangutan · 2025-05-20T09:14:04Z

@abh1sar 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 · 2025-05-20T10:38:12Z

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

abh1sar · 2025-05-20T14:57:58Z

@blueorangutan test

blueorangutan · 2025-05-20T15:00:04Z

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

blueorangutan · 2025-05-21T06:25:41Z

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

Test	Result	Time (s)	Test File
test_attach_and_distribute_multiple_volumes	`Error`	27.56	test_attach_multiple_volumes.py
test_attach_multiple_volumes	`Failure`	4.54	test_attach_multiple_volumes.py
test_attach_multiple_volumes	`Error`	4.55	test_attach_multiple_volumes.py
ContextSuite context=TestMultipleVolumeAttach>:teardown	`Error`	5.66	test_attach_multiple_volumes.py

abh1sar added 2 commits December 25, 2024 08:24

Initial api and service layer changes

35ed72c

Nas backup provider changes

e094e14

boring-cyborg bot added component:api component:backup component:kvm labels Dec 25, 2024

Add hypervisor, service_offering and template to backups table.

27feeda

abh1sar added 3 commits January 1, 2025 17:15

Create backup_details table and add details related to vm.

f98da37

Initial UI form

04a2deb

Save networkIds and diskOfferingIds in backup_details. Create require…

d3439ad

…d data volumes before restore.

boring-cyborg bot added component:storage component:UI labels Jan 3, 2025

Restore backup to VM plugin change for VeeamBackupProvider

753d80f

abh1sar added 3 commits January 7, 2025 02:50

UI form updates

72c943f

Create instance from backup using just the backupid

7ae078e

Remove zone and iso from DeployVMFromBackup.vue

31f89df

github-actions bot added the status:has-conflicts label Jan 8, 2025

abh1sar added 3 commits January 9, 2025 20:57

Create multiple data volumes using the deployVirtualMachine Api

7e3f083

Create multiple data volumes for createVMFromBackup api and ui

f46fad8

Merge remote-tracking branch 'upstream/main' into instance

d941809

boring-cyborg bot added component:compute component:kubernetes component:orchestration labels Jan 9, 2025

github-actions bot removed the status:has-conflicts label Jan 9, 2025

Fix build failure after merge

10f7beb

github-actions bot added the status:has-conflicts label May 13, 2025

Merge branch 'main' into instance-from-backup

bc1beb6

github-actions bot added status:has-conflicts and removed status:has-conflicts labels May 13, 2025

github-actions bot removed the status:has-conflicts label May 14, 2025

Fix error in restoring an expunged vm

127f807

github-actions bot added the status:has-conflicts label May 19, 2025

Merge remote-tracking branch 'upstream/main' into instance

40ba664

github-actions bot removed the status:has-conflicts label May 20, 2025

Get backed up disk offering details from backup.volumeinfo

1b10b3b

Create new Instance from VM backup #10140

Are you sure you want to change the base?

Create new Instance from VM backup #10140

Uh oh!

Conversation

abh1sar commented Dec 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Other Miscellaneous changes

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 Dec 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

leo79901 commented Dec 31, 2024

Uh oh!

abh1sar commented Jan 6, 2025

Uh oh!

blueorangutan commented Jan 6, 2025

Uh oh!

blueorangutan commented Jan 6, 2025

Uh oh!

github-actions bot commented Jan 8, 2025

Uh oh!

blueorangutan commented May 13, 2025

Uh oh!

blueorangutan commented May 13, 2025

Uh oh!

github-actions bot commented May 13, 2025

Uh oh!

github-actions bot commented May 13, 2025

Uh oh!

abh1sar commented May 15, 2025

Uh oh!

blueorangutan commented May 15, 2025

Uh oh!

blueorangutan commented May 15, 2025

Uh oh!

abh1sar commented May 15, 2025

Uh oh!

blueorangutan commented May 15, 2025

Uh oh!

blueorangutan commented May 15, 2025

Uh oh!

abh1sar commented May 16, 2025

Uh oh!

blueorangutan commented May 16, 2025

Uh oh!

blueorangutan commented May 17, 2025

Uh oh!

github-actions bot commented May 19, 2025

Uh oh!

abh1sar commented May 20, 2025

Uh oh!

blueorangutan commented May 20, 2025

Uh oh!

blueorangutan commented May 20, 2025

Uh oh!

abh1sar commented May 20, 2025

Uh oh!

blueorangutan commented May 20, 2025

Uh oh!

blueorangutan commented May 21, 2025

Uh oh!

Uh oh!

abh1sar commented Dec 25, 2024 •

edited

Loading

codecov bot commented Dec 25, 2024 •

edited

Loading