projects / ceph.git / blame
| Commit | Line | Data |
|---|---|---|
| 7c673cae FG |
1 | :orphan: |
| 2 | ||
| 3 | ========================================= | |
| 4 | ceph-fuse -- FUSE-based client for ceph | |
| 5 | ========================================= | |
| 6 | ||
| 7 | .. program:: ceph-fuse | |
| 8 | ||
| 9 | Synopsis | |
| 10 | ======== | |
| 11 | ||
| 28e407b8 | 12 | | **ceph-fuse** [-n *client.username*] [ -m *monaddr*:*port* ] *mountpoint* [ *fuse options* ] |
| 7c673cae FG |
13 | |
| 14 | ||
| 15 | Description | |
| 16 | =========== | |
| 17 | ||
| 9f95a23c TL |
18 | **ceph-fuse** is a FUSE ("Filesystem in USErspace") client for Ceph |
| 19 | distributed file system. It will mount a ceph file system specified via the -m | |
| 20 | option or described by ceph.conf (see below) at the specific mount point. See | |
| 21 | `Mount CephFS using FUSE`_ for detailed information. | |
| 7c673cae FG |
22 | |
| 23 | The file system can be unmounted with:: | |
| 24 | ||
| 25 | fusermount -u mountpoint | |
| 26 | ||
| 27 | or by sending ``SIGINT`` to the ``ceph-fuse`` process. | |
| 28 | ||
| 29 | ||
| 30 | Options | |
| 31 | ======= | |
| 32 | ||
| 33 | Any options not recognized by ceph-fuse will be passed on to libfuse. | |
| 34 | ||
| 28e407b8 AA |
35 | .. option:: -o opt,[opt...] |
| 36 | ||
| 11fdf7f2 | 37 | Mount options. |
| 28e407b8 | 38 | |
| 7c673cae FG |
39 | .. option:: -c ceph.conf, --conf=ceph.conf |
| 40 | ||
| 41 | Use *ceph.conf* configuration file instead of the default | |
| 42 | ``/etc/ceph/ceph.conf`` to determine monitor addresses during startup. | |
| 43 | ||
| 44 | .. option:: -m monaddress[:port] | |
| 45 | ||
| 46 | Connect to specified monitor (instead of looking through ceph.conf). | |
| 47 | ||
| 9f95a23c TL |
48 | .. option:: -n client.{cephx-username} |
| 49 | ||
| 50 | Pass the name of CephX user whose secret key is be to used for mounting. | |
| 51 | ||
| 20effc67 TL |
52 | .. option:: --id <client-id> |
| 53 | ||
| 54 | Pass the name of CephX user whose secret key is be to used for mounting. | |
| 55 | ``--id`` takes just the ID of the client in contrast to ``-n``. For | |
| 56 | example, ``--id 0`` for using ``client.0``. | |
| 57 | ||
| 92f5a8d4 TL |
58 | .. option:: -k <path-to-keyring> |
| 59 | ||
| 60 | Provide path to keyring; useful when it's absent in standard locations. | |
| 61 | ||
| 28e407b8 | 62 | .. option:: --client_mountpoint/-r root_directory |
| 7c673cae FG |
63 | |
| 64 | Use root_directory as the mounted root, rather than the full Ceph tree. | |
| 65 | ||
| 28e407b8 AA |
66 | .. option:: -f |
| 67 | ||
| 68 | Foreground: do not daemonize after startup (run in foreground). Do not generate a pid file. | |
| 69 | ||
| 20effc67 TL |
70 | .. option:: -d |
| 71 | ||
| 72 | Run in foreground, send all log output to stderr and enable FUSE debugging | |
| 73 | (-o debug). | |
| 74 | ||
| 28e407b8 AA |
75 | .. option:: -s |
| 76 | ||
| 77 | Disable multi-threaded operation. | |
| 7c673cae | 78 | |
| 20effc67 TL |
79 | .. option:: --client_fs |
| 80 | ||
| 81 | Pass the name of Ceph FS to be mounted. Not passing this option mounts the | |
| 82 | default Ceph FS on the Ceph cluster. | |
| 83 | ||
| 7c673cae FG |
84 | Availability |
| 85 | ============ | |
| 86 | ||
| 87 | **ceph-fuse** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to | |
| 20effc67 | 88 | the Ceph documentation at https://docs.ceph.com for more information. |
| 7c673cae FG |
89 | |
| 90 | ||
| 91 | See also | |
| 92 | ======== | |
| 93 | ||
| 94 | fusermount(8), | |
| 95 | :doc:`ceph <ceph>`\(8) | |
| 91327a77 | 96 | |
| f67539c2 | 97 | .. _Mount CephFS using FUSE: ../../../cephfs/mount-using-fuse/ |