.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "MOUNT.CEPH" "8" "Oct 24, 2023" "dev" "Ceph" .SH NAME mount.ceph \- mount a Ceph file system .SH SYNOPSIS .nf \fBmount.ceph\fP \fIname*@*fsid\fP\&.*fs_name*=/[\fIsubdir\fP] \fIdir\fP [\-o \fIoptions\fP ] .fi .sp .SH DESCRIPTION .sp \fBmount.ceph\fP is a helper for mounting the Ceph file system on a Linux host. It serves to resolve monitor hostname(s) into IP addresses and read authentication keys from disk; the Linux kernel client component does most of the real work. To mount a Ceph file system use: .INDENT 0.0 .INDENT 3.5 .sp .EX mount.ceph name@07fe3187\-00d9\-42a3\-814b\-72a4d5e7d5be.fs_name=/ /mnt/mycephfs \-o mon_addr=1.2.3.4 .EE .UNINDENT .UNINDENT .sp where \(dqname\(dq is the RADOS client name (referred to hereafter as \(dqRADOS user\(dq, and meaning any individual or system actor such as an application). .sp Mount helper can fill in the cluster FSID by reading the ceph configuration file. Its recommended to call the mount helper via mount(8) as per: .INDENT 0.0 .INDENT 3.5 .sp .EX mount \-t ceph name@.fs_name=/ /mnt/mycephfs \-o mon_addr=1.2.3.4 .EE .UNINDENT .UNINDENT .sp Note that the dot \fB\&.\fP still needs to be a part of the device string in this case. .sp The first argument is the device part of the mount command. It includes the RADOS user for authentication, the file system name and a path within CephFS that will be mounted at the mount point. .sp Monitor addresses can be passed using \fBmon_addr\fP mount option. Multiple monitor addresses can be passed by separating addresses with a slash (\fI/\fP). Only one monitor is needed to mount successfully; the client will learn about all monitors from any responsive monitor. However, it is a good idea to specify more than one in case the one happens to be down at the time of mount. Monitor addresses takes the form ip_address[:port]. If the port is not specified, the Ceph default of 6789 is assumed. .sp If monitor addresses are not specified, then \fBmount.ceph\fP will attempt to determine monitor addresses using local configuration files and/or DNS SRV records. In similar way, if authentication is enabled on Ceph cluster (which is done using CephX) and options \fBsecret\fP and \fBsecretfile\fP are not specified in the command, the mount helper will spawn a child process that will use the standard Ceph library routines to find a keyring and fetch the secret from it (including the monitor address and FSID if those not specified). .sp A sub\-directory of the file system can be mounted by specifying the (absolute) path to the sub\-directory right after \(dq=\(dq in the device part of the mount command. .sp Mount helper application conventions dictate that the first two options are device to be mounted and the mountpoint for that device. Options must be passed only after these fixed arguments. .SH OPTIONS .SS Basic .INDENT 0.0 .TP \fBconf\fP Path to a ceph.conf file. This is used to initialize the Ceph context for autodiscovery of monitor addresses and auth secrets. The default is to use the standard search path for ceph.conf files. .TP \fBmount_timeout\fP int (seconds), Default: 60 .TP \fBms_mode=\fP Set the connection mode that the client uses for transport. The available modes are: .INDENT 7.0 .IP \(bu 2 \fBlegacy\fP: use messenger v1 protocol to talk to the cluster .IP \(bu 2 \fBcrc\fP: use messenger v2, without on\-the\-wire encryption .IP \(bu 2 \fBsecure\fP: use messenger v2, with on\-the\-wire encryption .IP \(bu 2 \fBprefer\-crc\fP: crc mode, if denied agree to secure mode .IP \(bu 2 \fBprefer\-secure\fP: secure mode, if denied agree to crc mode .UNINDENT .TP \fBmon_addr\fP Monitor address of the cluster in the form of ip_address[:port] .TP \fBfsid\fP Cluster FSID. This can be found using \fIceph fsid\fP command. .TP \fBsecret\fP secret key for use with CephX. This option is insecure because it exposes the secret on the command line. To avoid this, use the secretfile option. .TP \fBsecretfile\fP path to file containing the secret key to use with CephX .TP \fBrecover_session=\fP Set auto reconnect mode in the case where the client is blocklisted. The available modes are \fBno\fP and \fBclean\fP\&. The default is \fBno\fP\&. .INDENT 7.0 .IP \(bu 2 \fBno\fP: never attempt to reconnect when client detects that it has been blocklisted. Blocklisted clients will not attempt to reconnect and their operations will fail too. .IP \(bu 2 \fBclean\fP: client reconnects to the Ceph cluster automatically when it detects that it has been blocklisted. During reconnect, client drops dirty data/metadata, invalidates page caches and writable file handles. After reconnect, file locks become stale because the MDS loses track of them. If an inode contains any stale file locks, read/write on the inode is not allowed until applications release all stale file locks. .UNINDENT .UNINDENT .INDENT 0.0 .TP .B command \fIfs=\fP Specify the non\-default file system to be mounted, when using the old syntax. .TP .B command \fImds_namespace=\fP A synonym of \(dqfs=\(dq (Deprecated). .UNINDENT .SS Advanced .INDENT 0.0 .TP \fBcap_release_safety\fP int, Default: calculated .TP \fBcaps_wanted_delay_max\fP int, cap release delay, Default: 60 .TP \fBcaps_wanted_delay_min\fP int, cap release delay, Default: 5 .TP \fBdirstat\fP funky \fIcat dirname\fP for stats, Default: off .TP \fBnodirstat\fP no funky \fIcat dirname\fP for stats .TP \fBip\fP my ip .TP \fBnoasyncreaddir\fP no dcache readdir .TP \fBnocrc\fP no data crc on writes .TP \fBnoshare\fP create a new client instance, instead of sharing an existing instance of a client mounting the same cluster .TP \fBosdkeepalive\fP int, Default: 5 .TP \fBosd_idle_ttl\fP int (seconds), Default: 60 .TP \fBrasize\fP int (bytes), max readahead. Default: 8388608 (8192*1024) .TP \fBrbytes\fP Report the recursive size of the directory contents for st_size on directories. Default: off .TP \fBnorbytes\fP Do not report the recursive size of the directory contents for st_size on directories. .TP \fBreaddir_max_bytes\fP int, Default: 524288 (512*1024) .TP \fBreaddir_max_entries\fP int, Default: 1024 .TP \fBrsize\fP int (bytes), max read size. Default: 16777216 (16*1024*1024) .TP \fBsnapdirname\fP string, set the name of the hidden snapdir. Default: .snap .TP \fBwrite_congestion_kb\fP int (kb), max writeback in flight. scale with available memory. Default: calculated from available memory .TP \fBwsize\fP int (bytes), max write size. Default: 16777216 (16*1024*1024) (writeback uses smaller of wsize and stripe unit) .TP \fBwsync\fP Execute all namespace operations synchronously. This ensures that the namespace operation will only complete after receiving a reply from the MDS. This is the default. .TP \fBnowsync\fP Allow the client to do namespace operations asynchronously. When this option is enabled, a namespace operation may complete before the MDS replies, if it has sufficient capabilities to do so. .UNINDENT .SH EXAMPLES .sp Mount the full file system: .INDENT 0.0 .INDENT 3.5 .sp .EX mount \-t ceph fs_user@.mycephfs2=/ /mnt/mycephfs .EE .UNINDENT .UNINDENT .sp Mount only part of the namespace/file system: .INDENT 0.0 .INDENT 3.5 .sp .EX mount.ceph fs_user@.mycephfs2=/some/directory/in/cephfs /mnt/mycephfs .EE .UNINDENT .UNINDENT .sp Pass the monitor host\(aqs IP address, optionally: .INDENT 0.0 .INDENT 3.5 .sp .EX mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs \-o mon_addr=192.168.0.1 .EE .UNINDENT .UNINDENT .sp Pass the port along with IP address if it\(aqs running on a non\-standard port: .INDENT 0.0 .INDENT 3.5 .sp .EX mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs \-o mon_addr=192.168.0.1:7000 .EE .UNINDENT .UNINDENT .sp If there are multiple monitors, pass each address separated by a \fI/\fP: .INDENT 0.0 .INDENT 3.5 .sp .EX mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs \-o mon_addr=192.168.0.1/192.168.0.2/192.168.0.3 .EE .UNINDENT .UNINDENT .sp Pass secret key for CephX user optionally: .INDENT 0.0 .INDENT 3.5 .sp .EX mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs \-o secret=AQATSKdNGBnwLhAAnNDKnH65FmVKpXZJVasUeQ== .EE .UNINDENT .UNINDENT .sp Pass file containing secret key to avoid leaving secret key in shell\(aqs command history: .INDENT 0.0 .INDENT 3.5 .sp .EX mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs \-o secretfile=/etc/ceph/fs_username.secret .EE .UNINDENT .UNINDENT .sp If authentication is disabled on Ceph cluster, omit the credential related option: .INDENT 0.0 .INDENT 3.5 .sp .EX mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs .EE .UNINDENT .UNINDENT .sp To mount using the old syntax: .INDENT 0.0 .INDENT 3.5 .sp .EX mount \-t ceph 192.168.0.1:/ /mnt/mycephfs .EE .UNINDENT .UNINDENT .SH AVAILABILITY .sp \fBmount.ceph\fP is part of Ceph, a massively scalable, open\-source, distributed storage system. Please refer to the Ceph documentation at \fI\%https://docs.ceph.com\fP for more information. .SH FEATURE AVAILABILITY .sp The \fBrecover_session=\fP option was added to mainline Linux kernels in v5.4. \fBwsync\fP and \fBnowsync\fP were added in v5.7. .SH SEE ALSO .sp \fI\%ceph\-fuse\fP(8), \fI\%ceph\fP(8) .SH COPYRIGHT 2010-2023, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0) .\" Generated by docutils manpage writer. .