mirror of
https://github.com/samba-team/samba.git
synced 2024-12-22 13:34:15 +03:00
62ea6ae8c9
Document how the `ceph:filesystem` parameter allows one to select the cephfs file system to use for the share. Signed-off-by: John Mulligan <jmulligan@redhat.com> Reviewed-by: Guenther Deschner <gd@samba.org> Reviewed-by: Anoop C S <anoopcs@samba.org> Autobuild-User(master): Anoop C S <anoopcs@samba.org> Autobuild-Date(master): Fri Feb 24 05:37:57 UTC 2023 on atb-devel-224
168 lines
4.3 KiB
XML
168 lines
4.3 KiB
XML
<?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>
|
|
|
|
<para>
|
|
<command>vfs_ceph</command> performs mapping between Windows and
|
|
POSIX Access Control Lists (ACLs). To ensure correct processing
|
|
and enforcement of POSIX ACLs, the following Ceph configuration
|
|
parameters are automatically applied:
|
|
</para>
|
|
<programlisting>
|
|
<command>client acl type = posix_acl</command>
|
|
<command>fuse default permissions = false</command>
|
|
</programlisting>
|
|
</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 (use the libcephfs
|
|
client default).
|
|
</para>
|
|
<para>
|
|
Example: ceph:user_id = samba
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>ceph:filesystem = fs_name</term>
|
|
<listitem>
|
|
<para>
|
|
Allows one to explicitly select the CephFS file system
|
|
to use when the Ceph cluster supports more than one
|
|
file system. Empty by default (use the default file system
|
|
of the Ceph cluster).
|
|
</para>
|
|
<para>
|
|
Example: ceph:filesystem = myfs2
|
|
</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>
|