Skip to content

Commit 46efdc7

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 717903c commit 46efdc7

File tree

1 file changed

+74
-35
lines changed

1 file changed

+74
-35
lines changed

source/installguide/configuration.rst

Lines changed: 74 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1430,53 +1430,92 @@ StorPool Plug-in
14301430
~~~~~~~~~~~~~~~~
14311431

14321432
.. note::
1433-
The StorPool storage plug-in for CloudStack is part of the standard
1434-
CloudStack install. There is no additional work required to add this
1435-
component.
1433+
The StorPool storage plug-in for CloudStack described here is part of
1434+
the standard installation for CloudStack versions 4.17.0.0 and newer.
1435+
There is no additional work required to add this component.
14361436

1437-
The StorPool plug-in is deeply integrated with CloudStack and works on with KVM hypervisors.
1437+
In case you use a version before 4.17.0.0, you should install the
1438+
StorPool plug-in provided in the `StorPool CloudStack
1439+
<https://github.com/storpool/storpool-cloudstack-integration/>`_
1440+
repository.
1441+
1442+
The StorPool plug-in is deeply integrated with CloudStack and works on with KVM
1443+
hypervisors. For more information on how you can accelerate your CloudStack
1444+
deployment using CloudStack and StorPool together, see `Primary CloudStack
1445+
storage <https://storpool.com/cloudstack>`_.
14381446

14391447
When used with service or disk offerings, an administrator is able to
14401448
build an environment in which a root or data disk that a user creates
14411449
leads to the dynamic creation of a StorPool volume, which has guaranteed
14421450
performance. Such a StorPool volume is associated with one CloudStack volume,
14431451
so performance of the CloudStack volume does not vary depending on how
14441452
heavily other tenants are using the system. The volume migration is supported
1445-
across non-managed storage pools (e.g. NFS/Local storage/Ceph) to StorPool, and
1446-
across StorPool storage pools.
1453+
accross non-managed storage pools (e.g. NFS/Local storage/Ceph) to StorPool, and
1454+
accross StorPool storage pools. For more information about StorPool volumes, see
1455+
`Volumes and snapshots
1456+
<https://kb.storpool.com/user_guides/user_guide.html#volumes-and-snapshots>`_.
14471457

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

1450-
The createStoragePool API has been augmented to support pluggable storage providers.
14511462
The following is a list of parameters to use when adding storage to CloudStack that is based on the StorPool plug-in:
14521463

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

14811520
HPE Primera/3PAR Plug-in
14821521
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)