Skip to content

Commit 06350e0

Browse files
committed
update config key names and handle review comments
1 parent a05f638 commit 06350e0

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

source/adminguide/service_offerings.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,8 +402,8 @@ To create a new compute offering:
402402
with the compute offering. When set to true, overriding of disk offering is not allowed on deploy instance
403403
and change disk offering is not allowed for the ROOT disk
404404

405-
- **Enable Lease**: When this flag is enabled, Compute Offering is created with 'Instance Lease' feature enabled.
406-
In CloudStack, a lease sets a specific time duration after which a chosen lease action action, such as stopping or destroying the instance, will take place.
405+
- **Enable Lease**: When this flag is enabled, Compute Offering is created with 'Instance Lease' enabled.
406+
In CloudStack, a lease for an instance sets a specific time duration (in days) after which a chosen lease action, such as stopping or destroying the instance, will take place.
407407
These lease settings are defined in the Compute Offering and are automatically applied to any Instance created using it.
408408

409409
.. note:: The global configuration ``instance.lease.enabled`` should be configured as true to create compute offering with lease.

source/adminguide/virtual_machines.rst

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -963,10 +963,13 @@ already in use by the Instance.
963963
Instance Lease
964964
--------------
965965

966-
CloudStack offers the option to create Instances with a Lease. A Lease defines a set time period after which a selected action, such as stopping or destroying the instance,
967-
will be automatically performed. This helps optimize cloud resource usage by automatically freeing up resources that are no longer in use.
968-
If a user needs an instance only for a limited time, this feature can be useful. When deploying an instance, users can either choose a Compute Offering that includes
969-
the Instance Lease feature or enable it specifically for that instance, setting the number of days after which the instance should be stopped or destroyed once their task is complete.
966+
CloudStack offers the option to create Instances with a Lease. A Lease defines a set time period after which a selected action,
967+
such as stopping or destroying the instance, will be automatically performed. This helps optimize cloud resource usage by automatically
968+
freeing up resources that are no longer in use.
969+
970+
If a user needs an instance only for a limited time, this option can be very helpful.
971+
When deploying an instance, users can either choose a Compute Offering that includes Instance Lease support or enable it specifically for that instance,
972+
setting the number of days after which the instance should be stopped or destroyed once their task is complete.
970973

971974

972975
**Configuring Instance Lease feature**
@@ -978,9 +981,9 @@ To set these variables, API or CloudStack UI can be used:
978981
Configuration Description
979982
======================================= ========================
980983
instance.lease.enabled Indicates whether to enable the Instance lease feature, will be applicable only on instances created after lease is enabled. **Default: false**
981-
instance.lease.scheduler.interval Background task interval in seconds that executes Lease expiry action on eligibile expired instances. Default: 3600.
982-
instance.lease.alertscheduler.interval Background task interval in seconds that executes Lease alert for instances about to be expired in next N days. Default: 86400
983-
instance.lease.alert.daysbefore Denotes number of days (N) for alert task. Default: 7 days
984+
instance.lease.scheduler.interval Background task interval in seconds that executes Lease expiry action on eligibile expired instances. Default: 3600.
985+
instance.lease.eventscheduler.interval Background task interval in seconds that executes Lease event executor for instances about to be expired in next N days. Default: 86400
986+
instance.lease.expiryevent.daysbefore Denotes number of days (N) in advance expiry events are generated for instance about to expire. Default: 7 days
984987
======================================= ========================
985988

986989

@@ -1087,6 +1090,7 @@ To disable lease using API:
10871090

10881091
.. note:: When the feature is disabled, the lease associated with instances is cancelled. Re-enabling the feature will not automatically reapply the lease to previously grandfathered instances.
10891092

1093+
.. note:: Lease duration is considered as total lease for instance.
10901094

10911095
**Instance Lease Events**
10921096

@@ -1095,10 +1099,10 @@ Lease feature generates various events to help in auditing and monitoring:
10951099
=================== ========================
10961100
Event Type Description
10971101
=================== ========================
1098-
VM.LEASE.EXPIRED Event is generated at lease expiry
1099-
VM.LEASE.DISABLED Denotes if lease is disabled by user/admin
1102+
VM.LEASE.EXPIRED Event is generated at lease expiry
1103+
VM.LEASE.DISABLED Denotes if lease is disabled by user/admin
11001104
VM.LEASE.CANCELLED When lease is cancelled (feature gets disabled)
1101-
VM.LEASE.EXPIRING Expiry intimation event for instance
1105+
VM.LEASE.EXPIRING Expiry intimation event for instance
11021106
=================== ========================
11031107

11041108

0 commit comments

Comments
 (0)