Merge remote-tracking branch 'upstream/main' into instance-from-backup

Author: abh1sar

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

@@ -1321,6 +1321,10 @@ public class ApiConstants {
             "however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not " +
             "added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.";
 
+    public static final String PARAMETER_DESCRIPTION_MAX_BACKUPS = "The maximum number of backups to keep for a VM. " +
+            "If \"0\", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. " +
+            "This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.";
+
     public static final String VMWARE_DC = "vmwaredc";
 
     public static final String CSS = "css";

api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListCapacityCmd.java

@@ -132,13 +132,12 @@ public void execute() {
         Collections.sort(capacityResponses, new Comparator<CapacityResponse>() {
             public int compare(CapacityResponse resp1, CapacityResponse resp2) {
                 int res = resp1.getZoneName().compareTo(resp2.getZoneName());
+                // Group by zone
                 if (res != 0) {
                     return res;
-                } else if (getSortBy() != null) {
-                    return 0;
-                } else {
-                    return resp1.getCapacityType().compareTo(resp2.getCapacityType());
                 }
+                // Sort by capacity type only if not already sorted by usage
+                return (getSortBy() != null) ? 0 : resp1.getCapacityType().compareTo(resp2.getCapacityType());
             }
         });
 

api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupCmd.java

@@ -19,7 +19,6 @@
 
 import javax.inject.Inject;
 
-import com.cloud.storage.Snapshot;
 import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiCommandResourceType;
@@ -28,7 +27,6 @@
 import org.apache.cloudstack.api.BaseAsyncCreateCmd;
 import org.apache.cloudstack.api.Parameter;
 import org.apache.cloudstack.api.ServerApiException;
-import org.apache.cloudstack.api.response.BackupScheduleResponse;
 import org.apache.cloudstack.api.response.SuccessResponse;
 import org.apache.cloudstack.api.response.UserVmResponse;
 import org.apache.cloudstack.backup.BackupManager;
@@ -74,13 +72,6 @@ public class CreateBackupCmd extends BaseAsyncCreateCmd {
             since = "4.21.0")
     private String description;
 
-    @Parameter(name = ApiConstants.SCHEDULE_ID,
-            type = CommandType.LONG,
-            entityType = BackupScheduleResponse.class,
-            description = "backup schedule ID of the VM, if this is null, it indicates that it is a manual backup.",
-            since = "4.21.0")
-    private Long scheduleId;
-
     @Parameter(name = ApiConstants.QUIESCE_VM,
             type = CommandType.BOOLEAN,
             required = false,
@@ -106,14 +97,6 @@ public String getDescription() {
         return description;
     }
 
-    public Long getScheduleId() {
-        if (scheduleId != null) {
-            return scheduleId;
-        } else {
-            return Snapshot.MANUAL_POLICY_ID;
-        }
-    }
-
     public Boolean getQuiesceVM() {
         return quiesceVM;
     }
@@ -125,7 +108,7 @@ public Boolean getQuiesceVM() {
     @Override
     public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, NetworkRuleConflictException {
         try {
-            boolean result = backupManager.createBackup(this);
+            boolean result = backupManager.createBackup(this, getJob());
             if (result) {
                 SuccessResponse response = new SuccessResponse(getCommandName());
                 response.setResponseName(getCommandName());

api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupScheduleCmd.java

@@ -75,10 +75,8 @@ public class CreateBackupScheduleCmd extends BaseCmd {
             description = "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.")
     private String timezone;
 
-    @Parameter(name = ApiConstants.MAX_BACKUPS,
-            type = CommandType.INTEGER,
-            description = "maximum number of backups to retain",
-            since = "4.21.0")
+    @Parameter(name = ApiConstants.MAX_BACKUPS, type = CommandType.INTEGER,
+            since = "4.21.0", description = ApiConstants.PARAMETER_DESCRIPTION_MAX_BACKUPS)
     private Integer maxBackups;
 
     @Parameter(name = ApiConstants.QUIESCE_VM,

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

@@ -116,7 +116,7 @@ public class BackupResponse extends BaseResponse {
     private Map<String, String> vmDetails;
 
     @SerializedName(ApiConstants.INTERVAL_TYPE)
-    @Param(description = "the interval type of the backup schedule", since = "4.21.0")
+    @Param(description = "Interval type of the backup", since = "4.21.0")
     private String intervalType;
 
     @SerializedName(ApiConstants.BACKUP_VM_OFFERING_REMOVED)

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

@@ -34,28 +34,6 @@ enum Status {
         Allocated, Queued, BackingUp, BackedUp, Error, Failed, Restoring, Removed, Expunged
     }
 
-    public enum Type {
-        MANUAL, HOURLY, DAILY, WEEKLY, MONTHLY;
-        private int max = 8;
-
-        public void setMax(int max) {
-            this.max = max;
-        }
-
-        public int getMax() {
-            return max;
-        }
-
-        @Override
-        public String toString() {
-            return this.name();
-        }
-
-        public boolean equals(String snapshotType) {
-            return this.toString().equalsIgnoreCase(snapshotType);
-        }
-    }
-
     class Metric {
         private Long backupSize = 0L;
         private Long dataSize = 0L;
@@ -216,9 +194,9 @@ public String toString() {
     void setName(String name);
     String getDescription();
     void setDescription(String description);
-    Short getBackupIntervalType();
     List<VolumeInfo> getBackedUpVolumes();
     long getZoneId();
     Map<String, String> getDetails();
     String getDetail(String name);
+    Long getBackupScheduleId();
 }

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

@@ -67,38 +67,6 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
             "false",
             "Enable volume attach/detach operations for VMs that are assigned to Backup Offerings.", true);
 
-    ConfigKey<Integer> BackupHourlyMax = new ConfigKey<Integer>("Advanced", Integer.class,
-            "backup.max.hourly",
-            "8",
-            "Maximum recurring hourly backups to be retained for an instance. If the limit is reached, early backups from the start of the hour are deleted so that newer ones can be saved. This limit does not apply to manual backups. If set to 0, recurring hourly backups can not be scheduled.",
-            false,
-            ConfigKey.Scope.Global,
-            null);
-
-    ConfigKey<Integer> BackupDailyMax = new ConfigKey<Integer>("Advanced", Integer.class,
-            "backup.max.daily",
-            "8",
-            "Maximum recurring daily backups to be retained for an instance. If the limit is reached, backups from the start of the day are deleted so that newer ones can be saved. This limit does not apply to manual backups. If set to 0, recurring daily backups can not be scheduled.",
-            false,
-            ConfigKey.Scope.Global,
-            null);
-
-    ConfigKey<Integer> BackupWeeklyMax = new ConfigKey<Integer>("Advanced", Integer.class,
-            "backup.max.weekly",
-            "8",
-            "Maximum recurring weekly backups to be retained for an instance. If the limit is reached, backups from the beginning of the week are deleted so that newer ones can be saved. This limit does not apply to manual backups. If set to 0, recurring weekly backups can not be scheduled.",
-            false,
-            ConfigKey.Scope.Global,
-            null);
-
-    ConfigKey<Integer> BackupMonthlyMax = new ConfigKey<Integer>("Advanced", Integer.class,
-            "backup.max.monthly",
-            "8",
-            "Maximum recurring monthly backups to be retained for an instance. If the limit is reached, backups from the beginning of the month are deleted so that newer ones can be saved. This limit does not apply to manual backups. If set to 0, recurring monthly backups can not be scheduled.",
-            false,
-             ConfigKey.Scope.Global,
-            null);
-
     ConfigKey<Long> DefaultMaxAccountBackups = new ConfigKey<Long>("Account Defaults", Long.class,
             "max.account.backups",
             "20",
@@ -217,11 +185,11 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
 
     /**
      * Creates backup of a VM
-     *
-     * @param cmd
+     * @param cmd CreateBackupCmd
+     * @param job The async job associated with the backup retention
      * @return returns operation success
      */
-    boolean createBackup(CreateBackupCmd cmd) throws ResourceAllocationException;
+    boolean createBackup(CreateBackupCmd cmd, Object job) throws ResourceAllocationException;
 
     /**
      * List existing backups for a VM

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

@@ -30,7 +30,7 @@ public interface BackupSchedule extends InternalIdentity {
     String getTimezone();
     Date getScheduledTimestamp();
     Long getAsyncJobId();
-    Integer getMaxBackups();
     Boolean getQuiesceVM();
+    int getMaxBackups();
     String getUuid();
 }

engine/schema/src/main/java/org/apache/cloudstack/backup/BackupScheduleVO.java

@@ -63,15 +63,15 @@ public class BackupScheduleVO implements BackupSchedule {
     Long asyncJobId;
 
     @Column(name = "max_backups")
-    Integer maxBackups = 0;
+    private int maxBackups = 0;
 
     @Column(name = "quiescevm")
     Boolean quiesceVM = false;
 
     public BackupScheduleVO() {
     }
 
-    public BackupScheduleVO(Long vmId, DateUtil.IntervalType scheduleType, String schedule, String timezone, Date scheduledTimestamp, Integer maxBackups, Boolean quiesceVM) {
+    public BackupScheduleVO(Long vmId, DateUtil.IntervalType scheduleType, String schedule, String timezone, Date scheduledTimestamp, int maxBackups, Boolean quiesceVM) {
         this.vmId = vmId;
         this.scheduleType = (short) scheduleType.ordinal();
         this.schedule = schedule;
@@ -146,11 +146,11 @@ public void setAsyncJobId(Long asyncJobId) {
         this.asyncJobId = asyncJobId;
     }
 
-    public Integer getMaxBackups() {
+    public int getMaxBackups() {
         return maxBackups;
     }
 
-    public void setMaxBackups(Integer maxBackups) {
+    public void setMaxBackups(int maxBackups) {
         this.maxBackups = maxBackups;
     }
 

engine/schema/src/main/java/org/apache/cloudstack/backup/BackupVO.java

@@ -97,12 +97,12 @@ public class BackupVO implements Backup {
     @Column(name = "zone_id")
     private long zoneId;
 
-    @Column(name = "backup_interval_type")
-    private Short backupIntervalType;
-
     @Column(name = "backed_volumes", length = 65535)
     protected String backedUpVolumes;
 
+    @Column(name = "backup_schedule_id")
+    private Long backupScheduleId;
+
     @Transient
     Map<String, String> details;
 
@@ -223,15 +223,6 @@ public void setZoneId(long zoneId) {
         this.zoneId = zoneId;
     }
 
-    @Override
-    public Short getBackupIntervalType() {
-        return backupIntervalType;
-    }
-
-    public void setBackupIntervalType(short backupIntervalType) {
-        this.backupIntervalType = backupIntervalType;
-    }
-
     @Override
     public Class<?> getEntityType() {
         return Backup.class;
@@ -288,4 +279,13 @@ public Date getRemoved() {
     public void setRemoved(Date removed) {
         this.removed = removed;
     }
+
+    @Override
+    public Long getBackupScheduleId() {
+        return backupScheduleId;
+    }
+
+    public void setBackupScheduleId(Long backupScheduleId) {
+        this.backupScheduleId = backupScheduleId;
+    }
 }