Skip to content

Commit

Permalink
[doc] Add Parallax documentation folder and fdb-hammer guide
Browse files Browse the repository at this point in the history
  • Loading branch information
NikosLasithiotakis committed Dec 16, 2024
1 parent 9ff720f commit 0752d5a
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions parallax_docs/run_fdb_hammer_with_parallax.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 0752d5a

Please sign in to comment.