Allow additional VM config on KVM

Author: Dingane Hlaluku

api/src/main/java/com/cloud/agent/api/to/VirtualMachineTO.java

@@ -72,6 +72,18 @@ public class VirtualMachineTO {
 
     Double cpuQuotaPercentage = null;
 
+    boolean enableExtraConfig = false;
+
+    public boolean isExtraConfigEnabled() {
+        return enableExtraConfig;
+    }
+
+    public String getExtraConfig() {
+        return extraConfig;
+    }
+
+    String extraConfig = null;
+
     Map<String, String> guestOsDetails = new HashMap<String, String>();
 
     public VirtualMachineTO(long id, String instanceName, VirtualMachine.Type type, int cpus, Integer speed, long minRam, long maxRam, BootloaderType bootloader,
@@ -350,4 +362,12 @@ public Double getCpuQuotaPercentage() {
     public void setCpuQuotaPercentage(Double cpuQuotaPercentage) {
         this.cpuQuotaPercentage = cpuQuotaPercentage;
     }
+
+    public void setEnableExtraConfig(boolean enableExtraConfig) {
+        this.enableExtraConfig = enableExtraConfig;
+    }
+
+    public void setExtraConfig(String extraConfig) {
+        this.extraConfig = extraConfig;
+    }
 }

api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java

@@ -200,7 +200,7 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
             " an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter")
     private Map dataDiskTemplateToDiskOfferingList;
 
-    @Parameter(name = ApiConstants.EXTRA_CONFIG, type = CommandType.STRING, since = "4.12", description = "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", authorized = { RoleType.Admin })
+    @Parameter(name = ApiConstants.EXTRA_CONFIG, type = CommandType.STRING, since = "4.12", description = "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", authorized = { RoleType.Admin }, length = 5120)
     private String extraConfig;
 
     /////////////////////////////////////////////////////
@@ -485,6 +485,10 @@ public Map<Long, DiskOffering> getDataDiskTemplateToDiskOfferingMap() {
         return dataDiskTemplateToDiskOfferingMap;
     }
 
+    public String getExtraConfig() {
+        return extraConfig;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

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

@@ -17,7 +17,9 @@
 
 package com.cloud.vm;
 
+import java.io.UnsupportedEncodingException;
 import java.net.URI;
+import java.net.URLDecoder;
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
 import java.sql.SQLException;
@@ -1104,6 +1106,19 @@ public void orchestrateStart(final String vmUuid, final Map<VirtualMachineProfil
 
                     final VirtualMachineTO vmTO = hvGuru.implement(vmProfile);
 
+                    UserVmDetailVO detailVO = _uservmDetailsDao.findDetail(vm.getId(), "extraConfig");
+
+                    if (detailVO != null) {
+                        vmTO.setEnableExtraConfig(true);
+                        String decodeURL;
+                        try {
+                            decodeURL = URLDecoder.decode(detailVO.getValue(), "UTF-8");
+                        } catch (UnsupportedEncodingException e) {
+                            throw new CloudRuntimeException("Failed to decode provided URL string");
+                        }
+                        vmTO.setExtraConfig(decodeURL);
+                    }
+
                     handlePath(vmTO.getDisks(), vm.getHypervisorType());
 
                     cmds = new Commands(Command.OnError.Stop);

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

@@ -47,6 +47,7 @@
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
 
+import com.cloud.hypervisor.kvm.resource.LibvirtVMDef.GenericXML;
 import com.cloud.resource.RequestWrapper;
 import org.apache.cloudstack.storage.to.PrimaryDataStoreTO;
 import org.apache.cloudstack.storage.to.VolumeObjectTO;
@@ -2186,6 +2187,10 @@ So if getMinSpeed() returns null we fall back to getSpeed().
 
         vm.addComp(devices);
 
+        GenericXML genericXML = new GenericXML();
+        genericXML.setExtraConfig(vmTO.getExtraConfig());
+        vm.addComp(genericXML);
+
         return vm;
     }
 

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

@@ -1834,4 +1834,17 @@ public String toString() {
         vmBuilder.append("</domain>\n");
         return vmBuilder.toString();
     }
+
+    public static class GenericXML {
+        private String extraConfig;
+
+        public void setExtraConfig(String extraConfig) {
+            this.extraConfig = extraConfig;
+        }
+
+        @Override
+        public String toString() {
+            return extraConfig;
+        }
+    }
 }

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

@@ -39,6 +39,7 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
+import com.google.common.base.Strings;
 import org.apache.cloudstack.acl.ControlledEntity.ACLType;
 import org.apache.cloudstack.acl.SecurityChecker.AccessType;
 import org.apache.cloudstack.affinity.AffinityGroupService;
@@ -515,6 +516,8 @@ public class UserVmManagerImpl extends ManagerBase implements UserVmManager, Vir
     private static final ConfigKey<Boolean> AllowDeployVmIfGivenHostFails = new ConfigKey<Boolean>("Advanced", Boolean.class, "allow.deploy.vm.if.deploy.on.given.host.fails", "false",
             "allow vm to deploy on different host if vm fails to deploy on the given host ", true);
 
+    private static final ConfigKey<Boolean> EnableAdditionalVmConfig = new ConfigKey<>("Advanced", Boolean.class, "enable.additional.vm.configuration", "false", "allow additional arbitrary configuration to vm", true);
+
 
     @Override
     public UserVmVO getVirtualMachine(long vmId) {
@@ -4852,6 +4855,14 @@ public UserVm createVirtualMachine(DeployVMCmd cmd) throws InsufficientCapacityE
                 _tmplService.attachIso(tmpl.getId(), vm.getId());
             }
         }
+
+        // Add extraConfig to user_vm_details table
+        if (EnableAdditionalVmConfig.value()) {
+            String extraConfig = cmd.getExtraConfig();
+            if (!Strings.isNullOrEmpty(extraConfig)) {
+                _uservmDetailsDao.addDetail(vm.getId(), "extraConfig", extraConfig, true);
+            }
+        }
         return vm;
     }
 
@@ -6399,7 +6410,7 @@ public String getConfigComponentName() {
     @Override
     public ConfigKey<?>[] getConfigKeys() {
         return new ConfigKey<?>[] {EnableDynamicallyScaleVm, AllowUserExpungeRecoverVm, VmIpFetchWaitInterval, VmIpFetchTrialMax, VmIpFetchThreadPoolMax,
-            VmIpFetchTaskWorkers, AllowDeployVmIfGivenHostFails};
+            VmIpFetchTaskWorkers, AllowDeployVmIfGivenHostFails, EnableAdditionalVmConfig};
     }
 
     @Override