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         </programlisting>
  66 </refsect1>
  67
  68 <refsect1>
  69         <title>OPTIONS</title>
  70
  71         <variablelist>
  72
  73                 <varlistentry>
  74                 <term>ceph:config_file = path</term>
  75                 <listitem>
  76                 <para>
  77                         Allows one to define a ceph configfile to use. Empty by default.
  78                 </para>
  79                 <para>
  80                         Example: ceph:config_file =
  81                         /etc/ceph/ceph.conf
  82                 </para>
  83                 </listitem>
  84                 </varlistentry>
  85
  86                 <varlistentry>
  87                 <term>ceph:user_id = name</term>
  88                 <listitem>
  89                 <para>
  90                         Allows one to explicitly set the client ID used for the
  91                         CephFS mount handle. Empty by default (CephFS uses the
  92                         process id).
  93                 </para>
  94                 <para>
  95                         Example: ceph:user_id = samba
  96                 </para>
  97                 </listitem>
  98                 </varlistentry>
  99
 100         </variablelist>
 101
 102 </refsect1>
 103
 104 <refsect1>
 105         <title>VERSION</title>
 106
 107         <para>
 108                 This man page is correct for version &doc.version;.2.0 of the Samba suite.
 109         </para>
 110 </refsect1>
 111
 112 <refsect1>
 113         <title>AUTHOR</title>
 114
 115         <para>The original Samba software and related utilities
 116         were created by Andrew Tridgell. Samba is now developed
 117         by the Samba Team as an Open Source project similar
 118         to the way the Linux kernel is developed.</para>
 119
 120 </refsect1>
 121
 122 </refentry>