KVM Live Storage Migration (#8)

* KVM Live Storage Migration

* Adding tests for live migration for KVM and optimisation on the other tests in the file

* KDDI-179: FindStoragePoolsForMigration not working when VM is running

* KDDI-180: Error message is misleading

* KDDI-183: After failed migration duplicate entry left behind in the DB

* KDDI-182: Migration of chained clones fails if template is missing on the primary store

* KDDI-186: NPE when live storage migration is not enabled

* KDDI-187: User is able to migrate to pool which is in Maintenance

* Fix KDDI-182 and KDDI-183 issues

* Fix KDDI-182 install path on template_spool_ref table

* Include missing marvin test from PR1961 - java code already backported

* Adding a fix for the kvm-livemigration tests

Author: nvazquez

api/src/com/cloud/storage/MigrationOptions.java

@@ -0,0 +1,99 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.cloud.storage;
+
+import java.io.Serializable;
+
+public class MigrationOptions implements Serializable {
+
+    private String srcPoolUuid;
+    private Storage.StoragePoolType srcPoolType;
+    private Type type;
+    private String srcBackingFilePath;
+    private String backingFile;
+    private boolean copySrcTemplate;
+    private String snapshotName;
+    private String srcVolumeUuid;
+    private int timeout;
+
+    public enum Type {
+        LinkedClone, FullClone
+    }
+
+    public MigrationOptions() {
+    }
+
+    public MigrationOptions(String srcPoolUuid, Storage.StoragePoolType srcPoolType, String srcBackingFilePath, boolean copySrcTemplate,
+                            String backingFile) {
+        this.srcPoolUuid = srcPoolUuid;
+        this.srcPoolType = srcPoolType;
+        this.type = Type.LinkedClone;
+        this.srcBackingFilePath = srcBackingFilePath;
+        this.copySrcTemplate = copySrcTemplate;
+        this.backingFile = backingFile;
+    }
+
+    public MigrationOptions(String srcPoolUuid, Storage.StoragePoolType srcPoolType, String snapshotName, String srcVolumeUuid) {
+        this.srcPoolUuid = srcPoolUuid;
+        this.srcPoolType = srcPoolType;
+        this.type = Type.FullClone;
+        this.snapshotName = snapshotName;
+        this.srcVolumeUuid = srcVolumeUuid;
+    }
+
+    public String getSrcPoolUuid() {
+        return srcPoolUuid;
+    }
+
+    public Storage.StoragePoolType getSrcPoolType() {
+        return srcPoolType;
+    }
+
+    public String getSrcBackingFilePath() {
+        return srcBackingFilePath;
+    }
+
+    public boolean isCopySrcTemplate() {
+        return copySrcTemplate;
+    }
+
+    public String getSnapshotName() {
+        return snapshotName;
+    }
+
+    public String getSrcVolumeUuid() {
+        return srcVolumeUuid;
+    }
+
+    public Type getType() {
+        return type;
+    }
+
+    public int getTimeout() {
+        return timeout;
+    }
+
+    public void setTimeout(int timeout) {
+        this.timeout = timeout;
+    }
+
+    public String getBackingFile() {
+        return backingFile;
+    }
+}

core/src/com/cloud/agent/api/CreateVMSnapshotCommand.java

@@ -32,6 +32,10 @@ public CreateVMSnapshotCommand(String vmName, String vmUuid, VMSnapshotTO snapsh
         this.vmUuid = vmUuid;
     }
 
+    public CreateVMSnapshotCommand(String vmName, VMSnapshotTO snapshot) {
+        super(vmName, snapshot, null, null);
+    }
+
     public String getVmUuid() {
         return vmUuid;
     }

core/src/com/cloud/agent/api/DeleteVMSnapshotCommand.java

@@ -27,4 +27,8 @@ public class DeleteVMSnapshotCommand extends VMSnapshotBaseCommand {
     public DeleteVMSnapshotCommand(String vmName, VMSnapshotTO snapshot, List<VolumeObjectTO> volumeTOs, String guestOSType) {
         super(vmName, snapshot, volumeTOs, guestOSType);
     }
+
+    public DeleteVMSnapshotCommand(String vmName, VMSnapshotTO snapshot) {
+        super(vmName, snapshot, null, null);
+    }
 }

core/src/com/cloud/agent/api/MigrateCommand.java

@@ -19,15 +19,21 @@
 
 package com.cloud.agent.api;
 
+import java.util.HashMap;
+import java.util.Map;
+
 import com.cloud.agent.api.to.VirtualMachineTO;
 
 public class MigrateCommand extends Command {
-    String vmName;
-    String destIp;
-    String hostGuid;
-    boolean isWindows;
-    VirtualMachineTO vmTO;
-    boolean executeInSequence = false;
+    private String vmName;
+    private String destIp;
+    private Map<String, MigrateDiskInfo> migrateStorage;
+    private boolean migrateStorageManaged;
+    private boolean autoConvergence;
+    private String hostGuid;
+    private boolean isWindows;
+    private VirtualMachineTO vmTO;
+    private boolean executeInSequence = false;
 
     protected MigrateCommand() {
     }
@@ -40,6 +46,30 @@ public MigrateCommand(String vmName, String destIp, boolean isWindows, VirtualMa
         this.executeInSequence = executeInSequence;
     }
 
+    public void setMigrateStorage(Map<String, MigrateDiskInfo> migrateStorage) {
+        this.migrateStorage = migrateStorage;
+    }
+
+    public Map<String, MigrateDiskInfo> getMigrateStorage() {
+        return migrateStorage != null ? new HashMap<>(migrateStorage) : new HashMap<String, MigrateDiskInfo>();
+    }
+
+    public boolean isMigrateStorageManaged() {
+        return migrateStorageManaged;
+    }
+
+    public void setMigrateStorageManaged(boolean migrateStorageManaged) {
+        this.migrateStorageManaged = migrateStorageManaged;
+    }
+
+    public void setAutoConvergence(boolean autoConvergence) {
+        this.autoConvergence = autoConvergence;
+    }
+
+    public boolean isAutoConvergence() {
+        return autoConvergence;
+    }
+
     public boolean isWindows() {
         return isWindows;
     }
@@ -68,4 +98,68 @@ public String getHostGuid() {
     public boolean executeInSequence() {
         return executeInSequence;
     }
+
+    public static class MigrateDiskInfo {
+
+        public enum DiskType {
+            FILE, BLOCK;
+
+            @Override
+            public String toString() {
+                return name().toLowerCase();
+            }
+        }
+
+        public enum DriverType {
+            QCOW2, RAW;
+
+            @Override
+            public String toString() {
+                return name().toLowerCase();
+            }
+        }
+
+        public enum Source {
+            FILE, DEV;
+
+            @Override
+            public String toString() {
+                return name().toLowerCase();
+            }
+        }
+
+        private final String serialNumber;
+        private final DiskType diskType;
+        private final DriverType driverType;
+        private final Source source;
+        private final String sourceText;
+
+        public MigrateDiskInfo(final String serialNumber, final DiskType diskType, final DriverType driverType, final Source source, final String sourceText) {
+            this.serialNumber = serialNumber;
+            this.diskType = diskType;
+            this.driverType = driverType;
+            this.source = source;
+            this.sourceText = sourceText;
+        }
+
+        public String getSerialNumber() {
+            return serialNumber;
+        }
+
+        public DiskType getDiskType() {
+            return diskType;
+        }
+
+        public DriverType getDriverType() {
+            return driverType;
+        }
+
+        public Source getSource() {
+            return source;
+        }
+
+        public String getSourceText() {
+            return sourceText;
+        }
+    }
 }

core/src/com/cloud/agent/api/ModifyTargetsAnswer.java

@@ -19,5 +19,27 @@
 
 package com.cloud.agent.api;
 
+import java.util.List;
+
 public class ModifyTargetsAnswer extends Answer {
+
+    private List<String> connectedPaths;
+
+    public void setConnectedPaths(List<String> connectedPaths) {
+        this.connectedPaths = connectedPaths;
+    }
+
+    public List<String> getConnectedPaths() {
+        return connectedPaths;
+    }
+
+    public ModifyTargetsAnswer() {
+        super();
+    }
+
+    public ModifyTargetsAnswer(boolean result, String details) {
+        super();
+        this.result = result;
+        this.details = details;
+    }
 }

core/src/com/cloud/agent/api/ModifyTargetsCommand.java

@@ -23,7 +23,11 @@
 import java.util.Map;
 
 public class ModifyTargetsCommand extends Command {
+    public enum TargetTypeToRemove { BOTH, NEITHER, STATIC, DYNAMIC }
+
     public static final String IQN = "iqn";
+    public static final String STORAGE_TYPE = "storageType";
+    public static final String STORAGE_UUID = "storageUuid";
     public static final String STORAGE_HOST = "storageHost";
     public static final String STORAGE_PORT = "storagePort";
     public static final String CHAP_NAME = "chapName";
@@ -32,6 +36,9 @@ public class ModifyTargetsCommand extends Command {
     public static final String MUTUAL_CHAP_SECRET = "mutualChapSecret";
 
     private boolean add;
+    private boolean applyToAllHostsInCluster;
+    private TargetTypeToRemove targetTypeToRemove = TargetTypeToRemove.BOTH;
+    private boolean removeAsync;
     private List<Map<String, String>> targets;
 
     public void setAdd(boolean add) {
@@ -42,6 +49,30 @@ public boolean getAdd() {
         return add;
     }
 
+    public void setApplyToAllHostsInCluster(boolean applyToAllHostsInCluster) {
+        this.applyToAllHostsInCluster = applyToAllHostsInCluster;
+    }
+
+    public boolean getApplyToAllHostsInCluster() {
+        return applyToAllHostsInCluster;
+    }
+
+    public void setTargetTypeToRemove(TargetTypeToRemove targetTypeToRemove) {
+        this.targetTypeToRemove = targetTypeToRemove;
+    }
+
+    public TargetTypeToRemove getTargetTypeToRemove() {
+        return targetTypeToRemove;
+    }
+
+    public void setRemoveAsync(boolean removeAsync) {
+        this.removeAsync = removeAsync;
+    }
+
+    public boolean isRemoveAsync() {
+        return removeAsync;
+    }
+
     public void setTargets(List<Map<String, String>> targets) {
         this.targets = targets;
     }

core/src/com/cloud/agent/api/PrepareForMigrationCommand.java

@@ -22,7 +22,8 @@
 import com.cloud.agent.api.to.VirtualMachineTO;
 
 public class PrepareForMigrationCommand extends Command {
-    VirtualMachineTO vm;
+    private VirtualMachineTO vm;
+    private boolean rollback;
 
     protected PrepareForMigrationCommand() {
     }
@@ -35,6 +36,14 @@ public VirtualMachineTO getVirtualMachine() {
         return vm;
     }
 
+    public void setRollback(boolean rollback) {
+        this.rollback = rollback;
+    }
+
+    public boolean isRollback() {
+        return rollback;
+    }
+
     @Override
     public boolean executeInSequence() {
         return true;

core/src/com/cloud/agent/api/storage/CheckStorageAvailabilityCommand.java

@@ -0,0 +1,43 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+package com.cloud.agent.api.storage;
+
+import com.cloud.agent.api.Command;
+import com.cloud.storage.Storage;
+
+import java.util.Map;
+
+public class CheckStorageAvailabilityCommand extends Command {
+
+    private Map<String, Storage.StoragePoolType> poolsMap;
+
+    public CheckStorageAvailabilityCommand(Map<String, Storage.StoragePoolType> poolsMap) {
+        this.poolsMap = poolsMap;
+    }
+
+    public Map<String, Storage.StoragePoolType> getPoolsMap() {
+        return poolsMap;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        return false;
+    }
+}