Skip to content

Commit 88d7c95

Browse files
doc/mgr: add a warning about the smb clustering option & placement
Add a warning to the docs highlighting that `clustering` is an advanced option and setting it without out also setting a compatible placement value may lead to unexpected behavior. Signed-off-by: John Mulligan <[email protected]>
1 parent 4cf3abd commit 88d7c95

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/mgr/smb.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,14 @@ custom_smb_global_options
418418
things in ways that the Ceph team can not help with. This special key will
419419
automatically be removed from the list of options passed to Samba.
420420

421+
.. warning::
422+
Setting the ``clustering`` option allows an administrator to choose exactly
423+
when Samba's CTDB clustering will be used. By default, the use of Samba's
424+
clustering is derived from the ``placement`` count. If you choose to set
425+
``clustering`` make sure you understand how clustering interacts with
426+
placement. In particular, be aware that running multiple instances of the
427+
same ``smb`` service without clustering enabled can cause unexpected behavior.
428+
421429

422430
.. _join-source-fields:
423431

0 commit comments

Comments
 (0)