summaryrefslogtreecommitdiffstats
path: root/doc/man/8/rbd-fuse.rst
blob: 7337b9214210b05c784b15eef862c065307f708d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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)