docs: Fix typo in vfs_ceph_snapshots man page.
[samba.git] / docs-xml / manpages / vfs_ceph_snapshots.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_ceph_snapshots.8">
4
5 <refmeta>
6         <refentrytitle>vfs_ceph_snapshots</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_ceph_snapshots</refname>
16         <refpurpose>
17                 Expose CephFS snapshots as shadow-copies
18         </refpurpose>
19 </refnamediv>
20
21 <refsynopsisdiv>
22         <cmdsynopsis>
23                 <command>vfs objects = ceph_snapshots</command>
24         </cmdsynopsis>
25 </refsynopsisdiv>
26
27 <refsect1>
28         <title>DESCRIPTION</title>
29
30         <para>This VFS module is part of the
31         <citerefentry><refentrytitle>samba</refentrytitle>
32         <manvolnum>8</manvolnum></citerefentry> suite.</para>
33
34         <para>
35                 The <command>vfs_ceph_snapshots</command> VFS module exposes
36                 CephFS snapshots for use by Samba. When enabled, SMB clients
37                 such as Windows Explorer's Previous Versions dialog, can
38                 enumerate snapshots and access them via "timewarp" tokens.
39         </para>
40
41         <para>
42                 This module can be combined with <command>vfs_ceph</command>,
43                 but <command>vfs_ceph_snapshots</command> must be listed first
44                 in the <command>vfs objects</command> parameter list.
45         </para>
46
47         <para>
48                 CephFS support for ceph.snap.btime virtual extended attributes
49                 is required for this module to work properly. This support was
50                 added via https://tracker.ceph.com/issues/38838.
51         </para>
52 </refsect1>
53
54 <refsect1>
55         <title>CONFIGURATION</title>
56
57         <para>
58                 When used atop <command>vfs_ceph</command>,
59                 <command>path</command> refers to an absolute path within the
60                 Ceph filesystem and should not be mounted locally:
61         </para>
62
63         <programlisting>
64                 <smbconfsection name="[share]"/>
65                 <smbconfoption name="vfs objects">ceph_snapshots ceph</smbconfoption>
66                 <smbconfoption name="path">/non-mounted/cephfs/path</smbconfoption>
67                 <smbconfoption name="kernel share modes">no</smbconfoption>
68         </programlisting>
69
70         <para>
71                 <command>vfs_ceph_snapshots</command> can also be used atop a
72                 kernel CephFS mounted share path, without
73                 <command>vfs_ceph</command>. In this case Samba's default VFS
74                 backend <command>vfs_default</command> is used:
75         </para>
76
77         <programlisting>
78                 <smbconfsection name="[share]"/>
79                 <smbconfoption name="vfs objects">ceph_snapshots</smbconfoption>
80                 <smbconfoption name="path">/mnt/cephfs/</smbconfoption>
81         </programlisting>
82 </refsect1>
83
84 <refsect1>
85         <title>OPTIONS</title>
86
87         <variablelist>
88                 <varlistentry>
89                 <term>ceph:snapdir = subdirectory</term>
90                 <listitem>
91                 <para>
92                         Allows for the configuration of the special CephFS
93                         snapshot subdirectory name. This parameter should only
94                         be changed from the ".snap" default if the ceph.conf
95                         <command>client snapdir</command> or
96                         <command>snapdirname</command> mount option settings
97                         are changed from their matching ".snap" defaults.
98                 </para>
99                 <para>
100                         Default:
101                         <smbconfoption name="ceph:snapdir">.snap</smbconfoption>
102                 </para>
103                 <para>
104                         Example:
105                         <smbconfoption name="ceph:snapdir">.snapshots</smbconfoption>
106                 </para>
107                 </listitem>
108                 </varlistentry>
109         </variablelist>
110 </refsect1>
111
112 <refsect1>
113         <title>VERSION</title>
114
115         <para>
116                 This man page is part of version &doc.version; of the Samba suite.
117         </para>
118 </refsect1>
119
120 <refsect1>
121         <title>AUTHOR</title>
122
123         <para>The original Samba software and related utilities
124         were created by Andrew Tridgell. Samba is now developed
125         by the Samba Team as an Open Source project similar
126         to the way the Linux kernel is developed.</para>
127
128 </refsect1>
129
130 </refentry>