doc/mgr: document new smb cluster resource option custom_ports

Signed-off-by: John Mulligan <jmulligan@redhat.com>
(cherry picked from commit ac213f4704d7fc98eea0fc3e18cccdbb3b85dc30)

diff --git a/doc/mgr/smb.rst b/doc/mgr/smb.rst
index a20ae81d0fccc1a133950d7bd025d54168e1858e..61e07f2c0b66a6cf4a4b7285e43914ba73d7625d 100644 (file)
--- a/doc/mgr/smb.rst
+++ b/doc/mgr/smb.rst
@@ -447,6 +447,15 @@ custom_dns
     Optional. List of IP Addresses. IP addresses will be used as DNS
     resolver(s) in Samba containers allowing the containers to use domain DNS
     even if the Ceph host does not
+custom_ports
+    Optional. A mapping of service names to port numbers that will override the
+    default ports used for those services. The service names are:
+    ``smb``, ``smbmetrics``, and ``ctdb``. If a service name is not
+    present in the mapping the default port will be used.
+    For example, ``{"smb": 4455, "smbmetrics": 9009}`` will change the
+    ports used by smb for client access and the metrics exporter, but
+    not change the port used by the CTDB clustering daemon.
+    Note - not all SMB clients are able to use alternate port numbers.
 placement
     Optional. A Ceph Orchestration :ref:`placement specifier
     <orchestrator-cli-placement-spec>`.  Defaults to one host if not provided