From ff2ecedd6f9fd9fa8b2b6278e9a0339c9d8b03b0 Mon Sep 17 00:00:00 2001 From: Shachar Sharon Date: Tue, 20 Feb 2024 19:37:45 +0200 Subject: [PATCH] docs-xml/manpages: add entry for vfs_ceph_new Create man entry for the newly added vfs_ceph_new module: almost identical to existing vfs_ceph, except to the configuration entry: [sharename] vfs objects = ceph_new ... Adds a bit of info for the motivation behind this new module. BUG: https://bugzilla.samba.org/show_bug.cgi?id=15686 Signed-off-by: Shachar Sharon Reviewed-by: Guenther Deschner Reviewed-by: Anoop C S (cherry picked from commit d8c84a2993b84ebb69011c33c1b5d44801c15363) --- docs-xml/manpages/vfs_ceph_new.8.xml | 177 +++++++++++++++++++++++++++ docs-xml/wscript_build | 1 + 2 files changed, 178 insertions(+) create mode 100644 docs-xml/manpages/vfs_ceph_new.8.xml diff --git a/docs-xml/manpages/vfs_ceph_new.8.xml b/docs-xml/manpages/vfs_ceph_new.8.xml new file mode 100644 index 00000000000..7a65b965ce0 --- /dev/null +++ b/docs-xml/manpages/vfs_ceph_new.8.xml @@ -0,0 +1,177 @@ + + + + + + vfs_ceph_new + 8 + Samba + System Administration tools + &doc.version; + + + + + vfs_ceph_new + + Utilize features provided by libcephfs low-level APIs + + + + + + vfs objects = ceph_new + + + + + DESCRIPTION + + This VFS module is part of the + samba + 8 suite. + + + The vfs_ceph_new VFS module exposes + CephFS specific features for use by Samba. + + + + 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. + + + + This module can be combined with other modules, but it + should be the last module in the vfs objects + list. Modules added to this list to the right of the ceph + entry may not have any effect at all. + + + + vfs_ceph_new performs mapping between Windows + and POSIX Access Control Lists (ACLs). To ensure correct + processing and enforcement of POSIX ACLs, the following Ceph + configuration parameters are automatically applied: + + + client acl type = posix_acl + fuse default permissions = false + + + + NOTE: + This is a second implementation of a ceph module which uses libcephfs + low-level APIs (compared to the original + vfs_ceph + 8 module which uses path-based + APIs). Using the low-level API allows more optimized and fine-grained + access to the Ceph storage layer. + + + + + CONFIGURATION + + + vfs_ceph_new requires that the underlying + share path is a Ceph filesystem. + + + + + ceph_new + /non-mounted/cephfs/path + no + + + + Since vfs_ceph_new does not require a + filesystem mount, the share path is treated + differently: it is interpreted as an absolute path within the + Ceph filesystem on the attached Ceph cluster. + In a ctdb cluster environment where ctdb manages Samba, + CTDB_SAMBA_SKIP_SHARE_CHECK=yes must be + configured to disable local share path checks, otherwise ctdb + will not reach a healthy state. + + + + Note that currently kernel share modes have + to be disabled in a share running with the CephFS vfs module for + file serving to work properly. + + + + + OPTIONS + + + + + ceph:config_file = path + + + Allows one to define a ceph configfile to use. Empty by default. + + + Example: ceph:config_file = + /etc/ceph/ceph.conf + + + + + + ceph:user_id = name + + + Allows one to explicitly set the client ID used for the + CephFS mount handle. Empty by default (use the libcephfs + client default). + + + Example: ceph:user_id = samba + + + + + + ceph:filesystem = fs_name + + + Allows one to explicitly select the CephFS file system + to use when the Ceph cluster supports more than one + file system. Empty by default (use the default file + system of the Ceph cluster). + + + Example: ceph:filesystem = myfs2 + + + + + + + + + + VERSION + + + This man page is part of version &doc.version; of the Samba suite. + + + + + AUTHOR + + The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed. + + + + diff --git a/docs-xml/wscript_build b/docs-xml/wscript_build index 434afacaf1e..967e18a6596 100644 --- a/docs-xml/wscript_build +++ b/docs-xml/wscript_build @@ -78,6 +78,7 @@ vfs_module_manpages = ['vfs_acl_tdb', 'vfs_cap', 'vfs_catia', 'vfs_ceph', + 'vfs_ceph_new', 'vfs_ceph_snapshots', 'vfs_commit', 'vfs_crossrename',