Merge pull request #64573 from apinnick/remove-pvc-api

Remove PVC API examples

Author: apinnick

_topic_maps/_topic_map.yml

@@ -3858,8 +3858,6 @@ Topics:
       File: virt-uploading-local-disk-images-block
     - Name: Managing virtual machine snapshots
       File: virt-managing-vm-snapshots
-    - Name: Moving a local virtual machine disk to a different node
-      File: virt-moving-local-vm-disk-to-different-node
     - Name: Expanding virtual storage by adding blank disk images
       File: virt-expanding-virtual-storage-with-blank-disk-images
     - Name: Cloning a data volume using smart-cloning

modules/virt-cloning-a-datavolume.adoc

@@ -4,56 +4,65 @@
 
 :_content-type: PROCEDURE
 [id="virt-cloning-a-datavolume_{context}"]
-= Cloning a data volume
+= Smart-cloning a PVC by using the command line
 
-.Prerequisites
+You can smart-clone a persistent volume claim (PVC) by using the command line to create a `DataVolume` object.
 
-For smart-cloning to occur, the following conditions are required:
+.Prerequisites
 
 * Your storage provider must support snapshots.
-* The source and target PVCs must be defined to the same storage class.
-* The source and target PVCs share the same *volumeMode*.
-* The `VolumeSnapshotClass` object must reference the storage class defined to both the source and target PVCs.
+* The source and target PVCs must have the same storage provider and volume mode.
+* The value of the `driver` key of the `VolumeSnapshotClass` object must match the value of the `provisioner` key of the `StorageClass` object as shown in the following example:
++
+.Example `VolumeSnapshotClass` object
+[source,yaml]
+----
+kind: VolumeSnapshotClass
+apiVersion: snapshot.storage.k8s.io/v1
+driver: openshift-storage.rbd.csi.ceph.com
+# ...
+----
++
+.Example `StorageClass` object
+[source,yaml]
+----
+kind: StorageClass
+apiVersion: storage.k8s.io/v1
+# ...
+provisioner: openshift-storage.rbd.csi.ceph.com
+----
 
 .Procedure
 
-To initiate cloning of a data volume:
-
-. Create a YAML file for a `DataVolume` object that specifies the name of the
-new data volume and the name and namespace of the source PVC. In this example, because you specify the *storage* API, there is no need to specify *accessModes* or *volumeMode*. The optimal values will be calculated for you automatically.
+. Create a YAML file for a `DataVolume` object as shown in the following example:
 +
 [source,yaml]
 ----
 apiVersion: cdi.kubevirt.io/v1beta1
 kind: DataVolume
 metadata:
-  name: <cloner-datavolume> <1>
+  name: <datavolume> <1>
 spec:
   source:
     pvc:
-      namespace: "<source-namespace>" <2>
-      name: "<my-favorite-vm-disk>" <3>
-  storage: <4>
-    resources:
-      requests:
-        storage: <2Gi> <5>
-----
-<1> The name of the new data volume.
-<2> The namespace where the source PVC exists.
-<3> The name of the source PVC.
-<4> Specifies allocation with the *storage* API
-<5> The size of the new data volume.
+      namespace: "<source_namespace>" <2>
+      name: "<my_vm_disk>" <3>
+  storage:
+    storageClassName: <storage_class> <4>
+----
+<1> Specify the name of the new data volume.
+<2> Specify the namespace of the source PVC.
+<3> Specify the name of the source PVC.
+<4> Optional: If the storage class is not specified, the default storage class is used.
 
-. Start cloning the PVC by creating the data volume:
+. Create the data volume by running the following command:
 +
 [source,terminal]
 ----
-$ oc create -f <cloner-datavolume>.yaml
+$ oc create -f <datavolume>.yaml
 ----
 +
 [NOTE]
 ====
-Data volumes prevent a virtual machine from starting before the PVC is prepared,
-so you can create a virtual machine that references the new data volume while the
-PVC clones.
+Data volumes prevent a virtual machine from starting before the PVC is prepared. You can create a virtual machine that references the new data volume while the PVC is being cloned.
 ====

modules/virt-cloning-local-volume-to-another-node.adoc

@@ -3,86 +3,53 @@
 // * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc
 // * virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-to-new-block-storage-pvc.adoc
 
-// `blockstorage` conditionals are used (declared in the "*-block" assembly) to separate content
-
 :_content-type: PROCEDURE
 [id="virt-cloning-pvc-of-vm-disk-into-new-datavolume_{context}"]
-= Cloning the persistent volume claim of a virtual machine disk into a new data volume
+= Cloning the PVC of a VM disk into a new data volume
 
-You can clone a persistent volume claim (PVC) of an existing virtual machine disk
+You can clone the persistent volume claim (PVC) of an existing (virtual machine) VM disk
 into a new data volume. The new data volume can then be used for a new virtual
 machine.
 
 [NOTE]
 ====
-When a data volume is created independently of a virtual machine, the lifecycle
-of the data volume is independent of the virtual machine. If the virtual machine
-is deleted, neither the data volume nor its associated PVC is deleted.
+When a data volume is created independently of a VM, the lifecycle of the data volume is independent of the VM. If the VM is deleted, neither the data volume nor its associated PVC is deleted.
 ====
 
 .Prerequisites
 
-* Determine the PVC of an existing virtual machine disk to use. You must power
-down the virtual machine that is associated with the PVC before you can clone it.
-* Install the OpenShift CLI (`oc`).
-ifdef::blockstorage[]
-* At least one available block persistent volume (PV) that is the same size as or larger than the source PVC.
-endif::[]
+* The VM must be stopped.
 
 .Procedure
 
-. Examine the virtual machine disk you want to clone to identify the name and
-namespace of the associated PVC.
-
-. Create a YAML file for a data volume that specifies the name of the
-new data volume, the name and namespace of the source PVC,
-ifdef::blockstorage[]
-`volumeMode: Block` so that an available block PV is used,
-endif::[]
-and the size of the new data volume.
-+
-For example:
+. Create a YAML file for a data volume as shown in the following example:
 +
 [source,yaml]
 ----
 apiVersion: cdi.kubevirt.io/v1beta1
 kind: DataVolume
 metadata:
-  name: <cloner-datavolume> <1>
+  name: <datavolume> <1>
 spec:
   source:
     pvc:
-      namespace: "<source-namespace>" <2>
-      name: "<my-favorite-vm-disk>" <3>
-  pvc:
-    accessModes:
-      - ReadWriteOnce
-    resources:
-      requests:
-        storage: <2Gi> <4>
-ifdef::blockstorage[]
-    volumeMode: Block <5>
-endif::[]
+      namespace: "<source_namespace>" <2>
+      name: "<my_vm_disk>" <3>
+  storage: {}
 ----
-<1> The name of the new data volume.
-<2> The namespace where the source PVC exists.
-<3> The name of the source PVC.
-<4> The size of the new data volume. You must allocate enough space, or the
-cloning operation fails. The size must be the same as or larger than the source PVC.
-ifdef::blockstorage[]
-<5> Specifies that the destination is a block PV
-endif::[]
+<1> Specify the name of the new data volume.
+<2> Specify the namespace of the source PVC.
+<3> Specify the name of the source PVC.
 
-. Start cloning the PVC by creating the data volume:
+. Create the data volume by running the following command:
 +
 [source,terminal]
 ----
-$ oc create -f <cloner-datavolume>.yaml
+$ oc create -f <datavolume>.yaml
 ----
 +
 [NOTE]
 ====
-Data volumes prevent a virtual machine from starting before the PVC is prepared,
-so you can create a virtual machine that references the new data volume while the
-PVC clones.
+Data volumes prevent a VM from starting before the PVC is prepared. You can create a VM that references the new data volume while the
+PVC is being cloned.
 ====

modules/virt-cloning-pvc-of-vm-disk-into-new-datavolume.adoc

@@ -6,38 +6,32 @@
 [id="virt-creating-an-upload-dv_{context}"]
 = Creating an upload data volume
 
-You can manually create a data volume with an `upload` data source to use for uploading
-local disk images.
+You can manually create a data volume with an `upload` data source to upload local disk images.
 
 .Procedure
 
-. Create a data volume configuration that specifies `spec: source: upload{}`:
+. Create a data volume configuration that specifies `upload` in the `spec.source` stanza:
 +
-
 [source,yaml]
 ----
 apiVersion: cdi.kubevirt.io/v1beta1
 kind: DataVolume
 metadata:
-  name: <upload-datavolume> <1>
+  name: <datavolume> <1>
 spec:
   source:
-      upload: {}
-  pvc:
-    accessModes:
-      - ReadWriteOnce
+    upload: {}
+  storage:
     resources:
       requests:
         storage: <2Gi> <2>
 ----
-<1> The name of the data volume.
-<2> The size of the data volume. Ensure that this value is greater than or equal
-to the size of the disk that you upload.
+<1> Specify the name of the new data volume.
+<2> Specify the amount of available space requested for the data volume. This value must be greater than or equal to the _virtual_ size of the disk that you upload.
 
 . Create the data volume by running the following command:
 +
-
 [source,terminal]
 ----
-$ oc create -f <upload-datavolume>.yaml
+$ oc create -f <datavolume>.yaml
 ----