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 37.69841% with 1099 lines in your changes missing coverage. Please review.

Project coverage is 16.58%. Comparing base (fd74895) to head (1e164ef).
Report is 4 commits behind head on main.

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	77.12%	42 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 ⚠️
...a/org/apache/cloudstack/backup/BackupDetailVO.java	18.91%	29 Missing and 1 partial ⚠️
...rg/apache/cloudstack/backup/NASBackupProvider.java	50.00%	27 Missing and 3 partials ⚠️
.../apache/cloudstack/backup/VeeamBackupProvider.java	6.25%	30 Missing ⚠️
...che/cloudstack/backup/NetworkerBackupProvider.java	0.00%	25 Missing ⚠️
...loudstack/backup/GetBackupStorageStatsCommand.java	18.51%	22 Missing ⚠️
... and 40 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #10140      +/-   ##
============================================
+ Coverage     16.40%   16.58%   +0.17%     
- Complexity    13587    13777     +190     
============================================
  Files          5692     5704      +12     
  Lines        501962   504308    +2346     
  Branches      60791    61214     +423     
============================================
+ Hits          82353    83640    +1287     
- Misses       410455   411311     +856     
- Partials       9154     9357     +203

Flag	Coverage Δ
uitests	`3.86% <ø> (-0.15%)`	⬇️
unittests	`17.49% <37.69%> (+0.23%)`	⬆️

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.

abh1sar · 2025-04-29T08:56:40Z

@blueorangutan package

blueorangutan · 2025-04-29T09:10: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-04-29T10:40:45Z

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

github-actions · 2025-05-02T08:39:44Z

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

abh1sar · 2025-05-05T10:36:10Z

@blueorangutan package

blueorangutan · 2025-05-05T10:38: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-05T11:52:25Z

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

…loudstack into instance

abh1sar · 2025-05-05T18:53:45Z

@blueorangutan package

blueorangutan · 2025-05-05T18:56: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.

…backups

blueorangutan · 2025-05-05T20:02:49Z

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

abh1sar · 2025-05-05T20:03:50Z

@blueorangutan test

blueorangutan · 2025-05-05T20:06:03Z

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

…loudstack into instance

…ue to get the provider name

…tance from backup form

blueorangutan · 2025-05-06T10:31:00Z

[SF] Trillian test result (tid-13204)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 49079 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10140-t13204-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`	32.21	test_attach_multiple_volumes.py
test_attach_multiple_volumes	`Failure`	2.42	test_attach_multiple_volumes.py
test_attach_multiple_volumes	`Error`	2.42	test_attach_multiple_volumes.py
ContextSuite context=TestMultipleVolumeAttach>:teardown	`Error`	3.51	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

abh1sar added 4 commits May 1, 2025 16:14

Added more UT to UserVmManagerImplTest

a34c78a

Fix errors in testDestroyVM in UserVmManagerImplTest

a298c33

Add more UT to BackupManagerTest

062e343

Added UT to BackupManager, NetworkService and StorageManager

359af7b

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

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

cd91111

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

abh1sar and others added 2 commits May 5, 2025 14:22

Fixed a bug in publishUsageEvent

5ff2e36

Fixed compilation error in BackupManagerTest

756af19

abh1sar added 2 commits May 6, 2025 00:18

Add Nas backup and recovery integration test

58d1067

Merge branch 'instance-from-backup' of https://github.com/shapeblue/c…

bb97ea6

…loudstack into instance

Disallow offering delete if it is not assigned to any vm, but it has …

4ef398b

…backups

abh1sar added 4 commits May 6, 2025 10:08

Add backup offering in the list view and search filter in list backups

8c881ef

Merge branch 'instance-from-backup' of https://github.com/shapeblue/c…

784cf76

…loudstack into instance

use listBackupOfferings instead of listConfiguration in startbackup.v…

c31da8b

…ue to get the provider name

Don't show select deployment infra section to end users in create ins…

1e164ef

…tance from backup form

abh1sar mentioned this pull request May 6, 2025

Set backup.framework.enabled config to true shapeblue/Trillian#195

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create new Instance from VM backup #10140

Create new Instance from VM backup #10140

abh1sar commented Dec 25, 2024 •

edited

Loading

codecov bot commented Dec 25, 2024 •

edited

Loading

leo79901 commented Dec 31, 2024

abh1sar commented Jan 6, 2025

blueorangutan commented Jan 6, 2025

blueorangutan commented Jan 6, 2025

github-actions bot commented Jan 8, 2025

abh1sar commented Apr 29, 2025

blueorangutan commented Apr 29, 2025

blueorangutan commented Apr 29, 2025

github-actions bot commented May 2, 2025

abh1sar commented May 5, 2025

blueorangutan commented May 5, 2025

blueorangutan commented May 5, 2025

abh1sar commented May 5, 2025

blueorangutan commented May 5, 2025

blueorangutan commented May 5, 2025

abh1sar commented May 5, 2025

blueorangutan commented May 5, 2025

blueorangutan commented May 6, 2025

Create new Instance from VM backup #10140

Are you sure you want to change the base?

Create new Instance from VM backup #10140

Conversation

abh1sar commented Dec 25, 2024 • edited Loading

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?

codecov bot commented Dec 25, 2024 • edited Loading

Codecov Report

leo79901 commented Dec 31, 2024

abh1sar commented Jan 6, 2025

blueorangutan commented Jan 6, 2025

blueorangutan commented Jan 6, 2025

github-actions bot commented Jan 8, 2025

abh1sar commented Apr 29, 2025

blueorangutan commented Apr 29, 2025

blueorangutan commented Apr 29, 2025

github-actions bot commented May 2, 2025

abh1sar commented May 5, 2025

blueorangutan commented May 5, 2025

blueorangutan commented May 5, 2025

abh1sar commented May 5, 2025

blueorangutan commented May 5, 2025

blueorangutan commented May 5, 2025

abh1sar commented May 5, 2025

blueorangutan commented May 5, 2025

blueorangutan commented May 6, 2025

abh1sar commented Dec 25, 2024 •

edited

Loading

codecov bot commented Dec 25, 2024 •

edited

Loading