Skip to content

Commit a05f638

Browse files
committed
incoporate suggestions
1 parent 3d19cdf commit a05f638

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

source/adminguide/service_offerings.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -402,10 +402,9 @@ 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 lease related metadata.
406-
In CloudStack, a lease represents the specific duration for which an instance is allocated.
407-
The user rents these resources for the duration of the lease. Once the lease period expires, instance may be stopped or destroyed.
408-
Lease information is inherited from compute offering and gets associated to Instance.
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.
407+
These lease settings are defined in the Compute Offering and are automatically applied to any Instance created using it.
409408

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

@@ -415,10 +414,10 @@ To create a new compute offering:
415414

416415
When the flag is enabled
417416

418-
- **Lease Duration (in days)**: Creates a compute offering with Lease duration. Instance created from this compute offering will inherit lease duration by default.
417+
- **Lease Duration (in days)**: Sets the lease duration. An instance created using this compute offering will inherit the lease duration by default.
419418

420-
- **Lease expiry action**: Denotes lease expiry action, which gets executed upon lease expiry for instances created from compute offering.
421-
Suported values for lease expiry action are as follows:
419+
- **Lease expiry action**: Lease expiry action: Denotes lease expiry action, which gets executed upon lease expiry for instances created using this compute offering.
420+
Supported values for lease expiry action are as follows:
422421

423422
- STOP
424423
- DESTROY

source/adminguide/virtual_machines.rst

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

966-
Cloudstack provides capability to create instance on lease. Lease denotes a set period for which resource is allocated and upon expiry cleanup is performed.
967-
This feature enables automated cleanup of instances created for specific duration and for specific purpose. This feature gives administrators the ability to automatically reclaim
968-
resources that are no longer needed by expired virtual machines, helping to optimize resource utilization and reduce wastage.
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.
969970

970971

971-
**Configuring lease feature**
972+
**Configuring Instance Lease feature**
972973

973974
The cloud administrator can use global configuration variables to control the behavior of Instance Lease.
974975
To set these variables, API or CloudStack UI can be used:
975976

976977
======================================= ========================
977978
Configuration Description
978979
======================================= ========================
979-
instance.lease.enabled Indicates whether to enable the Instance lease featuew, will be applicable only on instances created after lease is enabled. **Default: false**
980+
instance.lease.enabled Indicates whether to enable the Instance lease feature, will be applicable only on instances created after lease is enabled. **Default: false**
980981
instance.lease.scheduler.interval Background task interval in seconds that executes Lease expiry action on eligibile expired instances. Default: 3600.
981982
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
982983
instance.lease.alert.daysbefore Denotes number of days (N) for alert task. Default: 7 days
@@ -990,8 +991,8 @@ instance.lease.alert.daysbefore Denotes number of days (N) for alert ta
990991

991992
Lease may require to be disabled in following scenarios:
992993

993-
- During deployment of instance while using compute offering with lease metadata
994-
- Edit instance with existing lease
994+
- Users can disable the Instance Lease feature during instance deployment by unchecking the 'Enable Lease' option when using a Compute Offering that supports it.
995+
- For existing instances with a lease already enabled, the lease can be removed by editing the instance and unchecking the 'Enable Lease' option.
995996

996997
**leaseexpiryaction**: There are two expiry action supported:
997998

@@ -1015,7 +1016,7 @@ lease is removed from the instance for any further action.
10151016

10161017
#. Lease Assignment: A lease can only be assigned to an instance during deployment.
10171018
#. Lease Acquisition: Instances without a lease cannot acquire one by switching to a different compute offering or by editing the instance.
1018-
#. Lease Inheritance: Instances inherit the lease from a compute offering that contains lease metadata. This lease can be overridden or disabled in the "Advanced Settings".
1019+
#. Lease Inheritance: Instances inherit the lease from a compute offering with 'Instance Lease' feature enabled. This lease can be overridden or disabled in the Advanced Settings.
10191020
#. Lease Persistence: A lease is always tied to the instance. Modifications to the compute offering do not affect the instance's lease.
10201021
#. Non-Lease Compute offering: Instances can have a lease by enabling it in the "Advanced Settings" for non-lease based compute offering too.
10211022
#. Lease Duration Management: The lease duration can be extended or reduced for instances before expiry. However, once the lease is disabled, it cannot be re-enabled for that instance.
@@ -1027,7 +1028,7 @@ lease is removed from the instance for any further action.
10271028

10281029
There are 2 ways to deploy instance with lease from UI:
10291030

1030-
1. Use compute offering which has associated lease metadata for instance
1031+
1. Use compute offering which has 'Instance Lease' feature enabled.
10311032

10321033
.. image:: /_static/images/deploy_instance_lease_offering.png
10331034
:width: 400px

0 commit comments

Comments
 (0)