FR572 - KCPS2 migration improvements (#47)

Changes ported from 4.9.1.0-shapeblue8

Summarised changes from the 4.9.1.0-shapeblue8 release:
Changes will be done to bypass secondary storage during the migration of a detached volume while using migrateVolume API. Instead, a worker VM is used, as the transport mechanism, to migrate a detached volume with vMotion (volume is attached to the worker VM, VM migrated, volume detached), while paying attention to the cluster in which the worker VM is created.

Additionally, to improve the robustness of the CloudStack job queue framework for volumes. Change is made similar to the code change present in the upstream CloudStack repository pull request apache#2739

Author: shwstppr

api/src/com/cloud/hypervisor/HypervisorGuru.java

@@ -19,6 +19,7 @@
 import java.util.List;
 import java.util.Map;
 
+import com.cloud.storage.StoragePool;
 import org.apache.cloudstack.framework.config.ConfigKey;
 
 import com.cloud.agent.api.Command;
@@ -84,4 +85,13 @@ public interface HypervisorGuru extends Adapter {
     List<Command> finalizeExpungeVolumes(VirtualMachine vm);
 
     Map<String, String> getClusterSettings(long vmId);
+
+    /**
+     * will generate commands to migrate a vm to a pool. For now this will ony work for stopped VMs on Vmware.
+     *
+     * @param vm the stopped vm to migrate
+     * @param destination the primary storage pool to migrate to
+     * @return a list of commands to perform for a successful migration
+     */
+    List<Command> finalizeMigrate(VirtualMachine vm, StoragePool destination);
 }

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

@@ -29,11 +29,17 @@
 import org.apache.cloudstack.api.command.user.volume.ResizeVolumeCmd;
 import org.apache.cloudstack.api.command.user.volume.UploadVolumeCmd;
 import org.apache.cloudstack.api.response.GetUploadParamsResponse;
+import org.apache.cloudstack.framework.config.ConfigKey;
 
 import com.cloud.exception.ResourceAllocationException;
 import com.cloud.user.Account;
 
 public interface VolumeApiService {
+    ConfigKey<Long> ConcurrentMigrationsThresholdPerDatastore = new ConfigKey<Long>("Advanced", Long.class,
+            "concurrent.migrations.per.target.datastore", "0",
+            "Limits number of migrations that can be handled per target datastore concurrently. Default is 0 - unlimited.",
+            true, ConfigKey.Scope.Global);
+
     /**
      * Creates the database object for a volume based on the given criteria
      *

api/src/org/apache/cloudstack/api/BaseAsyncCmd.java

@@ -27,6 +27,7 @@ public abstract class BaseAsyncCmd extends BaseCmd {
     public static final String ipAddressSyncObject = "ipaddress";
     public static final String networkSyncObject = "network";
     public static final String vpcSyncObject = "vpc";
+    public static final String migrationSyncObject = "migration";
     public static final String snapshotHostSyncObject = "snapshothost";
     public static final String gslbSyncObject = "globalserverloadbalancer";
     private static final Logger s_logger = Logger.getLogger(BaseAsyncCmd.class.getName());

api/src/org/apache/cloudstack/api/command/admin/vm/MigrateVMCmd.java

@@ -44,7 +44,7 @@
 
 @APICommand(name = "migrateVirtualMachine",
             description = "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool",
-        responseObject = UserVmResponse.class, entityType = {VirtualMachine.class},
+            responseObject = UserVmResponse.class, entityType = {VirtualMachine.class},
             requestHasSensitiveInfo = false,
             responseHasSensitiveInfo = true)
 public class MigrateVMCmd extends BaseAsyncCmd {
@@ -149,6 +149,7 @@ public void execute() {
             CallContext.current().setEventDetails("VM Id: " + getVirtualMachineId() + " to host Id: " + getHostId());
         }
 
+        // OfflineMigration performed when this parameter is specified
         StoragePool destStoragePool = null;
         if (getStoragePoolId() != null) {
             destStoragePool = _storageService.getStoragePool(getStoragePoolId());
@@ -186,4 +187,25 @@ public void execute() {
             throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
         }
     }
+
+    @Override
+    public String getSyncObjType() {
+        if (getSyncObjId() != null) {
+            return BaseAsyncCmd.migrationSyncObject;
+        }
+        return null;
+    }
+
+    @Override
+    public Long getSyncObjId() {
+        if (getStoragePoolId() != null) {
+            return getStoragePoolId();
+        }
+        // OfflineVmwareMigrations: undocumented feature;
+        // OfflineVmwareMigrations: on implementing a maximum queue size for per storage migrations it seems counter intuitive for the user to not enforce it for hosts as well.
+        if (getHostId() != null) {
+            return getHostId();
+        }
+        return null;
+    }
 }

api/src/org/apache/cloudstack/api/command/admin/vm/MigrateVirtualMachineWithVolumeCmd.java

@@ -46,7 +46,7 @@
 
 @APICommand(name = "migrateVirtualMachineWithVolume",
             description = "Attempts Migration of a VM with its volumes to a different host",
-        responseObject = UserVmResponse.class, entityType = {VirtualMachine.class},
+            responseObject = UserVmResponse.class, entityType = {VirtualMachine.class},
             requestHasSensitiveInfo = false,
             responseHasSensitiveInfo = true)
 public class MigrateVirtualMachineWithVolumeCmd extends BaseAsyncCmd {
@@ -147,6 +147,7 @@ public void execute() {
         }
 
         Host destinationHost = _resourceService.getHost(getHostId());
+        // OfflineVmwareMigration: destination host would have to not be a required parameter for stopped VMs
         if (destinationHost == null) {
             throw new InvalidParameterValueException("Unable to find the host to migrate the VM, host id =" + getHostId());
         }
@@ -163,13 +164,7 @@ public void execute() {
         } catch (ResourceUnavailableException ex) {
             s_logger.warn("Exception: ", ex);
             throw new ServerApiException(ApiErrorCode.RESOURCE_UNAVAILABLE_ERROR, ex.getMessage());
-        } catch (ConcurrentOperationException e) {
-            s_logger.warn("Exception: ", e);
-            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
-        } catch (ManagementServerException e) {
-            s_logger.warn("Exception: ", e);
-            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
-        } catch (VirtualMachineMigrationException e) {
+        } catch (ConcurrentOperationException | ManagementServerException | VirtualMachineMigrationException e) {
             s_logger.warn("Exception: ", e);
             throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
         }

api/src/org/apache/cloudstack/api/command/user/volume/MigrateVolumeCmd.java

@@ -119,4 +119,19 @@ public void execute() {
         }
     }
 
+    @Override
+    public String getSyncObjType() {
+        if (getSyncObjId() != null) {
+            return BaseAsyncCmd.migrationSyncObject;
+        }
+        return null;
+    }
+
+    @Override
+    public Long getSyncObjId() {
+        if (getStoragePoolId() != null) {
+            return getStoragePoolId();
+        }
+        return null;
+    }
 }

core/src/com/cloud/agent/api/MigrateVmToPoolAnswer.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;
+
+import org.apache.cloudstack.storage.to.VolumeObjectTO;
+
+import java.util.List;
+
+public class MigrateVmToPoolAnswer extends Answer {
+
+    List<VolumeObjectTO> volumeTos;
+
+    public MigrateVmToPoolAnswer(MigrateVmToPoolCommand cmd, Exception ex) {
+        super(cmd, ex);
+        volumeTos = null;
+    }
+
+    public MigrateVmToPoolAnswer(MigrateVmToPoolCommand cmd, List<VolumeObjectTO> volumeTos) {
+        super(cmd, true, null);
+        this.volumeTos = volumeTos;
+    }
+
+    public List<VolumeObjectTO> getVolumeTos() {
+        return volumeTos;
+    }
+}

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

@@ -0,0 +1,70 @@
+//
+// 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;
+
+import com.cloud.agent.api.to.VolumeTO;
+
+import java.util.Collection;
+
+/**
+ * used to tell the agent to migrate a vm to a different primary storage pool.
+ * It is for now only implemented on Vmware and is supposed to work irrespective of whether the VM is started or not.
+ *
+ */
+public class MigrateVmToPoolCommand extends Command {
+    private Collection<VolumeTO> volumes;
+    private String vmName;
+    private String destinationPool;
+    private boolean executeInSequence = false;
+
+    protected MigrateVmToPoolCommand() {
+    }
+
+    /**
+     *
+     * @param vmName the name of the VM to migrate
+     * @param volumes used to supply feedback on vmware generated names
+     * @param destinationPool the primary storage pool to migrate the VM to
+     * @param executeInSequence
+     */
+    public MigrateVmToPoolCommand(String vmName, Collection<VolumeTO> volumes, String destinationPool, boolean executeInSequence) {
+        this.vmName = vmName;
+        this.volumes = volumes;
+        this.destinationPool = destinationPool;
+        this.executeInSequence = executeInSequence;
+    }
+
+    public Collection<VolumeTO> getVolumes() {
+        return volumes;
+    }
+
+    public String getDestinationPool() {
+        return destinationPool;
+    }
+
+    public String getVmName() {
+        return vmName;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        return executeInSequence;
+    }
+
+}

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

@@ -22,14 +22,19 @@
 public class UnregisterVMCommand extends Command {
     String vmName;
     boolean cleanupVmFiles = false;
+    boolean executeInSequence = false;
 
     public UnregisterVMCommand(String vmName) {
+        this(vmName, false);
+    }
+    public UnregisterVMCommand(String vmName, boolean executeInSequence) {
         this.vmName = vmName;
+        this.executeInSequence = executeInSequence;
     }
 
     @Override
     public boolean executeInSequence() {
-        return false;
+        return executeInSequence;
     }
 
     public String getVmName() {

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

@@ -31,6 +31,7 @@ public class MigrateVolumeCommand extends Command {
     long volumeId;
     String volumePath;
     StorageFilerTO pool;
+    StorageFilerTO sourcePool;
     String attachedVmName;
     Volume.Type volumeType;
 
@@ -47,12 +48,14 @@ public MigrateVolumeCommand(long volumeId, String volumePath, StoragePool pool,
     }
 
     public MigrateVolumeCommand(long volumeId, String volumePath, StoragePool pool, String attachedVmName, Volume.Type volumeType, int timeout) {
-        this.volumeId = volumeId;
-        this.volumePath = volumePath;
-        this.pool = new StorageFilerTO(pool);
+        this(volumeId,volumePath,pool,timeout);
         this.attachedVmName = attachedVmName;
         this.volumeType = volumeType;
-        this.setWait(timeout);
+    }
+
+    public MigrateVolumeCommand(long volumeId, String volumePath, StoragePool sourcePool, StoragePool targetPool) {
+        this(volumeId,volumePath,targetPool, null, Volume.Type.UNKNOWN, -1);
+        this.sourcePool = new StorageFilerTO(sourcePool);
     }
 
     public MigrateVolumeCommand(DataTO srcData, DataTO destData, Map<String, String> srcDetails, Map<String, String> destDetails, int timeout) {
@@ -81,6 +84,14 @@ public StorageFilerTO getPool() {
         return pool;
     }
 
+    public StorageFilerTO getSourcePool() {
+        return sourcePool;
+    }
+
+    public StorageFilerTO getTargetPool() {
+        return pool;
+    }
+
     public String getAttachedVmName() {
         return attachedVmName;
     }