persist kvm domain when unmanaged from CS

Author: sudo87

core/src/main/java/com/cloud/agent/api/UnmanageInstanceAnswer.java

@@ -0,0 +1,32 @@
+//
+// 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;
+
+public class UnmanageInstanceAnswer extends Answer {
+
+    public UnmanageInstanceAnswer(UnmanageInstanceCommand cmd, boolean success, String details) {
+        super(cmd, success, details);
+    }
+
+    public UnmanageInstanceAnswer(UnmanageInstanceCommand cmd, Exception e) {
+        super(cmd, e);
+    }
+
+}

core/src/main/java/com/cloud/agent/api/UnmanageInstanceCommand.java

@@ -0,0 +1,50 @@
+//
+// 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.VirtualMachineTO;
+
+/**
+ */
+public class UnmanageInstanceCommand extends Command {
+    VirtualMachineTO vm;
+    boolean executeInSequence = false;
+
+    public VirtualMachineTO getVirtualMachine() {
+        return vm;
+    }
+
+    @Override
+    public boolean executeInSequence() {
+        //VR start doesn't go through queue
+        if (vm.getName() != null && vm.getName().startsWith("r-")) {
+            return false;
+        }
+        return executeInSequence;
+    }
+
+    protected UnmanageInstanceCommand() {
+    }
+
+    public UnmanageInstanceCommand(VirtualMachineTO vm,  boolean executeInSequence) {
+        this.vm = vm;
+        this.executeInSequence = executeInSequence;
+    }
+}

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

@@ -49,7 +49,6 @@
 import javax.naming.ConfigurationException;
 import javax.persistence.EntityExistsException;
 
-
 import org.apache.cloudstack.affinity.dao.AffinityGroupVMMapDao;
 import org.apache.cloudstack.annotation.AnnotationService;
 import org.apache.cloudstack.annotation.dao.AnnotationDao;
@@ -150,6 +149,8 @@
 import com.cloud.agent.api.StopCommand;
 import com.cloud.agent.api.UnPlugNicAnswer;
 import com.cloud.agent.api.UnPlugNicCommand;
+import com.cloud.agent.api.UnmanageInstanceAnswer;
+import com.cloud.agent.api.UnmanageInstanceCommand;
 import com.cloud.agent.api.UnregisterVMCommand;
 import com.cloud.agent.api.VmDiskStatsEntry;
 import com.cloud.agent.api.VmNetworkStatsEntry;
@@ -297,8 +298,8 @@
 import com.cloud.vm.VirtualMachine.State;
 import com.cloud.vm.dao.NicDao;
 import com.cloud.vm.dao.UserVmDao;
-import com.cloud.vm.dao.VMInstanceDetailsDao;
 import com.cloud.vm.dao.VMInstanceDao;
+import com.cloud.vm.dao.VMInstanceDetailsDao;
 import com.cloud.vm.snapshot.VMSnapshotManager;
 import com.cloud.vm.snapshot.VMSnapshotVO;
 import com.cloud.vm.snapshot.dao.VMSnapshotDao;
@@ -2014,31 +2015,43 @@ public boolean unmanage(String vmUuid) {
             throw new ConcurrentOperationException(msg);
         }
 
-        Boolean result = Transaction.execute(new TransactionCallback<Boolean>() {
-            @Override
-            public Boolean doInTransaction(TransactionStatus status) {
+        boolean isCmdAnswerSuccess = true;
+        // define domain for kvm host
+        if (HypervisorType.KVM.equals(vm.getHypervisorType())) {
+            final UnmanageInstanceCommand unmanageInstanceCommand = new UnmanageInstanceCommand(getVmTO(vm.getId()), false);
+            try {
+                Answer answer = _agentMgr.send(vm.getHostId(), unmanageInstanceCommand);
+                isCmdAnswerSuccess = (answer instanceof UnmanageInstanceAnswer && answer.getResult());
+            } catch (Exception ex) {
+                isCmdAnswerSuccess = false;
+            }
+        }
 
-                logger.debug("Unmanaging VM {}", vm);
+        if (isCmdAnswerSuccess) {
+            logger.debug("Unmanaging VM {}", vm);
+            Boolean result = Transaction.execute(new TransactionCallback<Boolean>() {
+                @Override
+                public Boolean doInTransaction(TransactionStatus status) {
+                    final VirtualMachineProfile profile = new VirtualMachineProfileImpl(vm);
+                    final VirtualMachineGuru guru = getVmGuru(vm);
 
-                final VirtualMachineProfile profile = new VirtualMachineProfileImpl(vm);
-                final VirtualMachineGuru guru = getVmGuru(vm);
+                    try {
+                        unmanageVMSnapshots(vm);
+                        unmanageVMNics(profile, vm);
+                        unmanageVMVolumes(vm);
 
-                try {
-                    unmanageVMSnapshots(vm);
-                    unmanageVMNics(profile, vm);
-                    unmanageVMVolumes(vm);
+                        guru.finalizeUnmanage(vm);
+                    } catch (Exception e) {
+                        logger.error("Error while unmanaging VM {}", vm, e);
+                        return false;
+                    }
 
-                    guru.finalizeUnmanage(vm);
-                } catch (Exception e) {
-                    logger.error("Error while unmanaging VM {}", vm, e);
-                    return false;
+                    return true;
                 }
-
-                return true;
-            }
-        });
-
-        return BooleanUtils.isTrue(result);
+            });
+            return BooleanUtils.isTrue(result);
+        }
+        return false;
     }
 
     /**

plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java

@@ -2205,6 +2205,14 @@ public String startVM(final Connect conn, final String vmName, final String doma
         return null;
     }
 
+    public void defineVMDomain(final Connect conn, final String domainXML) throws LibvirtException {
+        try {
+            conn.domainDefineXML(domainXML);
+        } catch (final LibvirtException ex) {
+            throw ex;
+        }
+    }
+
     @Override
     public boolean stop() {
         try {

plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtUnmanageInstanceCommandWrapper.java

@@ -0,0 +1,87 @@
+//
+// 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.hypervisor.kvm.resource.wrapper;
+
+import org.libvirt.Connect;
+import org.libvirt.LibvirtException;
+
+import com.cloud.agent.api.Answer;
+import com.cloud.agent.api.UnmanageInstanceAnswer;
+import com.cloud.agent.api.UnmanageInstanceCommand;
+import com.cloud.agent.api.to.NicTO;
+import com.cloud.agent.api.to.VirtualMachineTO;
+import com.cloud.hypervisor.kvm.resource.LibvirtComputingResource;
+import com.cloud.hypervisor.kvm.resource.LibvirtKvmAgentHook;
+import com.cloud.hypervisor.kvm.resource.LibvirtVMDef;
+import com.cloud.resource.CommandWrapper;
+import com.cloud.resource.ResourceWrapper;
+import com.cloud.vm.VirtualMachine;
+
+@ResourceWrapper(handles =  UnmanageInstanceCommand.class)
+public final class LibvirtUnmanageInstanceCommandWrapper extends CommandWrapper<UnmanageInstanceCommand, Answer, LibvirtComputingResource> {
+
+
+    @Override
+    public Answer execute(final UnmanageInstanceCommand command, final LibvirtComputingResource libvirtComputingResource) {
+        final VirtualMachineTO vmSpec = command.getVirtualMachine();
+        LibvirtVMDef vm = null;
+        final LibvirtUtilitiesHelper libvirtUtilitiesHelper = libvirtComputingResource.getLibvirtUtilitiesHelper();
+        Connect conn = null;
+        try {
+
+            vm = libvirtComputingResource.createVMFromSpec(vmSpec);
+            conn = libvirtUtilitiesHelper.getConnectionByType(vm.getHvsType());
+
+            final NicTO[] nics = vmSpec.getNics();
+
+            for (final NicTO nic : nics) {
+                if (vmSpec.getType() != VirtualMachine.Type.User) {
+                    nic.setPxeDisable(true);
+                }
+            }
+
+            String vmInitialSpecification = vm.toString();
+            String vmFinalSpecification = performXmlTransformHook(vmInitialSpecification, libvirtComputingResource);
+            libvirtComputingResource.defineVMDomain(conn, vmFinalSpecification);
+
+            return new UnmanageInstanceAnswer(command, true, "Successfully unmanaged");
+        } catch (final LibvirtException ex) {
+            logger.warn("LibvirtException ", ex);
+            return new UnmanageInstanceAnswer(command, false, ex.getMessage());
+        }
+    }
+
+    private String performXmlTransformHook(String vmInitialSpecification, final LibvirtComputingResource libvirtComputingResource) {
+        String vmFinalSpecification;
+        try {
+            // if transformer fails, everything must go as it's just skipped.
+            LibvirtKvmAgentHook t = libvirtComputingResource.getTransformer();
+            vmFinalSpecification = (String) t.handle(vmInitialSpecification);
+            if (null == vmFinalSpecification) {
+                logger.warn("Libvirt XML transformer returned NULL, will use XML specification unchanged.");
+                vmFinalSpecification = vmInitialSpecification;
+            }
+        } catch(Exception e) {
+            logger.warn("Exception occurred when handling LibVirt XML transformer hook: {}", e);
+            vmFinalSpecification = vmInitialSpecification;
+        }
+        return vmFinalSpecification;
+    }
+}