Merge pull request #235701 from asudbring/linux-fixes-2

[Doc-a-thon] Linux doc-athon fixes for DPDK in a Azure Linux VM

Author: v-ccolin

articles/virtual-network/setup-dpdk.md

@@ -1,21 +1,20 @@
 ---
 title: DPDK in an Azure Linux VM
+titleSuffix: Azure Virtual Network
 description: Learn the benefits of the Data Plane Development Kit (DPDK) and how to set up the DPDK on a Linux virtual machine.
 services: virtual-network
 author: asudbring
-manager: gedegrac
 ms.service: virtual-network
 ms.topic: how-to
-ms.workload: infrastructure-services
-ms.date: 05/12/2020
+ms.date: 04/24/2023
 ms.author: allensu
 ---
 
 # Set up DPDK in a Linux virtual machine
 
 Data Plane Development Kit (DPDK) on Azure offers a faster user-space packet processing framework for performance-intensive applications. This framework bypasses the virtual machine’s kernel network stack.
 
-In typical packet processing that uses the kernel network stack, the process is interrupt-driven. When the network interface receives incoming packets, there is a kernel interrupt to process the packet and a context switch from the kernel space to the user space. DPDK eliminates context switching and the interrupt-driven method in favor of a user-space implementation that uses poll mode drivers for fast packet processing.
+In typical packet processing that uses the kernel network stack, the process is interrupt-driven. When the network interface receives incoming packets, there's a kernel interrupt to process the packet and a context switch from the kernel space to the user space. DPDK eliminates context switching and the interrupt-driven method in favor of a user-space implementation that uses poll mode drivers for fast packet processing.
 
 DPDK consists of sets of user-space libraries that provide access to lower-level resources. These resources can include hardware, logical cores, memory management, and poll mode drivers for network interface cards.
 
@@ -25,7 +24,6 @@ DPDK can run on Azure virtual machines that are supporting multiple operating sy
 
 **Higher packets per second (PPS)**: Bypassing the kernel and taking control of packets in the user space reduces the cycle count by eliminating context switches. It also improves the rate of packets that are processed per second in Azure Linux virtual machines.
 
-
 ## Supported operating systems minimum versions
 
 The following distributions from the Azure Marketplace are supported:
@@ -50,55 +48,47 @@ All Azure regions support DPDK.
 
 ## Prerequisites
 
-Accelerated networking must be enabled on a Linux virtual machine. The virtual machine should have at least two network interfaces, with one interface for management. Enabling Accelerated networking on management interface is not recommended. Learn how to [create a Linux virtual machine with accelerated networking enabled](create-vm-accelerated-networking-cli.md).
+Accelerated networking must be enabled on a Linux virtual machine. The virtual machine should have at least two network interfaces, with one interface for management. Enabling Accelerated networking on management interface isn't recommended. Learn how to [create a Linux virtual machine with accelerated networking enabled](create-vm-accelerated-networking-cli.md).
 
 On virtual machines that are using InfiniBand, ensure the appropriate `mlx4_ib` or `mlx5_ib` drivers are loaded, see [Enable InfiniBand](../virtual-machines/workloads/hpc/enable-infiniband.md).
 
 ## Install DPDK via system package (recommended)
 
-### Ubuntu 18.04
+# [RHEL, CentOS](#tab/redhat)
 
 ```bash
-sudo add-apt-repository ppa:canonical-server/server-backports -y
-sudo apt-get update
-sudo apt-get install -y dpdk
+sudo yum install -y dpdk
 ```
 
-### Ubuntu 20.04 and newer
+# [openSUSE, SLES](#tab/suse)
 
 ```bash
-sudo apt-get install -y dpdk
+sudo zypper install -y dpdk
 ```
 
-### Debian 10 and newer
-
-```bash
-sudo apt-get install -y dpdk
-```
-
-## Install DPDK manually (not recommended)
-
-### Install build dependencies
+# [Ubuntu, Debian](#tab/ubuntu)
 
-#### Ubuntu 18.04
+### Ubuntu 18.04
 
 ```bash
 sudo add-apt-repository ppa:canonical-server/server-backports -y
 sudo apt-get update
-sudo apt-get install -y build-essential librdmacm-dev libnuma-dev libmnl-dev meson
+sudo apt-get install -y dpdk
 ```
 
-#### Ubuntu 20.04 and newer
+### Ubuntu 20.04/Debian 10 and newer
 
 ```bash
-sudo apt-get install -y build-essential librdmacm-dev libnuma-dev libmnl-dev meson
+sudo apt-get install -y dpdk
 ```
 
-#### Debian 10 and newer
+---
 
-```bash
-sudo apt-get install -y build-essential librdmacm-dev libnuma-dev libmnl-dev meson
-```
+## Install DPDK manually (not recommended)
+
+### Install build dependencies
+
+# [RHEL, CentOS](#tab/redhat)
 
 #### RHEL7.5/CentOS 7.5
 
@@ -108,6 +98,8 @@ sudo dracut --add-drivers "mlx4_en mlx4_ib mlx5_ib" -f
 yum install -y gcc kernel-devel-`uname -r` numactl-devel.x86_64 librdmacm-devel libmnl-devel meson
 ```
 
+# [openSUSE, SLES](#tab/suse)
+
 #### SLES 15 SP1
 
 **Azure kernel**
@@ -128,11 +120,31 @@ zypper \
   --gpg-auto-import-keys install kernel-default-devel gcc make libnuma-devel numactl librdmacm1 rdma-core-devel meson
 ```
 
+# [Ubuntu, Debian](#tab/ubuntu)
+
+#### Ubuntu 18.04
+
+```bash
+sudo add-apt-repository ppa:canonical-server/server-backports -y
+sudo apt-get update
+sudo apt-get install -y build-essential librdmacm-dev libnuma-dev libmnl-dev meson
+```
+
+#### Ubuntu 20.04/Debian 10 and newer
+
+```bash
+sudo apt-get install -y build-essential librdmacm-dev libnuma-dev libmnl-dev meson
+```
+
+---
 ### Compile and install DPDK manually
 
 1. [Download the latest DPDK](https://core.dpdk.org/download). Version 19.11 LTS or newer is required for Azure.
+
 2. Build the default config with `meson builddir`.
+
 3. Compile with `ninja -C builddir`.
+
 4. Install with `DESTDIR=<output folder> ninja -C builddir install`.
 
 ## Configure the runtime environment
@@ -141,24 +153,27 @@ After restarting, run the following commands once:
 
 1. Hugepages
 
-   * Configure hugepage by running the following command, once for each numa node:
+    * Configure hugepage by running the following command, once for each numa node:
 
-     ```bash
+    ```bash
      echo 1024 | sudo tee /sys/devices/system/node/node*/hugepages/hugepages-2048kB/nr_hugepages
-     ```
+    ```
 
-   * Create a directory for mounting with `mkdir /mnt/huge`.
-   * Mount hugepages with `mount -t hugetlbfs nodev /mnt/huge`.
-   * Check that hugepages are reserved with `grep Huge /proc/meminfo`.
+    * Create a directory for mounting with `mkdir /mnt/huge`.
+   
+    * Mount hugepages with `mount -t hugetlbfs nodev /mnt/huge`.
+   
+    * Check that hugepages are reserved with `grep Huge /proc/meminfo`.
 
-     > [NOTE]
+     > [!NOTE]
      > There is a way to modify the grub file so that hugepages are reserved on boot by following the [instructions](https://dpdk.org/doc/guides/linux_gsg/sys_reqs.html#use-of-hugepages-in-the-linux-environment) for the DPDK. The instructions are at the bottom of the page. When you're using an Azure Linux virtual machine, modify files under **/etc/config/grub.d** instead, to reserve hugepages across reboots.
 
 2. MAC & IP addresses: Use `ifconfig –a` to view the MAC and IP address of the network interfaces. The *VF* network interface and *NETVSC* network interface have the same MAC address, but only the *NETVSC* network interface has an IP address. *VF* interfaces are running as subordinate interfaces of *NETVSC* interfaces.
 
 3. PCI addresses
 
    * Use `ethtool -i <vf interface name>` to find out which PCI address to use for *VF*.
+   
    * If *eth0* has accelerated networking enabled, make sure that testpmd doesn’t accidentally take over the *VF* pci device for *eth0*. If the DPDK application accidentally takes over the management network interface and causes you to lose your SSH connection, use the serial console to stop the DPDK application. You can also use the serial console to stop or start the virtual machine.
 
 4. Load *ibuverbs* on each reboot with `modprobe -a ib_uverbs`. For SLES 15 only, also load *mlx4_ib* with `modprobe -a mlx4_ib`.
@@ -197,6 +212,7 @@ To run testpmd in root mode, use `sudo` before the *testpmd* command.
    If you're running testpmd with more than two NICs, the `--vdev` argument follows this pattern: `net_vdev_netvsc<id>,iface=<vf’s pairing eth>`.
 
 3.  After it's started, run `show port info all` to check port information. You should see one or two DPDK ports that are net_failsafe (not *net_mlx4*).
+
 4.  Use `start <port> /stop <port>` to start traffic.
 
 The previous commands start *testpmd* in interactive mode, which is recommended for trying out  testpmd commands.
@@ -238,6 +254,7 @@ The following commands periodically print the packets per second statistics:
 When you're running the previous commands on a virtual machine, change *IP_SRC_ADDR* and *IP_DST_ADDR* in `app/test-pmd/txonly.c` to match the actual IP address of the virtual machines before you compile. Otherwise, the packets are dropped before reaching the receiver.
 
 ### Advanced: Single sender/single forwarder
+
 The following commands periodically print the packets per second statistics:
 
 1. On the TX side, run the following command:
@@ -271,10 +288,12 @@ The following commands periodically print the packets per second statistics:
      --stats-period <display interval in seconds>
     ```
 
-When you're running the previous commands on a virtual machine, change *IP_SRC_ADDR* and *IP_DST_ADDR* in `app/test-pmd/txonly.c` to match the actual IP address of the virtual machines before you compile. Otherwise, the packets are dropped before reaching the forwarder. You won’t be able to have a third machine receive forwarded traffic, because the *testpmd* forwarder doesn’t modify the layer-3 addresses, unless you make some code changes.
+When you're running the previous commands on a virtual machine, change *IP_SRC_ADDR* and *IP_DST_ADDR* in `app/test-pmd/txonly.c` to match the actual IP address of the virtual machines before you compile. Otherwise, the packets are dropped before reaching the forwarder. You can't have a third machine receive forwarded traffic, because the *testpmd* forwarder doesn’t modify the layer-3 addresses, unless you make some code changes.
 
 ## References
 
 * [EAL options](https://dpdk.org/doc/guides/testpmd_app_ug/run_app.html#eal-command-line-options)
+
 * [Testpmd commands](https://dpdk.org/doc/guides/testpmd_app_ug/run_app.html#testpmd-command-line-options)
+
 * [Packet dump commands](https://doc.dpdk.org/guides/tools/pdump.html#pdump-tool)