← Back to branch summary

~ubuntu-branches/ubuntu/quantal/ceph/quantal

« back to all changes in this revision

Viewing changes to doc/man/8/mount.ceph.rst

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2012-07-16 09:56:24 UTC
  • mfrom: (0.3.11)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: package-import@ubuntu.com-20120716095624-azr2w4hbhei1rxmx
Tags: upstream-0.48
Import upstream version 0.48

Show diffs side-by-side

added added

removed removed

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