Skip to content

Commit 9f6b34d

Browse files
committed
Language editting and added info links
- Language editting and formatting. - Added links with additional information for StorPool and the StorPool plug-in
1 parent b275541 commit 9f6b34d

File tree

1 file changed

+73
-34
lines changed

1 file changed

+73
-34
lines changed

source/installguide/configuration.rst

Lines changed: 73 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1412,11 +1412,19 @@ StorPool Plug-in
14121412
~~~~~~~~~~~~~~~~
14131413

14141414
.. note::
1415-
The StorPool storage plug-in for CloudStack is part of the standard
1416-
CloudStack install. There is no additional work required to add this
1417-
component.
1415+
The StorPool storage plug-in for CloudStack described here is part of
1416+
the standard installation for CloudStack versions 4.17.0.0 and newer.
1417+
There is no additional work required to add this component.
14181418

1419-
The StorPool plug-in is deeply integrated with CloudStack and works on with KVM hypervisors.
1419+
In case you use a version before 4.17.0.0, you should install the
1420+
StorPool plug-in provided in the `StorPool CloudStack
1421+
<https://github.com/storpool/storpool-cloudstack-integration/>`_
1422+
repository.
1423+
1424+
The StorPool plug-in is deeply integrated with CloudStack and works on with KVM
1425+
hypervisors. For more information on how you can accelerate your CloudStack
1426+
deployment using CloudStack and StorPool together, see `Primary CloudStack
1427+
storage <https://storpool.com/cloudstack>`_.
14201428

14211429
When used with service or disk offerings, an administrator is able to
14221430
build an environment in which a root or data disk that a user creates
@@ -1425,40 +1433,71 @@ performance. Such a StorPool volume is associated with one CloudStack volume,
14251433
so performance of the CloudStack volume does not vary depending on how
14261434
heavily other tenants are using the system. The volume migration is supported
14271435
accross non-managed storage pools (e.g. NFS/Local storage/Ceph) to StorPool, and
1428-
accross StorPool storage pools.
1436+
accross StorPool storage pools. For more information about StorPool volumes, see
1437+
`Volumes and snapshots
1438+
<https://kb.storpool.com/user_guides/user_guide.html#volumes-and-snapshots>`_.
14291439

1430-
More technical details could be found on `StorPool Knowledge Base <https://kb.storpool.com/>`_.
1440+
The `createStoragePool <https://cloudstack.apache.org/api/apidocs-4.19/apis/
1441+
createStoragePool.html>`_ API has been augmented to support plugable storage
1442+
providers.
14311443

1432-
The createStoragePool API has been augmented to support plugable storage providers.
14331444
The following is a list of parameters to use when adding storage to CloudStack that is based on the StorPool plug-in:
14341445

1435-
command=createStoragePool
1436-
scope=[zone]
1437-
zoneid=[your zone id]
1438-
hypervisor=KVM
1439-
name=[name for primary storage]
1440-
protocol=SharedMountPoint
1441-
provider=StorPool
1442-
capacityBytes=[used for accounting purposes only. May be more or less than the actual StorPool Template capacity]
1443-
url=[storage pool url]
1444-
The url parameter contains the StorPool storage pool details, specified in the following format:
1445-
1446-
SP_API_HTTP=address:port;SP_AUTH_TOKEN=token;SP_TEMPLATE=template_name
1447-
1448-
- <SP_API_HTTP>=[address of StorPool Api]
1449-
- <SP_AUTH_TOKEN>=[StorPool's token]
1450-
- <SP_TEMPLATE>=[name of StorPool's Template]
1451-
1452-
================================= ====================================================================================================================================================================
1453-
StorPool Configurations Description
1454-
================================= ====================================================================================================================================================================
1455-
sp.bypass.secondary.storage For StorPool Managed storage backup to secondary
1456-
sp.cluster.id For StorPool multi cluster authorization (It will be set automatically for each cluster)
1457-
sp.enable.alternative.endpoint Used for StorPool primary storage, defines if there is a need to be used alternative endpoint
1458-
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`
1459-
storpool.volume.tags.checkup Minimal interval (in seconds) to check and report if a StorPool volume created by CloudStack exists in CloudStack's database
1460-
storpool.snapshot.tags.checkup Minimal interval (in seconds) to check and report if a StorPool Snapshot created by CloudStack exists in CloudStack's database
1461-
================================= ====================================================================================================================================================================
1446+
- command=createStoragePool
1447+
- scope=[zone]
1448+
- zoneid=[your zone id]
1449+
- hypervisor=KVM
1450+
- name=[name for primary storage]
1451+
- protocol=SharedMountPoint
1452+
- provider=StorPool
1453+
- capacityBytes=[used for accounting purposes only. May be more or less than
1454+
the actual StorPool Template capacity]
1455+
- url=[storage pool url]
1456+
1457+
The ``url`` parameter contains the StorPool storage pool details, specified in
1458+
the following format:
1459+
1460+
.. code-block:: console
1461+
1462+
SP_API_HTTP=address:port;SP_AUTH_TOKEN=token;SP_TEMPLATE=template_name
1463+
1464+
The details are as follows:
1465+
1466+
- <SP_API_HTTP>=[address of StorPool API]
1467+
- <SP_AUTH_TOKEN>=[StorPool's token]
1468+
- <SP_TEMPLATE>=[name of StorPool's Template]
1469+
1470+
For more information about these values, see
1471+
`Node configuration options
1472+
<https://kb.storpool.com/user_guides/user_guide.html#node-configuration-options>`_
1473+
and `Templates <https://kb.storpool.com/user_guides/user_guide.html#templates>`_.
1474+
1475+
After adding StorPool as primary storage you can set the following parameters in
1476+
the Settings tab:
1477+
1478+
sp.bypass.secondary.storage
1479+
For StorPool managed storage backup to secondary.
1480+
1481+
sp.cluster.id
1482+
For StorPool multi cluster authorization (it will be set automatically for
1483+
each cluster).
1484+
1485+
sp.enable.alternative.endpoint
1486+
Used for StorPool primary storage, defines if there is a need to be used
1487+
alternative endpoint.
1488+
1489+
sp.alternative.endpoint
1490+
Used for StorPool primary storage for an alternative endpoint. Structure of
1491+
the endpoint is `SP_API_HTTP=address:port; SP_AUTH_TOKEN=token;
1492+
SP_TEMPLATE=template_name`.
1493+
1494+
storpool.volume.tags.checkup
1495+
Minimal interval (in seconds) to check and report if a StorPool volume
1496+
created by CloudStack exists in CloudStack's database.
1497+
1498+
storpool.snapshot.tags.checkup
1499+
Minimal interval (in seconds) to check and report if a StorPool Snapshot
1500+
created by CloudStack exists in CloudStack's database.
14621501

14631502
HPE Primera/3PAR Plug-in
14641503
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)