src/ceph/doc/man/8/rbd-ggate.rst

   1 :orphan:
   2
   3 ==================================================
   4  rbd-ggate -- map rbd images via FreeBSD GEOM Gate
   5 ==================================================
   6
   7 .. program:: rbd-ggate
   8
   9 Synopsis
  10 ========
  11
  12 | **rbd-ggate** [--read-only] [--exclusive] [--device *ggate device*] map *image-spec* | *snap-spec*
  13 | **rbd-ggate** unmap *ggate device*
  14 | **rbd-ggate** list
  15
  16 Description
  17 ===========
  18
  19 **rbd-ggate** is a client for RADOS block device (rbd) images. It will
  20 map a rbd image to a ggate (FreeBSD GEOM Gate class) device, allowing
  21 access it as regular local block device.
  22
  23 Commands
  24 ========
  25
  26 map
  27 ---
  28
  29 Spawn a process responsible for the creation of ggate device and
  30 forwarding I/O requests between the GEOM Gate kernel subsystem and
  31 RADOS.
  32
  33 unmap
  34 -----
  35
  36 Destroy ggate device and terminate the process responsible for it.
  37
  38 list
  39 ----
  40
  41 List mapped ggate devices.
  42
  43 Options
  44 =======
  45
  46 .. option:: --device *ggate device*
  47
  48    Specify ggate device path.
  49
  50 .. option:: --read-only
  51
  52    Map read-only.
  53
  54 .. option:: --exclusive
  55
  56    Forbid writes by other clients.
  57
  58 Image and snap specs
  59 ====================
  60
  61 | *image-spec* is [*pool-name*]/*image-name*
  62 | *snap-spec*  is [*pool-name*]/*image-name*\ @\ *snap-name*
  63
  64 The default for *pool-name* is "rbd".  If an image name contains a slash
  65 character ('/'), *pool-name* is required.
  66
  67 Availability
  68 ============
  69
  70 **rbd-ggate** is part of Ceph, a massively scalable, open-source,
  71 distributed storage system. Please refer to the Ceph documentation at
  72 http://ceph.com/docs for more information.
  73
  74
  75 See also
  76 ========
  77
  78 :doc:`rbd <rbd>`\(8)
  79 :doc:`ceph <ceph>`\(8)