1MOUNT.CEPH(8) Ceph MOUNT.CEPH(8)
2
6 mount.ceph - mount a Ceph file system
7
9 mount.ceph [mon1_socket,mon2_socket,...]:/[subdir] dir [
10 -o options ]
11
14 mount.ceph is a helper for mounting the Ceph file system on a Linux
15 host. It serves to resolve monitor hostname(s) into IP addresses and
16 read authentication keys from disk; the Linux kernel client component
17 does most of the real work. In fact, it is possible to mount a
18 non-authenticated Ceph file system without mount.ceph by specifying
19 monitor address(es) by IP:
20 mount -t ceph 1.2.3.4:/ /mnt/mycephfs
22 The first argument is the device part of the mount command. It includes
24 host's socket and path within CephFS that will be mounted at the mount
25 point. The socket, obviously, takes the form ip_address[:port]. If the
26 port is not specified, the Ceph default of 6789 is assumed. Multiple
27 monitor addresses can be passed by separating them by commas. Only one
28 monitor is needed to mount successfully; the client will learn about
29 all monitors from any responsive monitor. However, it is a good idea to
30 specify more than one in case the one happens to be down at the time of
31 mount.
32 If the host portion of the device is left blank, then mount.ceph will
34 attempt to determine monitor addresses using local configuration files
35 and/or DNS SRV records. In similar way, if authentication is enabled on
36 Ceph cluster (which is done using CephX) and options secret and secret‐
37 file are not specified in the command, the mount helper will spawn a
38 child process that will use the standard Ceph library routines to find
39 a keyring and fetch the secret from it.
40 A sub-directory of the file system can be mounted by specifying the
42 (absolute) path to the sub-directory right after ":" after the socket
43 in the device part of the mount command.
44 Mount helper application conventions dictate that the first two options
46 are device to be mounted and the mountpoint for that device. Options
47 must be passed only after these fixed arguments.
48
50 Basic
51 conf Path to a ceph.conf file. This is used to initialize the Ceph
52 context for autodiscovery of monitor addresses and auth secrets.
53 The default is to use the standard search path for ceph.conf
54 files.
55 command
57 fs=<fs-name> Specify the non-default file system to be mounted.
58 Not passing this option mounts the default file system.
59 command
61 mds_namespace=<fs-name> A synonym of "fs=" and its use is depre‐
62 cated.
63 mount_timeout
65 int (seconds), Default: 60
66 name RADOS user to authenticate as when using CephX. Default: guest
68 secret secret key for use with CephX. This option is insecure because
70 it exposes the secret on the command line. To avoid this, use
71 the secretfile option.
72 secretfile
74 path to file containing the secret key to use with CephX
75 recover_session=<no|clean>
77 Set auto reconnect mode in the case where the client is black‐
78 listed. The available modes are no and clean. The default is no.
79 ·
81 no: never attempt to reconnect when client detects that it has
83 been
84 blacklisted. Blacklisted clients will not attempt to
85 reconnect and their operations will fail too.
86 · clean: client reconnects to the Ceph cluster automatically
88 when it detects that it has been blacklisted. During recon‐
89 nect, client drops dirty data/metadata, invalidates page
90 caches and writable file handles. After reconnect, file locks
91 become stale because the MDS loses track of them. If an inode
92 contains any stale file locks, read/write on the inode is not
93 allowed until applications release all stale file locks.
94 Advanced
96 cap_release_safety
97 int, Default: calculated
98 caps_wanted_delay_max
100 int, cap release delay, Default: 60
101 caps_wanted_delay_min
103 int, cap release delay, Default: 5
104 dirstat
106 funky cat dirname for stats, Default: off
107 nodirstat
109 no funky cat dirname for stats
110 ip my ip
112 noasyncreaddir
114 no dcache readdir
115 nocrc no data crc on writes
117 noshare
119 create a new client instance, instead of sharing an existing
120 instance of a client mounting the same cluster
121 osdkeepalive
123 int, Default: 5
124 osdtimeout
126 int (seconds), Default: 60
127 osd_idle_ttl
129 int (seconds), Default: 60
130 rasize int (bytes), max readahead. Default: 8388608 (8192*1024)
132 rbytes Report the recursive size of the directory contents for st_size
134 on directories. Default: off
135 norbytes
137 Do not report the recursive size of the directory contents for
138 st_size on directories.
139 readdir_max_bytes
141 int, Default: 524288 (512*1024)
142 readdir_max_entries
144 int, Default: 1024
145 rsize int (bytes), max read size. Default: 16777216 (16*1024*1024)
147 snapdirname
149 string, set the name of the hidden snapdir. Default: .snap
150 write_congestion_kb
152 int (kb), max writeback in flight. scale with available memory.
153 Default: calculated from available memory
154 wsize int (bytes), max write size. Default: 16777216 (16*1024*1024)
156 (writeback uses smaller of wsize and stripe unit)
157
159 Mount the full file system:
160 mount.ceph :/ /mnt/mycephfs
162 Assuming mount.ceph is installed properly, it should be automatically
164 invoked by mount(8):
165 mount -t ceph :/ /mnt/mycephfs
167 Mount only part of the namespace/file system:
169 mount.ceph :/some/directory/in/cephfs /mnt/mycephfs
171 Mount non-default FS, in case cluster has multiple FSs:
173 mount -t ceph :/ /mnt/mycephfs2 -o mds_namespace=mycephfs2
175 Pass the monitor host's IP address, optionally:
177 mount.ceph 192.168.0.1:/ /mnt/mycephfs
179 Pass the port along with IP address if it's running on a non-standard
181 port:
182 mount.ceph 192.168.0.1:7000:/ /mnt/mycephfs
184 If there are multiple monitors, passes addresses separated by a comma:
186 mount.ceph 192.168.0.1,192.168.0.2,192.168.0.3:/ /mnt/mycephfs
188 If authentication is enabled on Ceph cluster:
190 mount.ceph :/ /mnt/mycephfs -o name=fs_username
192 Pass secret key for CephX user optionally:
194 mount.ceph :/ /mnt/mycephfs -o name=fs_username,secret=AQATSKdNGBnwLhAAnNDKnH65FmVKpXZJVasUeQ==
196 Pass file containing secret key to avoid leaving secret key in shell's
198 command history:
199 mount.ceph :/ /mnt/mycephfs -o name=fs_username,secretfile=/etc/ceph/fs_username.secret
201
203 mount.ceph is part of Ceph, a massively scalable, open-source, distrib‐
204 uted storage system. Please refer to the Ceph documentation at
205 http://ceph.com/docs for more information.
206
208 ceph-fuse(8), ceph(8)
209
211 2010-2021, Inktank Storage, Inc. and contributors. Licensed under Cre‐
212 ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
213dev Mar 18, 2021 MOUNT.CEPH(8)