ceph/doc/man/8/mount.ceph.rst

:orphan:

========================================
 mount.ceph -- mount a ceph file system
========================================

.. program:: mount.ceph

Synopsis
========

| **mount.ceph** [*monaddr1*\ ,\ *monaddr2*\ ,...]:/[*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:/ mountpoint

Each monitor address monaddr takes the form host[:port]. If the port
is not specified, the Ceph default of 6789 is assumed.

Multiple monitor addresses can be separated by commas. Only one
responsible monitor is needed to successfully mount; the client will
learn about all monitors from any responsive monitor. However, it is a
good idea to specify more than one in case 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.

A subdirectory subdir may be specified if a subset of the file system
is to be mounted.

Mount helper application conventions dictate that the first two
options are device to be mounted and destination path. Options must be
passed only after these fixed arguments.


Options
=======

:command:`wsize`
  int (bytes), max write size. Default: 16777216 (16*1024*1024) (writeback uses smaller of wsize
  and stripe unit)

:command:`rsize`
  int (bytes), max read size. Default: 16777216 (16*1024*1024)

:command:`rasize`
  int (bytes), max readahead. Default: 8388608 (8192*1024)

:command:`osdtimeout`
  int (seconds), Default: 60

:command:`osdkeepalive`
  int, Default: 5

:command:`mount_timeout`
  int (seconds), Default: 60

:command:`osd_idle_ttl`
  int (seconds), Default: 60

:command:`caps_wanted_delay_min`
  int, cap release delay, Default: 5

:command:`caps_wanted_delay_max`
  int, cap release delay, Default: 60

:command:`cap_release_safety`
  int, Default: calculated

:command:`readdir_max_entries`
  int, Default: 1024

:command:`readdir_max_bytes`
  int, Default: 524288 (512*1024)

:command:`write_congestion_kb`
  int (kb), max writeback in flight. scale with available
  memory. Default: calculated from available memory

:command:`snapdirname`
  string, set the name of the hidden snapdir. Default: .snap

:command:`name`
  RADOS user to authenticate as when using cephx. Default: guest

:command:`secret`
  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.

:command:`secretfile`
  path to file containing the secret key to use with cephx

:command:`ip`
  my ip

:command:`noshare`
  create a new client instance, instead of sharing an existing
  instance of a client mounting the same cluster

:command:`dirstat`
  funky `cat dirname` for stats, Default: off

:command:`nodirstat`
  no funky `cat dirname` for stats

:command:`rbytes`
  Report the recursive size of the directory contents for st_size on
  directories.  Default: off

:command:`norbytes`
  Do not report the recursive size of the directory contents for
  st_size on directories.

:command:`nocrc`
  no data crc on writes

:command:`noasyncreaddir`
  no dcache readdir

:command:`conf`
  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.

:command:`recover_session=<no|clean>`
  Set auto reconnect mode in the case where the client is blacklisted. The
  available modes are ``no`` and ``clean``. The default is ``no``.

  - ``no``: never attempt to reconnect when client detects that it has been blacklisted. Blacklisted 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 blacklisted. 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.


:command: `mds_namespace=<fs-name>`
    Specify the non-default file system to be mounted. Not passing this option
    mounts the default file system.

Mount Secrets
=============
If the `secret` and `secretfile` options are not specified on the command-line
then 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.

Examples
========

Mount the full file system::

        mount.ceph monhost:/ /mnt/foo

If there are multiple monitors::

        mount.ceph monhost1,monhost2,monhost3:/ /mnt/foo

If :doc:`ceph-mon <ceph-mon>`\(8) is running on a non-standard
port::

        mount.ceph monhost1:7000,monhost2:7000,monhost3:7000:/ /mnt/foo

To automatically determine the monitor addresses from local configuration::

        mount.ceph :/ /mnt/foo

To mount only part of the namespace::

        mount.ceph monhost1:/some/small/thing /mnt/thing

Assuming mount.ceph(8) is installed properly, it should be
automatically invoked by mount(8) like so::

        mount -t ceph monhost:/ /mnt/foo

If you have more than one file system on your Ceph cluster, you can mount the
non-default FS on your local FS as follows::

    mount -t ceph :/ /mnt/mycephfs2 -o name=fs,mds_namespace=mycephfs2

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 for more
information.

See also
========

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