From 88d7c95f437c5081d78c60374c8ef0c2fbf0bf4b Mon Sep 17 00:00:00 2001 From: John Mulligan Date: Wed, 2 Apr 2025 16:36:29 -0400 Subject: [PATCH] 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 --- doc/mgr/smb.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/mgr/smb.rst b/doc/mgr/smb.rst index 3252c485a9aa7..2dcb6e31512d2 100644 --- a/doc/mgr/smb.rst +++ b/doc/mgr/smb.rst @@ -418,6 +418,14 @@ custom_smb_global_options things in ways that the Ceph team can not help with. This special key will automatically be removed from the list of options passed to Samba. +.. warning:: + Setting the ``clustering`` option allows an administrator to choose exactly + when Samba's CTDB clustering will be used. By default, the use of Samba's + clustering is derived from the ``placement`` count. If you choose to set + ``clustering`` make sure you understand how clustering interacts with + placement. In particular, be aware that running multiple instances of the + same ``smb`` service without clustering enabled can cause unexpected behavior. + .. _join-source-fields: -- 2.39.5