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 </refsect1>
  53
  54 <refsect1>
  55         <title>CONFIGURATION</title>
  56
  57         <para>
  58                 <command>vfs_ceph</command> requires that the underlying share
  59                 path is a Ceph filesystem.
  60         </para>
  61
  62         <programlisting>
  63                 <smbconfsection name="[share]"/>
  64                 <smbconfoption name="vfs objects">ceph</smbconfoption>
  65                 <smbconfoption name="path">/non-mounted/cephfs/path</smbconfoption>
  66                 <smbconfoption name="kernel share modes">no</smbconfoption>
  67         </programlisting>
  68
  69         <para>
  70                 Since <command>vfs_ceph</command> does not require a filesystem
  71                 mount, the share <command>path</command> is treated differently:
  72                 it is interpreted as an absolute path within the Ceph filesystem
  73                 on the attached Ceph cluster.
  74                 In a ctdb cluster environment where ctdb manages Samba,
  75                 <command>CTDB_SAMBA_SKIP_SHARE_CHECK=yes</command> must be
  76                 configured to disable local share path checks, otherwise ctdb
  77                 will not reach a healthy state.
  78         </para>
  79
  80         <para>
  81                 Note that currently <command>kernel share modes</command> have
  82                 to be disabled in a share running with the CephFS vfs module for
  83                 file serving to work properly.
  84         </para>
  85 </refsect1>
  86
  87 <refsect1>
  88         <title>OPTIONS</title>
  89
  90         <variablelist>
  91
  92                 <varlistentry>
  93                 <term>ceph:config_file = path</term>
  94                 <listitem>
  95                 <para>
  96                         Allows one to define a ceph configfile to use. Empty by default.
  97                 </para>
  98                 <para>
  99                         Example: ceph:config_file =
 100                         /etc/ceph/ceph.conf
 101                 </para>
 102                 </listitem>
 103                 </varlistentry>
 104
 105                 <varlistentry>
 106                 <term>ceph:user_id = name</term>
 107                 <listitem>
 108                 <para>
 109                         Allows one to explicitly set the client ID used for the
 110                         CephFS mount handle. Empty by default (CephFS uses the
 111                         process id).
 112                 </para>
 113                 <para>
 114                         Example: ceph:user_id = samba
 115                 </para>
 116                 </listitem>
 117                 </varlistentry>
 118
 119         </variablelist>
 120
 121 </refsect1>
 122
 123 <refsect1>
 124         <title>VERSION</title>
 125
 126         <para>
 127                 This man page is part of version &doc.version; of the Samba suite.
 128         </para>
 129 </refsect1>
 130
 131 <refsect1>
 132         <title>AUTHOR</title>
 133
 134         <para>The original Samba software and related utilities
 135         were created by Andrew Tridgell. Samba is now developed
 136         by the Samba Team as an Open Source project similar
 137         to the way the Linux kernel is developed.</para>
 138
 139 </refsect1>
 140
 141 </refentry>