docs-xml/manpages/vfs_ceph.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.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_ceph</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</refname>
  16         <refpurpose>
  17                 Utilize features provided by CephFS
  18         </refpurpose>
  19 </refnamediv>
  20
  21 <refsynopsisdiv>
  22         <cmdsynopsis>
  23                 <command>vfs objects = ceph</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</command> VFS module exposes
  36                 CephFS specific features for use by Samba.
  37         </para>
  38
  39         <para>
  40                 Ceph is a distributed network file system designed to provide
  41                 excellent performance, reliability, and scalability. This is a
  42                 shared library allowing applications to access a Ceph
  43                 distributed file system via a POSIX-like interface.
  44         </para>
  45
  46         <para>
  47                 This module can be combined with other modules, but it
  48                 should be the last module in the <command>vfs objects</command>
  49                 list. Modules added to this list to the right of the ceph
  50                 entry may not have any effect at all.
  51         </para>
  52
  53         <para>
  54                 <command>vfs_ceph</command> performs mapping between Windows and
  55                 POSIX Access Control Lists (ACLs). To ensure correct processing
  56                 and enforcement of POSIX ACLs, the following Ceph configuration
  57                 parameters are automatically applied:
  58         </para>
  59         <programlisting>
  60                 <command>client acl type = posix_acl</command>
  61                 <command>fuse default permissions = false</command>
  62         </programlisting>
  63 </refsect1>
  64
  65 <refsect1>
  66         <title>CONFIGURATION</title>
  67
  68         <para>
  69                 <command>vfs_ceph</command> requires that the underlying share
  70                 path is a Ceph filesystem.
  71         </para>
  72
  73         <programlisting>
  74                 <smbconfsection name="[share]"/>
  75                 <smbconfoption name="vfs objects">ceph</smbconfoption>
  76                 <smbconfoption name="path">/non-mounted/cephfs/path</smbconfoption>
  77                 <smbconfoption name="kernel share modes">no</smbconfoption>
  78         </programlisting>
  79
  80         <para>
  81                 Since <command>vfs_ceph</command> does not require a filesystem
  82                 mount, the share <command>path</command> is treated differently:
  83                 it is interpreted as an absolute path within the Ceph filesystem
  84                 on the attached Ceph cluster.
  85                 In a ctdb cluster environment where ctdb manages Samba,
  86                 <command>CTDB_SAMBA_SKIP_SHARE_CHECK=yes</command> must be
  87                 configured to disable local share path checks, otherwise ctdb
  88                 will not reach a healthy state.
  89         </para>
  90
  91         <para>
  92                 Note that currently <command>kernel share modes</command> have
  93                 to be disabled in a share running with the CephFS vfs module for
  94                 file serving to work properly.
  95         </para>
  96 </refsect1>
  97
  98 <refsect1>
  99         <title>OPTIONS</title>
 100
 101         <variablelist>
 102
 103                 <varlistentry>
 104                 <term>ceph:config_file = path</term>
 105                 <listitem>
 106                 <para>
 107                         Allows one to define a ceph configfile to use. Empty by default.
 108                 </para>
 109                 <para>
 110                         Example: ceph:config_file =
 111                         /etc/ceph/ceph.conf
 112                 </para>
 113                 </listitem>
 114                 </varlistentry>
 115
 116                 <varlistentry>
 117                 <term>ceph:user_id = name</term>
 118                 <listitem>
 119                 <para>
 120                         Allows one to explicitly set the client ID used for the
 121                         CephFS mount handle. Empty by default (use the libcephfs
 122                         client default).
 123                 </para>
 124                 <para>
 125                         Example: ceph:user_id = samba
 126                 </para>
 127                 </listitem>
 128                 </varlistentry>
 129
 130                 <varlistentry>
 131                 <term>ceph:filesystem = fs_name</term>
 132                 <listitem>
 133                 <para>
 134                         Allows one to explicitly select the CephFS file system
 135                         to use when the Ceph cluster supports more than one
 136                         file system. Empty by default (use the default file system
 137                         of the Ceph cluster).
 138                 </para>
 139                 <para>
 140                         Example: ceph:filesystem = myfs2
 141                 </para>
 142                 </listitem>
 143                 </varlistentry>
 144
 145         </variablelist>
 146
 147 </refsect1>
 148
 149 <refsect1>
 150         <title>VERSION</title>
 151
 152         <para>
 153                 This man page is part of version &doc.version; of the Samba suite.
 154         </para>
 155 </refsect1>
 156
 157 <refsect1>
 158         <title>AUTHOR</title>
 159
 160         <para>The original Samba software and related utilities
 161         were created by Andrew Tridgell. Samba is now developed
 162         by the Samba Team as an Open Source project similar
 163         to the way the Linux kernel is developed.</para>
 164
 165 </refsect1>
 166
 167 </refentry>