summaryrefslogtreecommitdiffstats
path: root/doc/man/8/ceph-fuse.rst
blob: 95efebbd2b9f5d1f3ea1982cec06a85de3e8c244 (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
:orphan:

=========================================
 ceph-fuse -- FUSE-based client for ceph
=========================================

.. program:: ceph-fuse

Synopsis
========

| **ceph-fuse** [-n *client.username*] [ -m *monaddr*:*port* ] *mountpoint* [ *fuse options* ]


Description
===========

**ceph-fuse** is a FUSE (File system in USErspace) client for Ceph
distributed file system. It will mount a ceph file system specified
via the -m option or described by ceph.conf (see below) at the
specific mount point. See `Mount CephFS using FUSE`_ for detailed
information.

The file system can be unmounted with::

        fusermount -u mountpoint

or by sending ``SIGINT`` to the ``ceph-fuse`` process.


Options
=======

Any options not recognized by ceph-fuse will be passed on to libfuse.

.. option:: -o opt,[opt...]

   Mount options.

.. option:: -d

   Run in foreground, send all log output to stderr and enable FUSE debugging (-o debug).

.. option:: -c ceph.conf, --conf=ceph.conf

   Use *ceph.conf* configuration file instead of the default
   ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup.

.. option:: -m monaddress[:port]

   Connect to specified monitor (instead of looking through ceph.conf).

.. option:: -k <path-to-keyring>

   Provide path to keyring; useful when it's absent in standard locations.

.. option:: --client_mountpoint/-r root_directory

   Use root_directory as the mounted root, rather than the full Ceph tree.

.. option:: -f

   Foreground: do not daemonize after startup (run in foreground). Do not generate a pid file.

.. option:: -s

   Disable multi-threaded operation.

Availability
============

**ceph-fuse** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
the Ceph documentation at http://ceph.com/docs for more information.


See also
========

fusermount(8),
:doc:`ceph <ceph>`\(8)

.. _Mount CephFS using FUSE: ../../../cephfs/fuse/