From 46efdc7125f030e02e7f3b3312ce7fda0c59d5c9 Mon Sep 17 00:00:00 2001 From: Slavka Peleva Date: Fri, 1 Mar 2024 11:05:40 +0200 Subject: [PATCH 1/2] Language editting and added info links - Language editting and formatting. - Added links with additional information for StorPool and the StorPool plug-in --- source/installguide/configuration.rst | 109 +++++++++++++++++--------- 1 file changed, 74 insertions(+), 35 deletions(-) diff --git a/source/installguide/configuration.rst b/source/installguide/configuration.rst index de57b0b7b3..1322971665 100644 --- a/source/installguide/configuration.rst +++ b/source/installguide/configuration.rst @@ -1430,11 +1430,19 @@ 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 storage plug-in for CloudStack described here is part of + the standard installation for CloudStack versions 4.17.0.0 and newer. + 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. + In case you use a version before 4.17.0.0, you should install the + StorPool plug-in provided in the `StorPool CloudStack + `_ + repository. + +The StorPool plug-in is deeply integrated with CloudStack and works on with KVM +hypervisors. For more information on how you can accelerate your CloudStack +deployment using CloudStack and StorPool together, see `Primary CloudStack +storage `_. 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 @@ -1442,41 +1450,72 @@ 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 -across non-managed storage pools (e.g. NFS/Local storage/Ceph) to StorPool, and -across StorPool storage pools. +accross non-managed storage pools (e.g. NFS/Local storage/Ceph) to StorPool, and +accross StorPool storage pools. For more information about StorPool volumes, see +`Volumes and snapshots +`_. -More technical details could be found on `StorPool Knowledge Base `_. +The `createStoragePool `_ API has been augmented to support plugable storage +providers. -The createStoragePool API has been augmented to support pluggable 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, specified in the following format: - -SP_API_HTTP=address:port;SP_AUTH_TOKEN=token;SP_TEMPLATE=template_name - -- =[address of StorPool Api] -- =[StorPool's token] -- =[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 automatically 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 -================================= ==================================================================================================================================================================== +- 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, specified in +the following format: + +.. code-block:: console + + SP_API_HTTP=address:port;SP_AUTH_TOKEN=token;SP_TEMPLATE=template_name + +The details are as follows: + +- =[address of StorPool API] +- =[StorPool's token] +- =[name of StorPool's Template] + +For more information about these values, see +`Node configuration options +`_ +and `Templates `_. + +After adding StorPool as primary storage you can set the following parameters in +the Settings tab: + +sp.bypass.secondary.storage + For StorPool managed storage backup to secondary. + +sp.cluster.id + For StorPool multi cluster authorization (it will be set automatically 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. HPE Primera/3PAR Plug-in ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From c01d67c674ecfefeb6a36e7cbf3fbbeed7ee5803 Mon Sep 17 00:00:00 2001 From: Slavka Peleva Date: Thu, 28 Mar 2024 13:53:07 +0200 Subject: [PATCH 2/2] More refactoring and added link to StorPool documentation for CloudStack --- source/installguide/configuration.rst | 76 ++++----------------------- 1 file changed, 9 insertions(+), 67 deletions(-) diff --git a/source/installguide/configuration.rst b/source/installguide/configuration.rst index 1322971665..63c07f0bb0 100644 --- a/source/installguide/configuration.rst +++ b/source/installguide/configuration.rst @@ -1439,10 +1439,10 @@ StorPool Plug-in `_ repository. -The StorPool plug-in is deeply integrated with CloudStack and works on with KVM +The StorPool plug-in is deeply integrated with CloudStack and works with KVM hypervisors. For more information on how you can accelerate your CloudStack -deployment using CloudStack and StorPool together, see `Primary CloudStack -storage `_. +deployment using CloudStack and StorPool together, see the `StorPool +`_ site. 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 @@ -1451,71 +1451,13 @@ 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. For more information about StorPool volumes, see -`Volumes and snapshots -`_. +accross StorPool storage pools. -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, specified in -the following format: - -.. code-block:: console - - SP_API_HTTP=address:port;SP_AUTH_TOKEN=token;SP_TEMPLATE=template_name - -The details are as follows: - -- =[address of StorPool API] -- =[StorPool's token] -- =[name of StorPool's Template] - -For more information about these values, see -`Node configuration options -`_ -and `Templates `_. - -After adding StorPool as primary storage you can set the following parameters in -the Settings tab: - -sp.bypass.secondary.storage - For StorPool managed storage backup to secondary. - -sp.cluster.id - For StorPool multi cluster authorization (it will be set automatically 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. +For detailed information about *Command*, *Scope*, *Hypervisor*, and other +parameters you need to specify when setting up the StorPool plug-in, see the +`CloudStack integration +`_ +documentation. HPE Primera/3PAR Plug-in ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~