Merge branch 'isolated-backups' into '4.20.0.0-scclouds'

_Backups_ isolados

Closes #3046

See merge request scclouds/scclouds!1302

Author: Fabrício Duarte

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

@@ -560,6 +560,7 @@ public class ApiConstants {
     public static final String VLAN_RANGE = "vlanrange";
     public static final String REMOVE_VLAN = "removevlan";
     public static final String VLAN_ID = "vlanid";
+    public static final String ISOLATED = "isolated";
     public static final String ISOLATED_PVLAN = "isolatedpvlan";
     public static final String ISOLATED_PVLAN_TYPE = "isolatedpvlantype";
     public static final String ISOLATION_URI = "isolationuri";
@@ -1255,6 +1256,10 @@ public class ApiConstants {
             "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, KNIB, NAS and EMC Networker backup provider.";
 
+    public static final String PARAMETER_DESCRIPTION_ISOLATED_BACKUPS = "Whether the backup will be isolated, defaults to false. " +
+            "Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain " +
+            "and no backup chain will depend on them. Currently only supported for the KNIB provider.";
+
     public static final String CSS = "css";
 
     public static final String JSON_CONFIGURATION = "jsonconfiguration";

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

@@ -67,6 +67,12 @@ public class CreateBackupCmd extends BaseAsyncCreateCmd {
             description = "Whether the VM's file systems should be frozen for the backup. Currently only supported for KNIB")
     private boolean quiesceVm;
 
+    @Parameter(name = ApiConstants.ISOLATED,
+            type = CommandType.BOOLEAN,
+            description = ApiConstants.PARAMETER_DESCRIPTION_ISOLATED_BACKUPS,
+            since = "4.20.0.6-scclouds")
+    private boolean isolated;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -86,7 +92,7 @@ public boolean isQuiesceVm() {
     @Override
     public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, NetworkRuleConflictException {
         try {
-            boolean result = backupManager.createBackup(getVmId(), quiesceVm, getJob());
+            boolean result = backupManager.createBackup(getVmId(), quiesceVm, isolated, getJob());
             if (result) {
                 SuccessResponse response = new SuccessResponse(getCommandName());
                 response.setResponseName(getCommandName());

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

@@ -84,6 +84,12 @@ public class CreateBackupScheduleCmd extends BaseCmd {
             description = ApiConstants.PARAMETER_DESCRIPTION_MAX_BACKUPS, since = "4.20.0.4-scclouds")
     private Integer maxBackups;
 
+    @Parameter(name = ApiConstants.ISOLATED,
+            type = CommandType.BOOLEAN,
+            description = ApiConstants.PARAMETER_DESCRIPTION_ISOLATED_BACKUPS,
+            since = "4.20.0.6-scclouds")
+    private boolean isolated;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -112,6 +118,10 @@ public Integer getMaxBackups() {
         return maxBackups;
     }
 
+    public boolean isIsolated() {
+        return isolated;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

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

@@ -60,6 +60,10 @@ public class BackupScheduleResponse extends BaseResponse {
     @Param(description = ApiConstants.PARAMETER_DESCRIPTION_MAX_BACKUPS)
     private int maxBackups;
 
+    @SerializedName(ApiConstants.ISOLATED)
+    @Param(description = ApiConstants.PARAMETER_DESCRIPTION_ISOLATED_BACKUPS)
+    private boolean isolated;
+
     public void setId(String id) {
         this.id = id;
     }
@@ -111,4 +115,8 @@ public void setQuiesceVm(boolean quiesceVm) {
     public void setMaxBackups(int maxBackups) {
         this.maxBackups = maxBackups;
     }
+
+    public void setIsolated(boolean isolated) {
+        this.isolated = isolated;
+    }
 }

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

@@ -125,10 +125,11 @@ public interface BackupManager extends BackupService, Configurable, PluggableSer
      *
      * @param vmId Virtual Machine ID
      * @param quiesceVm
+     * @param isolated Whether the backup will be isolated or not
      * @param job The async job associated with the backup creation
      * @return returns operation success
      */
-    boolean createBackup(final Long vmId, boolean quiesceVm, Object job);
+    boolean createBackup(final Long vmId, boolean quiesceVm, boolean isolated, Object job);
 
     /**
      * List existing backups for a VM

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

@@ -79,10 +79,11 @@ public interface BackupProvider {
      *
      * @param vm VirtualMachine definition
      * @param quiesceVm whether to quiesce the VM or not.
+     * @param isolated whether the backup will be isolated or not.
      * @param backupScheduleId the ID of the backup schedule; should be null if the backup is manual.
      * @return
      */
-    boolean takeBackup(VirtualMachine vm, boolean quiesceVm, Long backupScheduleId);
+    boolean takeBackup(VirtualMachine vm, boolean quiesceVm, boolean isolated, Long backupScheduleId);
 
     /**
      * Delete an existing backup
@@ -122,7 +123,7 @@ Pair<Boolean, String> restoreBackedUpVolume(Backup backup, String volumeUuid, St
      * This method should be overwritten by any backup providers that want to schedule their backup jobs in the same queue as the VM jobs.
      * Otherwise, just use the takeBackup method.
      * */
-    default Boolean orchestrateTakeBackup(Backup backup, boolean quiesceVm) {
+    default Boolean orchestrateTakeBackup(Backup backup, boolean quiesceVm, boolean isolated) {
         return null;
     }
 

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

@@ -33,4 +33,5 @@ public interface BackupSchedule extends InternalIdentity {
     String getUuid();
     boolean isQuiesceVm();
     int getMaxBackups();
+    boolean isIsolated();
 }

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

@@ -40,14 +40,17 @@ public class TakeKnibBackupCommand extends Command {
 
     private List<KnibTO> knibTOs;
 
-    public TakeKnibBackupCommand(boolean quiesceVm, boolean runningVM, boolean endChain, String vmName, String imageStoreUrl, List<String> backupChainImageStoreUrls, List<KnibTO> knibTOs) {
+    private boolean isolated;
+
+    public TakeKnibBackupCommand(boolean quiesceVm, boolean runningVM, boolean endChain, String vmName, String imageStoreUrl, List<String> backupChainImageStoreUrls, List<KnibTO> knibTOs, boolean isolated) {
         this.quiesceVm = quiesceVm;
         this.runningVM = runningVM;
         this.endChain = endChain;
         this.vmName = vmName;
         this.imageStoreUrl = imageStoreUrl;
         this.backupChainImageStoreUrls = backupChainImageStoreUrls;
         this.knibTOs = knibTOs;
+        this.isolated = isolated;
     }
 
     public boolean isQuiesceVm() {
@@ -78,6 +81,10 @@ public List<KnibTO> getKnibTOs() {
         return knibTOs;
     }
 
+    public boolean isIsolated() {
+        return isolated;
+    }
+
     @Override
     public boolean executeInSequence() {
         return false;

engine/components-api/src/main/java/com/cloud/vm/VmWorkTakeBackup.java

@@ -25,11 +25,14 @@ public class VmWorkTakeBackup extends VmWork {
 
     private boolean quiesceVm;
 
-    public VmWorkTakeBackup(long userId, long accountId, long vmId, long backupId, String handlerName, String backupProvider, boolean quiesceVm) {
+    private boolean isolated;
+
+    public VmWorkTakeBackup(long userId, long accountId, long vmId, long backupId, String handlerName, String backupProvider, boolean quiesceVm, boolean isolated) {
         super(userId, accountId, vmId, handlerName);
         this.backupProvider = backupProvider;
         this.quiesceVm = quiesceVm;
         this.backupId = backupId;
+        this.isolated = isolated;
     }
 
     public String getBackupProvider() {
@@ -44,6 +47,10 @@ public long getBackupId() {
         return backupId;
     }
 
+    public boolean isIsolated() {
+        return isolated;
+    }
+
     @Override
     public String toString() {
         return super.toStringAfterRemoveParams(null, null);

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

@@ -67,17 +67,21 @@ public class BackupScheduleVO implements BackupSchedule {
     @Column(name = "quiesce_vm")
     private boolean quiesceVm;
 
+    @Column(name = "isolated")
+    private boolean isolated;
+
     public BackupScheduleVO() {
     }
 
-    public BackupScheduleVO(Long vmId, DateUtil.IntervalType scheduleType, String schedule, String timezone, Date scheduledTimestamp, boolean quiesceVm, int maxBackups) {
+    public BackupScheduleVO(Long vmId, DateUtil.IntervalType scheduleType, String schedule, String timezone, Date scheduledTimestamp, boolean quiesceVm, int maxBackups, boolean isolated) {
         this.vmId = vmId;
         this.scheduleType = (short) scheduleType.ordinal();
         this.schedule = schedule;
         this.timezone = timezone;
         this.scheduledTimestamp = scheduledTimestamp;
         this.quiesceVm = quiesceVm;
         this.maxBackups = maxBackups;
+        this.isolated = isolated;
     }
 
     @Override
@@ -156,4 +160,13 @@ public void setQuiesceVm(boolean quiesceVm) {
     public boolean isQuiesceVm() {
         return quiesceVm;
     }
+
+    @Override
+    public boolean isIsolated() {
+        return isolated;
+    }
+
+    public void setIsolated(boolean isolated) {
+        this.isolated = isolated;
+    }
 }