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 <jmulligan@redhat.com>

diff --git a/doc/mgr/smb.rst b/doc/mgr/smb.rst
index 3252c485a9aa7b24b0369d8fd35cd13ae9646531..2dcb6e31512d2424ac74ab625c31ffeb88e0b3c6 100644 (file)
--- 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: