OSDOCS-1720-bugs fixes

Author: Bob

modules/persistent-storage-csi-drivers-supported.adoc

@@ -0,0 +1,29 @@
+// Module included in the following assemblies:
+//
+// * storage/container_storage_interface/persistent-storage-csi.adoc
+
+[id="csi-drivers-supported_{context}"]
+= CSI drivers supported by {product-title}
+
+{product-title} installs certain CSI drivers by default, giving users storage options that are not possible with in-tree volume plug-ins.
+
+To create CSI-provisioned persistent volumes that mount to these supported storage assets, {product-title} installs the necessary CSI driver Operator, the CSI driver, and the required storage class by default. For more details about the default namespace of the Operator and driver, see the documentation for the specific CSI Driver Operator.
+
+The following table describes the CSI drivers that are installed with {product-title} and which CSI features they support, such as volume snapshots, cloning, and resize.
+
+.Supported CSI drivers and features in {product-title}
+[cols=",^v,^v,^v, width="100%",options="header"]
+|===
+|CSI driver  |CSI volume snapshots  |CSI cloning  |CSI resize
+
+|AWS EBS (Tech Preview) | ✅ | - | ✅
+|Google Cloud Platform (GCP) persistent disk (PD) (Tech Preview)| ✅ | - | ✅
+|OpenStack Cinder | ✅ | ✅ | ✅
+|OpenStack Manila | ✅ | ✅ | ✅
+|Red Hat Virtualization (oVirt) | - | - | -
+|===
+
+[IMPORTANT]
+====
+If your CSI driver is not listed in the preceding table, you must follow the installation instructions provided by your CSI storage vendor to use their supported CSI features.
+====

modules/persistent-storage-csi-snapshots-create.adoc

@@ -36,7 +36,6 @@ metadata:
 driver: hostpath.csi.k8s.io
 deletionPolicy: Delete
 ----
-<1> Allows you to specify different attributes belonging to a volume snapshot.
 
 +
 . Create the object you saved in the previous step by entering the following command:
@@ -62,8 +61,7 @@ spec:
     persistentVolumeClaimName: myclaim <2>
 ----
 +
-<1> The request for a particular class by the volume snapshot. If `volumeSnapshotClassName` is empty, then no snapshot is created.
-
+<1> The request for a particular class by the volume snapshot. If the `volumeSnapshotClassName` setting is absent and there is a default volume snapshot class, a snapshot is created with the default volume snapshot class name. But if the field is absent and no default volume snapshot class exists, then no snapshot is created.
 +
 <2> The name of the `PersistentVolumeClaim` object bound to a persistent volume. This defines what you want to create a snapshot of. Required for dynamically provisioning a snapshot.
 

modules/persistent-storage-csi-snapshots-delete.adoc

@@ -14,7 +14,7 @@ To enable deletion of a volume snapshot in a cluster:
 . Specify the deletion policy that you require in the `VolumeSnapshotClass` object, as shown in the following example:
 
 +
-.volumesnapshot.yaml
+.volumesnapshotclass.yaml
 [source,yaml]
 ----
 apiVersion: snapshot.storage.k8s.io/v1

modules/persistent-storage-csi-snapshots-operator.adoc

@@ -7,24 +7,25 @@
 
 The CSI Snapshot Controller Operator runs in the `openshift-cluster-storage-operator` namespace. It is installed by the Cluster Version Operator (CVO) in all clusters by default.
 
-The CSI Snapshot Controller Operator installs the CSI snapshot controller, which runs in the `csi-snapshot-controller` namespace.
+The CSI Snapshot Controller Operator installs the CSI snapshot controller, which runs in the `openshift-cluster-storage-operator` namespace.
 
 == Volume snapshot CRDs
 
 During {product-title} installation, the CSI Snapshot Controller Operator creates the following snapshot custom resource definitions (CRDs) in the `snapshot.storage.k8s.io/v1` API group:
 
 `VolumeSnapshotContent`::
+
 A snapshot taken of a volume in the cluster that has been provisioned by a cluster administrator.
 +
-Similar to the `PersistentVolume` CRD, the `VolumeSnapshotContent` CRD is a cluster resource that points to a real snapshot in the storage back end.
+Similar to the `PersistentVolume` object, the `VolumeSnapshotContent` CRD is a cluster resource that points to a real snapshot in the storage back end.
 +
-For manually pre-provisioned snapshots, a cluster administrator creates a number of `VolumeSnapshotContent` objects. These carry the details of the real volume snapshot in the storage system.
+For manually pre-provisioned snapshots, a cluster administrator creates a number of `VolumeSnapshotContent` CRDs. These carry the details of the real volume snapshot in the storage system.
 +
 The `VolumeSnapshotContent` CRD is not namespaced and is for use by a cluster administrator.
 
 `VolumeSnapshot`::
 
-Similar to the `PersistentVolumeClaim` CRD, the `VolumeSnapshot` CRD defines a developer request for a snapshot. The CSI Snapshot Controller Operator runs the CSI snapshot controller, which handles the binding of a `VolumeSnapshot` object with an appropriate `VolumeSnapshotContent` object. The binding is a one-to-one mapping.
+Similar to the `PersistentVolumeClaim` object, the `VolumeSnapshot` CRD defines a developer request for a snapshot. The CSI Snapshot Controller Operator runs the CSI snapshot controller, which handles the binding of a `VolumeSnapshot` CRD with an appropriate `VolumeSnapshotContent` CRD. The binding is a one-to-one mapping.
 +
 The `VolumeSnapshot` CRD is namespaced. A developer uses the CRD as a distinct request for a snapshot.
 

modules/persistent-storage-csi-snapshots-overview.adoc

@@ -26,7 +26,7 @@ With CSI volume snapshots, an app developer can:
 Be aware of the following when using volume snapshots:
 
 * Support is only available for CSI drivers. In-tree and FlexVolumes are not supported.
-* {product-title} does not ship with any CSI drivers. It is recommended to use the CSI drivers provided by
+* {product-title} only ships with select CSI drivers. For CSI drivers that are not provided by an {product-title} Driver Operator, it is recommended to use the CSI drivers provided by
 link:https://kubernetes-csi.github.io/docs/drivers.html[community or storage vendors]. Follow the installation instructions provided by the CSI driver.
 * CSI drivers may or may not have implemented the volume snapshot functionality. CSI drivers that have provided support for volume snapshots will likely use the `csi-external-snapshotter` sidecar. See documentation provided by the CSI driver for details.
 * {product-title} {product-version} supports version 1.1.0 of the link:https://github.com/container-storage-interface/spec[CSI specification].

modules/persistent-storage-csi-snapshots-restore.adoc

@@ -5,14 +5,14 @@
 [id="persistent-storage-csi-snapshots-restore_{context}"]
 = Restoring a volume snapshot
 
-After your `VolumeSnapshot` object is bound, you can use that object to provision a new volume that is pre-populated with data from the snapshot.
-
-The volume snapshot content object is used to restore the existing volume to a previous state.
+The `VolumeSnapshot` CRD content can be used to restore the existing volume to a previous state.
 
+After your `VolumeSnapshot` CRD is bound and the `readyToUse` value is set to `true`, you can use that resource to provision a new volume that is pre-populated with data from the snapshot.
 .Prerequisites
 * Logged in to a running {product-title} cluster.
 * A persistent volume claim (PVC) created using a Container Storage Interface (CSI) driver that supports volume snapshots.
 * A storage class to provision the storage back end.
+* A volume snapshot has been created and is ready to use.
 
 .Procedure
 
@@ -57,4 +57,4 @@ $ oc create -f pvc-restore.yaml
 $ oc get pvc
 ----
 +
-Two different PVCs are displayed.
+A new PVC such as `myclaim-restore` is displayed.

storage/container_storage_interface/persistent-storage-csi.adoc

@@ -26,6 +26,8 @@ include::modules/persistent-storage-csi-external-controllers.adoc[leveloffset=+2
 
 include::modules/persistent-storage-csi-driver-daemonset.adoc[leveloffset=+2]
 
+include::modules/persistent-storage-csi-drivers-supported.adoc[leveloffset=+1]
+
 include::modules/persistent-storage-csi-dynamic-provisioning.adoc[leveloffset=+1]
 
 include::modules/persistent-storage-csi-mysql-example.adoc[leveloffset=+1]