From 0752d5a98a92ca82d3d811816f7f488a11fa2a25 Mon Sep 17 00:00:00 2001
From: Nikos Lasithiotakis <lasnick03@gmail.com>
Date: Mon, 16 Dec 2024 16:17:30 +0200
Subject: [PATCH] [doc] Add Parallax documentation folder and fdb-hammer guide

---
 parallax_docs/run_fdb_hammer_with_parallax.md | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 parallax_docs/run_fdb_hammer_with_parallax.md

diff --git a/parallax_docs/run_fdb_hammer_with_parallax.md b/parallax_docs/run_fdb_hammer_with_parallax.md
new file mode 100644
index 000000000..bfb00c451
--- /dev/null
+++ b/parallax_docs/run_fdb_hammer_with_parallax.md
@@ -0,0 +1,32 @@
+# Running fdb-hammer with Parallax
+
+1. **Edit the Configuration File**
+   - Open the configuration file:
+     ```
+     fdb-kv/tests/fdb/etc/fdb/config.yaml
+     ```
+   - Set the engine to `daos`.
+   - *(Optional)* Change the root path to mounted NVMe folders for realistic performance testing.
+
+2. **Build fdb-kv**
+   - Read the `README.md` file in the project, and also check the `Dockerfile` to understand how to download the necessary dependencies for the project.
+   - **IMPORTANT:** Use the flag:
+     ```
+     -DUSE_PARALLAX=ON
+     ```
+     when building the project.
+
+3. **Build Parallax**
+   - Build Parallax with the following flag enabled:
+     ```
+     -DKV_MAX_SIZE_128K=ON
+     ```
+   - Follow the Parallax build instructions if additional guidance is needed.
+
+4. **Start the Parallax Server**
+   - Run the Parallax server executable on `localhost:8080`.
+   - Ensure the server is running before starting `fdb-hammer`.
+
+5. **Run the fdb-hammer executable**
+   - Execute the `fdb-hammer` binary with the required parameters.
+   - **IMPORTANT:** Always set the `nparams` parameter to `4` when running the executable.