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

   1 :orphan:
   2
   3 ========================================
   4  mount.ceph -- mount a ceph file system
   5 ========================================
   6
   7 .. program:: mount.ceph
   8
   9 Synopsis
  10 ========
  11
  12 | **mount.ceph** *monaddr1*\ [,\ *monaddr2*\ ,...]:/[*subdir*] *dir* [
  13   -o *options* ]
  14
  15
  16 Description
  17 ===========
  18
  19 **mount.ceph** is a simple helper for mounting the Ceph file system on
  20 a Linux host. It serves to resolve monitor hostname(s) into IP
  21 addresses and read authentication keys from disk; the Linux kernel
  22 client component does most of the real work. In fact, it is possible
  23 to mount a non-authenticated Ceph file system without mount.ceph by
  24 specifying monitor address(es) by IP::
  25
  26         mount -t ceph 1.2.3.4:/ mountpoint
  27
  28 Each monitor address monaddr takes the form host[:port]. If the port
  29 is not specified, the Ceph default of 6789 is assumed.
  30
  31 Multiple monitor addresses can be separated by commas. Only one
  32 responsible monitor is needed to successfully mount; the client will
  33 learn about all monitors from any responsive monitor. However, it is a
  34 good idea to specify more than one in case one happens to be down at
  35 the time of mount.
  36
  37 A subdirectory subdir may be specified if a subset of the file system
  38 is to be mounted.
  39
  40 Mount helper application conventions dictate that the first two
  41 options are device to be mounted and destination path. Options must be
  42 passed only after these fixed arguments.
  43
  44
  45 Options
  46 =======
  47
  48 :command:`wsize`
  49   int (bytes), max write size. Default: none (writeback uses smaller of wsize
  50   and stripe unit)
  51
  52 :command:`rsize`
  53   int (bytes), max read size. Default: none
  54
  55 :command:`rasize`
  56   int (bytes), max readahead, multiple of 1024, Default: 8388608
  57   (8192*1024)
  58
  59 :command:`osdtimeout`
  60   int (seconds), Default: 60
  61
  62 :command:`osdkeepalive`
  63   int, Default: 5
  64
  65 :command:`mount_timeout`
  66   int (seconds), Default: 60
  67
  68 :command:`osd_idle_ttl`
  69   int (seconds), Default: 60
  70
  71 :command:`caps_wanted_delay_min`
  72   int, cap release delay, Default: 5
  73
  74 :command:`caps_wanted_delay_max`
  75   int, cap release delay, Default: 60
  76
  77 :command:`cap_release_safety`
  78   int, Default: calculated
  79
  80 :command:`readdir_max_entries`
  81   int, Default: 1024
  82
  83 :command:`readdir_max_bytes`
  84   int, Default: 524288 (512*1024)
  85
  86 :command:`write_congestion_kb`
  87   int (kb), max writeback in flight. scale with available
  88   memory. Default: calculated from available memory
  89
  90 :command:`snapdirname`
  91   string, set the name of the hidden snapdir. Default: .snap
  92
  93 :command:`name`
  94   RADOS user to authenticate as when using cephx. Default: guest
  95
  96 :command:`secret`
  97   secret key for use with cephx. This option is insecure because it exposes
  98   the secret on the command line. To avoid this, use the secretfile option.
  99
 100 :command:`secretfile`
 101   path to file containing the secret key to use with cephx
 102
 103 :command:`ip`
 104   my ip
 105
 106 :command:`noshare`
 107   create a new client instance, instead of sharing an existing
 108   instance of a client mounting the same cluster
 109
 110 :command:`dirstat`
 111   funky `cat dirname` for stats, Default: off
 112
 113 :command:`nodirstat`
 114   no funky `cat dirname` for stats
 115
 116 :command:`rbytes`
 117   Report the recursive size of the directory contents for st_size on
 118   directories.  Default: on
 119
 120 :command:`norbytes`
 121   Do not report the recursive size of the directory contents for
 122   st_size on directories.
 123
 124 :command:`nocrc`
 125   no data crc on writes
 126
 127 :command:`noasyncreaddir`
 128   no dcache readdir
 129
 130
 131 Examples
 132 ========
 133
 134 Mount the full file system::
 135
 136         mount.ceph monhost:/ /mnt/foo
 137
 138 If there are multiple monitors::
 139
 140         mount.ceph monhost1,monhost2,monhost3:/ /mnt/foo
 141
 142 If :doc:`ceph-mon <ceph-mon>`\(8) is running on a non-standard
 143 port::
 144
 145         mount.ceph monhost1:7000,monhost2:7000,monhost3:7000:/ /mnt/foo
 146
 147 To mount only part of the namespace::
 148
 149         mount.ceph monhost1:/some/small/thing /mnt/thing
 150
 151 Assuming mount.ceph(8) is installed properly, it should be
 152 automatically invoked by mount(8) like so::
 153
 154         mount -t ceph monhost:/ /mnt/foo
 155
 156
 157 Availability
 158 ============
 159
 160 **mount.ceph** is part of Ceph, a massively scalable, open-source, distributed storage system. Please
 161 refer to the Ceph documentation at http://ceph.com/docs for more
 162 information.
 163
 164 See also
 165 ========
 166
 167 :doc:`ceph-fuse <ceph-fuse>`\(8),
 168 :doc:`ceph <ceph>`\(8)