Docs release 1.8.0 CSI 3512 svc space efficiency updates (#411)

* CSI-3512 initial content update

* various typo updates

* updated to indicate deduplicated deprecation

per #411 (comment)

docs/content/configuration/creating_volumesnapshotclass.md

@@ -10,7 +10,7 @@ When configuring the file, be sure to use the same array secret and array secret
 
 -   The `snapshot_name_prefix` parameter is optional.
 
-    **Note:** For IBM DS8000® Family, the maximum prefix length is five characters.<br/>The maximum prefix length for other systems is 20 characters.<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.<br/>The maximum prefix length for other systems is 20 characters.<br/>For storage systems that use Spectrum Virtualize, the `CSI` prefix is added as default if not specified by the user.
 
 -   The `pool` parameter is not available on IBM FlashSystem A9000 and A9000R storage systems. For these storage systems, the snapshot must be created on the same pool as the source.
 

docs/content/configuration/creating_volumestrorageclass.md

@@ -19,10 +19,10 @@ _<a name=spaceefficiency>**Table:**</a> `SpaceEfficiency` parameter definitions
 |Storage system type|SpaceEfficiency parameter options|
 |-------------------|---------------------------------|
 |IBM FlashSystem® A9000 and A9000R|Always includes deduplication and compression. No need to specify during configuration.|
-|IBM Spectrum® Virtualize Family|- `thick` (default value)<br />- `thin`<br />- `compressed`<br />- `deduplicated` <br /><br /> **Note:** If not specified, the default value is thick.|
-|IBM® DS8000® Family| - `none` (default value) <br />- `thin`<br /><br /> **Note:** If not specified, the default value is `none`.|
+|IBM Spectrum® Virtualize family|- `thick` (default value)<br />- `thin`<br />- `compressed`<br />- `dedup_thin` (creates volumes that are deduplicated with thin-provisioning)<br />- `dedup_compressed` (creates deduplicated and compressed volumes)<br />- `deduplicated` (creates deduplicated and compressed volumes, like `dedup_compressed`)<br /><br /> **Note:** <br />- The `deduplicated` value is deprecated. Use `dedup_compressed`, if possible.<br />- If not specified, the default value is `thick`.|
+|IBM® DS8000® family| - `none` (default value) <br />- `thin`<br /><br /> **Note:** If not specified, the default value is `none`.|
 
-- The IBM DS8000 Family `pool` value is the pool ID and not the pool name as is used in other storage systems.
+- 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:
 
@@ -40,7 +40,7 @@ _<a name=spaceefficiency>**Table:**</a> `SpaceEfficiency` parameter definitions
 - 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 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.
+  **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/configuration/importing_existing_volume.md

@@ -8,7 +8,7 @@ Before starting to import an existing volume, find the following information in
 
   Including:
 
-    - `pool_name`: _Name of Pool where volume is located_ (Listed as `pool_id` for DS8000® Family systems.)
+    - `pool_name`: _Name of Pool where volume is located_ (Listed as `pool_id` for DS8000® family systems.)
     - `storage_type`: <`SVC` | `A9000` | `DS8K`>
     - `volume_name`: _Volume name_
     - `array_address`: _Array address_
@@ -60,7 +60,7 @@ To find the `volumeHandle`, use one of the following procedures:
 
     For more information, see [IBM Hyper-Scale Manager documentation](https://www.ibm.com/docs/en/hyper-scale-manager/).
 
-- **For DS8000 Family:**
+- **For DS8000 family:**
 
   The `volumeHandle` is formatted as `DS8K:id;GUID`.
   The `id` is the last four digits of the `GUID`.
@@ -81,7 +81,7 @@ To find the `volumeHandle`, use one of the following procedures:
 
         The Properties window is displayed. Use the **GUID** value.
 
-    For more information about DS8000 Family products, find your product information in [IBM Documentation](https://www.ibm.com/docs/).
+    For more information about DS8000 family products, find your product information in [IBM Documentation](https://www.ibm.com/docs/).
 
 
 Use this procedure to help build a PV YAML file for your volumes.

docs/content/installation/install_compatibility_requirements.md

@@ -17,11 +17,11 @@ For IBM Cloud® Satellite users, see [cloud.ibm.com/docs/satellite](https://clou
 
         Port 7778
 
-    -   **IBM Spectrum® Virtualize Family includes IBM® SAN Volume Controller and IBM FlashSystem® family members that are built with IBM Spectrum® Virtualize (including FlashSystem 5xxx, 7200, 9100, 9200, 9200R)**
+    -   **IBM Spectrum® Virtualize family includes IBM® SAN Volume Controller and IBM FlashSystem® family members that are built with IBM Spectrum® Virtualize (including FlashSystem 5xxx, 7200, 9100, 9200, 9200R)**
 
         Port 22
 
-    -   **DS8000® Family systems**
+    -   **DS8000® family systems**
 
         Port 8452
 

docs/content/release_notes/changelog_1.1.0.md

@@ -2,7 +2,7 @@
 
 IBM® block storage CSI driver 1.1.0 provided a range of enhancements:
 
--   Added support for DS8000® Family storage systems
+-   Added support for DS8000® family storage systems
 -   RHCOS support
 -   Now supports Kubernetes 1.16 and Red Hat® OpenShift® 4.3
 -   IBM Z® architecture support

docs/content/release_notes/changelog_1.4.0.md

@@ -10,7 +10,7 @@ IBM® block storage CSI driver 1.4.0 provided a range of enhancements and resolv
 |Ticket ID|Severity|Description|
 |---------|--------|-----------|
 |**CSI-2156**|Service|**Fixed:** IBM block storage driver node registration may encounter an error when the `node_id` exceeds 128 bytes.|
-|**CSI-1842**|Service|**Fixed:** When creating a new volume on a DS8000® Family storage system, if an error occurs during PersistentVolumeClaim (PVC) attachment, the attachment retry may fail.|
+|**CSI-1842**|Service|**Fixed:** When creating a new volume on a DS8000® family storage system, if an error occurs during PersistentVolumeClaim (PVC) attachment, the attachment retry may fail.|
 |**CSI-645**|Low|**Fixed:** In some cases, during high-scale operations, such as pod creation with many PersistentVolumeClaims (PVCs), the "ibm-block-csi-controller-0" controller pod restarts.|
 
 

docs/content/release_notes/changelog_1.8.0.md

@@ -3,4 +3,5 @@
 IBM® block storage CSI driver 1.8.0 adds new support and enhancements:
 - Now supports HyperSwap for IBM Spectrum Virtualize family storage systems
 - New NVMe/FC support
+- Increased StorageClass `SpaceEfficiency` parameter capabilities
 - Additional support for Kubernetes 1.23

docs/content/release_notes/limitations.md

@@ -4,14 +4,14 @@ As opposed to known issues, limitations are functionality restrictions that are
 
 ## IBM® DS8000® usage limitations
 
-Connectivity limits on the storage side might be reached with DS8000 Family products due to too many open connections. This occurs due to connection closing lag times from the storage side.
+Connectivity limits on the storage side might be reached with DS8000 family products due to too many open connections. This occurs due to connection closing lag times from the storage side.
 
 ## Volume snapshot limitations
 
 The following limitations apply when using volume snapshots with the IBM block storage CSI driver:
 
 -   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.
+-   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).
 
@@ -31,7 +31,7 @@ The following limitations apply when using volume clones with the IBM block stor
 
 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 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 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.
 

docs/content/release_notes/supported_orchestration.md

@@ -9,7 +9,7 @@ The following table details orchestration platforms suitable for deployment of t
 |Red Hat OpenShift|4.8|x86, IBM Z, IBM Power Systems<sup>1</sup>|
 |Red Hat OpenShift|4.9|x86, IBM Z, IBM Power Systems<sup>1</sup>|
 
-<sup>1</sup>IBM Power Systems architecture is only supported on Spectrum Virtualize and DS8000 Family storage systems.
+<sup>1</sup>IBM Power Systems architecture is only supported on Spectrum Virtualize and DS8000 family storage systems.
 
 **Note:** 
 - As of this document's publication date, IBM Cloud® Satellite only supports RHEL 7 on x86 architecture for Red Hat OpenShift. For the latest support information, see [cloud.ibm.com/docs/satellite](https://cloud.ibm.com/docs/satellite).

docs/content/release_notes/supported_os.md

@@ -7,7 +7,7 @@ The following table lists operating systems required for deployment of the IBM®
 |Red Hat® Enterprise Linux® (RHEL) 7.x|x86, IBM Z®|
 |Red Hat Enterprise Linux CoreOS (RHCOS)|x86, IBM Z, IBM Power Systems™<sup>1</sup>|
 
-<sup>1</sup>IBM Power Systems architecture is only supported on Spectrum Virtualize and DS8000 Family storage systems.
+<sup>1</sup>IBM Power Systems architecture is only supported on Spectrum Virtualize and DS8000 family storage systems.
 
 **Note:** For the latest operating system support information, see the [Lifecycle and support matrix](https://www.ibm.com/docs/en/stg-block-csi-driver?topic=SSRQ8T/landing/csi_lifecycle_support_matrix.html).
 

docs/content/release_notes/supported_storage.md

@@ -6,9 +6,9 @@ IBM® block storage CSI driver 1.8.0 supports different IBM storage systems as l
 |--------------|-----------------|
 |IBM FlashSystem™ A9000|12.3.0.a or later|
 |IBM FlashSystem A9000R|12.3.0.a or later|
-|IBM Spectrum Virtualize™ Family including IBM SAN Volume Controller (SVC) and IBM FlashSystem® family members built with IBM Spectrum® Virtualize (including FlashSystem 5xxx, 7200, 9100, 9200, 9200R)|7.8 and above, 8.x|
+|IBM Spectrum Virtualize™ family including IBM SAN Volume Controller (SVC) and IBM FlashSystem® family members built with IBM Spectrum® Virtualize (including FlashSystem 5xxx, 7200, 9100, 9200, 9200R)|7.8 and above, 8.x|
 |IBM Spectrum Virtualize as software only|7.8 and above, 8.x|
-|IBM DS8000® Family|8.x and higher with same API interface|
+|IBM DS8000® family|8.x and higher with same API interface|
 
 **Note:**
 

docs/content/release_notes/whats_new.md

@@ -12,6 +12,10 @@ IBM® block storage CSI driver 1.8.0 now supports HyperSwap implementation, when
 
 This version adds NVMe/FC support for supported IBM Spectrum Virtualize family storage systems using Red Hat® Enterprise Linux® (RHEL) operating systems. 
 
+## Increased StorageClass `SpaceEfficiency` parameter capabilities
+
+Version 1.8.0 increases the `SpaceEfficiency` deduplication parameter options for IBM Spectrum Virtualize family storage systems. For more information, see [Creating a StorageClass](../content/configuration/creating_volumestrorageclass.md).
+
 ## 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/using/sample_stateful_container.md

@@ -14,7 +14,7 @@ Use this information to run a stateful container on StatefulSet volumes using ei
 
     **Remember:** The `SpaceEfficiency` values for Spectrum Virtualize family are: `thick`, `thin`, `compressed`, or `deduplicated`. These values are not case specific.
 
-    For DS8000 Family systems, the default value is `none`, but can be set to `thin`, if required. These values are not case specific. For more information, see [Creating a StorageClass](../configuration/creating_volumestrorageclass.md).
+    For DS8000 family systems, the default value is `none`, but can be set to `thin`, if required. These values are not case specific. For more information, see [Creating a StorageClass](../configuration/creating_volumestrorageclass.md).
 
     This parameter is not applicable for IBM FlashSystem A9000 and A9000R systems. These systems always include deduplication and compression.