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 96beb7a Add Resource Limits to Backups and Object Storage (#461)
96beb7a is described below
commit 96beb7a31d6e5edaf172755c302451ef01391bae
Author: Abhisar Sinha <[email protected]>
AuthorDate: Fri Jan 31 17:08:53 2025 +0530
Add Resource Limits to Backups and Object Storage (#461)
* Added new resource limits to backup and object storage section
* Add information about backup resource limits using physical size
* Added new resource limits to the project page
---
source/_static/images/B&R-BackupScheduleEntry.png | Bin 29420 -> 55652 bytes
source/_static/images/add-bucket.png | Bin 32707 -> 36399 bytes
source/adminguide/backup_and_recovery.rst | 19 ++++++++--
source/adminguide/projects.rst | 40 ++++++++++++++++------
source/adminguide/storage.rst | 11 ++++++
5 files changed, 57 insertions(+), 13 deletions(-)
diff --git a/source/_static/images/B&R-BackupScheduleEntry.png
b/source/_static/images/B&R-BackupScheduleEntry.png
index 3f5b339..67f73cf 100644
Binary files a/source/_static/images/B&R-BackupScheduleEntry.png and
b/source/_static/images/B&R-BackupScheduleEntry.png differ
diff --git a/source/_static/images/add-bucket.png
b/source/_static/images/add-bucket.png
index 988a7e4..bfbd1f5 100644
Binary files a/source/_static/images/add-bucket.png and
b/source/_static/images/add-bucket.png differ
diff --git a/source/adminguide/backup_and_recovery.rst
b/source/adminguide/backup_and_recovery.rst
index eb926a3..ee06d8d 100644
--- a/source/adminguide/backup_and_recovery.rst
+++ b/source/adminguide/backup_and_recovery.rst
@@ -144,12 +144,12 @@ icon.
|B&R-createBackup.png|
-To setup a recurring backup schedule, navigate to the Instance and click on
the 'Backup Schedule'
+To setup a recurring backup schedule, navigate to the Instance and click on
the 'Configure Backup Schedule'
icon.
|B&R-BackupSchedule.png|
-Then set the time and frequency of the backups, click 'Configure' and then
'Close'
+Then set the Interval type, timezone, time of taking the backup and maximum
numbers of backups to retain.
|B&R-BackupScheduleEntry.png|
@@ -178,6 +178,21 @@ Supported APIs:
- **restoreVolumeFromBackupAndAttachToVM**: restore and attach a backed-up
volume (of an Instance backup) to a specified Instance.
+Configuring resource limits on Backups
+--------------------------------------
+Administrators can enforce limits on the maximum number of backups that can be
taken and
+the total backup storage size that can be used at an account, domain and
project level.
+Administrators can do this by going to the configure limits tab in accounts,
domains and projects
+similar to when enforcing resource limits on volumes, primary storage usage
etc.
+
+Unlike other resources like volumes, backup limits take into account the
physical used size
+and not the allocated size of the backup. This is because the backup once
taken can never
+grow into the allocated size. At the time of backup creation, Cloudstack
doesn't know the
+size of the backup that will be taken, so it uses the physical size of the
volumes to be
+backed up from Volume Stats to calculate the backup size for checking resource
limits.
+If Volume Stats are not present, then the virtual size of the volumes is used
to calculate
+the backup size, although the actual backup size may be less than the size use
to do resource limit check.
+
.. |B&R-assignOffering.png| image:: /_static/images/B&R-assignOffering.png
:alt: Assigning an SLA/Policy to an Instance.
:width: 400 px
diff --git a/source/adminguide/projects.rst b/source/adminguide/projects.rst
index 65b0cd3..c497adb 100644
--- a/source/adminguide/projects.rst
+++ b/source/adminguide/projects.rst
@@ -205,17 +205,35 @@ Setting the Global Project Resource Limits
.. cssclass:: table-striped table-bordered table-hover
-
+--------------------------+------------------------------------------------------------------------------------------------------------------------------+
- | max.project.public.ips | Maximum number of public IP addresses that can
be owned by any project in the cloud. See About Public IP Addresses. |
-
+--------------------------+------------------------------------------------------------------------------------------------------------------------------+
- | max.project.snapshots | Maximum number of Snapshots that can be owned
by any project in the cloud. See Working with Snapshots. |
-
+--------------------------+------------------------------------------------------------------------------------------------------------------------------+
- | max.project.templates | Maximum number of Templates that can be owned
by any project in the cloud. See Working with Templates. |
-
+--------------------------+------------------------------------------------------------------------------------------------------------------------------+
- | max.project.uservms | Maximum number of guest Instances that can be
owned by any project in the cloud. See Working With Instances. |
-
+--------------------------+------------------------------------------------------------------------------------------------------------------------------+
- | max.project.volumes | Maximum number of data volumes that can be
owned by any project in the cloud. See Working with Volumes.
|
-
+--------------------------+------------------------------------------------------------------------------------------------------------------------------+
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.public.ips | Default maximum number of public IP
addresses that can be owned by any project in the cloud. See About Public IP
Addresses. |
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.snapshots | Default maximum number of Snapshots that
can be owned by any project in the cloud. See Working with Snapshots.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.templates | Default maximum number of Templates that
can be owned by any project in the cloud. See Working with Templates.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.uservms | Default maximum number of guest Instances
that can be owned by any project in the cloud. See Working With Instances.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.volumes | Default maximum number of data volumes that
can be owned by any project in the cloud. See Working with Volumes.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.networks | Default maximum number of networks that can
be owned by any project in the cloud.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.vpcs | Default maximum number of vpcs that can be
owned by any project in the cloud.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.cpus | Default maximum number of cpu cores that
can be owned by any project in the cloud.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.memory | Default maximum memory (in MB) that can be
used by any project in the cloud.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.primary.storage | Default maximum primary storage space (in
GiB) that can be used by any project in the cloud.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.backups | Default maximum number of backups that can
be owned by any project in the cloud.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.backup.storage | Default maximum backup storage (in GiB)
that can be used by any project in the cloud.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.buckets | Default maximum number of buckets that can
be owned by any project in the cloud.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
+ | max.project.object storage | Default maximum Object storage (in GiB)
that can be used by any project in the cloud.
|
+
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
#. Restart the Management Server.
diff --git a/source/adminguide/storage.rst b/source/adminguide/storage.rst
index c2b086b..db130bd 100644
--- a/source/adminguide/storage.rst
+++ b/source/adminguide/storage.rst
@@ -1505,6 +1505,8 @@ To create a new bucket, click create Bucket, provide the
following details, and
#. Object Store: Select the object store where you want the Bucket to reside
+#. Quota in GiB: Enforce a quota on the bucket. This is a mandatory field
since 4.21 as it is used to enforce resource limit on object store usage.
+
Based on the selected Object Store, you can specify additional details like
quota, encryption, policy.
|Createbucket.png|
@@ -1545,6 +1547,15 @@ Deleting objects from a bucket
2. Click on the |delete-button.png| button to delete the selected files from
the bucket.
+
+Configuring resource limits on buckets and object storage usage
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Administrators can enforce limits on the maximum number of buckets they can be
created and
+the total object storage space that can be allocated at an account, domain and
project level.
+Allocated storage is the sum of quota used by all of the buckets.
+Administrators can do this by going to the configure limits tab in accounts,
domains and projects
+similar to when enforcing resource limits on volumes, primary storage usage
etc.
+
Shared FileSystems
------------------
