ceph/doc/man/8/rbd-fuse.rst

   1 :orphan:
   2
   3 =======================================
   4  rbd-fuse -- expose rbd images as files
   5 =======================================
   6
   7 .. program:: rbd-fuse
   8
   9 Synopsis
  10 ========
  11
  12 | **rbd-fuse** [ -p pool ] [-c conffile] *mountpoint* [ *fuse options* ]
  13
  14
  15 Note
  16 ====
  17
  18 **rbd-fuse** is not recommended for any production or high performance workloads.
  19
  20 Description
  21 ===========
  22
  23 **rbd-fuse** is a FUSE ("Filesystem in USErspace") client for RADOS
  24 block device (rbd) images.  Given a pool containing rbd images,
  25 it will mount a userspace file system allowing access to those images
  26 as regular files at **mountpoint**.
  27
  28 The file system can be unmounted with::
  29
  30         fusermount -u mountpoint
  31
  32 or by sending ``SIGINT`` to the ``rbd-fuse`` process.
  33
  34
  35 Options
  36 =======
  37
  38 Any options not recognized by rbd-fuse will be passed on to libfuse.
  39
  40 .. option:: -c ceph.conf
  41
  42    Use *ceph.conf* configuration file instead of the default
  43    ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.
  44
  45 .. option:: -p pool
  46
  47    Use *pool* as the pool to search for rbd images.  Default is ``rbd``.
  48
  49
  50 Availability
  51 ============
  52
  53 **rbd-fuse** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
  54 the Ceph documentation at http://ceph.com/docs for more information.
  55
  56
  57 See also
  58 ========
  59
  60 fusermount(8),
  61 :doc:`rbd <rbd>`\(8)