blob: 453052ebae91891187dc7bdaf8220725480b0be7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="vfs_ceph.8">
<refmeta>
<refentrytitle>vfs_ceph</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
<refmiscinfo class="version">&doc.version;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vfs_ceph</refname>
<refpurpose>
Utilize features provided by CephFS
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>vfs objects = ceph</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This VFS module is part of the
<citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> suite.</para>
<para>
The <command>vfs_ceph</command> VFS module exposes
CephFS specific features for use by Samba.
</para>
<para>
Ceph is a distributed network file system designed to provide
excellent performance, reliability, and scalability. This is a
shared library allowing applications to access a Ceph
distributed file system via a POSIX-like interface.
</para>
<para>
This module can be combined with other modules, but it
should be the last module in the <command>vfs objects</command>
list. Modules added to this list to the right of the ceph
entry may not have any effect at all.
</para>
</refsect1>
<refsect1>
<title>CONFIGURATION</title>
<para>
<command>vfs_ceph</command> requires that the underlying share
path is a Ceph filesystem.
</para>
<programlisting>
<smbconfsection name="[share]"/>
<smbconfoption name="vfs objects">ceph</smbconfoption>
<smbconfoption name="path">/non-mounted/cephfs/path</smbconfoption>
<smbconfoption name="kernel share modes">no</smbconfoption>
</programlisting>
<para>
Since <command>vfs_ceph</command> does not require a filesystem
mount, the share <command>path</command> is treated differently:
it is interpreted as an absolute path within the Ceph filesystem
on the attached Ceph cluster.
In a ctdb cluster environment where ctdb manages Samba,
<command>CTDB_SAMBA_SKIP_SHARE_CHECK=yes</command> must be
configured to disable local share path checks, otherwise ctdb
will not reach a healthy state.
</para>
<para>
Note that currently <command>kernel share modes</command> have
to be disabled in a share running with the CephFS vfs module for
file serving to work properly.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>ceph:config_file = path</term>
<listitem>
<para>
Allows one to define a ceph configfile to use. Empty by default.
</para>
<para>
Example: ceph:config_file =
/etc/ceph/ceph.conf
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ceph:user_id = name</term>
<listitem>
<para>
Allows one to explicitly set the client ID used for the
CephFS mount handle. Empty by default (CephFS uses the
process id).
</para>
<para>
Example: ceph:user_id = samba
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>
This man page is part of version &doc.version; of the Samba suite.
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
</refsect1>
</refentry>
|
