Save and restore Instance settings to/from backup

Author: abh1sar

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -607,6 +607,7 @@ public class ApiConstants {
     public static final String VM_DETAILS = "vmdetails";
     public static final String VM_LIMIT = "vmlimit";
     public static final String VM_TOTAL = "vmtotal";
+    public static final String VM_SETTINGS = "vmsettings";
     public static final String VM_TYPE = "vmtype";
     public static final String VNET = "vnet";
     public static final String IS_VOLATILE = "isvolatile";

api/src/main/java/org/apache/cloudstack/backup/BackupManager.java

@@ -262,7 +262,7 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
 
     void checkDiskOfferingSizeAgainstBackup(List<DiskOfferingInfo> dataDiskOfferingsInfo, Backup backup);
 
-    Map<String, String> getVmDetailsForBackup(VirtualMachine vm);
+    Map<String, String> getBackupDetailsFromVM(VirtualMachine vm);
 
     String createVolumeInfoFromVolumes(List<Volume> vmVolumes);
 

plugins/backup/dummy/src/main/java/org/apache/cloudstack/backup/DummyBackupProvider.java

@@ -172,7 +172,7 @@ public Pair<Boolean, Backup> takeBackup(VirtualMachine vm, Boolean quiesceVM) {
         backup.setName(backupManager.getBackupNameFromVM(vm));
         List<Volume> volumes = new ArrayList<>(volumeDao.findByInstance(vm.getId()));
         backup.setBackedUpVolumes(backupManager.createVolumeInfoFromVolumes(volumes));
-        Map<String, String> details = backupManager.getVmDetailsForBackup(vm);
+        Map<String, String> details = backupManager.getBackupDetailsFromVM(vm);
         backup.setDetails(details);
 
         backup = backupDao.persist(backup);

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

@@ -240,7 +240,7 @@ private BackupVO createBackupObject(VirtualMachine vm, String backupPath) {
         backup.setDomainId(vm.getDomainId());
         backup.setZoneId(vm.getDataCenterId());
         backup.setName(backupManager.getBackupNameFromVM(vm));
-        Map<String, String> details = backupManager.getVmDetailsForBackup(vm);
+        Map<String, String> details = backupManager.getBackupDetailsFromVM(vm);
         backup.setDetails(details);
 
         return backupDao.persist(backup);

plugins/backup/networker/src/main/java/org/apache/cloudstack/backup/NetworkerBackupProvider.java

@@ -521,7 +521,7 @@ public Pair<Boolean, Backup> takeBackup(VirtualMachine vm, Boolean quiesceVM) {
         if (backup != null) {
             List<Volume> volumes = new ArrayList<>(volumeDao.findByInstance(vm.getId()));
             backup.setBackedUpVolumes(backupManager.createVolumeInfoFromVolumes(volumes));
-            Map<String, String> details = backupManager.getVmDetailsForBackup(vm);
+            Map<String, String> details = backupManager.getBackupDetailsFromVM(vm);
             backup.setDetails(details);
             backupDao.persist(backup);
             return new Pair<>(true, backup);

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java

@@ -25,6 +25,7 @@
 import java.io.IOException;
 import java.io.StringReader;
 import java.io.UnsupportedEncodingException;
+import java.lang.reflect.Type;
 import java.net.URLDecoder;
 import java.text.SimpleDateFormat;
 import java.time.LocalDateTime;
@@ -400,6 +401,8 @@
 import com.cloud.vm.snapshot.VMSnapshotManager;
 import com.cloud.vm.snapshot.VMSnapshotVO;
 import com.cloud.vm.snapshot.dao.VMSnapshotDao;
+import com.google.gson.Gson;
+import com.google.gson.reflect.TypeToken;
 
 import org.apache.cloudstack.engine.subsystem.api.storage.SnapshotDataFactory;
 import org.apache.cloudstack.engine.subsystem.api.storage.SnapshotInfo;
@@ -9411,7 +9414,6 @@ private void checkRootDiskSizeAgainstBackup(Long instanceVolumeSize,DiskOffering
 
     @Override
     public UserVm allocateVMFromBackup(CreateVMFromBackupCmd cmd) throws InsufficientCapacityException, ResourceAllocationException, ResourceUnavailableException {
-        //Verify that all objects exist before passing them to the service
         Account owner = _accountService.getActiveAccountById(cmd.getEntityOwnerId());
         Long zoneId = cmd.getZoneId();
         DataCenter zone = _dcDao.findById(zoneId);
@@ -9453,19 +9455,21 @@ public UserVm allocateVMFromBackup(CreateVMFromBackupCmd cmd) throws Insufficien
         }
         verifyServiceOffering(cmd, serviceOffering);
 
-        Long templateId;
         VirtualMachineTemplate template;
         if (cmd.getTemplateId() != null) {
-            templateId = cmd.getTemplateId();
+            Long templateId = cmd.getTemplateId();
             template = _templateDao.findById(templateId);
             if (template == null) {
                 throw new InvalidParameterValueException("Unable to use template " + templateId);
             }
         } else {
-            templateId = backupVm.getTemplateId();
-            template = _templateDao.findById(templateId);
+            String templateUuid = backup.getDetail(ApiConstants.TEMPLATE_ID);
+            if (templateUuid == null) {
+                throw new CloudRuntimeException("Backup doesn't contain Template uuid. Please specify a valid Template/ISO while creating the instance");
+            }
+            template = _templateDao.findByUuid(templateUuid);
             if (template == null) {
-                throw new CloudRuntimeException("Unable to find template associated with the backup. Please specify a valid template while creating instance");
+                throw new CloudRuntimeException("Unable to find template associated with the backup. Please specify a valid Template/ISO while creating instance");
             }
         }
         verifyTemplate(cmd, template, serviceOffering.getId());
@@ -9534,7 +9538,23 @@ public UserVm allocateVMFromBackup(CreateVMFromBackupCmd cmd) throws Insufficien
             ipToNetworkMap = backupManager.getIpToNetworkMapFromBackup(backup, cmd.getPreserveIp(), networkIds);
         }
 
-        return createVirtualMachine(cmd, zone, owner, serviceOffering, template, hypervisorType, diskOfferingId, size, overrideDiskOfferingId, dataDiskOfferingsInfo, networkIds, ipToNetworkMap, null, null);
+        UserVm vm = createVirtualMachine(cmd, zone, owner, serviceOffering, template, hypervisorType, diskOfferingId, size, overrideDiskOfferingId, dataDiskOfferingsInfo, networkIds, ipToNetworkMap, null, null);
+
+        String vmSettingsFromBackup = backup.getDetail(ApiConstants.VM_SETTINGS);
+        if (vm != null && vmSettingsFromBackup != null) {
+            UserVmVO vmVO = _vmDao.findById(vm.getId());
+            Map<String, String> details = userVmDetailsDao.listDetailsKeyPairs(vm.getId());
+            vmVO.setDetails(details);
+
+            Type type = new TypeToken<Map<String, String>>(){}.getType();
+            Map<String, String> vmDetailsFromBackup = new Gson().fromJson(vmSettingsFromBackup, type);
+            for (Map.Entry<String, String> entry : vmDetailsFromBackup.entrySet()) {
+                vmVO.setDetail(entry.getKey(), entry.getValue());
+            }
+            _vmDao.saveDetails(vmVO);
+        }
+
+        return vm;
     }
 
     @Override

server/src/main/java/org/apache/cloudstack/backup/BackupManagerImpl.java

@@ -16,6 +16,7 @@
 // under the License.
 package org.apache.cloudstack.backup;
 
+import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -53,9 +54,11 @@
 import com.cloud.storage.DiskOfferingVO;
 import com.cloud.storage.VolumeApiService;
 import com.cloud.storage.dao.VMTemplateDao;
+import com.cloud.template.VirtualMachineTemplate;
 import com.cloud.user.DomainManager;
 import com.cloud.user.ResourceLimitService;
 import com.cloud.utils.fsm.NoTransitionException;
+import com.cloud.vm.UserVmDetailVO;
 import com.cloud.vm.VirtualMachineManager;
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
@@ -149,8 +152,10 @@
 import com.cloud.vm.VMInstanceVO;
 import com.cloud.vm.VirtualMachine;
 import com.cloud.vm.dao.UserVmDao;
+import com.cloud.vm.dao.UserVmDetailsDao;
 import com.cloud.vm.dao.VMInstanceDao;
 import com.google.gson.Gson;
+import com.google.gson.reflect.TypeToken;
 
 public class BackupManagerImpl extends ManagerBase implements BackupManager {
 
@@ -191,6 +196,8 @@ public class BackupManagerImpl extends ManagerBase implements BackupManager {
     @Inject
     private UserVmJoinDao userVmJoinDao;
     @Inject
+    private UserVmDetailsDao userVmDetailsDao;
+    @Inject
     private NetworkDao networkDao;
     @Inject
     private NetworkService networkService;
@@ -324,12 +331,24 @@ public boolean deleteBackupOffering(final Long offeringId) {
     }
 
     @Override
-    public Map<String, String> getVmDetailsForBackup(VirtualMachine vm) {
+    public Map<String, String> getBackupDetailsFromVM(VirtualMachine vm) {
         HashMap<String, String> details = new HashMap<>();
-        ServiceOffering serviceOffering =  serviceOfferingDao.findById(vm.getServiceOfferingId());
+
+        ServiceOffering serviceOffering = serviceOfferingDao.findById(vm.getServiceOfferingId());
         details.put(ApiConstants.SERVICE_OFFERING_ID, serviceOffering.getUuid());
-        List<UserVmJoinVO> userVmJoinVOs = userVmJoinDao.searchByIds(vm.getId());
+        VirtualMachineTemplate template = vmTemplateDao.findById(vm.getTemplateId());
+        details.put(ApiConstants.TEMPLATE_ID, template.getUuid());
 
+        List<UserVmDetailVO> vmDetails = userVmDetailsDao.listDetails(vm.getId());
+        HashMap<String, String> settings = new HashMap<>();
+        for (UserVmDetailVO detail : vmDetails) {
+            settings.put(detail.getName(), detail.getValue());
+        }
+        if (!settings.isEmpty()) {
+            details.put(ApiConstants.VM_SETTINGS, new Gson().toJson(settings));
+        }
+
+        List<UserVmJoinVO> userVmJoinVOs = userVmJoinDao.searchByIds(vm.getId());
         if (userVmJoinVOs != null && !userVmJoinVOs.isEmpty()) {
             List<Map<String, String>> nics = new ArrayList<>();
             Set<String> seen = new HashSet<>();
@@ -1102,7 +1121,8 @@ public Map<Long, Network.IpAddresses> getIpToNetworkMapFromBackup(Backup backup,
                     "Please specify at least one valid network while creating instance");
         }
 
-        List<Map<String, String>> nics = new Gson().fromJson(nicsJson, List.class);
+        Type type = new TypeToken<List<Map<String, String>>>(){}.getType();
+        List<Map<String, String>> nics = new Gson().fromJson(nicsJson, type);
 
         for (Map<String, String> nic : nics) {
             String networkUuid = nic.get(ApiConstants.NETWORK_ID);

server/src/test/java/org/apache/cloudstack/backup/BackupManagerTest.java

@@ -804,7 +804,7 @@ public void testBackupSyncTask() {
     }
 
     @Test
-    public void testGetVmDetailsForBackup() {
+    public void testGetBackupDetailsFromVM() {
         Long vmId = 1L;
         VirtualMachine vm = mock(VirtualMachine.class);
         when(vm.getServiceOfferingId()).thenReturn(1L);
@@ -819,7 +819,7 @@ public void testGetVmDetailsForBackup() {
         List<UserVmJoinVO> userVmJoinVOs = Collections.singletonList(userVmJoinVO);
         when(userVmJoinDao.searchByIds(vmId)).thenReturn(userVmJoinVOs);
 
-        Map<String, String> details = backupManager.getVmDetailsForBackup(vm);
+        Map<String, String> details = backupManager.getBackupDetailsFromVM(vm);
 
         assertEquals("service-offering-uuid", details.get(ApiConstants.SERVICE_OFFERING_ID));
         assertEquals("mocked-network-uuid", details.get(ApiConstants.NETWORK_IDS));

ui/src/components/view/BackupMetadata.vue

@@ -7,11 +7,11 @@
         <div style="width: 100%">
           <strong>{{ getFieldLabel(item) }}</strong>
           <br/>
-                      <div v-if="item === 'nics'">
-              <div v-for="(nic, idx) in getNicEntities()" :key="idx">
-                <router-link :to="{ path: '/guestnetwork/' + nic.networkid }">
-                  {{ nic.networkname || nic.networkid }}
-                </router-link>
+          <div v-if="item === 'nics'">
+            <div v-for="(nic, idx) in getNicEntities()" :key="idx">
+              <router-link :to="{ path: '/guestnetwork/' + nic.networkid }">
+                {{ nic.networkname || nic.networkid }}
+              </router-link>
               <br/>
               IP Address: {{ nic.ipaddress }}
               <span v-if="nic.ip6address && nic.ip6address !== 'null'"> | IPv6: {{ nic.ip6address }}</span>
@@ -30,6 +30,14 @@
               {{ getServiceOfferingDisplayName() }}
             </router-link>
           </div>
+          <div v-else-if="item === 'vmsettings'">
+            <div v-for="(value, key, index) in getVmSettings()" :key="key">
+              {{ key }}
+              <br/>
+              {{ value }}
+              <div v-if="index < Object.keys(getVmSettings()).length - 1" style="margin: 6px 0; border-bottom: 1px dashed #d9d9d9;"></div>
+            </div>
+          </div>
           <div v-else>{{ backupMetadata[item] }}</div>
         </div>
       </a-list-item>
@@ -66,20 +74,23 @@ export default {
       }
       fieldOrder.push('serviceofferingid')
       fieldOrder.push('nics')
+      fieldOrder.push('vmsettings')
 
       return fieldOrder.filter(field => this.backupMetadata[field] !== undefined)
     },
     getNicEntities () {
       if (this.backupMetadata.nics) {
-        const nics = JSON.parse(this.backupMetadata.nics)
-        return nics
+        return JSON.parse(this.backupMetadata.nics)
       }
       return []
     },
     getFieldLabel (field) {
       if (field === 'templateid') {
         return this.backupMetadata.isiso === 'true' ? this.$t('label.iso') : this.$t('label.template')
       }
+      if (field === 'vmsettings') {
+        return this.$t('label.settings')
+      }
       return this.$t('label.' + String(field).toLowerCase())
     },
     getTemplateDisplayName () {
@@ -93,6 +104,12 @@ export default {
         return this.backupMetadata.serviceofferingname
       }
       return this.backupMetadata.serviceofferingid
+    },
+    getVmSettings () {
+      if (this.backupMetadata.vmsettings) {
+        return JSON.parse(this.backupMetadata.vmsettings)
+      }
+      return {}
     }
   }
 }