Skip to content

Commit 2b06024

Browse files
Merge pull request ceph#63088 from spuiuk/doc-provider
doc/mgr/smb: document the 'provider' option for smb share
2 parents 5ebf217 + 742659b commit 2b06024

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

doc/mgr/smb.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -608,8 +608,20 @@ cephfs
608608
subvolume field will automatically be split into
609609
``<subvolumegroup>/<subvolume>`` parts for convenience
610610
provider
611-
Optional. One of ``samba-vfs`` or ``kcephfs`` (``kcephfs`` is not yet
612-
supported) . Selects how CephFS storage should be provided to the share
611+
Optional. Selects how CephFS storage should be provided to the share.
612+
The value may be one of ``samba-vfs``, ``samba-vfs/classic``,
613+
``samba-vfs/new`` or ``samba-vfs/proxied``. If unspecified,
614+
``samba-vfs`` is assumed.
615+
616+
Selecting ``samba-vfs/new`` selects the new Samba VFS plugin to connect to
617+
CephFS and ``samba-vfs/proxied`` uses the new VFS plugin but routes the
618+
connections through a proxy. Using the proxy allows for a greater number of
619+
simultaneous client connections to the share, but it comes at the cost of
620+
performance. ``samba-vfs/classic`` uses the older Samba VFS plugin to
621+
connect to CephFS. ``samba-vfs`` automatically selects the preferred VFS
622+
based implementation, currently ``samba-vfs/proxied``. This option is
623+
suitable for the majority of use cases and can be left unspecified for most
624+
shares.
613625
restrict_access
614626
Optional boolean, defaulting to false. If true the share will only permit
615627
access by users explicitly listed in ``login_control``.

0 commit comments

Comments
 (0)