The branch, master has been updated
via 1b39c68 vfs: Add a brief vfs_ceph manpage.
from a99a5a3 Fix the developer O3 build
https://git.samba.org/?p=samba.git;a=shortlog;h=master
- Log -----------------------------------------------------------------
commit 1b39c688cc2c7f57147e45faedc4509d0da2f2b4
Author: Günther Deschner <g...@samba.org>
Date: Thu Feb 5 15:59:52 2015 +0100
vfs: Add a brief vfs_ceph manpage.
Bug: https://bugzilla.samba.org/show_bug.cgi?id=11088
Guenther
Signed-off-by: Günther Deschner <g...@samba.org>
Reviewed-by: Michael Adam <ob...@samba.org>
Autobuild-User(master): Günther Deschner <g...@samba.org>
Autobuild-Date(master): Wed Feb 25 20:56:01 CET 2015 on sn-devel-104
-----------------------------------------------------------------------
Summary of changes:
.../manpages/{vfs_snapper.8.xml => vfs_ceph.8.xml} | 65 +++++++++++++---------
docs-xml/wscript_build | 1 +
2 files changed, 41 insertions(+), 25 deletions(-)
copy docs-xml/manpages/{vfs_snapper.8.xml => vfs_ceph.8.xml} (52%)
Changeset truncated at 500 lines:
diff --git a/docs-xml/manpages/vfs_snapper.8.xml
b/docs-xml/manpages/vfs_ceph.8.xml
similarity index 52%
copy from docs-xml/manpages/vfs_snapper.8.xml
copy to docs-xml/manpages/vfs_ceph.8.xml
index 0e06ec5..978f6b3 100644
--- a/docs-xml/manpages/vfs_snapper.8.xml
+++ b/docs-xml/manpages/vfs_ceph.8.xml
@@ -1,9 +1,9 @@
<?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_snapper.8">
+<refentry id="vfs_ceph.8">
<refmeta>
- <refentrytitle>vfs_snapper</refentrytitle>
+ <refentrytitle>vfs_ceph</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
@@ -12,15 +12,15 @@
<refnamediv>
- <refname>vfs_snapper</refname>
+ <refname>vfs_ceph</refname>
<refpurpose>
- Expose snapshots managed by snapper as shadow-copies
+ Utilize features provided by CephFS
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>vfs objects = snapper</command>
+ <command>vfs objects = ceph</command>
</cmdsynopsis>
</refsynopsisdiv>
@@ -32,14 +32,22 @@
<manvolnum>8</manvolnum></citerefentry> suite.</para>
<para>
- The <command>vfs_snapper</command> VFS module exposes snapshots
- managed by snapper for use by Samba. This provides the ability
- for remote SMB clients to access shadow-copies via Windows
- Explorer using the "previous versions" dialog.
+ The <command>vfs_ceph</command> VFS module exposes
+ CephFS specific features for use by Samba.
</para>
<para>
- This module is stackable.
+ 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>
@@ -47,29 +55,36 @@
<title>CONFIGURATION</title>
<para>
- The underlying share path must have a corresponding snapper
- configuration file. The snapshot directory tree must allow
- access for relavent users.
+ <command>vfs_ceph</command> requires that the underlying share
+ path is a Ceph filesystem.
</para>
<programlisting>
<smbconfsection name="[share]"/>
- <smbconfoption name="vfs objects">snapper</smbconfoption>
+ <smbconfoption name="vfs objects">ceph</smbconfoption>
</programlisting>
</refsect1>
<refsect1>
- <title>PERMISSIONS</title>
- <para>
- Snapper stores snapshots under a .snapshots subdirectory. This
- directory must permit traversal for any users wishing to access
- snapshots via the Windows Explorer previous versions dialog.
- By default, traversal is forbidden for all non-root users.
- Additionally, users must be granted permission to list snapshots
- managed by snapper, via snapper's ALLOW_USERS or ALLOW_GROUPS
- options. Snapper can grant these users and groups .snapshots
- traversal access automatically via the SYNC_ACL option.
- </para>
+ <title>OPTIONS</title>
+
+ <variablelist>
+
+ <varlistentry>
+ <term>ceph:config_file = path</term>
+ <listitem>
+ <para>
+ Allows to define a ceph configfile to use. Empty by
default.
+ </para>
+ <para>
+ Example: ceph:config_file =
+ /etc/ceph/ceph.conf
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
</refsect1>
<refsect1>
diff --git a/docs-xml/wscript_build b/docs-xml/wscript_build
index 4060021..66da399 100644
--- a/docs-xml/wscript_build
+++ b/docs-xml/wscript_build
@@ -53,6 +53,7 @@ manpages='''
manpages/vfs_cacheprime.8
manpages/vfs_cap.8
manpages/vfs_catia.8
+ manpages/vfs_ceph.8
manpages/vfs_commit.8
manpages/vfs_crossrename.8
manpages/vfs_default_quota.8
--
Samba Shared Repository
