This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
The following commit(s) were added to refs/heads/main by this push:
new 1f02579 notes on purging expunged resources (#397)
1f02579 is described below
commit 1f0257900d6e6769ced6e12a1a8dc9f2b18af233
Author: Abhishek Kumar <[email protected]>
AuthorDate: Thu Jun 20 11:35:12 2024 +0530
notes on purging expunged resources (#397)
* notes on purging expunged resources
Feature PR: https://github.com/apache/cloudstack/pull/8999
Signed-off-by: Abhishek Kumar <[email protected]>
* Apply suggestions from code review
Co-authored-by: Suresh Kumar Anaparti <[email protected]>
Co-authored-by: dahn <[email protected]>
* Update source/adminguide/tuning.rst
* changes from global config description
Signed-off-by: Abhishek Kumar <[email protected]>
---------
Signed-off-by: Abhishek Kumar <[email protected]>
Co-authored-by: Suresh Kumar Anaparti <[email protected]>
Co-authored-by: dahn <[email protected]>
---
source/adminguide/service_offerings.rst | 6 +++
source/adminguide/tuning.rst | 73 +++++++++++++++++++++++++++++++++
2 files changed, 79 insertions(+)
diff --git a/source/adminguide/service_offerings.rst
b/source/adminguide/service_offerings.rst
index 9a3e690..ea50df7 100644
--- a/source/adminguide/service_offerings.rst
+++ b/source/adminguide/service_offerings.rst
@@ -319,6 +319,12 @@ To create a new compute offering:
- **Storage Policy**: Name of the storage policy defined at vCenter, this
is applicable only for VMware.
When a specific Zone is selected, one of the storage policies can be
selected from the list box.
+ - **Purge Resources**: Whether to cleanup instance and its associated
resources from
+ database upon expunge. When set to true, the database records for the
instances with the offering and its
+ associated resources such as volumes, NICs, etc will be purged
immediately once the instance is
+ expunged. The duration between enpunge and purging of the records can be
controlled using
+ the global configuration - _expunged.resource.purge.job.delay_.
+
- **Compute only Disk Offering**: When this flag is enabled, a compute
only disk offering
is created with the disk related information provided and then linked to
the compute offering.
Compute only disk offering is specific to the newly created compute
offering to record the
diff --git a/source/adminguide/tuning.rst b/source/adminguide/tuning.rst
index c1fb354..f304efd 100644
--- a/source/adminguide/tuning.rst
+++ b/source/adminguide/tuning.rst
@@ -143,3 +143,76 @@ Article
<http://support.citrix.com/article/CTX126531>`_.The article
refers to XenServer 5.6, but the same information applies to XenServer 6
+Purging Expunged Resources
+--------------------------
+
+.. note::
+ Currently only available for Instances and their linked resources.
+
+Over the time there are chances of piling up of millions of database records
+for the removed or expunged resources. The presence of a lot of useless
+records in the database can also affect the performance of the cloud so it is
+needed to purge such entries in a systematic way.
+CloudStack provides the following methods to allow purging of the expunged
+resources and their database records:
+
+Using background task
+~~~~~~~~~~~~~~~~~~~~~
+
+A background task will run at regular intervals. The interval for the task and
+other parameters for it such as resource types, start and end date and batch
size
+can also be controlled with the help of global settings.
+
+The following new global settings have been introduced which would allow
+configuring background task for purging the expunged resources:
+
+.. cssclass:: table-striped table-bordered table-hover
+
+================================================ ================
===================================================================
+Global setting Default values
Description
+================================================ ================
===================================================================
+expunged.resources.purge.enabled false Whether
to run a background task to purge the DB records of the expunged resources.
+expunged.resources.purge.resources (empty) A
comma-separated list of resource types that will be considered by the
background task to purge the DB records of the expunged resources. Currently
only VirtualMachine is supported. An empty value will result in considering all
resource types for purging.
+expunged.resources.purge.interval 86400 Interval
(in seconds) for the background task to purge the DB records of the expunged
resources.
+expunged.resources.purge.delay 300 Initial
delay (in seconds) to start the background task to purge the DB records of the
expunged resources task.
+expunged.resources.purge.batch.size 50 Batch
size to be used during purging of the DB records of the expunged resources.
+expunged.resources.purge.start.time (empty) Start
time to be used by the background task to purge the DB records of the expunged
resources. Use format yyyy-MM-dd or yyyy-MM-dd HH:mm:ss.
+expunged.resources.purge.keep.past.days 30 The
number of days in the past from the execution time of the background task to
purge the DB records of the expunged resources for which the expunged resources
must not be purged. To enable purging DB records of the expunged resource till
the execution of the background task, set the value to zero.
+================================================ ================
===================================================================
+
+
+Using API
+~~~~~~~~~
+
+An admin-only API `purgeExpungedResources` allows purging the expunged
resources
+with desired parameters. It will allow passing the following parameters -
+resourcetype, batchsize, startdate, enddate. An example of
purgeExpungedResources
+API call is shown below:
+
+
+.. parsed-literal::
+
+ > purge expungedresources startdate=2024-04-15 enddate=2024-04-20
resourcetype=VirtualMachine
+ {
+ "purgeexpungedresourcesresponse": {
+ "resourcecount": 6
+ }
+ }
+
+
+Using configuration in offerings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+..note::
+ Available only for service offerings
+
+_purgeresources_ configuration for offerings can be used to allow immediately
+purging a resource when it is expunged. The configuration can be set to true or
+false _purgeresources_ parameter while creating the corresponding offerings.
The
+following global setting can be used to control the delay for purging the
+resource after expunge:
+
+================================================ ================
===================================================================
+Global setting Default values
Description
+================================================ ================
===================================================================
+expunged.resource.purge.job.delay 180 Delay
(in seconds) to execute the purging of the DB records of an expunged resource
initiated by the configuration in the offering. Minimum value should be 180
seconds and if a lower value is set then the minimum value will be used.
+================================================ ================
===================================================================
