CSI-3242: HyperSwap feature updates (#397)

* CSI-3242: initial input of HyperSwap information

* remove volume replication from whatsnew

* whatsnew update for version

* what's new updates

* removed extra spaces (general)

* removed HyperSwap limitations for everything except cloning

per #397 (comment)

* Additional HyperSwap prereqs

per #397 (comment)

* updated linking

* added back in hyperswap with snapshot limitation

per #397 (comment)

* updated wording of hyperswap limitation note for clarification

* clarified hyperswap wording

per #397 (comment)

* updated slashes for pathing

* updated typos

docs/content/configuration/csi_ug_config_create_storageclasses.md

@@ -24,14 +24,23 @@ _<a name=spaceefficiency>**Table:**</a> `SpaceEfficiency` parameter definitions
 
 - The IBM DS8000 Family `pool` value is the pool ID and not the pool name as is used in other storage systems.
 - Be sure that the `pool` value is the name of an existing pool on the storage system.
+- To create a volume with HyperSwap on IBM Spectrum Virtualize storage systems, put a colon (:) between the two pools within the `pool` value. For example:
+
+  ```
+  pool: demo-pool1:demo-pool2 
+  ```
+   **Important:** The two pools must be from different sites.
+
+  For more information about the HyperSwap limitations and requirements, see [Limitations](../release_notes/csi_rn_limitations.md) within the release notes and [Compatibility and requirements](../installation/csi_ug_requirements.md) within this guide.
+
 - The `allowVolumeExpansion` parameter is optional but is necessary for using volume expansion. The default value is _false_.
 
 **Note:** Be sure to set the value to true to allow volume expansion.
 
 - The `csi.storage.k8s.io/fstype` parameter is optional. The values that are allowed are _ext4_ or _xfs_. The default value is _ext4_.
 - The `volume_name_prefix` parameter is optional.
 
-**Note:** For IBM DS8000 Family, the maximum prefix length is 5 characters. The maximum prefix length for other systems is 20 characters. <br /><br />For storage systems that use Spectrum Virtualize, the `CSI` prefix is added as default if not specified by the user.
+**Note:** For IBM DS8000 Family, the maximum prefix length is five characters. The maximum prefix length for other systems is 20 characters. <br /><br />For storage systems that use Spectrum Virtualize, the `CSI` prefix is added as default if not specified by the user.
 
 
     kind: StorageClass

docs/content/installation/csi_ug_requirements.md

@@ -94,4 +94,6 @@ Complete these steps for each worker node in Kubernetes cluster to prepare your
       
       **Important:** This label-prefix must be found on the nodes in the cluster **before** installing the IBM® block storage CSI driver. If the nodes do not have the proper label-prefix before installation, CSI Topology cannot be used with the CSI driver.
 
-      For more information, see [Configuring for CSI Topology](../configuration/csi_ug_config_topology.md).
+      For more information, see [Configuring for CSI Topology](../configuration/csi_ug_config_topology.md).
+
+7. (Optional) If planning on using HyperSwap on your storage system, see the following section within your Spectrum Virtualize product documentation on [IBM Documentation](https://www.ibm.com/docs/en/): **Planning** > **Planning for high availability** > **Planning for a HyperSwap topology system**.

docs/content/release_notes/csi_rn_limitations.md

@@ -13,6 +13,8 @@ The following limitations apply when using volume snapshots with the IBM block s
 -   When deleting a PersistentVolumeClaim (PVC), the persistent volume (PV) remains until all snapshots of the specific PV are deleted.
 -   When using the CSI (Container Storage Interface) driver with IBM Spectrum® Virtualize Family products, a snapshot can only be used to provision a new volume of equal size.
 
+**Note:** For volume snapshot limitations pertaining specifically to HyperSwap usage, see [HyperSwap usage limitations](#hyperSwap-usage-limitations).
+
 ## Volume clone limitations
 
 The following limitations apply when using volume clones with the IBM block storage CSI driver:
@@ -23,13 +25,15 @@ The following limitations apply when using volume clones with the IBM block stor
 
 -   A PVC and its clone need to both have the same volume mode (**Filesystem** or **Block**).
 
+**Note:** For volume clone limitations pertaining specifically to HyperSwap usage, see [HyperSwap usage limitations](#hyperSwap-usage-limitations).
+
 ## Volume expansion limitations
 
 The following limitations apply when expanding volumes with the IBM block storage CSI driver:
 
 -   When using the CSI driver with IBM Spectrum Virtualize Family and IBM DS8000 Family products, during size expansion of a PersistentVolumeClaim (PVC), the size remains until all snapshots of the specific PVC are deleted.
 -   When expanding a PVC while not in use by a pod, the volume size immediately increases on the storage side. However, PVC size only increases after a pod uses the PVC.
--   When expanding a filesystem PVC for a volume that was previously formatted but is now no longer being used by a pod, any copy or replication operations performed on the PVC (such as snapshots or cloning) results in a copy with the newer, larger, size on the storage. However, its filesystem has the original, smaller, size.
+-   When expanding a file system PVC for a volume that was previously formatted but is now no longer being used by a pod, any copy or replication operations performed on the PVC (such as snapshots or cloning) results in a copy with the newer, larger, size on the storage. However, its file system has the original, smaller, size.
 
 ## Volume replication limitations
 
@@ -41,4 +45,15 @@ When a role switch is conducted, this is not reflected within the other orchestr
  2. Delete the relevant PersistentVolumes.
  3. Import the volumes, by using the latest import procedure (version 1.7.0 or later) (see **CSI driver configuration** > **Advanced configuration** > **Importing an existing volume** in the user information).
 
-    For more information, see the [Change the Reclaim Policy of a PersistentVolume](https://kubernetes.io/docs/tasks/administer-cluster/change-pv-reclaim-policy/) information in the Kubernetes documentation.
+    For more information, see the [Change the Reclaim Policy of a PersistentVolume](https://kubernetes.io/docs/tasks/administer-cluster/change-pv-reclaim-policy/) information in the Kubernetes documentation.
+
+## HyperSwap usage limitations
+
+**Important:** The HyperSwap feature is only supported for use with IBM Spectrum Virtualize Family storage systems.
+
+The following IBM block storage CSI driver features are not supported on volumes where HyperSwap is used:
+
+- A HyperSwap volume cannot be created from a snapshot.
+
+    **Note:** A snapshot can be created from a HyperSwap volume.
+ - Volume cloning.

docs/content/release_notes/csi_rn_whatsnew.md

@@ -4,9 +4,10 @@ IBM® block storage CSI driver 1.8.0 introduces the enhancements that are detail
 
 **General availability date:** 30 December 2021
 
-## Additional support for Kubernetes 1.23 orchestration platforms for deployment
-
-This version adds support for orchestration platform Kubernetes 1.23, suitable for deployment of the CSI (Container Storage Interface) driver.
+## New HyperSwap support for IBM Spectrum Virtualize Family storage systems
 
+IBM® block storage CSI driver 1.8.0 now supports HyperSwap implementation, when using IBM Spectrum Virtualize Family storage systems.
 
+## Additional support for Kubernetes 1.23 orchestration platforms for deployment
 
+This version adds support for orchestration platform Kubernetes 1.23, suitable for deployment of the CSI (Container Storage Interface) driver.

docs/content/troubleshooting/csi_ug_troubleshooting_misc.md

@@ -2,7 +2,7 @@
 
 Use this information to help pinpoint potential causes for stateful pod failure.
 
-**Note:** These procedures are applicable for both Kubernetes and Red Hat® OpenShift®. For Red Hat OpenShift, replace   `kubectl`  with `oc` in all relevant commands.
+**Note:** These procedures are applicable for both Kubernetes and Red Hat® OpenShift®. For Red Hat OpenShift, replace `kubectl` with `oc` in all relevant commands.
 
 ## General troubleshooting
 Use the following command for general troubleshooting: