From 998fa2ff59a3ad96a0c3116e8dfb75433d17e60f Mon Sep 17 00:00:00 2001 From: Dirk von Suchodoletz Date: Mon, 13 Oct 2025 15:39:26 +0000 Subject: dnbd3 -> DNBD3 as it is usually referenced that way --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2e3d49a..d1c9f9c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# dnbd3 - distributed network block device (version 3) +# DNBD3 - distributed network block device (version 3) -The distributed network block device version 3 (dnbd3) is a network protocol similar to [nbd](https://github.com/NetworkBlockDevice/nbd) to implement a distributed block-based read-only storage system. Such a distributed block-based storage system consists of dnbd3 components, namly one or more servers and several clients. Servers are meant to expose virtual disk images as block devices to clients using dnbd3. Clients read data blocks from servers and implement failover and a load balancing mechanism to connect to the fastest server available for data exchange. +The distributed network block device version 3 (DNBD3) is a network protocol similar to [nbd](https://github.com/NetworkBlockDevice/nbd) to implement a distributed block-based read-only storage system. Such a distributed block-based storage system consists of dnbd3 components, namly one or more servers and several clients. Servers are meant to expose virtual disk images as block devices to clients using dnbd3. Clients read data blocks from servers and implement failover and a load balancing mechanism to connect to the fastest server available for data exchange. This repository contains the source code for the following dnbd3 components: - - **dnbd3**: Linux kernel module client for dnbd3 - - **dnbd3-bench**: Benchmark utility to test dnbd3 - - **dnbd3-fuse**: Fuse client for dnbd3 - - **dnbd3-server**: Server to serve virtual disk images for dnbd3 + - **dnbd3**: Linux kernel module client for DNBD3 + - **dnbd3-bench**: Benchmark utility to test DNBD3 + - **dnbd3-fuse**: Fuse client for DNBD3 + - **dnbd3-server**: Server to serve virtual disk images for DNBD3 -The dnbd3 components have been built/tested on the following Linux kernel versions and Unix distributions: +The DNBD3 components have been built/tested on the following Linux kernel versions and Unix distributions: - Generic/Vanilla Kernel **4.9** to **6.12** - Archlinux with **Linux kernel 5.15.x** or **6.1.x** @@ -25,8 +25,10 @@ The dnbd3 components have been built/tested on the following Linux kernel versio ## Build +Unfortunately the module didn't get mainlined (yet) and thus needs to be compiled against the kernel it should be used with. + ### Preliminaries -A build of the dnbd3 components requires the installation of the following build tools and libraries under your supported Unix distribution. +A build of the DNBD3 components requires the installation of the following build tools and libraries under your supported Unix distribution. #### Archlinux with Linux kernel 5.15.x or 5.10.x ```shell -- cgit v1.2.3-55-g7522