Merge pull request #62130 from sabrinajess/CNV27190

CNV-27190 - control plane tuning

Author: michaelryanpeter

_topic_maps/_topic_map.yml

@@ -3689,6 +3689,8 @@ Topics:
       File: virt-enabling-descheduler-evictions
     - Name: About high availability for virtual machines
       File: virt-high-availability-for-vms
+    - Name: Control plane tuning
+      File: virt-vm-control-plane-tuning
 # Importing virtual machines
   - Name: Importing virtual machines
     Dir: importing_vms

modules/virt-configuring-highburst-profile.adoc

@@ -0,0 +1,35 @@
+
+// Module included in the following assemblies:
+//
+// * virt/advanced_vm_management/virt-vm-control-plane-tuning.adoc
+
+:_content-type: PROCEDURE
+[id="virt-configuring-highburst-profile_{context}"]
+= Configuring a highBurst profile
+
+Use the `highBurst` profile to create and maintain a large number of virtual machines (VMs) in one cluster.
+
+.Procedure
+
+* Apply the following patch to enable the `highBurst` tuning policy profile:
++
+[source,terminal]
+----
+$ oc patch -n openshift-cnv hco kubevirt-hyperconverged \
+--type=json -p='[{"op": "add", "path": "/spec/tuningPolicy", \
+"value": "highBurst"}]'
+----
+
+.Verification
+
+* Run the following command to verify the `highBurst` tuning policy profile is enabled:
+
++
+[source,terminal]
+----
+$ oc get kubevirt.kubevirt.io/kubevirt-kubevirt-hyperconverged \
+-n openshift-cnv -o go-template --template='{{range $config, \
+$value := .spec.configuration}} {{if eq $config "apiConfiguration" \
+"webhookConfiguration" "controllerConfiguration" "handlerConfiguration"}} \
+{{"\n"}} {{$config}} = {{$value}} {{end}} {{end}} {{"\n"}}
+----

modules/virt-configuring-rate-limiters.adoc

@@ -0,0 +1,14 @@
+
+// Module included in the following assemblies:
+//
+// * virt/advanced_vm_management/virt-vm-control-plane-tuning.adoc
+
+:_content-type: PROCEDURE
+[id="virt-configuring-rate-limiters_{context}"]
+= Configuring rate limiters
+
+To compensate for large-scale burst rates, scale the `QPS` (Queries per Second) and `burst` rate limits to process a higher rate of client requests or API calls concurrently for each component.
+
+.Procedure
+
+* Apply a `jsonpatch` annotation to adjust the `kubevirt-hyperconverged` cluster configuration by using `tuningPolicy` to apply scalable tuning parameters. This tuning policy automatically adjusts all virtualization components (`webhook`, `api`, `controller`, `handler`) to match the `QPS` and `burst` values specified by the profile.

virt/virtual_machines/advanced_vm_management/virt-vm-control-plane-tuning.adoc

@@ -0,0 +1,18 @@
+:_content-type: ASSEMBLY
+[id="virt-vm-control-plane-tuning"]
+= Virtual machine control plane tuning
+
+include::_attributes/common-attributes.adoc[]
+:context: virt-control-plane-tuning
+
+toc::[]
+
+{VirtProductName} offers the following tuning options at the control-plane level:
+
+* The `highBurst` profile, which uses fixed `QPS` and `burst` rates, to create hundreds of virtual machines (VMs) in one batch
+* Migration setting adjustment based on workload type
+
+// this module commented out until jsonpatch is supported or this becomes a TP or DP
+// include::modules/virt-configuring-rate-limiters.adoc[leveloffset=+1]
+
+include::modules/virt-configuring-highburst-profile.adoc[leveloffset=+1]