docs: Add document for vhost-user

smartxworks · Feb 27, 2023 · f46e257 · f46e257
1 parent 4f6ab5e
commit f46e257
Show file tree

Hide file tree

Showing 19 changed files with 1,083 additions and 0 deletions.
diff --git a/docs/images/simulation_latency_different_host.png b/docs/images/simulation_latency_different_host.png
diff --git a/docs/images/simulation_latency_same_host.png b/docs/images/simulation_latency_same_host.png
diff --git a/docs/images/simulation_tcp_bandwidth_different_host.png b/docs/images/simulation_tcp_bandwidth_different_host.png
diff --git a/docs/images/simulation_tcp_bandwidth_same_host.png b/docs/images/simulation_tcp_bandwidth_same_host.png
diff --git a/docs/images/tcp_bandwidth_different_host.png b/docs/images/tcp_bandwidth_different_host.png
diff --git a/docs/images/tcp_bandwidth_same_host.png b/docs/images/tcp_bandwidth_same_host.png
diff --git a/docs/images/tcp_latency_different_host.png b/docs/images/tcp_latency_different_host.png
diff --git a/docs/images/tcp_latency_same_host.png b/docs/images/tcp_latency_same_host.png
diff --git a/docs/images/tcp_pps_different_host.png b/docs/images/tcp_pps_different_host.png
diff --git a/docs/images/tcp_pps_same_host.png b/docs/images/tcp_pps_same_host.png
diff --git a/docs/images/udp_bandwidth_different_host.png b/docs/images/udp_bandwidth_different_host.png
diff --git a/docs/images/udp_bandwidth_same_host.png b/docs/images/udp_bandwidth_same_host.png
diff --git a/docs/images/udp_latency_different_host.png b/docs/images/udp_latency_different_host.png
diff --git a/docs/images/udp_latency_same_host.png b/docs/images/udp_latency_same_host.png
diff --git a/docs/images/udp_pps_different_host.png b/docs/images/udp_pps_different_host.png
diff --git a/docs/images/udp_pps_same_host.png b/docs/images/udp_pps_same_host.png
diff --git a/docs/interfaces_and_networks.md b/docs/interfaces_and_networks.md
@@ -83,6 +83,7 @@ Each interface should declare its type by defining one of the following fields:
 | `bridge`     | Connect using a linux bridge                    |
 | `masquerade` | Connect using iptables rules to NAT the traffic |
 | `sriov`      | Passthrough a SR-IOV PCI device via VFIO        |
+| `vhost-user` | Connect using DPDK in userspace                 |
 
 Each interface may also have additional configuration fields that modify properties "seen" inside guest instances, as listed below:
 
@@ -224,3 +225,7 @@ spec:
       multus:
         networkName: mellanox-sriov-25g
 ```
+
+### `vhost-user` mode
+
+In `vhost-user` mode, VMs are connected to the network by DPDK, this fast packet processing library is implemented entirely in userspace, bypassing the kernel's networking stack. You can refer to document [vhost-user-net](vhost-user-net.md) to setup the vhost-user network and learn its performance details.
diff --git a/docs/vhost-user-net-test.md b/docs/vhost-user-net-test.md