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

sudo87 · 2025-03-13T03:06:01Z

Description

This PR enables Administrator to provide capability for end user to provision Lease based instances, which will be self destroyed or stopped once lease expires. This will improve efficient utilization of cloud infrastructure and reduce unused VMs in the cloud infrastructure.

Doc PR: apache/cloudstack-documentation#492

Feature can be enabled by updating value for following key to true:
instance.lease.enabled: true
default: false

There are additional configuration keys:

instance.lease.scheduler.interval: when scheduler will run to execute expiryaction, default value: 3600 (seconds)
instance.lease.alertscheduler.interval: alert scheduler interval, sends alerts for any instance which are about to expire in next 7 days (default: 86400)

Feature introduces new parameters in following APIs:
leaseduration: duration in days for which instance is provisioned
leaseexpiryaction: action will be executed once expiry is over

DeployVMCmd

deploy virtualmachine name=test-vm templateid=e6962fb7-fa6f-11ef-86b8-50eb71576f75 serviceofferingid=8fcc7ba4-298c-4c21-b5f6-c3c4e1d2afe7 leaseduration=10 leaseexpiryaction=STOP zoneid=988db21e-ffc9-4708-9546-797cb7592cb9

CreateServiceOfferingCmd

create serviceoffering name=cmd-lease leaseduration=10 leaseexpiryaction=STOP

UpdateVMCmd

update virtualmachine id=e22a2b2b-66c0-4566-9648-ec3219dbcb96 leaseduration=-1

Valid values for
leaseduration: positive number, negative value to removing lease from instance (-1)
leaseexpiryaction: STOP | DESTROY

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

…syncjobmanager

config key setup and configured for alert email lease options in create and update vm screen handle delete protection, edit vm, create vm validated stop and detroy, delete protection

…e offering

…us UI elements

…rsona, bug fixes

sudo87 · 2025-03-13T03:29:50Z

@blueorangutan package

blueorangutan · 2025-03-13T03:32:03Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-03-13T03:54:50Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 12761

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

codecov · 2025-03-13T05:57:48Z

Codecov Report

Attention: Patch coverage is 52.91667% with 226 lines in your changes missing coverage. Please review.

Project coverage is 16.56%. Comparing base (b17808b) to head (ba8802f).
Report is 49 commits behind head on main.

Files with missing lines	Patch %	Lines
...apache/cloudstack/vm/lease/VMLeaseManagerImpl.java	69.75%	47 Missing and 15 partials ⚠️
...ava/com/cloud/api/query/dao/UserVmJoinDaoImpl.java	38.00%	28 Missing and 3 partials ⚠️
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	75.64%	13 Missing and 6 partials ⚠️
...apache/cloudstack/api/response/UserVmResponse.java	0.00%	18 Missing ⚠️
.../cloud/configuration/ConfigurationManagerImpl.java	14.28%	18 Missing ⚠️
...main/java/com/cloud/api/query/vo/UserVmJoinVO.java	0.00%	13 Missing ⚠️
...he/cloudstack/api/command/user/vm/DeployVMCmd.java	0.00%	12 Missing ⚠️
...he/cloudstack/api/command/user/vm/UpdateVMCmd.java	0.00%	12 Missing ⚠️
...oudstack/api/response/ServiceOfferingResponse.java	0.00%	12 Missing ⚠️
...ain/java/com/cloud/api/query/QueryManagerImpl.java	0.00%	8 Missing ⚠️
... and 7 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #10560      +/-   ##
============================================
+ Coverage     16.52%   16.56%   +0.04%     
- Complexity    13791    13854      +63     
============================================
  Files          5716     5719       +3     
  Lines        506016   506908     +892     
  Branches      61380    61537     +157     
============================================
+ Hits          83617    83992     +375     
- Misses       413037   413509     +472     
- Partials       9362     9407      +45

Flag	Coverage Δ
uitests	`3.96% <ø> (-0.02%)`	⬇️
unittests	`17.44% <52.91%> (+0.05%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

shwstppr

@sudo87 build failing with unit tests failure. Please check

server/src/test/java/org/apache/cloudstack/vm/lease/VMLeaseManagerImplTest.java

sudo87 · 2025-03-17T05:14:20Z

@blueorangutan package

blueorangutan · 2025-03-17T05:16:03Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-03-17T05:56:29Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 12802

…n tests

server/src/main/java/com/cloud/api/query/dao/UserVmJoinDaoImpl.java

weizhouapache

code lgtm

sudo87 · 2025-05-23T12:56:08Z

@blueorangutan package

blueorangutan · 2025-05-23T12:58:03Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-05-23T14:05:34Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13497

sudo87 · 2025-05-24T02:10:21Z

@blueorangutan test

blueorangutan · 2025-05-24T02:12:04Z

@sudo87 a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-05-24T17:37:26Z

[SF] Trillian test result (tid-13397)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 52705 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10560-t13397-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

Copilot

Pull Request Overview

This PR adds instance lease functionality to allow administrators to provision VMs with a defined lease duration and an expiry action (STOP or DESTROY), improving resource utilization.

Added new lease-related fields in service offering and VM view objects and responses.
Introduced new DAO search builders and queries to filter leased and expiring instances.
Updated API commands and database views to support instance lease parameters.

Reviewed Changes

Copilot reviewed 44 out of 44 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
ServiceOfferingJoinVO.java	Added leaseDuration and leaseExpiryAction fields with corresponding getters.
UserVmJoinDaoImpl.java	Added search builders to filter leased instance queries and compute lease duration.
QueryManagerImpl.java	Updated VM ID search logic to include leased instance filtering and error handling.
SQL Views (cloud.user_vm_view.sql, cloud.service_offering_view.sql)	Extended views with lease-related columns.
API Modules (UserVmResponse.java, ServiceOfferingResponse.java, UpdateVMCmd.java, etc.)	Updated API responses and commands with lease parameters.
ApiConstants.java, VmDetailConstants.java, EventTypes.java	Introduced new lease-related constants and event types.
Tests	Added test cases for lease parameters in CreateServiceOfferingCmdTest.java.

Comments suppressed due to low confidence (3)

org/apache/cloudstack/api/query/QueryManagerImpl.java:1359

[nitpick] Extract the error message into a constant to avoid duplication and ensure consistency in error handling.

if (!VMLeaseManager.InstanceLeaseEnabled.value() && cmd.getOnlyLeasedInstances()) {

org/apache/cloudstack/api/query/QueryManagerImpl.java:1517

[nitpick] Clarify the join condition by verifying that filtering on the 'name' field for lease execution details is the intended approach; consider using a more descriptive field or alias to improve readability.

leasedInstancesSearch.and(leasedInstancesSearch.entity().getName(), SearchCriteria.Op.EQ).values(VmDetailConstants.INSTANCE_LEASE_EXECUTION);

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

[nitpick] Consider renaming the local variable 'onlyLeasedInstances' to 'leased' or similar to match the API constant (LEASED) for consistency.

@Parameter(name = ApiConstants.LEASED, type = CommandType.BOOLEAN,

vishesh92

@sudo87 left some minor comments.

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

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

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

server/src/main/java/com/cloud/api/query/dao/ServiceOfferingJoinDaoImpl.java

server/src/main/java/org/apache/cloudstack/vm/lease/VMLeaseManager.java

server/src/main/java/org/apache/cloudstack/vm/lease/VMLeaseManagerImpl.java

ui/public/locales/en.json

…ager.java Co-authored-by: Vishesh <[email protected]>

sudo87 · 2025-05-27T12:05:55Z

@blueorangutan package

vishesh92

clgtm

sudo87 · 2025-05-27T13:40:06Z

@blueorangutan package

blueorangutan · 2025-05-27T13:42:04Z

@sudo87 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-05-27T14:55:29Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13526

sudo87 · 2025-05-27T16:01:18Z

@blueorangutan test

blueorangutan · 2025-05-27T16:02:04Z

@sudo87 a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-05-28T07:54:15Z

[SF] Trillian test result (tid-13423)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 54074 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10560-t13423-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

… leaseexpiry action (apache#10560) * FR-248: Instance lease, WIP commit * insert lease expiry into db and use that to filter exiring vms, add asyncjobmanager * Add leaseDuration and leaseExpiryAction in Service offering create flow * Update listVM cmd to allow listing only leased instances * Add methods to fetch instances for which lease is expiring in next days * Changes included: config key setup and configured for alert email lease options in create and update vm screen handle delete protection, edit vm, create vm validated stop and detroy, delete protection * Update UI screens for leased properties coming from config and service offering * use global lock before running scheduler * Unit tests * Flow changes done in UI based on discussion * Include view changes in schema upgrade files and use feature in various UI elements * Added integration test for vm deployment, UI enhancements for user persona, bug fixes * validate integration tests, minor ui changes and log messages * fix build: moving configkey from setup to test itself * Disable testAlert to unblock build and trim whitespaces in integration tests * Address review comments * Minor changes in EditVM screen * Use ExecutorService instead of Timer and TimerTask * Additional review comments * Incorporate following changes: 1. Execute lease action once on the instance 2. Cancel lease on instance when feature is disabled 3. Relevant events when lease gets disabled, cancelled, executed 4. Disable associating lease after deployment 5. UI elements and flow changes 6. Changes based on feedback from demo * Handle pr review comments * address review comments * move instance.lease.enabled config to VMLeaseManager interface * bug fix in edit instance flow and reject api request for invalid values * max allowed lease is for 100 years * log instance ids for expired instance * Fix config validation for value range and code coverage improvement * fix lease expiry request failures in async * dont use forced: true for StopVmCmd * Update server/src/main/java/org/apache/cloudstack/vm/lease/VMLeaseManager.java Co-authored-by: Vishesh <[email protected]> * handle review comments --------- Co-authored-by: Rohit Yadav <[email protected]> Co-authored-by: Vishesh <[email protected]>

sudo87 added 12 commits February 21, 2025 13:54

FR-248: Instance lease, WIP commit

d737cea

insert lease expiry into db and use that to filter exiring vms, add a…

9bef279

…syncjobmanager

Add leaseDuration and leaseExpiryAction in Service offering create flow

759f1fa

Update listVM cmd to allow listing only leased instances

8c7a9f2

Add methods to fetch instances for which lease is expiring in next days

1495b08

Changes included:

e2da246

config key setup and configured for alert email lease options in create and update vm screen handle delete protection, edit vm, create vm validated stop and detroy, delete protection

Update UI screens for leased properties coming from config and servic…

0969bf0

…e offering

use global lock before running scheduler

f239e92

Unit tests

e7ce8ae

Flow changes done in UI based on discussion

0cf2fe8

Include view changes in schema upgrade files and use feature in vario…

7bc5f2a

…us UI elements

Added integration test for vm deployment, UI enhancements for user pe…

aff544f

…rsona, bug fixes

boring-cyborg bot added component:api component:integration-test component:management-server Python Warning... Python code Ahead! labels Mar 13, 2025

validate integration tests, minor ui changes and log messages

62397cc

sudo87 force-pushed the int_fr_248 branch from 59ee208 to 62397cc Compare March 13, 2025 03:13

vishesh92 reviewed Mar 13, 2025

View reviewed changes

...src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java Outdated Show resolved Hide resolved

shwstppr reviewed Mar 13, 2025

View reviewed changes

server/src/test/java/org/apache/cloudstack/vm/lease/VMLeaseManagerImplTest.java Outdated Show resolved Hide resolved

fix build: moving configkey from setup to test itself

faf484f

Disable testAlert to unblock build and trim whitespaces in integratio…

410a882

…n tests

sudo87 force-pushed the int_fr_248 branch from 338edd7 to 410a882 Compare March 17, 2025 07:12

weizhouapache reviewed May 23, 2025

View reviewed changes

server/src/main/java/com/cloud/api/query/dao/UserVmJoinDaoImpl.java Show resolved Hide resolved

weizhouapache approved these changes May 23, 2025

View reviewed changes

dont use forced: true for StopVmCmd

d5988a5

sudo87 requested a review from sureshanaparti May 23, 2025 12:17

sureshanaparti approved these changes May 23, 2025

View reviewed changes

vishesh92 requested a review from Copilot May 25, 2025 10:26

Copilot AI reviewed May 25, 2025

View reviewed changes

vishesh92 reviewed May 26, 2025

View reviewed changes

rohityadavcloud and others added 2 commits May 27, 2025 12:00

Update server/src/main/java/org/apache/cloudstack/vm/lease/VMLeaseMan…

785dbf4

…ager.java Co-authored-by: Vishesh <[email protected]>

handle review comments

ba8802f

sudo87 force-pushed the int_fr_248 branch from d9e7f86 to ba8802f Compare May 27, 2025 12:04

vishesh92 approved these changes May 27, 2025

View reviewed changes

sudo87 assigned rohityadavcloud May 28, 2025

rohityadavcloud merged commit 7632814 into apache:main May 28, 2025
25 of 26 checks passed

sureshanaparti added the type:new-feature label Jun 4, 2025

sureshanaparti added this to Apache CloudStack 4.21.0 Jun 5, 2025

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

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

Uh oh!

Conversation

sudo87 commented Mar 13, 2025 • edited by sureshanaparti Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

sudo87 commented Mar 13, 2025

Uh oh!

blueorangutan commented Mar 13, 2025

Uh oh!

blueorangutan commented Mar 13, 2025

Uh oh!

Uh oh!

codecov bot commented Mar 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sudo87 commented Mar 17, 2025

Uh oh!

blueorangutan commented Mar 17, 2025

Uh oh!

blueorangutan commented Mar 17, 2025

Uh oh!

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

sudo87 commented May 23, 2025

Uh oh!

blueorangutan commented May 23, 2025

Uh oh!

blueorangutan commented May 23, 2025

Uh oh!

sudo87 commented May 24, 2025

Uh oh!

blueorangutan commented May 24, 2025

Uh oh!

blueorangutan commented May 24, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

vishesh92 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sudo87 commented May 27, 2025

Uh oh!

vishesh92 left a comment

Choose a reason for hiding this comment

Uh oh!

sudo87 commented May 27, 2025

Uh oh!

blueorangutan commented May 27, 2025

Uh oh!

blueorangutan commented May 27, 2025

Uh oh!

sudo87 commented Mar 13, 2025 •

edited by sureshanaparti

Loading

codecov bot commented Mar 13, 2025 •

edited

Loading