Fix some bugs when testing opensds ansible
[stor4nfv.git] / src / ceph / doc / cephfs / best-practices.rst
1
2 CephFS best practices
3 =====================
4
5 This guide provides recommendations for best results when deploying CephFS.
6
7 For the actual configuration guide for CephFS, please see the instructions
8 at :doc:`/cephfs/index`.
9
10 Which Ceph version?
11 -------------------
12
13 Use at least the Jewel (v10.2.0) release of Ceph.  This is the first
14 release to include stable CephFS code and fsck/repair tools.  Make sure
15 you are using the latest point release to get bug fixes.
16
17 Note that Ceph releases do not include a kernel, this is versioned
18 and released separately.  See below for guidance of choosing an
19 appropriate kernel version if you are using the kernel client
20 for CephFS.
21
22 Most stable configuration
23 -------------------------
24
25 Some features in CephFS are still experimental.  See
26 :doc:`/cephfs/experimental-features` for guidance on these.
27
28 For the best chance of a happy healthy filesystem, use a **single active MDS** 
29 and **do not use snapshots**.  Both of these are the default.
30
31 Note that creating multiple MDS daemons is fine, as these will simply be
32 used as standbys.  However, for best stability you should avoid
33 adjusting ``max_mds`` upwards, as this would cause multiple
34 daemons to be active at once.
35
36 Which client?
37 -------------
38
39 The fuse client is the easiest way to get up to date code, while
40 the kernel client will often give better performance.
41
42 The clients do not always provide equivalent functionality, for example
43 the fuse client supports client-enforced quotas while the kernel client
44 does not.
45
46 When encountering bugs or performance issues, it is often instructive to
47 try using the other client, in order to find out whether the bug was
48 client-specific or not (and then to let the developers know).
49
50 Which kernel version?
51 ~~~~~~~~~~~~~~~~~~~~~
52
53 Because the kernel client is distributed as part of the linux kernel (not
54 as part of packaged ceph releases),
55 you will need to consider which kernel version to use on your client nodes.
56 Older kernels are known to include buggy ceph clients, and may not support
57 features that more recent Ceph clusters support.
58
59 Remember that the "latest" kernel in a stable linux distribution is likely
60 to be years behind the latest upstream linux kernel where Ceph development
61 takes place (including bug fixes).
62
63 As a rough guide, as of Ceph 10.x (Jewel), you should be using a least a
64 4.x kernel.  If you absolutely have to use an older kernel, you should use
65 the fuse client instead of the kernel client.
66
67 This advice does not apply if you are using a linux distribution that
68 includes CephFS support, as in this case the distributor will be responsible
69 for backporting fixes to their stable kernel: check with your vendor.
70
71 Reporting issues
72 ----------------
73
74 If you have identified a specific issue, please report it with as much
75 information as possible.  Especially important information:
76
77 * Ceph versions installed on client and server
78 * Whether you are using the kernel or fuse client
79 * If you are using the kernel client, what kernel version?
80 * How many clients are in play, doing what kind of workload?
81 * If a system is 'stuck', is that affecting all clients or just one?
82 * Any ceph health messages
83 * Any backtraces in the ceph logs from crashes
84
85 If you are satisfied that you have found a bug, please file it on
86 http://tracker.ceph.com.  For more general queries please write
87 to the ceph-users mailing list.
88