Ddpk: Add README

Author: Pavel Siska

src/plugins/input/dpdk/README.md

@@ -0,0 +1,69 @@
+# DPDK (input plugin)
+
+DPDK (Data Plane Development Kit) is used for high-performance packet processing. It enables
+direct access to network interfaces, bypassing the kernel, and is suitable for use in environments
+requiring high throughput, low latency, and high packet processing rates.
+
+## Parameters
+```
+p, port=NUMBER     DPDK port to be used as an input interface (required)
+b, bsize=SIZE      Size of the MBUF packet buffer (default: 64)
+m, mem=SIZE        Size of the memory pool for received packets. (default: 8192)
+q, queue=COUNT     Number of RX queues (default: 1)
+e, eal=PARAMS      Extra parameters to be passed to DPDK EAL (Environment Abstraction Layer)
+M, mtu=SIZE        Maximum transmission unit size for the port (default: 1500)
+````
+
+# How to use
+
+To use the DPDK input plugin, you must ensure that your system is properly configured for DPDK operation. This includes the following steps:
+
+## 1. Configure the DPDK Driver
+
+TODO MEllanox, broadcom
+
+### 2. Allocate Hugepages
+
+DPDK requires hugepages for optimal performance. Instead of manually configuring hugepages, you can use the `dpdk-hugepages` tool, which simplifies the process.
+
+### Install `dpdk-hugepages`
+
+`dpdk-hugepages` is part of the DPDK utilities package. You can install it as follows:
+
+- **On RHEL/CentOS**:
+  ```sh
+  dnf install dpdk-tools
+  ```
+- **On Debian/Ubuntu**:
+  ```sh
+  apt-get install dpdk
+  ```
+
+### Allocate Hugepages with `dpdk-hugepages`
+
+To allocate hugepages, run:
+
+```sh
+dpdk-hugepages.py -p 1G --setup 2G
+```
+
+This allocates 2GB of hugepages with a default page size of 1GB. You can adjust these values based on your memory requirements.
+
+To verify the allocated hugepages:
+
+```sh
+dpdk-hugepages -s
+```
+
+### Configuration:
+
+```yaml
+input_plugin:
+  dpdk:
+    allowed_nics: "0000:00:00.0,0000:00:00.1"  # List of allowed NICs (PCI addresses)
+    burst_size: 64  # Number of packets processed in each cycle
+    mempool_size: 8192  # Size of the memory pool (power of 2)
+    rx_queues: 1  # Number of RX queues
+    eal_opts: null  # EAL options (null = default)
+    mtu: null  # Maximum Transmission Unit (defaults to RTE_ETHER_MAX_LEN)
+```