From 9997a648d984f8751897fd9adfaa453058da5f14 Mon Sep 17 00:00:00 2001 From: John Mulligan Date: Fri, 23 Aug 2024 10:01:08 -0400 Subject: [PATCH] doc: add documentation for (cluster_)public_addrs options Document the spec and resource options (they're basically the same) for specifying public addresses that will be managed automatically by CTDB. Signed-off-by: John Mulligan --- doc/cephadm/services/smb.rst | 28 +++++++++++++++++++++++++--- doc/mgr/smb.rst | 21 +++++++++++++++++++++ 2 files changed, 46 insertions(+), 3 deletions(-) diff --git a/doc/cephadm/services/smb.rst b/doc/cephadm/services/smb.rst index 15cf085c53d76..abd3f4343f0de 100644 --- a/doc/cephadm/services/smb.rst +++ b/doc/cephadm/services/smb.rst @@ -105,21 +105,43 @@ custom_dns Active Directory even if the Ceph host nodes are not tied into the Active Directory DNS domain(s). -include_ceph_users: +include_ceph_users A list of cephx user (aka entity) names that the Samba Containers may use. The cephx keys for each user in the list will automatically be added to the keyring in the container. -cluster_meta_uri: +cluster_meta_uri A string containing a URI that identifies where the cluster structure metadata will be stored. Required if ``clustered`` feature is set. Must be a RADOS pseudo-URI. -cluster_lock_uri: +cluster_lock_uri A string containing a URI that identifies where Samba/CTDB will store a cluster lock. Required if ``clustered`` feature is set. Must be a RADOS pseudo-URI. +cluster_public_addrs + List of objects; optional. Supported only when using Samba's clustering. + Assign "virtual" IP addresses that will be managed by the clustering + subsystem and may automatically move between nodes running Samba + containers. + Fields: + + address + Required string. An IP address with a required prefix length (example: + ``192.168.4.51/24``). This address will be assigned to one of the + host's network devices and managed automatically. + destination + Optional. String or list of strings. A ``destination`` defines where + the system will assign the managed IPs. Each string value must be a + network address (example ``192.168.4.0/24``). One or more destinations + may be supplied. The typical case is to use exactly one destination and + so the value may be supplied as a string, rather than a list with a + single item. Each destination network will be mapped to a device on a + host. Run ``cephadm list-networks`` for an example of these mappings. + If destination is not supplied the network is automatically determined + using the address value supplied and taken as the destination. + .. note:: diff --git a/doc/mgr/smb.rst b/doc/mgr/smb.rst index 687822c0557e5..05e6369ddf107 100644 --- a/doc/mgr/smb.rst +++ b/doc/mgr/smb.rst @@ -376,6 +376,27 @@ clustering enables clustering regardless of the placement count. A value of ``never`` disables clustering regardless of the placement count. If unspecified, ``default`` is assumed. +public_addrs + List of objects; optional. Supported only when using Samba's clustering. + Assign "virtual" IP addresses that will be managed by the clustering + subsystem and may automatically move between nodes running Samba + containers. + Fields: + + address + Required string. An IP address with a required prefix length (example: + ``192.168.4.51/24``). This address will be assigned to one of the + host's network devices and managed automatically. + destination + Optional. String or list of strings. A ``destination`` defines where + the system will assign the managed IPs. Each string value must be a + network address (example ``192.168.4.0/24``). One or more destinations + may be supplied. The typical case is to use exactly one destination and + so the value may be supplied as a string, rather than a list with a + single item. Each destination network will be mapped to a device on a + host. Run ``cephadm list-networks`` for an example of these mappings. + If destination is not supplied the network is automatically determined + using the address value supplied and taken as the destination. custom_smb_global_options Optional mapping. Specify key-value pairs that will be directly added to the global ``smb.conf`` options (or equivalent) of a Samba server. Do -- 2.39.5