summaryrefslogtreecommitdiffstats
path: root/doc/man/8/mount.fuse.ceph.rst
blob: 6dacd4719474984d432f7a419049ba5f4539d142 (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
:orphan:

====================================================
 mount.fuse.ceph -- mount ceph-fuse from /etc/fstab.
====================================================

.. program:: mount.fuse.ceph

Synopsis
========

| **mount.fuse.ceph** [-h] [-o OPTIONS [*OPTIONS* ...]]
                      device [*device* ...]
                      mountpoint [*mountpoint* ...]

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

**mount.fuse.ceph** is a helper for mounting ceph-fuse from
``/etc/fstab``.

To use mount.fuse.ceph, add an entry in ``/etc/fstab`` like::

  DEVICE    PATH        TYPE        OPTIONS
  none      /mnt/ceph   fuse.ceph   ceph.id=admin,_netdev,defaults  0 0
  none      /mnt/ceph   fuse.ceph   ceph.name=client.admin,_netdev,defaults  0 0
  none      /mnt/ceph   fuse.ceph   ceph.id=myuser,ceph.conf=/etc/ceph/foo.conf,_netdev,defaults  0 0

ceph-fuse options are specified in the ``OPTIONS`` column and must begin
with '``ceph.``' prefix. This way ceph related fs options will be passed to
ceph-fuse and others will be ignored by ceph-fuse.

Options
=======

.. option:: ceph.id=<username>

   Specify that the ceph-fuse will authenticate as the given user.

.. option:: ceph.name=client.admin

   Specify that the ceph-fuse will authenticate as client.admin

.. option:: ceph.conf=/etc/ceph/foo.conf

   Sets 'conf' option to /etc/ceph/foo.conf via ceph-fuse command line.


Any valid ceph-fuse options can be passed this way.   

Additional Info
===============

The old format /etc/fstab entries are also supported::

  DEVICE                              PATH        TYPE        OPTIONS
  id=admin                            /mnt/ceph   fuse.ceph   defaults   0 0
  id=myuser,conf=/etc/ceph/foo.conf   /mnt/ceph   fuse.ceph   defaults   0 0

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

**mount.fuse.ceph** 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
========

:doc:`ceph-fuse <ceph-fuse>`\(8),
:doc:`ceph <ceph>`\(8)