You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by nv...@apache.org on 2022/04/28 12:28:27 UTC

[cloudstack-documentation] branch main updated: Information about StorPool plugin (#270)

This is an automated email from the ASF dual-hosted git repository.

nvazquez 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 ed6583f  Information about StorPool plugin (#270)
ed6583f is described below

commit ed6583f692b207eeb0f527e3a6cc71525de4e3e6
Author: slavkap <51...@users.noreply.github.com>
AuthorDate: Thu Apr 28 15:28:22 2022 +0300

    Information about StorPool plugin (#270)
---
 source/installguide/configuration.rst | 51 +++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/source/installguide/configuration.rst b/source/installguide/configuration.rst
index a6dc628..7cb469f 100644
--- a/source/installguide/configuration.rst
+++ b/source/installguide/configuration.rst
@@ -1328,6 +1328,57 @@ powerflex://<API_USER>:<API_PASSWORD>@<GATEWAY>/<STORAGEPOOL>
 
 -	<STORAGEPOOL>=[PowerFlex storage pool name (case sensitive)]
 
+StorPool Plug-in
+~~~~~~~~~~~~~~~~
+
+.. note::
+   The StorPool storage plug-in for CloudStack is part of the standard
+   CloudStack install. There is no additional work required to add this
+   component.
+
+The StorPool plug-in is deeply integrated with CloudStack and works on with KVM hypervisors.
+
+When used with service or disk offerings, an administrator is able to
+build an environment in which a root or data disk that a user creates
+leads to the dynamic creation of a StorPool volume, which has guaranteed
+performance. Such a StorPool volume is associated with one CloudStack volume,
+so performance of the CloudStack volume does not vary depending on how
+heavily other tenants are using the system. The volume migration is supported
+accross non-managed storage pools (e.g. NFS/Local storage/Ceph) to StorPool, and
+accross StorPool storage pools.
+
+More technical details could be found on `StorPool Knowledge Base <https://kb.storpool.com/>`_.
+
+The createStoragePool API has been augmented to support plugable storage providers.
+The following is a list of parameters to use when adding storage to CloudStack that is based on the StorPool plug-in:
+
+command=createStoragePool
+scope=[zone]
+zoneid=[your zone id]
+hypervisor=KVM
+name=[name for primary storage]
+protocol=SharedMountPoint
+provider=StorPool
+capacityBytes=[used for accounting purposes only. May be more or less than the actual StorPool template capacity]
+url=[storage pool url]
+The url parameter contains the StorPool storage pool details, specifed in the following format:
+
+SP_API_HTTP=address:port;SP_AUTH_TOKEN=token;SP_TEMPLATE=template_name
+
+-       <SP_API_HTTP>=[address of StorPool Api]
+-       <SP_AUTH_TOKEN>=[StorPool's token]
+-       <SP_TEMPLATE>=[name of StorPool's template]
+
+================================= ====================================================================================================================================================================
+StorPool Configurations                     Description
+================================= ====================================================================================================================================================================
+sp.bypass.secondary.storage       For StorPool Managed storage backup to secondary
+sp.cluster.id                     For StorPool multi cluster authorization (It will be set automaticaly for each cluster)
+sp.enable.alternative.endpoint    Used for StorPool primary storage, defines if there is a need to be used alternative endpoint
+sp.alternative.endpoint           Used for StorPool primary storage for an alternative endpoint. Structure of the endpoint is `SP_API_HTTP=address:port; SP_AUTH_TOKEN=token; SP_TEMPLATE=template_name`
+storpool.volume.tags.checkup      Minimal interval (in seconds) to check and report if a StorPool volume created by CloudStack exists in CloudStack's database
+storpool.snapshot.tags.checkup    Minimal interval (in seconds) to check and report if a StorPool snapshot created by CloudStack exists in CloudStack's database
+================================= ====================================================================================================================================================================
 
 .. _add-secondary-storage: