Instance lease: Allow deployment of instances with lease duration and leaseexpiry action

api/src/main/java/com/cloud/vm/VmDetailConstants.java

@@ -101,4 +101,7 @@ public interface VmDetailConstants {
     String VMWARE_HOST_NAME = String.format("%s-host", VMWARE_TO_KVM_PREFIX);
     String VMWARE_DISK = String.format("%s-disk", VMWARE_TO_KVM_PREFIX);
     String VMWARE_MAC_ADDRESSES = String.format("%s-mac-addresses", VMWARE_TO_KVM_PREFIX);
+
+    String INSTANCE_LEASE_EXPIRY_DATE = "leaseexpirydate";
+    String INSTANCE_LEASE_EXPIRY_ACTION = "leaseexpiryaction";
 }

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

@@ -269,6 +269,7 @@ public class ApiConstants {
     public static final String INTERNAL_DNS2 = "internaldns2";
     public static final String INTERNET_PROTOCOL = "internetprotocol";
     public static final String INTERVAL_TYPE = "intervaltype";
+    public static final String INSTANCE_LEASE_ENABLED = "instanceleaseenabled";
     public static final String LOCATION_TYPE = "locationtype";
     public static final String IOPS_READ_RATE = "iopsreadrate";
     public static final String IOPS_READ_RATE_MAX = "iopsreadratemax";
@@ -520,6 +521,10 @@ public class ApiConstants {
     public static final String USED_SUBNETS = "usedsubnets";
     public static final String USED_IOPS = "usediops";
     public static final String USER_DATA = "userdata";
+    public static final String INSTANCE_LEASE_DURATION = "leaseduration";
+    public static final String INSTANCE_LEASE_EXPIRY_DATE= "leaseexpirydate";
+    public static final String INSTANCE_LEASE_EXPIRY_ACTION = "leaseexpiryaction";
+    public static final String LEASED = "leased";
 
     public static final String USER_DATA_NAME = "userdataname";
     public static final String USER_DATA_ID = "userdataid";

api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java

@@ -251,7 +251,14 @@ public class CreateServiceOfferingCmd extends BaseCmd {
             since="4.20")
     private Boolean purgeResources;
 
+    @Parameter(name = ApiConstants.INSTANCE_LEASE_DURATION, type = CommandType.LONG,
+            description = "Number of days instance is leased for.",
+            since = "4.21.0")
+    private Long leaseDuration;
 
+    @Parameter(name = ApiConstants.INSTANCE_LEASE_EXPIRY_ACTION, type = CommandType.STRING, since = "4.21.0",
+            description = "Lease expiry action, valid values are STOP and DESTROY")
+    private String leaseExpiryAction;
 
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
@@ -487,6 +494,14 @@ public boolean getEncryptRoot() {
         return false;
     }
 
+    public String getLeaseExpiryAction() {
+        return leaseExpiryAction;
+    }
+
+    public Long getLeaseDuration() {
+        return leaseDuration;
+    }
+
     public boolean isPurgeResources() {
         return Boolean.TRUE.equals(purgeResources);
     }

api/src/main/java/org/apache/cloudstack/api/command/user/config/ListCapabilitiesCmd.java

@@ -72,6 +72,7 @@
         response.setInstancesDisksStatsRetentionTime((Integer) capabilities.get(ApiConstants.INSTANCES_DISKS_STATS_RETENTION_TIME));
         response.setSharedFsVmMinCpuCount((Integer)capabilities.get(ApiConstants.SHAREDFSVM_MIN_CPU_COUNT));
         response.setSharedFsVmMinRamSize((Integer)capabilities.get(ApiConstants.SHAREDFSVM_MIN_RAM_SIZE));
+        response.setInstanceLeaseEnabled((Boolean) capabilities.get(ApiConstants.INSTANCE_LEASE_ENABLED));
         response.setObjectName("capability");
         response.setResponseName(getCommandName());
         this.setResponseObject(response);

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

@@ -278,6 +278,14 @@
             description = "Enable packed virtqueues or not.")
     private Boolean nicPackedVirtQueues;
 
+    @Parameter(name = ApiConstants.INSTANCE_LEASE_DURATION, type = CommandType.LONG, since = "4.21.0",
+            description = "Number of days instance is leased for.")
+    private Long leaseDuration;
+
+    @Parameter(name = ApiConstants.INSTANCE_LEASE_EXPIRY_ACTION, type = CommandType.STRING, since = "4.21.0",
+            description = "Lease expiry action, valid values are STOP and DESTROY")
+    private String leaseExpiryAction;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -475,6 +483,14 @@
         return password;
     }
 
+    public Long getLeaseDuration() {
+        return leaseDuration;
+    }
+
+    public String getLeaseExpiryAction() {
+        return leaseExpiryAction;
+    }
+
     public List<Long> getNetworkIds() {
         if (MapUtils.isNotEmpty(vAppNetworks)) {
             if (CollectionUtils.isNotEmpty(networkIds) || ipAddress != null || getIp6Address() != null || MapUtils.isNotEmpty(ipToNetworkList)) {

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

@@ -153,6 +153,11 @@
     @Parameter(name = ApiConstants.USER_DATA_ID, type = CommandType.UUID, entityType = UserDataResponse.class, required = false, description = "the instances by userdata", since = "4.20.1")
     private Long userdataId;
 
+    @Parameter(name = ApiConstants.LEASED, type = CommandType.BOOLEAN,
+            description = "Whether to return only leased instances",
+            since = "4.21.0")
+    private Boolean onlyLeasedInstances = false;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -330,4 +335,8 @@
             vmResponse.setResourceIconResponse(iconResponse);
         }
     }
+
+    public Boolean getOnlyLeasedInstances() {
+        return onlyLeasedInstances;
+    }
 }

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

@@ -154,6 +154,14 @@
                     " autoscaling groups or CKS, delete protection will be ignored.")
     private Boolean deleteProtection;
 
+    @Parameter(name = ApiConstants.INSTANCE_LEASE_DURATION, type = CommandType.LONG, since = "4.21.0",
+            description = "Number of days instance is leased for.")
+    private Long leaseDuration;
+
+    @Parameter(name = ApiConstants.INSTANCE_LEASE_EXPIRY_ACTION, type = CommandType.STRING, since = "4.21.0",
+            description = "Lease expiry action, valid values are STOP and DESTROY")
+    private String leaseExpiryAction;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -324,4 +332,13 @@
     public ApiCommandResourceType getApiResourceType() {
         return ApiCommandResourceType.VirtualMachine;
     }
+
+    public Long getLeaseDuration() {
+        return leaseDuration;
+    }
+
+    public String getLeaseExpiryAction() {
+        return leaseExpiryAction;
+    }
+
 }

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

@@ -136,6 +136,10 @@
     @Param(description = "the min Ram size for the service offering used by the shared filesystem instance", since = "4.20.0")
     private Integer sharedFsVmMinRamSize;
 
+    @SerializedName(ApiConstants.INSTANCE_LEASE_ENABLED)
+    @Param(description = "true if instance lease feature is enabled", since = "4.21.0")
+    private Boolean instanceLeaseEnabled;
+
     public void setSecurityGroupsEnabled(boolean securityGroupsEnabled) {
         this.securityGroupsEnabled = securityGroupsEnabled;
     }
@@ -247,4 +251,8 @@
     public void setSharedFsVmMinRamSize(Integer sharedFsVmMinRamSize) {
         this.sharedFsVmMinRamSize = sharedFsVmMinRamSize;
     }
+
+    public void setInstanceLeaseEnabled(Boolean instanceLeaseEnabled) {
+        this.instanceLeaseEnabled = instanceLeaseEnabled;
+    }
 }

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

@@ -238,6 +238,14 @@
     @Param(description = "Whether to cleanup VM and its associated resource upon expunge", since = "4.20")
     private Boolean purgeResources;
 
+    @SerializedName(ApiConstants.INSTANCE_LEASE_DURATION)
+    @Param(description = "Instance lease duration for service offering", since = "4.21.0")
+    private Long leaseDuration;
+
+    @SerializedName(ApiConstants.INSTANCE_LEASE_EXPIRY_ACTION)
+    @Param(description = "Action to be taken once lease is over", since = "4.21.0")
+    private String leaseExpiryAction;
+
     public ServiceOfferingResponse() {
     }
 
@@ -505,6 +513,22 @@
         this.cacheMode = cacheMode;
     }
 
+    public Long getLeaseDuration() {
+        return leaseDuration;
+    }
+
+    public void setLeaseDuration(Long leaseDuration) {
+        this.leaseDuration = leaseDuration;
+    }
+
+    public String getLeaseExpiryAction() {
+        return leaseExpiryAction;
+    }
+
+    public void setLeaseExpiryAction(String leaseExpiryAction) {
+        this.leaseExpiryAction = leaseExpiryAction;
+    }
+
     public String getVsphereStoragePolicy() {
         return vsphereStoragePolicy;
     }

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

@@ -16,6 +16,18 @@
 // under the License.
 package org.apache.cloudstack.api.response;
 
+import com.cloud.network.router.VirtualRouter;
+import com.cloud.serializer.Param;
+import com.cloud.uservm.UserVm;
+import com.cloud.vm.VirtualMachine;
+import com.google.gson.annotations.SerializedName;
+import org.apache.cloudstack.acl.RoleType;
+import org.apache.cloudstack.affinity.AffinityGroupResponse;
+import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.BaseResponseWithTagInformation;
+import org.apache.cloudstack.api.EntityReference;
+import org.apache.commons.collections.CollectionUtils;
+
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.Date;
@@ -26,19 +38,6 @@
 import java.util.Set;
 import java.util.TreeSet;
 
-import org.apache.cloudstack.acl.RoleType;
-import org.apache.cloudstack.affinity.AffinityGroupResponse;
-import org.apache.cloudstack.api.ApiConstants;
-import org.apache.cloudstack.api.BaseResponseWithTagInformation;
-import org.apache.cloudstack.api.EntityReference;
-
-import com.cloud.network.router.VirtualRouter;
-import com.cloud.serializer.Param;
-import com.cloud.uservm.UserVm;
-import com.cloud.vm.VirtualMachine;
-import com.google.gson.annotations.SerializedName;
-import org.apache.commons.collections.CollectionUtils;
-
 @SuppressWarnings("unused")
 @EntityReference(value = {VirtualMachine.class, UserVm.class, VirtualRouter.class})
 public class UserVmResponse extends BaseResponseWithTagInformation implements ControlledEntityResponse, SetResourceIconResponse {
@@ -392,10 +391,22 @@
     @Param(description = "VNF details", since = "4.19.0")
     private Map<String, String> vnfDetails;
 
-    @SerializedName((ApiConstants.VM_TYPE))
+    @SerializedName(ApiConstants.VM_TYPE)
     @Param(description = "User VM type", since = "4.20.0")
     private String vmType;
 
+    @SerializedName(ApiConstants.INSTANCE_LEASE_DURATION)
+    @Param(description = "Instance lease duration in days", since = "4.21.0")
+    private Long leaseDuration;
+
+    @SerializedName(ApiConstants.INSTANCE_LEASE_EXPIRY_DATE)
+    @Param(description = "Instance lease expiry date", since = "4.21.0")
+    private Date leaseExpiryDate;
+
+    @SerializedName(ApiConstants.INSTANCE_LEASE_EXPIRY_ACTION)
+    @Param(description = "Instance lease expiry action", since = "4.21.0")
+    private String leaseExpiryAction;
+
     public UserVmResponse() {
         securityGroupList = new LinkedHashSet<>();
         nics = new TreeSet<>(Comparator.comparingInt(x -> Integer.parseInt(x.getDeviceId())));
@@ -1169,4 +1180,29 @@
     public void setIpAddress(String ipAddress) {
         this.ipAddress = ipAddress;
     }
+
+    public Long getLeaseDuration() {
+        return leaseDuration;
+    }
+
+    public void setLeaseDuration(Long leaseDuration) {
+        this.leaseDuration = leaseDuration;
+    }
+
+    public String getLeaseExpiryAction() {
+        return leaseExpiryAction;
+    }
+
+    public void setLeaseExpiryAction(String leaseExpiryAction) {
+        this.leaseExpiryAction = leaseExpiryAction;
+    }
+
+    public Date getLeaseExpiryDate() {
+        return leaseExpiryDate;
+    }
+
+    public void setLeaseExpiryDate(Date leaseExpiryDate) {
+        this.leaseExpiryDate = leaseExpiryDate;
+    }
+
 }

api/src/test/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmdTest.java

@@ -55,4 +55,19 @@ public void testIsPurgeResourcesTrue() {
         ReflectionTestUtils.setField(createServiceOfferingCmd, "purgeResources", true);
         Assert.assertTrue(createServiceOfferingCmd.isPurgeResources());
     }
+
+    @Test
+    public void testGetLeaseDuration() {
+        ReflectionTestUtils.setField(createServiceOfferingCmd, "leaseDuration", 10L);
+        Assert.assertEquals(10, createServiceOfferingCmd.getLeaseDuration().longValue());
+    }
+
+    @Test
+    public void testGetLeaseExpiryAction() {
+        ReflectionTestUtils.setField(createServiceOfferingCmd, "leaseExpiryAction", "stop");
+        Assert.assertEquals("stop", createServiceOfferingCmd.getLeaseExpiryAction());
+
+        ReflectionTestUtils.setField(createServiceOfferingCmd, "leaseExpiryAction", "DESTROY");
+        Assert.assertEquals("DESTROY", createServiceOfferingCmd.getLeaseExpiryAction());
+    }
 }

engine/schema/src/main/resources/META-INF/db/views/cloud.service_offering_view.sql

@@ -71,6 +71,8 @@ SELECT
     `service_offering`.`dynamic_scaling_enabled` AS `dynamic_scaling_enabled`,
     `service_offering`.`disk_offering_strictness` AS `disk_offering_strictness`,
     `vsphere_storage_policy`.`value` AS `vsphere_storage_policy`,
+    `lease_duration_details`.`value` AS `lease_duration`,
+    `lease_expiry_action_details`.`value` AS `lease_expiry_action`,
     GROUP_CONCAT(DISTINCT(domain.id)) AS domain_id,
     GROUP_CONCAT(DISTINCT(domain.uuid)) AS domain_uuid,
     GROUP_CONCAT(DISTINCT(domain.name)) AS domain_name,
@@ -109,5 +111,11 @@ FROM
         LEFT JOIN
     `cloud`.`service_offering_details` AS `vsphere_storage_policy` ON `vsphere_storage_policy`.`service_offering_id` = `service_offering`.`id`
         AND `vsphere_storage_policy`.`name` = 'storagepolicy'
+        LEFT JOIN
+    `cloud`.`service_offering_details` AS `lease_duration_details` ON `lease_duration_details`.`service_offering_id` = `service_offering`.`id`
+        AND `lease_duration_details`.`name` = 'leaseduration'
+        LEFT JOIN
+    `cloud`.`service_offering_details` AS `lease_expiry_action_details` ON `lease_expiry_action_details`.`service_offering_id` = `service_offering`.`id`
+        AND `lease_expiry_action_details`.`name` = 'leaseexpiryaction'
 GROUP BY
     `service_offering`.`id`;

engine/schema/src/main/resources/META-INF/db/views/cloud.user_vm_view.sql

@@ -168,7 +168,9 @@ SELECT
     `user_data`.`uuid` AS `user_data_uuid`,
     `user_data`.`name` AS `user_data_name`,
     `user_vm`.`user_data_details` AS `user_data_details`,
-    `vm_template`.`user_data_link_policy` AS `user_data_policy`
+    `vm_template`.`user_data_link_policy` AS `user_data_policy`,
+    `lease_expiry_date`.`value` AS `lease_expiry_date`,
+    `lease_expiry_action`.`value` AS `lease_expiry_action`
 FROM
     (((((((((((((((((((((((((((((((((((`user_vm`
         JOIN `vm_instance` ON (((`vm_instance`.`id` = `user_vm`.`id`)
@@ -215,4 +217,8 @@ FROM
         LEFT JOIN `user_vm_details` `custom_speed` ON (((`custom_speed`.`vm_id` = `vm_instance`.`id`)
         AND (`custom_speed`.`name` = 'CpuSpeed'))))
         LEFT JOIN `user_vm_details` `custom_ram_size` ON (((`custom_ram_size`.`vm_id` = `vm_instance`.`id`)
-        AND (`custom_ram_size`.`name` = 'memory'))));
+        AND (`custom_ram_size`.`name` = 'memory')))
+        LEFT JOIN `user_vm_details` `lease_expiry_date` ON ((`lease_expiry_date`.`vm_id` = `vm_instance`.`id`)
+        AND (`lease_expiry_date`.`name` = 'leaseexpirydate'))
+        LEFT JOIN `user_vm_details` `lease_expiry_action` ON (((`lease_expiry_action`.`vm_id` = `vm_instance`.`id`)
+        AND (`lease_expiry_action`.`name` = 'leaseexpiryaction'))));

framework/db/src/main/java/com/cloud/utils/db/SearchBase.java

@@ -359,6 +359,24 @@
         return (J)this;
     }
 
+    /**
+     * Adds an AND NOT condition to the search.  Normally you should use this to
+     * perform an 'AND NOT' with a big conditional in parenthesis.  For example,
+     *
+     * search.andNot().op(entity.getId(), Op.Eq, "abc").cp()
+     *
+     * The above fragment produces something similar to
+     *
+     * "AND NOT (id = $abc) where abc is the token to be replaced by a value later.
+     *
+     * @return this
+     */
+    @SuppressWarnings("unchecked")
+    public J andNot() {
+        constructCondition(null, " AND NOT ", null, null);
+        return (J)this;
+    }
+
     /**
      * Closes a parenthesis that's started by op()
      * @return this