Merge branch '4.22' into 4.22-vr-fix-haproxy-check-with-ssl-offloading

Author: weizhouapache

api/src/main/java/com/cloud/host/Host.java

@@ -59,6 +59,9 @@ public static String[] toStrings(Host.Type... types) {
     String HOST_INSTANCE_CONVERSION = "host.instance.conversion";
     String HOST_OVFTOOL_VERSION = "host.ovftool.version";
     String HOST_VIRTV2V_VERSION = "host.virtv2v.version";
+    String HOST_SSH_PORT = "host.ssh.port";
+
+    int DEFAULT_SSH_PORT = 22;
 
     /**
      * @return name of the machine.

api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoCmd.java

@@ -153,8 +153,8 @@ public Map getDetails() {
         return (Map) (paramsCollection.toArray())[0];
     }
 
-    public boolean isCleanupDetails(){
-        return cleanupDetails == null ? false : cleanupDetails.booleanValue();
+    public boolean isCleanupDetails() {
+        return cleanupDetails != null && cleanupDetails;
     }
 
     public CPU.CPUArch getCPUArch() {

api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddHostCmd.java

@@ -60,7 +60,8 @@ public class AddHostCmd extends BaseCmd {
     @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, required = true, description = "The Pod ID for the host")
     private Long podId;
 
-    @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "The host URL")
+    @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "The host URL, optionally add ssh port (format: 'host:port') for KVM hosts," +
+            " otherwise falls back to the port defined at the config 'kvm.host.discovery.ssh.port'")
     private String url;
 
     @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "The Zone ID for the host")

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

@@ -188,7 +188,7 @@ public abstract class BaseDeployVMCmd extends BaseAsyncCreateCustomIdCmd impleme
     @Parameter(name = ApiConstants.MAC_ADDRESS, type = CommandType.STRING, description = "the mac address for default vm's network")
     private String macAddress;
 
-    @Parameter(name = ApiConstants.KEYBOARD, type = CommandType.STRING, description = "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us")
+    @Parameter(name = ApiConstants.KEYBOARD, type = CommandType.STRING, description = "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us")
     private String keyboard;
 
     @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Deploy vm for the project")

api/src/main/java/org/apache/cloudstack/api/response/UserVmResponse.java

@@ -340,6 +340,10 @@ public class UserVmResponse extends BaseResponseWithTagInformation implements Co
     @Param(description = "List of read-only Instance details as comma separated string.", since = "4.16.0")
     private String readOnlyDetails;
 
+    @SerializedName("alloweddetails")
+    @Param(description = "List of allowed Vm details as comma separated string if VM instance settings are read from OVA.", since = "4.22.1")
+    private String allowedDetails;
+
     @SerializedName(ApiConstants.SSH_KEYPAIRS)
     @Param(description = "SSH key-pairs")
     private String keyPairNames;
@@ -1091,6 +1095,10 @@ public void setReadOnlyDetails(String readOnlyDetails) {
         this.readOnlyDetails = readOnlyDetails;
     }
 
+    public void setAllowedDetails(String allowedDetails) {
+        this.allowedDetails = allowedDetails;
+    }
+
     public void setOsTypeId(String osTypeId) {
         this.osTypeId = osTypeId;
     }
@@ -1115,6 +1123,10 @@ public String getReadOnlyDetails() {
         return readOnlyDetails;
     }
 
+    public String getAllowedDetails() {
+        return allowedDetails;
+    }
+
     public Boolean getDynamicallyScalable() {
         return isDynamicallyScalable;
     }

api/src/main/java/org/apache/cloudstack/backup/BackupManager.java

@@ -32,6 +32,7 @@
 import org.apache.cloudstack.api.command.user.backup.ListBackupsCmd;
 import org.apache.cloudstack.api.response.BackupResponse;
 import org.apache.cloudstack.framework.config.ConfigKey;
+import org.apache.cloudstack.framework.config.ValidatedConfigKey;
 import org.apache.cloudstack.framework.config.Configurable;
 
 import com.cloud.exception.ResourceUnavailableException;
@@ -53,10 +54,11 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
             "false",
             "Is backup and recovery framework enabled.", false, ConfigKey.Scope.Zone);
 
-    ConfigKey<String> BackupProviderPlugin = new ConfigKey<>("Advanced", String.class,
+    ConfigKey<String> BackupProviderPlugin = new ValidatedConfigKey<>("Advanced", String.class,
             "backup.framework.provider.plugin",
             "dummy",
-            "The backup and recovery provider plugin. Valid plugin values: dummy, veeam, networker and nas", true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key());
+            "The backup and recovery provider plugin. Valid plugin values: dummy, veeam, networker and nas",
+            true, ConfigKey.Scope.Zone, BackupFrameworkEnabled.key(), value -> validateBackupProviderConfig((String)value));
 
     ConfigKey<Long> BackupSyncPollingInterval = new ConfigKey<>("Advanced", Long.class,
             "backup.framework.sync.interval",
@@ -247,4 +249,14 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
     Capacity getBackupStorageUsedStats(Long zoneId);
 
     void checkAndRemoveBackupOfferingBeforeExpunge(VirtualMachine vm);
+
+    static void validateBackupProviderConfig(String value) {
+        if (value != null && (value.contains(",") || value.trim().contains(" "))) {
+            throw new IllegalArgumentException("Multiple backup provider plugins are not supported. Please provide a single plugin value.");
+        }
+        List<String> validPlugins = List.of("dummy", "veeam", "networker", "nas");
+        if (value != null && !validPlugins.contains(value)) {
+            throw new IllegalArgumentException("Invalid backup provider plugin: " + value + ". Valid plugin values are: " + String.join(", ", validPlugins));
+        }
+    }
 }

core/src/main/java/org/apache/cloudstack/backup/RestoreBackupCommand.java

@@ -34,9 +34,9 @@ public class RestoreBackupCommand extends Command  {
     private List<String> backupVolumesUUIDs;
     private List<PrimaryDataStoreTO> restoreVolumePools;
     private List<String> restoreVolumePaths;
+    private List<String> backupFiles;
     private String diskType;
     private Boolean vmExists;
-    private String restoreVolumeUUID;
     private VirtualMachine.State vmState;
     private Integer mountTimeout;
 
@@ -92,6 +92,14 @@ public void setRestoreVolumePaths(List<String> restoreVolumePaths) {
         this.restoreVolumePaths = restoreVolumePaths;
     }
 
+    public List<String> getBackupFiles() {
+        return backupFiles;
+    }
+
+    public void setBackupFiles(List<String> backupFiles) {
+        this.backupFiles = backupFiles;
+    }
+
     public Boolean isVmExists() {
         return vmExists;
     }
@@ -116,14 +124,6 @@ public void setMountOptions(String mountOptions) {
         this.mountOptions = mountOptions;
     }
 
-    public String getRestoreVolumeUUID() {
-        return restoreVolumeUUID;
-    }
-
-    public void setRestoreVolumeUUID(String restoreVolumeUUID) {
-        this.restoreVolumeUUID = restoreVolumeUUID;
-    }
-
     public VirtualMachine.State getVmState() {
         return vmState;
     }

engine/components-api/src/main/java/com/cloud/agent/AgentManager.java

@@ -54,6 +54,10 @@ public interface AgentManager {
             "This timeout overrides the wait global config. This holds a comma separated key value pairs containing timeout (in seconds) for specific commands. " +
                     "For example: DhcpEntryCommand=600, SavePasswordCommand=300, VmDataCommand=300", false);
 
+    ConfigKey<Integer> KVMHostDiscoverySshPort = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Integer.class,
+            "kvm.host.discovery.ssh.port", String.valueOf(Host.DEFAULT_SSH_PORT), "SSH port used for KVM host discovery and any other operations on host (using SSH)." +
+                " Please note that this is applicable when port is not defined through host url while adding the KVM host.", true, ConfigKey.Scope.Cluster);
+
     enum TapAgentsAction {
         Add, Del, Contains,
     }
@@ -172,4 +176,6 @@ enum TapAgentsAction {
     void propagateChangeToAgents(Map<String, String> params);
 
     boolean transferDirectAgentsFromMS(String fromMsUuid, long fromMsId, long timeoutDurationInMs, boolean excludeHostsInMaintenance);
+
+    int getHostSshPort(HostVO host);
 }

engine/components-api/src/main/java/com/cloud/resource/ResourceManager.java

@@ -167,6 +167,8 @@ public interface ResourceManager extends ResourceService, Configurable {
 
     public HostVO findHostByGuid(String guid);
 
+    HostVO findHostByGuidPrefix(String guid);
+
     public HostVO findHostByName(String name);
 
     HostStats getHostStatistics(Host host);

engine/orchestration/src/main/java/com/cloud/agent/manager/AgentManagerImpl.java

@@ -42,6 +42,7 @@
 import javax.inject.Inject;
 import javax.naming.ConfigurationException;
 
+import com.cloud.utils.StringUtils;
 import org.apache.cloudstack.agent.lb.IndirectAgentLB;
 import org.apache.cloudstack.ca.CAManager;
 import org.apache.cloudstack.command.ReconcileCommandService;
@@ -64,7 +65,6 @@
 import org.apache.commons.collections.MapUtils;
 import org.apache.commons.lang3.BooleanUtils;
 import org.apache.commons.lang3.ObjectUtils;
-import org.apache.commons.lang3.StringUtils;
 import org.apache.logging.log4j.ThreadContext;
 
 import com.cloud.agent.AgentManager;
@@ -2113,7 +2113,7 @@ public ConfigKey<?>[] getConfigKeys() {
         return new ConfigKey<?>[] { CheckTxnBeforeSending, Workers, Port, Wait, AlertWait, DirectAgentLoadSize,
                 DirectAgentPoolSize, DirectAgentThreadCap, EnableKVMAutoEnableDisable, ReadyCommandWait,
                 GranularWaitTimeForCommands, RemoteAgentSslHandshakeTimeout, RemoteAgentMaxConcurrentNewConnections,
-                RemoteAgentNewConnectionsMonitorInterval };
+                RemoteAgentNewConnectionsMonitorInterval, KVMHostDiscoverySshPort };
     }
 
     protected class SetHostParamsListener implements Listener {
@@ -2236,6 +2236,25 @@ public boolean transferDirectAgentsFromMS(String fromMsUuid, long fromMsId, long
         return true;
     }
 
+    @Override
+    public int getHostSshPort(HostVO host) {
+        if (host == null) {
+            return KVMHostDiscoverySshPort.value();
+        }
+
+        if (host.getHypervisorType() != HypervisorType.KVM) {
+            return Host.DEFAULT_SSH_PORT;
+        }
+
+        _hostDao.loadDetails(host);
+        String hostPort = host.getDetail(Host.HOST_SSH_PORT);
+        if (StringUtils.isBlank(hostPort)) {
+            return KVMHostDiscoverySshPort.valueIn(host.getClusterId());
+        }
+
+        return Integer.parseInt(hostPort);
+    }
+
     private GlobalLock getHostJoinLock(Long hostId) {
         return GlobalLock.getInternLock(String.format("%s-%s", "Host-Join", hostId));
     }