This is an automated email from the ASF dual-hosted git repository.
shwstppr 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 883174f Add doc for dynamic secondary storage selectors (#368)
883174f is described below
commit 883174f6dddb31f04c78cddb792a07ff1a972499
Author: Bryan Lima <[email protected]>
AuthorDate: Tue Dec 19 07:56:01 2023 -0300
Add doc for dynamic secondary storage selectors (#368)
Addresses apache/cloudstack#8285
---
source/adminguide/storage.rst | 92 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 92 insertions(+)
diff --git a/source/adminguide/storage.rst b/source/adminguide/storage.rst
index e22c3c2..ce0ea1e 100644
--- a/source/adminguide/storage.rst
+++ b/source/adminguide/storage.rst
@@ -281,6 +281,98 @@ from being used for storing any further Templates, Volumes
and Snapshots.
cmk updateImageStore id=4440f406-b9b6-46f1-93a4-378a75cf15de
readonly=true
+Direct resources to a specific secondary storage
+~~~~~~~~~
+
+By default, ACS allocates ISOs, volumes, snapshots, and templates to the
freest secondary storage of the zone. In order to direct these resources to a
specific secondary storage, the user can utilize the functionality of the
dynamic secondary storage selectors using heuristic rules. This functionality
utilizes JavaScript rules, defined by the user, to direct these resources to a
specific secondary storage. When creating the heuristic rule, the script will
have access to some preset varia [...]
+
+ +-----------------------------------+-----------------------------------+
+ | Resource | Variables |
+ +===================================+===================================+
+ | Secondary Storage | ``id`` |
+ | +-----------------------------------|
+ | | ``name`` |
+ | +-----------------------------------|
+ | | ``usedDiskSize`` |
+ | +-----------------------------------|
+ | | ``totalDiskSize`` |
+ | +-----------------------------------|
+ | | ``protocol`` |
+ +-----------------------------------+-----------------------------------+
+ | Snapshot | ``size`` |
+ | +-----------------------------------|
+ | | ``hypervisorType`` |
+ | +-----------------------------------|
+ | | ``name`` |
+ +-----------------------------------+-----------------------------------+
+ | ISO/Template | ``format`` |
+ | +-----------------------------------|
+ | | ``hypervisorType`` |
+ | +-----------------------------------|
+ | | ``templateType`` |
+ | +-----------------------------------|
+ | | ``name`` |
+ +-----------------------------------+-----------------------------------+
+ | Volume | ``size`` |
+ | +-----------------------------------|
+ | | ``format`` |
+ +-----------------------------------+-----------------------------------+
+ | Account | ``id`` |
+ | +-----------------------------------|
+ | | ``name`` |
+ | +-----------------------------------|
+ | | ``domain.id`` |
+ | +-----------------------------------|
+ | | ``domain.name`` |
+ +-----------------------------------+-----------------------------------+
+
+To utilize this functionality, the user needs to create a selector, using the
API ``createSecondaryStorageSelector``. Each selector created specifies the
type of resource the heuristic rule will be verified upon allocation (e.g. ISO,
snapshot, template or volume), and the zone the heuristic will be applied on.
It is noteworthy that can only be one heuristic rule for the same type within a
zone. Another thing to consider is that the heuristic rule should return the ID
of a valid secondary [...]
+
+1. Allocate a resource type to a specific secondary storage.
+
+.. code:: javascript
+
+ function findStorageWithSpecificId(pool) {
+ return pool.id === '7432f961-c602-4e8e-8580-2496ffbbc45d';
+ }
+
+ secondaryStorages.filter(findStorageWithSpecificId)[0].id
+
+2. Dedicate storage pools for a type of template format.
+
+.. code:: javascript
+
+ function directToDedicatedQCOW2Pool(pool) {
+ return pool.id === '7432f961-c602-4e8e-8580-2496ffbbc45d';
+ }
+
+ function directToDedicatedVHDPool(pool) {
+ return pool.id === '1ea0109a-299d-4e37-8460-3e9823f9f25c';
+ }
+
+ if (template.format === 'QCOW2') {
+ secondaryStorages.filter(directToDedicatedQCOW2Pool)[0].id
+ } else if (template.format === 'VHD') {
+ secondaryStorages.filter(directToDedicatedVHDPool)[0].id
+ }
+
+3. Direct snapshot of volumes with the KVM hypervisor to a specific secondary
storage.
+
+.. code:: javascript
+
+ if (snapshot.hypervisorType === 'KVM') {
+ '7432f961-c602-4e8e-8580-2496ffbbc45d';
+ }
+
+4. Direct resources to a specific domain:
+
+.. code:: javascript
+
+ if (account.domain.id == '52d83793-26de-11ec-8dcf-5254005dcdac') {
+ '1ea0109a-299d-4e37-8460-3e9823f9f25c'
+ } else if (account.domain.id == 'c1186146-5ceb-4901-94a1-dd1d24bd849d') {
+ '7432f961-c602-4e8e-8580-2496ffbbc45d'
+ }
Working With Volumes
--------------------
