Offline volume migrations for Vmware (#6)

* [CLOUDSTACK-9858] Retirement of midonet plugin (build disabling)

* build problem workaround for conflicting java versions

* research comments

* Adding marvin tests for:
    1) simple VM migration with root volume
    2) migration of vm and volume for a vm with 2 data disks
    3) volume migration of detached disk

* the hypervisor-guru made migrate aware
  implemented for vmware

* enable canHandle and implement detached volume migration for vmware

* rename method to fit naming scheme

* command rename to better specify scope of action

* pull up condition for readability

* extract some logic for readability

* fixing the migrate detached volume test

* info on destination cluster

* extra attempts on volume paths

* logging on name not found

* move volume to root after migration

* vmdk-extension

* nuage profile readded

* defensive debug logging

* Fix tag matching in 'migrateVolume'`

* Fix was meant for disk offering replacement and addapted for regular migration

* tagging tests

* reset status on failure

* Revert "nuage profile readded"

This reverts commit 05664c1801163ae2959052fa88cb87303ad93972.

* limit migration jobs

* null pointers during startup

* old style config

* space

* job count method

* job count check

* implement global setting fixes

Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>

* option2: implement throwing exception if async_job table pending jobs exceed the threshold for migration

Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>

* option1: use the sync_queue mechanism to limit execution per DS

This uses the ideal way that must be accepted by the community that uses
the sync_queue + the global setting via API dispatcher to enforce the
number of async API jobs executed for a sync Obj ID (datastore in our cases).
This is much cleaner implementation but involves changes to the
job framework, in case of any regressions we'll partially revert this
commit and aim to fix this during community submission.

Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>

* revert option2 - removes check/exception way

We can re-revert this commit to get the changes back

Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>

* Revert "option1: use the sync_queue mechanism to limit execution per DS"

This reverts commit c4c286c5ac87171018b99fb079e512477fcb0aa0.

* Revert "revert option2 - removes check/exception way"

This reverts commit c610f476ddc9f42ab7e6f7a799c1b825cf96ae99.

Author: DaanHoogland

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 succesful migration
+     */
+    List<Command> finalizeMigrate(VirtualMachine vm, StoragePool destination);
 }

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

@@ -31,10 +31,16 @@
 import com.cloud.exception.ResourceAllocationException;
 import com.cloud.user.Account;
 import org.apache.cloudstack.api.response.GetUploadParamsResponse;
+import org.apache.cloudstack.framework.config.ConfigKey;
 
 import java.net.MalformedURLException;
 
 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

@@ -186,4 +186,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

@@ -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;
+    }
 }

client/pom.xml

@@ -136,11 +136,6 @@
       <artifactId>cloud-plugin-network-bigswitch</artifactId>
       <version>${project.version}</version>
     </dependency>
-    <dependency>
-      <groupId>org.apache.cloudstack</groupId>
-      <artifactId>cloud-plugin-network-midonet</artifactId>
-      <version>${project.version}</version>
-    </dependency>
     <dependency>
       <groupId>org.apache.cloudstack</groupId>
       <artifactId>cloud-plugin-network-ssp</artifactId>
@@ -995,21 +990,6 @@
         </dependency>
       </dependencies>
     </profile>
-    <profile>
-      <id>nuagevsp</id>
-      <activation>
-        <property>
-          <name>noredist</name>
-        </property>
-      </activation>
-      <dependencies>
-        <dependency>
-          <groupId>org.apache.cloudstack</groupId>
-          <artifactId>cloud-plugin-network-vsp</artifactId>
-          <version>${project.version}</version>
-        </dependency>
-      </dependencies>
-    </profile>
     <profile>
       <id>srx</id>
       <activation>

core/resources/META-INF/cloudstack/core/spring-core-registry-core-context.xml

@@ -134,7 +134,6 @@
     <bean id="ipDeployersRegistry"
         class="org.apache.cloudstack.spring.lifecycle.registry.ExtensionRegistry">
         <property name="excludeKey" value="ip.deployers.exclude" />
-        <property name="excludeDefault" value="MidoNetElement" />
         <property name="preRegistered">
             <list>
                 <ref bean="VpcVirtualRouter" />
@@ -145,7 +144,6 @@
     <bean id="dhcpProvidersRegistry"
         class="org.apache.cloudstack.spring.lifecycle.registry.ExtensionRegistry">
         <property name="excludeKey" value="dhcp.providers.exclude" />
-        <property name="excludeDefault" value="MidoNetElement" />
         <property name="preRegistered">
             <list>
                 <ref bean="VpcVirtualRouter" />

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 primare storage pool.
+ * It is for now only mplemented 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 suplly feedback on vmware generated names
+     * @param destinationPool the primare 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;
+    }
+
+}