CNV-10283: CDI customizations in HCO

Author: ousleyp

modules/virt-about-cpu-and-memory-quota-namespace.adoc

@@ -7,5 +7,5 @@
 
 A _resource quota_, defined by the `ResourceQuota` object, imposes restrictions on a namespace that limit the total amount of compute resources that can be consumed by resources within that namespace.
 
-The `CDI` object defines the user configuration for the Containerized Data Importer (CDI). The CPU and memory request and limit values for the `CDI` object are set to a default value of 0.
+The `HyperConverged` custom resource (CR) defines the user configuration for the Containerized Data Importer (CDI). The CPU and memory request and limit values are set to a default value of `0`.
 This ensures that pods created by CDI that do not specify compute resource requirements are given the default values and are allowed to run in a namespace that is restricted with a quota.

modules/virt-defining-storageclass-in-cdi.adoc

@@ -0,0 +1,36 @@
+// Module included in the following assemblies:
+//
+// * virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc
+
+[id="virt-defining-storageclass_{context}"]
+= Defining a storage class
+
+You can define the storage class that the Containerized Data Importer (CDI) uses when allocating scratch space by adding the `spec.scratchSpaceStorageClass` field to the `HyperConverged` custom resource (CR).
+
+.Prerequisites
+
+* Install the OpenShift client (`oc`).
+
+.Procedure
+
+. Edit the `HyperConverged` CR by running the following command:
++
+[source,terminal]
+----
+$ oc edit hco -n openshift-cnv kubevirt-hyperconverged
+----
+
+. Add the `spec.scratchSpaceStorageClass` field to the CR, setting the value to the name of a storage class that exists in the cluster:
++
+[source,yaml]
+----
+apiVersion: hco.kubevirt.io/v1beta1
+kind: HyperConverged
+metadata:
+  name: kubevirt-hyperconverged
+spec:
+  scratchSpaceStorageClass: "<storage_class>" <1>
+----
+<1> If you do not specify a storage class, CDI uses the storage class of the persistent volume claim that is being populated.
+
+. Save and exit your default editor to update the `HyperConverged` CR.

modules/virt-defining-storageclass.adoc

@@ -0,0 +1,42 @@
+// Module included in the following assemblies:
+//
+// * virt/virtual_machines/virtual_disks/virt-configuring-cdi-for-namespace-resourcequota.adoc
+
+[id="virt-overriding-cpu-and-memory-defaults_{context}"]
+= Overriding CPU and memory defaults
+
+Modify the default settings for CPU and memory requests and limits for your use case by adding the `spec.resourceRequirements.storageWorkloads` stanza to the `HyperConverged` custom resource (CR).
+
+.Prerequisites
+
+* Install the OpenShift CLI (`oc`).
+
+.Procedure
+
+. Edit the `HyperConverged` CR by running the following command:
++
+[source,terminal]
+----
+$ oc edit hco -n openshift-cnv kubevirt-hyperconverged
+----
+
+. Add the `spec.resourceRequirements.storageWorkloads` stanza to the CR, setting the values based on your use case. For example:
++
+[source,yaml]
+----
+apiVersion: hco.kubevirt.io/v1beta1
+kind: HyperConverged
+metadata:
+  name: kubevirt-hyperconverged
+spec:
+  resourceRequirements:
+    storageWorkloads:
+      limits:
+        cpu: "500m"
+        memory: "2Gi"
+      requests:
+        cpu: "250m"
+        memory: "1Gi"
+----
+
+. Save and exit the editor to update the `HyperConverged` CR.

modules/virt-editing-cdi-cpu-and-memory-defaults.adoc

@@ -9,7 +9,7 @@ The Containerized Data Importer (CDI) requires scratch space (temporary storage)
 During this process, CDI provisions a scratch space PVC equal to the size of the PVC backing the destination data volume (DV).
 The scratch space PVC is deleted after the operation completes or aborts.
 
-You can define the storage class that is used to bind the scratch space PVC in the `spec.config.scratchSpaceStorageClass` field of the `CDI` object.
+You can define the storage class that is used to bind the scratch space PVC in the `spec.scratchSpaceStorageClass` field of the `HyperConverged` custom resource.
 
 If the defined storage class does not match a storage class in the cluster, then the default storage class defined for the cluster is used.
 If there is no default storage class defined in the cluster, the storage class used to provision the original DV or PVC is used.

modules/virt-overriding-cpu-and-memory-defaults.adoc

@@ -24,7 +24,7 @@ Refer to the operating system documentation for details.
 
 * If you require scratch space according to the
 xref:#virt-cdi-supported-operations-matrix_virt-importing-virtual-machine-images-datavolumes-block[CDI supported operations matrix], you must first
-xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass-in-cdi_virt-preparing-cdi-scratch-space[define a storage class or prepare CDI scratch space]
+xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass_virt-preparing-cdi-scratch-space[define a storage class or prepare CDI scratch space]
 for this operation to complete successfully.
 
 include::modules/virt-about-datavolumes.adoc[leveloffset=+1]

modules/virt-understanding-scratch-space.adoc

@@ -26,7 +26,7 @@ in the same namespace as the data volume and referenced in the data volume confi
 ** You might need to xref:../../../virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc#virt-preparing-container-disk-for-vms_virt-using-container-disks-with-vms[prepare a container disk from a virtual machine image] and store it in your container registry before importing it.
 ** If the container registry does not have TLS, you must xref:../../../virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc#virt-disabling-tls-for-registry_virt-using-container-disks-with-vms[add the registry to the `insecureRegistries` field of the `HyperConverged` custom resource] before you can import a container disk from it.
 
-* You might need to xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass-in-cdi_virt-preparing-cdi-scratch-space[define a storage class or prepare CDI scratch space]
+* You might need to xref:../../../virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc#virt-defining-storageclass_virt-preparing-cdi-scratch-space[define a storage class or prepare CDI scratch space]
 for this operation to complete successfully.
 
 include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1]

virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc

@@ -9,8 +9,9 @@ You can use the Containerized Data Importer (CDI) to import, upload, and clone v
 
 include::modules/virt-about-cpu-and-memory-quota-namespace.adoc[leveloffset=+1]
 
-include::modules/virt-editing-cdi-cpu-and-memory-defaults.adoc[leveloffset=+1]
+include::modules/virt-overriding-cpu-and-memory-defaults.adoc[leveloffset=+1]
 
+[id="{context}_additional-resources"]
 == Additional resources
 
 * xref:../../../applications/quotas/quotas-setting-per-project.adoc#quotas-setting-per-project[Resource quotas per project]

virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc

@@ -11,10 +11,11 @@ include::modules/virt-understanding-scratch-space.adoc[leveloffset=+1]
 
 include::modules/virt-operations-requiring-scratch-space.adoc[leveloffset=+1]
 
-include::modules/virt-defining-storageclass-in-cdi.adoc[leveloffset=+1]
+include::modules/virt-defining-storageclass.adoc[leveloffset=+1]
 
 include::modules/virt-cdi-supported-operations-matrix.adoc[leveloffset=+1]
 
-.Additional resources
+[id="{context}-additional-resources"]
+== Additional resources
 
-* See the xref:../../../storage/dynamic-provisioning.adoc#about_dynamic-provisioning[Dynamic provisioning] section for more information on storage classes and how these are defined in the cluster.
+* xref:../../../storage/dynamic-provisioning.adoc#about_dynamic-provisioning[Dynamic provisioning]