Synopsis
========
-| **mount.ceph** [*mon1_socket*\ ,\ *mon2_socket*\ ,...]:/[*subdir*] *dir* [
- -o *options* ]
+| **mount.ceph** *name*@*fsid*.*fs_name*=/[*subdir*] *dir* [-o *options* ]
Description
**mount.ceph** 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. In fact, it is possible to mount a non-authenticated Ceph file
-system without mount.ceph by specifying monitor address(es) by IP::
-
- mount -t ceph 1.2.3.4:/ /mnt/mycephfs
-
-The first argument is the device part of the mount command. It includes host's
-socket and path within CephFS that will be mounted at the mount point. The
-socket, obviously, takes the form ip_address[:port]. If the port is not
-specified, the Ceph default of 6789 is assumed. Multiple monitor addresses can
-be passed by separating them by commas. 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.
-
-If the host portion of the device is left blank, then **mount.ceph** 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 ``secret`` and ``secretfile``
-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.
+the real work. To mount a Ceph file system use::
+
+ mount.ceph name@07fe3187-00d9-42a3-814b-72a4d5e7d5be.fs_name=/ /mnt/mycephfs -o mon_addr=1.2.3.4
+
+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::
+
+ mount -t ceph name@.fs_name=/ /mnt/mycephfs -o mon_addr=1.2.3.4
+
+Note that the dot ``.`` still needs to be a part of the device string in this case.
+
+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.
+
+Monitor addresses can be passed using ``mon_addr`` mount option. Multiple monitor
+addresses can be passed by separating addresses with a slash (`/`). 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.
+
+If monitor addresses are not specified, then **mount.ceph** 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 ``secret`` and ``secretfile`` 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).
A sub-directory of the file system can be mounted by specifying the (absolute)
-path to the sub-directory right after ":" after the socket in the device part
-of the mount command.
+path to the sub-directory right after "=" in the device part of the mount command.
Mount helper application conventions dictate that the first two options are
device to be mounted and the mountpoint for that device. Options must be
for autodiscovery of monitor addresses and auth secrets. The default is
to use the standard search path for ceph.conf files.
-:command: `fs=<fs-name>`
- Specify the non-default file system to be mounted. Not passing this
- option mounts the default file system.
-
-:command: `mds_namespace=<fs-name>`
- A synonym of "fs=" and its use is deprecated.
-
:command:`mount_timeout`
int (seconds), Default: 60
- ``prefer-secure``: secure mode, if denied agree to crc mode
-:command:`name`
- RADOS user to authenticate as when using CephX. Default: guest
+:command:`mon_addr`
+ Monitor address of the cluster in the form of ip_address[:port]
+
+:command:`fsid`
+ Cluster FSID. This can be found using `ceph fsid` command.
:command:`secret`
secret key for use with CephX. This option is insecure because it exposes
available modes are ``no`` and ``clean``. The default is ``no``.
- ``no``: 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.
+ blocklisted. Blocklisted clients will not attempt to reconnect and
+ their operations will fail too.
- ``clean``: client reconnects to the Ceph cluster automatically when it
detects that it has been blocklisted. During reconnect, client drops
Mount the full file system::
- mount.ceph :/ /mnt/mycephfs
-
-Assuming mount.ceph is installed properly, it should be automatically invoked
-by mount(8)::
-
- mount -t ceph :/ /mnt/mycephfs
+ mount -t ceph fs_user@.mycephfs2=/ /mnt/mycephfs
Mount only part of the namespace/file system::
- mount.ceph :/some/directory/in/cephfs /mnt/mycephfs
-
-Mount non-default FS, in case cluster has multiple FSs::
- mount -t ceph :/ /mnt/mycephfs2 -o fs=mycephfs2
-
- or
-
- mount -t ceph :/ /mnt/mycephfs2 -o mds_namespace=mycephfs2 # This option name is deprecated.
+ mount.ceph fs_user@.mycephfs2=/some/directory/in/cephfs /mnt/mycephfs
Pass the monitor host's IP address, optionally::
- mount.ceph 192.168.0.1:/ /mnt/mycephfs
+ mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs -o mon_addr=192.168.0.1
Pass the port along with IP address if it's running on a non-standard port::
- mount.ceph 192.168.0.1:7000:/ /mnt/mycephfs
-
-If there are multiple monitors, passes addresses separated by a comma::
+ mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs -o mon_addr=192.168.0.1:7000
- mount.ceph 192.168.0.1,192.168.0.2,192.168.0.3:/ /mnt/mycephfs
+If there are multiple monitors, pass each address separated by a `/`::
-If authentication is enabled on Ceph cluster::
-
- mount.ceph :/ /mnt/mycephfs -o name=fs_username
+ mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs -o mon_addr=192.168.0.1/192.168.0.2/192.168.0.3
Pass secret key for CephX user optionally::
- mount.ceph :/ /mnt/mycephfs -o name=fs_username,secret=AQATSKdNGBnwLhAAnNDKnH65FmVKpXZJVasUeQ==
+ mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs -o secret=AQATSKdNGBnwLhAAnNDKnH65FmVKpXZJVasUeQ==
Pass file containing secret key to avoid leaving secret key in shell's command
history::
- mount.ceph :/ /mnt/mycephfs -o name=fs_username,secretfile=/etc/ceph/fs_username.secret
+ mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs -o secretfile=/etc/ceph/fs_username.secret
+
+If authentication is disabled on Ceph cluster, omit the credential related option::
+ mount.ceph fs_user@.mycephfs2=/ /mnt/mycephfs
Availability
============
**mount.ceph** is part of Ceph, a massively scalable, open-source, distributed
-storage system. Please refer to the Ceph documentation at http://ceph.com/docs
+storage system. Please refer to the Ceph documentation at https://docs.ceph.com
for more information.
Feature Availability
projects / ceph.git / blobdiff