README

   1 NBD README
   2 ==========
   3
   4 Welcome to the NBD userland support files!
   5
   6 This package contains nbd-server and nbd-client. You'll want to run the
   7 client on a machine where you want to use an NBD device, and the server
   8 on a different machine; although it's technically possible to use
   9 nbd-server and nbd-client on the same machine, you may run into some
  10 deadlock issues if you do that[1].
  11
  12 To install the package, please see the INSTALL file. You'll need to
  13 install it on both the client and the server.
  14
  15 Using NBD is quite easy. First, on the client, you need to create the
  16 device nodes:
  17
  18 # cd /dev
  19 # ./MAKEDEV nb0
  20
  21 (if you need more than one NBD device, repeat the above command for nb1,
  22 nb2, ...)
  23
  24 Next, start the server. You can use a file or a block device for that:
  25
  26 nbd-server <port> <filename>
  27
  28 e.g.,
  29
  30 nbd-server 1234 /home/wouter/nbd-export
  31
  32 Note that the filename must be an absolute path; i.e., something like
  33 /path/to/file, not ../file. See the nbd-server manpage for details on
  34 any available options.
  35
  36 Finally, you'll be able to start the client:
  37
  38 nbd-client <hostname> <port> <nbd device>
  39
  40 e.g.,
  41
  42 nbd-client 10.0.0.1 1234 /dev/nb0
  43
  44 nbd-client must be ran as root; the same is not true for nbd-server (but
  45 do make sure that /var/run is writeable by the server that nbd-server
  46 runs as; otherwise, you won't get a PID file, though the server will
  47 keep running).
  48
  49 Starting with NBD 2.9, there is also support for a configuration file.
  50 This configuration file is expected to be found at
  51 <sysconfdir>/nbd-server/config, and should look something like this:
  52
  53 # This is a comment
  54 [generic]
  55         # The [generic] section is required, but can not currently
  56         # contain any options. This section name is reserved for future
  57         # use.
  58 [export1]
  59         exportname = /export/nbd/export1-file
  60         port = 12345
  61         authfile = /export/nbd/export1-authfile
  62         timeout = 30
  63         filesize = 10000000
  64         readonly = false
  65         multifile = false
  66         copyonwrite = false
  67 [otherexport]
  68         exportname = /export/nbd/experiment
  69         port = 12346
  70         # The other options are all optional.
  71
  72 The configuration file is parsed with GLib's GKeyFile, which parses key
  73 files as they are specified in the Freedesktop.org Desktop Entry
  74 Specification, as can be found at
  75 <http://freedesktop.org/Standards/desktop-entry-spec>. While this format
  76 was not intended to be used for configuration files, the glib API is
  77 flexible enough for it to be used as such.
  78
  79 The old command-line syntax is still supported, however.
  80
  81 There are packages (or similar) available for the following operating
  82 systems:
  83
  84 Debian (and derivatives, like Ubuntu): "nbd-client" and "nbd-server",
  85         since Debian woody.
  86 Gentoo: the "nbd" ebuild in the "sys-block" category, available in
  87         Portage since 2002.
  88 FreeBSD: "net/nbd-server", available in the ports tree since 2003.
  89         FreeBSD doesn't have kernel support for NBD, so obviously the
  90         client isn't built there.
  91 SuSE: "nbd", since SuSE 10.0
  92
  93 If you're packaging NBD for a different operating system that isn't in
  94 the above list, I'd like to know about it.
  95
  96 Thanks, and have fun,
  97
  98 Wouter Verhelst
  99
 100
 101
 102
 103 [1] When you write something to a block device, the kernel will not
 104 immediately write that to the physical block device; instead, your
 105 changes are written to a cache, which is periodically flushed by a
 106 kernel thread, 'kblockd'. If you're using a single-processor system,
 107 then you'll have only one kblockd, meaning, the kernel can't write to
 108 more than one block device at the same time.
 109
 110 If, while your kblockd is emptying the NBD buffer cache, the kernel
 111 decides that the cache of the block device your nbd-server is writing to
 112 needs to be emptied, then you've got a deadlock.