diff options
Diffstat (limited to 'doc/man/8/rbd-fuse.rst')
-rw-r--r-- | doc/man/8/rbd-fuse.rst | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/doc/man/8/rbd-fuse.rst b/doc/man/8/rbd-fuse.rst new file mode 100644 index 000000000..7337b9214 --- /dev/null +++ b/doc/man/8/rbd-fuse.rst @@ -0,0 +1,61 @@ +:orphan: + +======================================= + rbd-fuse -- expose rbd images as files +======================================= + +.. program:: rbd-fuse + +Synopsis +======== + +| **rbd-fuse** [ -p pool ] [-c conffile] *mountpoint* [ *fuse options* ] + + +Note +==== + +**rbd-fuse** is not recommended for any production or high performance workloads. + +Description +=========== + +**rbd-fuse** is a FUSE ("Filesystem in USErspace") client for RADOS +block device (rbd) images. Given a pool containing rbd images, +it will mount a userspace file system allowing access to those images +as regular files at **mountpoint**. + +The file system can be unmounted with:: + + fusermount -u mountpoint + +or by sending ``SIGINT`` to the ``rbd-fuse`` process. + + +Options +======= + +Any options not recognized by rbd-fuse will be passed on to libfuse. + +.. option:: -c ceph.conf + + Use *ceph.conf* configuration file instead of the default + ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup. + +.. option:: -p pool + + Use *pool* as the pool to search for rbd images. Default is ``rbd``. + + +Availability +============ + +**rbd-fuse** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to +the Ceph documentation at https://docs.ceph.com for more information. + + +See also +======== + +fusermount(8), +:doc:`rbd <rbd>`\(8) |