]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | ======================== |
2 | Client Config Reference | |
3 | ======================== | |
4 | ||
5 | ``client acl type`` | |
6 | ||
7 | :Description: Set the ACL type. Currently, only possible value is ``"posix_acl"`` to enable POSIX ACL, or an empty string. This option only takes effect when the ``fuse_default_permissions`` is set to ``false``. | |
8 | ||
9 | :Type: String | |
10 | :Default: ``""`` (no ACL enforcement) | |
11 | ||
12 | ``client cache mid`` | |
13 | ||
14 | :Description: Set client cache midpoint. The midpoint splits the least recently used lists into a hot and warm list. | |
15 | :Type: Float | |
16 | :Default: ``0.75`` | |
17 | ||
11fdf7f2 | 18 | ``client cache size`` |
7c673cae FG |
19 | |
20 | :Description: Set the number of inodes that the client keeps in the metadata cache. | |
21 | :Type: Integer | |
22 | :Default: ``16384`` | |
23 | ||
11fdf7f2 | 24 | ``client caps release delay`` |
7c673cae FG |
25 | |
26 | :Description: Set the delay between capability releases in seconds. The delay sets how many seconds a client waits to release capabilities that it no longer needs in case the capabilities are needed for another user space operation. | |
27 | :Type: Integer | |
28 | :Default: ``5`` (seconds) | |
29 | ||
11fdf7f2 | 30 | ``client debug force sync read`` |
7c673cae FG |
31 | |
32 | :Description: If set to ``true``, clients read data directly from OSDs instead of using a local page cache. | |
33 | :Type: Boolean | |
34 | :Default: ``false`` | |
35 | ||
11fdf7f2 | 36 | ``client dirsize rbytes`` |
7c673cae FG |
37 | |
38 | :Description: If set to ``true``, use the recursive size of a directory (that is, total of all descendants). | |
39 | :Type: Boolean | |
40 | :Default: ``true`` | |
41 | ||
11fdf7f2 | 42 | ``client max inline size`` |
7c673cae FG |
43 | |
44 | :Description: Set the maximum size of inlined data stored in a file inode rather than in a separate data object in RADOS. This setting only applies if the ``inline_data`` flag is set on the MDS map. | |
45 | :Type: Integer | |
46 | :Default: ``4096`` | |
47 | ||
11fdf7f2 | 48 | ``client metadata`` |
7c673cae FG |
49 | |
50 | :Description: Comma-delimited strings for client metadata sent to each MDS, in addition to the automatically generated version, host name, and other metadata. | |
51 | :Type: String | |
52 | :Default: ``""`` (no additional metadata) | |
53 | ||
11fdf7f2 | 54 | ``client mount gid`` |
7c673cae FG |
55 | |
56 | :Description: Set the group ID of CephFS mount. | |
57 | :Type: Integer | |
58 | :Default: ``-1`` | |
59 | ||
11fdf7f2 | 60 | ``client mount timeout`` |
7c673cae FG |
61 | |
62 | :Description: Set the timeout for CephFS mount in seconds. | |
63 | :Type: Float | |
64 | :Default: ``300.0`` | |
65 | ||
11fdf7f2 | 66 | ``client mount uid`` |
7c673cae FG |
67 | |
68 | :Description: Set the user ID of CephFS mount. | |
69 | :Type: Integer | |
70 | :Default: ``-1`` | |
71 | ||
11fdf7f2 | 72 | ``client mountpoint`` |
7c673cae FG |
73 | |
74 | :Description: Directory to mount on the CephFS file system. An alternative to the ``-r`` option of the ``ceph-fuse`` command. | |
75 | :Type: String | |
76 | :Default: ``"/"`` | |
77 | ||
11fdf7f2 | 78 | ``client oc`` |
7c673cae FG |
79 | |
80 | :Description: Enable object caching. | |
81 | :Type: Boolean | |
82 | :Default: ``true`` | |
83 | ||
11fdf7f2 | 84 | ``client oc max dirty`` |
7c673cae FG |
85 | |
86 | :Description: Set the maximum number of dirty bytes in the object cache. | |
87 | :Type: Integer | |
88 | :Default: ``104857600`` (100MB) | |
89 | ||
11fdf7f2 | 90 | ``client oc max dirty age`` |
7c673cae FG |
91 | |
92 | :Description: Set the maximum age in seconds of dirty data in the object cache before writeback. | |
93 | :Type: Float | |
94 | :Default: ``5.0`` (seconds) | |
95 | ||
11fdf7f2 | 96 | ``client oc max objects`` |
7c673cae FG |
97 | |
98 | :Description: Set the maximum number of objects in the object cache. | |
99 | :Type: Integer | |
100 | :Default: ``1000`` | |
101 | ||
11fdf7f2 | 102 | ``client oc size`` |
7c673cae FG |
103 | |
104 | :Description: Set how many bytes of data will the client cache. | |
105 | :Type: Integer | |
106 | :Default: ``209715200`` (200 MB) | |
107 | ||
11fdf7f2 | 108 | ``client oc target dirty`` |
7c673cae FG |
109 | |
110 | :Description: Set the target size of dirty data. We recommend to keep this number low. | |
111 | :Type: Integer | |
112 | :Default: ``8388608`` (8MB) | |
113 | ||
11fdf7f2 | 114 | ``client permissions`` |
7c673cae FG |
115 | |
116 | :Description: Check client permissions on all I/O operations. | |
117 | :Type: Boolean | |
118 | :Default: ``true`` | |
119 | ||
11fdf7f2 | 120 | ``client quota`` |
7c673cae FG |
121 | |
122 | :Description: Enable client quota checking if set to ``true``. | |
123 | :Type: Boolean | |
124 | :Default: ``true`` | |
125 | ||
11fdf7f2 | 126 | ``client quota df`` |
7c673cae FG |
127 | |
128 | :Description: Report root directory quota for the ``statfs`` operation. | |
129 | :Type: Boolean | |
130 | :Default: ``true`` | |
131 | ||
11fdf7f2 | 132 | ``client readahead max bytes`` |
7c673cae | 133 | |
11fdf7f2 | 134 | :Description: Set the maximum number of bytes that the client reads ahead for future read operations. Overridden by the ``client_readahead_max_periods`` setting. |
7c673cae FG |
135 | :Type: Integer |
136 | :Default: ``0`` (unlimited) | |
137 | ||
11fdf7f2 | 138 | ``client readahead max periods`` |
7c673cae | 139 | |
11fdf7f2 | 140 | :Description: Set the number of file layout periods (object size * number of stripes) that the client reads ahead. Overrides the ``client_readahead_max_bytes`` setting. |
7c673cae FG |
141 | :Type: Integer |
142 | :Default: ``4`` | |
143 | ||
11fdf7f2 | 144 | ``client readahead min`` |
7c673cae | 145 | |
11fdf7f2 | 146 | :Description: Set the minimum number bytes that the client reads ahead. |
7c673cae FG |
147 | :Type: Integer |
148 | :Default: ``131072`` (128KB) | |
149 | ||
11fdf7f2 | 150 | ``client reconnect stale`` |
7c673cae FG |
151 | |
152 | :Description: Automatically reconnect stale session. | |
153 | :Type: Boolean | |
154 | :Default: ``false`` | |
155 | ||
11fdf7f2 | 156 | ``client snapdir`` |
7c673cae FG |
157 | |
158 | :Description: Set the snapshot directory name. | |
159 | :Type: String | |
160 | :Default: ``".snap"`` | |
161 | ||
11fdf7f2 | 162 | ``client tick interval`` |
7c673cae FG |
163 | |
164 | :Description: Set the interval in seconds between capability renewal and other upkeep. | |
165 | :Type: Float | |
166 | :Default: ``1.0`` (seconds) | |
167 | ||
11fdf7f2 | 168 | ``client use random mds`` |
7c673cae FG |
169 | |
170 | :Description: Choose random MDS for each request. | |
171 | :Type: Boolean | |
172 | :Default: ``false`` | |
173 | ||
11fdf7f2 | 174 | ``fuse default permissions`` |
7c673cae FG |
175 | |
176 | :Description: When set to ``false``, ``ceph-fuse`` utility checks does its own permissions checking, instead of relying on the permissions enforcement in FUSE. Set to ``false`` together with the ``client acl type=posix_acl`` option to enable POSIX ACL. | |
177 | :Type: Boolean | |
178 | :Default: ``true`` | |
179 | ||
11fdf7f2 TL |
180 | ``fuse max write`` |
181 | ||
182 | :Description: Set the maximum number of bytes in a single write operation. Because the FUSE default is 128kbytes, SO fuse_max_write default set to 0(The default does not take effect) | |
183 | :Type: Integer | |
184 | :Default: ``0`` | |
185 | ||
7c673cae FG |
186 | Developer Options |
187 | ################# | |
188 | ||
189 | .. important:: These options are internal. They are listed here only to complete the list of options. | |
190 | ||
11fdf7f2 | 191 | ``client debug getattr caps`` |
7c673cae FG |
192 | |
193 | :Description: Check if the reply from the MDS contains required capabilities. | |
194 | :Type: Boolean | |
195 | :Default: ``false`` | |
196 | ||
11fdf7f2 | 197 | ``client debug inject tick delay`` |
7c673cae FG |
198 | |
199 | :Description: Add artificial delay between client ticks. | |
200 | :Type: Integer | |
201 | :Default: ``0`` | |
202 | ||
11fdf7f2 | 203 | ``client inject fixed oldest tid`` |
7c673cae FG |
204 | |
205 | :Description: | |
206 | :Type: Boolean | |
207 | :Default: ``false`` | |
208 | ||
11fdf7f2 | 209 | ``client inject release failure`` |
7c673cae FG |
210 | |
211 | :Description: | |
212 | :Type: Boolean | |
213 | :Default: ``false`` | |
214 | ||
11fdf7f2 | 215 | ``client trace`` |
7c673cae FG |
216 | |
217 | :Description: The path to the trace file for all file operations. The output is designed to be used by the Ceph `synthetic client <../../man/8/ceph-syn>`_. | |
218 | :Type: String | |
219 | :Default: ``""`` (disabled) | |
220 |