Network binding plugins: Add compute resource overhead (#814)

Following PR kubevirt/kubevirt#12235, it is now possible to specify memory overhead for the virt-launcher's compute container. Add an explanation about the compute resource overhead in general, with a note that only memory overhead request is currently supported. Signed-off-by: Orel Misan <[email protected]>
kubevirt · Jul 10, 2024 · e7c9a54 · e7c9a54
1 parent d2b5c68
commit e7c9a54
Showing 1 changed file with 37 additions and 0 deletions.
diff --git a/docs/network/network_binding_plugins.md b/docs/network/network_binding_plugins.md
@@ -208,6 +208,43 @@ kubectl patch kubevirts -n kubevirt kubevirt --type=json -p='[{"op": "add", "pat
         }}]'
 ```
 
+#### Compute Resource Overhead
+From: v1.3.0
+
+Some plugins may need additional resources to be added to the compute container of the virt-launcher pod.
+
+It is possible to specify compute resource overhead that will be added to the `compute` container of virt-launcher pods
+derived from virtual machines using the plugin.
+
+> **Note**: At the moment, only memory overhead requests are supported.
+
+> **Note**: In some deployments the Kubevirt CR is controlled by an external
+> controller (e.g. [HCO](https://github.com/kubevirt/hyperconverged-cluster-operator)).
+> In such cases, make sure to configure the wrapper operator/controller so the
+> changes will get preserved.
+
+Example (the `passt` binding):
+```shell
+kubectl patch kubevirts -n kubevirt kubevirt --type=json -p='[{"op": "add", "path": "/spec/configuration/network",   "value": {
+            "binding": {
+                "passt": {
+                    "networkAttachmentDefinition": "default/netbindingpasst",
+                    "sidecarImage": "quay.io/kubevirt/network-passt-binding:20231205_29a16d5c9",
+                    "migration": {
+                        "method": "link-refresh"
+                    },
+                    "computeResourceOverhead": {
+                      "requests": {
+                        "memory": "500Mi",
+                      }
+                    }
+                }
+            }
+        }}]'
+```
+
+Every compute container in a virt-launcher pod derived from a VM using the passt network binding plugin, will have an additional `500Mi` memory overhead.
+
 ### VM Network Interface
 When configuring the VM/VMI network interface, the binding plugin name
 can be specified. If it exists in the Kubevirt CR, it will be used