Merge pull request #47113 from emarcusRH/ocprhv-693

ocprhv-693  add disk prealocation parameters to RHV Machinset sample yaml file

Author: pneedle-rh

modules/machineset-yaml-rhv.adoc

@@ -44,25 +44,27 @@ spec:
           cluster_id: <ovirt_cluster_id> <6>
           template_name: <ovirt_template_name> <7>
           instance_type_id: <instance_type_id> <8>
-          cpu: <9>
-            sockets: <number_of_sockets> <10>
-            cores: <number_of_cores> <11>
-            threads: <number_of_threads> <12>
-          memory_mb: <memory_size> <13>
-          guaranteed_memory_mb:  <memory_size> <14>
-          os_disk: <15>
-            size_gb: <disk_size> <16>
-            storage_domain_id: <storage_domain_UUID> <17>
-          network_interfaces: <18>
-            vnic_profile_id:  <vnic_profile_id> <19>
+          sparse: <boolean_value> <9>
+          format: <raw_or_cow> <10>
+          cpu: <11>
+            sockets: <number_of_sockets> <12>
+            cores: <number_of_cores> <13>
+            threads: <number_of_threads> <14>
+          memory_mb: <memory_size> <15>
+          guaranteed_memory_mb:  <memory_size> <16>
+          os_disk: <17>
+            size_gb: <disk_size> <18>
+            storage_domain_id: <storage_domain_UUID> <19>
+          network_interfaces: <20>
+            vnic_profile_id:  <vnic_profile_id> <21>
           credentialsSecret:
-            name: ovirt-credentials <20>
+            name: ovirt-credentials <22>
           kind: OvirtMachineProviderSpec
-          type: <workload_type> <21>
-          auto_pinning_policy: <auto_pinning_policy> <22>
-          hugepages: <hugepages> <23>
+          type: <workload_type> <23>
+          auto_pinning_policy: <auto_pinning_policy> <24>
+          hugepages: <hugepages> <25>
           affinityGroupsNames:
-            - compute <24>
+            - compute <26>
           userDataSecret:
             name: worker-user-data
 ----
@@ -93,39 +95,45 @@ The `instance_type_id` field is deprecated and will be removed in a future relea
 ====
 +
 If you include this parameter, you do not need to specify the hardware parameters of the VM including CPU and memory because this parameter overrides all hardware parameters.
+<9> Setting this option to `false` enables preallocation of disks. The default is `true`. Setting `sparse` to `true` with `format` set to `raw` is not available for block storage domains. The `raw` format writes the entire virtual disk to the underlying physical disk.
+<10> Can be set to `cow` or `raw`. The default is `cow`. The `cow` format is optimized for virtual machines.
++
+[NOTE]
+====
+Preallocating disks on file storage domains writes zeroes to the file. This might not actually preallocate disks depending on the underlying storage.
+====
+<11> Optional: The CPU field contains the CPU configuration, including sockets, cores, and threads.
 
-<9> Optional: The CPU field contains the CPU's configuration, including sockets, cores, and threads.
-
-<10> Optional: Specify the number of sockets for a VM.
+<12> Optional: Specify the number of sockets for a VM.
 
-<11> Optional: Specify the number of cores per socket.
+<13> Optional: Specify the number of cores per socket.
 
-<12> Optional: Specify the number of threads per core.
+<14> Optional: Specify the number of threads per core.
 
-<13> Optional: Specify the size of a VM's memory in MiB.
+<15> Optional: Specify the size of a VM's memory in MiB.
 
-<14> Optional: Specify the size of a virtual machine's guaranteed memory in MiB. This is the amount of memory that is guaranteed not to be drained by the ballooning mechanism. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide#memory_ballooning[Memory Ballooning] and link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide#Cluster_Optimization_Settings_Explained[Optimization Settings Explained].
+<16> Optional: Specify the size of a virtual machine's guaranteed memory in MiB. This is the amount of memory that is guaranteed not to be drained by the ballooning mechanism. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide#memory_ballooning[Memory Ballooning] and link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/administration_guide#Cluster_Optimization_Settings_Explained[Optimization Settings Explained].
 +
 [NOTE]
 ====
 If you are using a version earlier than {rh-virtualization} 4.4.8, see link:https://access.redhat.com/articles/6454811[Guaranteed memory requirements for OpenShift on Red Hat Virtualization clusters].
 ====
-<15> Optional: Root disk of the node.
+<17> Optional: Root disk of the node.
 
-<16> Optional: Specify the size of the bootable disk in GiB.
+<18> Optional: Specify the size of the bootable disk in GiB.
 
-<17> Optional: Specify the UUID of the storage domain for the compute node's disks. If none is provided, the compute node is created on the same storage domain as the control nodes. (default)
+<19> Optional: Specify the UUID of the storage domain for the compute node's disks. If none is provided, the compute node is created on the same storage domain as the control nodes. (default)
 
-<18> Optional: List of the network interfaces of the VM. If you include this parameter, {product-title} discards all network interfaces from the template and creates new ones.
+<20> Optional: List of the network interfaces of the VM. If you include this parameter, {product-title} discards all network interfaces from the template and creates new ones.
 
-<19> Optional: Specify the vNIC profile ID.
+<21> Optional: Specify the vNIC profile ID.
 
-<20> Specify the name of the secret object that holds the {rh-virtualization} credentials.
+<22> Specify the name of the secret object that holds the {rh-virtualization} credentials.
 
-<21> Optional: Specify the workload type for which the instance is optimized. This value affects the `{rh-virtualization} VM` parameter. Supported values: `desktop`, `server` (default), `high_performance`. `high_performance` improves performance on the VM. Limitations exist, for example, you cannot access the VM with a graphical console. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Configuring_High_Performance_Virtual_Machines_Templates_and_Pools[Configuring High Performance Virtual Machines, Templates, and Pools] in the _Virtual Machine Management Guide_.
-<22> Optional: AutoPinningPolicy defines the policy that automatically sets CPU and NUMA settings, including pinning to the host for this instance. Supported values: `none`, `resize_and_pin`. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Setting_NUMA_Nodes[Setting NUMA Nodes] in the _Virtual Machine Management Guide_.
-<23> Optional: Hugepages is the size in KiB for defining hugepages in a VM. Supported values: `2048` or `1048576`. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Configuring_Huge_Pages[Configuring Huge Pages] in the _Virtual Machine Management Guide_.
-<24> Optional: A list of affinity group names to be applied to the VMs. The affinity groups must exist in oVirt.
+<23> Optional: Specify the workload type for which the instance is optimized. This value affects the `{rh-virtualization} VM` parameter. Supported values: `desktop`, `server` (default), `high_performance`. `high_performance` improves performance on the VM. Limitations exist, for example, you cannot access the VM with a graphical console. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Configuring_High_Performance_Virtual_Machines_Templates_and_Pools[Configuring High Performance Virtual Machines, Templates, and Pools] in the _Virtual Machine Management Guide_.
+<24> Optional: AutoPinningPolicy defines the policy that automatically sets CPU and NUMA settings, including pinning to the host for this instance. Supported values: `none`, `resize_and_pin`. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Setting_NUMA_Nodes[Setting NUMA Nodes] in the _Virtual Machine Management Guide_.
+<25> Optional: Hugepages is the size in KiB for defining hugepages in a VM. Supported values: `2048` or `1048576`. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html-single/virtual_machine_management_guide/index#Configuring_Huge_Pages[Configuring Huge Pages] in the _Virtual Machine Management Guide_.
+<26> Optional: A list of affinity group names to be applied to the VMs. The affinity groups must exist in oVirt.
 
 [NOTE]
 ====