]> git.ipfire.org Git - thirdparty/samba.git/commitdiff
docs_xml/vfs_ceph_new: Add new proxy option
authorAnoop C S <anoopcs@samba.org>
Thu, 5 Sep 2024 06:15:19 +0000 (11:45 +0530)
committerJule Anger <janger@samba.org>
Mon, 17 Feb 2025 16:09:09 +0000 (16:09 +0000)
Update man page to describe new 'proxy' module option.

BUG: https://bugzilla.samba.org/show_bug.cgi?id=15703

Signed-off-by: Anoop C S <anoopcs@samba.org>
Reviewed-by: Guenther Deschner <gd@samba.org>
Autobuild-User(master): Anoop C S <anoopcs@samba.org>
Autobuild-Date(master): Thu Sep 12 16:51:14 UTC 2024 on atb-devel-224

(cherry picked from commit 12ad4832a74a6fba3fb8954a8630b900f5763f18)

docs-xml/manpages/vfs_ceph_new.8.xml

index b0640a591a51d110622475d278bf03a372b4c073..eaf5b66ccebf076fbbdfa01e15c2389128408c95 100644 (file)
                </listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>ceph_new:proxy = [ yes | no | auto ]</term>
+               <listitem>
+               <para>
+                       Allows one to indicate use of the libcephfs proxy library
+                       for optimized resource utilization, allowing more simultaneous
+                       client connections. Prerequisites include the presence of
+                       <emphasis>libcephfs_proxy.so.X</emphasis> shared library file
+                       under loadable locations for dynamic linker and an active(running)
+                       <emphasis>libcephfsd</emphasis> daemon.
+               </para>
+
+               <itemizedlist>
+                       <listitem><para><constant>no</constant> (default) - Do
+                       not use the proxy library but regular connection through
+                       <emphasis>libcephfs.so.X</emphasis>.</para></listitem>
+
+                       <listitem><para><constant>yes</constant> - Always use
+                       the proxy library and fail the client connection request
+                       if prerequisites are unmet.</para></listitem>
+
+                       <listitem><para><constant>auto</constant> - Attempt to
+                       use the proxy library but fall back to the regular cephfs
+                       connection if prerequisites are unmet.</para></listitem>
+
+               </itemizedlist>
+
+               </listitem>
+               </varlistentry>
        </variablelist>
 
 </refsect1>