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 deployVIrtualMachine
new argument : backupId
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

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 templateUuid, serviceOfferingUuid, hypervisor, networkUuids
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.

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

Project coverage is 16.38%. Comparing base (d94aaa8) to head (1574f3a).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	33.48%	114 Missing and 31 partials ⚠️
...rg/apache/cloudstack/backup/BackupManagerImpl.java	68.36%	36 Missing and 26 partials ⚠️
...ack/api/command/user/vm/CreateVMFromBackupCmd.java	3.57%	54 Missing ⚠️
...rg/apache/cloudstack/backup/dao/BackupDaoImpl.java	40.98%	30 Missing and 6 partials ⚠️
...a/org/apache/cloudstack/backup/BackupDetailVO.java	18.91%	29 Missing and 1 partial ⚠️
.../apache/cloudstack/backup/DummyBackupProvider.java	0.00%	29 Missing ⚠️
...rg/apache/cloudstack/backup/NASBackupProvider.java	60.31%	21 Missing and 4 partials ⚠️
...apache/cloudstack/api/response/BackupResponse.java	23.33%	23 Missing ⚠️
...che/cloudstack/backup/NetworkerBackupProvider.java	0.00%	23 Missing ⚠️
...loudstack/backup/GetBackupStorageStatsCommand.java	18.51%	22 Missing ⚠️
... and 32 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #10140      +/-   ##
============================================
+ Coverage     16.26%   16.38%   +0.12%     
- Complexity    13387    13518     +131     
============================================
  Files          5674     5683       +9     
  Lines        498927   500912    +1985     
  Branches      60337    60687     +350     
============================================
+ Hits          81155    82093     +938     
- Misses       408732   409627     +895     
- Partials       9040     9192     +152

Flag	Coverage Δ
uitests	`3.88% <ø> (-0.12%)`	⬇️
unittests	`17.28% <35.21%> (+0.16%)`	⬆️

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.

github-actions · 2025-03-06T07:23:21Z

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

…loudstack into instance-from-backup

github-actions · 2025-03-10T08:05:24Z

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

…ger.

abh1sar · 2025-03-11T06:00:44Z

@blueorangutan package

blueorangutan · 2025-03-11T06: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-03-11T07:11:04Z

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

DaanHoogland · 2025-03-11T08:16:48Z

engine/schema/src/test/java/org/apache/cloudstack/backup/dao/BackupDaoImplTest.java

@@ -0,0 +1,150 @@
+package org.apache.cloudstack.backup.dao;


DaanHoogland · 2025-03-11T08:17:04Z

engine/schema/src/test/java/org/apache/cloudstack/backup/dao/BackupDaoImplTest.java

+        Assert.assertEquals("test-offering", response.getBackupOffering());
+        Assert.assertEquals("MANUAL", response.getIntervalType());
+    }
+}


eol before eof

…th backups.

DaanHoogland · 2025-03-11T10:31:27Z

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

+                            if (vm.getBackupOfferingId() != null) {
+                                List<Backup> backupsForVm = backupDao.listByVmId(vm.getDataCenterId(), vm.getId());
+                                if (CollectionUtils.isEmpty(backupsForVm)) {
+                                    backupManager.removeVMFromBackupOffering(vm.getId(), true);
+                                } else {
+                                    throw new CloudRuntimeException(String.format("This VM [uuid: %s, name: %s] has a "
+                                                    + "Backup Offering [id: %s, external id: %s] with %s backups. Please, remove the backup offering "
+                                                    + "before proceeding to VM exclusion!", vm.getUuid(), vm.getInstanceName(), vm.getBackupOfferingId(),
+                                            vm.getBackupExternalId(), backupsForVm.size()));
+                                }
+                            }


extract method?

abh1sar · 2025-03-11T12:50:11Z

@blueorangutan package

blueorangutan · 2025-03-11T12:52: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-03-11T13:55:20Z

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

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

rohityadavcloud added this to the 4.21.0 milestone Mar 4, 2025

abh1sar and others added 2 commits March 4, 2025 23:57

Backup storage capacity and alert framework layer.

beb05ae

Nas provider support for backup storage stats

c72a10e

github-actions bot added the status:has-conflicts label Mar 6, 2025

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

54bf763

github-actions bot removed the status:has-conflicts label Mar 6, 2025

abh1sar added 2 commits March 7, 2025 05:17

Don't show object store and backup capacity if total capacity is 0

7791ff3

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

3d3f6c1

…loudstack into instance-from-backup

github-actions bot added the status:has-conflicts label Mar 10, 2025

abh1sar added 3 commits March 10, 2025 17:16

Handle backup listing and restore for expunged and purged Instances

051d52c

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

73c185c

Fix BackupManagerTest failure

dd45cfe

github-actions bot removed the status:has-conflicts label Mar 10, 2025

abh1sar added 5 commits March 11, 2025 09:28

Added UT to AlertManager, BackupDao, NasBackupProvider and BackupMana…

9894eff

…ger.

make capacity dasboard scrollable

47b6cd1

Fix syntax errors in schema-42010to42100.sql

e909c18

Fix pre commit failure in BackupDaoImplTest

22d25d3

Enable cephFS in NAS backup repository

4997056

DaanHoogland reviewed Mar 11, 2025

View reviewed changes

Error out vm expunge from destroyvmCmd if it has a backup offering wi…

1574f3a

…th backups.

DaanHoogland reviewed Mar 11, 2025

View reviewed changes

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

github-actions bot commented Mar 6, 2025

github-actions bot commented Mar 10, 2025

abh1sar commented Mar 11, 2025

blueorangutan commented Mar 11, 2025

blueorangutan commented Mar 11, 2025

DaanHoogland Mar 11, 2025

DaanHoogland Mar 11, 2025

DaanHoogland Mar 11, 2025

abh1sar commented Mar 11, 2025

blueorangutan commented Mar 11, 2025

blueorangutan commented Mar 11, 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

github-actions bot commented Mar 6, 2025

github-actions bot commented Mar 10, 2025

abh1sar commented Mar 11, 2025

blueorangutan commented Mar 11, 2025

blueorangutan commented Mar 11, 2025

DaanHoogland Mar 11, 2025

Choose a reason for hiding this comment

DaanHoogland Mar 11, 2025

Choose a reason for hiding this comment

DaanHoogland Mar 11, 2025

Choose a reason for hiding this comment

abh1sar commented Mar 11, 2025

blueorangutan commented Mar 11, 2025

blueorangutan commented Mar 11, 2025

abh1sar commented Dec 25, 2024 •

edited

Loading

codecov bot commented Dec 25, 2024 •

edited

Loading