From 0cd76bd8a4098b33cbeaedda75deb6010f7f59d8 Mon Sep 17 00:00:00 2001
From: Liviu Chircu <liviu@opensips.org>
Date: Mon, 23 Sep 2024 18:08:10 +0300
Subject: [PATCH] Clustered modules: Add sections on clusterer's "seed"
 mechanism

    * b2b_entities
    * cachedb_local
    * dialog
    * load_balancer
    * presence
    * usrloc

(cherry picked from commit 7723f0e918d0cb562a5424104eb3077bd8dd3054)
---
 modules/b2b_entities/doc/b2b_entities.xml         | 2 ++
 modules/b2b_entities/doc/b2b_entities_admin.xml   | 3 +++
 modules/cachedb_local/doc/cachedb_local.xml       | 2 ++
 modules/cachedb_local/doc/cachedb_local_admin.xml | 3 +++
 modules/dialog/doc/dialog.xml                     | 2 ++
 modules/dialog/doc/dialog_admin.xml               | 3 +++
 modules/load_balancer/doc/load_balancer.xml       | 2 ++
 modules/load_balancer/doc/load_balancer_admin.xml | 3 +++
 modules/presence/doc/presence.xml                 | 2 ++
 modules/presence/doc/presence_admin.xml           | 3 +++
 modules/usrloc/doc/usrloc.xml                     | 2 ++
 modules/usrloc/doc/usrloc_admin.xml               | 3 +++
 12 files changed, 30 insertions(+)

diff --git a/modules/b2b_entities/doc/b2b_entities.xml b/modules/b2b_entities/doc/b2b_entities.xml
index f44c05e81a7..15e51b28947 100644
--- a/modules/b2b_entities/doc/b2b_entities.xml
+++ b/modules/b2b_entities/doc/b2b_entities.xml
@@ -7,6 +7,8 @@
 <!ENTITY devel SYSTEM "b2b_entities_devel.xml">
 <!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 <!ENTITY contrib SYSTEM "contributors.xml">
+<!ENTITY my_cl_sync_cap "b2be-entities-repl">
+<!ENTITY clusterer_sync_cap_para SYSTEM "../../clusterer/doc/clusterer_sync_cap.xml">
 
 <!-- Include general documentation entities -->
 <!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
diff --git a/modules/b2b_entities/doc/b2b_entities_admin.xml b/modules/b2b_entities/doc/b2b_entities_admin.xml
index 8123a664eff..907b2e92283 100644
--- a/modules/b2b_entities/doc/b2b_entities_admin.xml
+++ b/modules/b2b_entities/doc/b2b_entities_admin.xml
@@ -297,6 +297,9 @@ modparam("b2b_entities", "db_table", "some table name")
 		persistency through the <emphasis>clusterer</emphasis> module's
 		data "sync" mechanism.
 		</para>
+
+			&clusterer_sync_cap_para;
+
 		<para>
 		<emphasis>Default value is <quote>0</quote> (clustering disabled)</emphasis>
 		</para>
diff --git a/modules/cachedb_local/doc/cachedb_local.xml b/modules/cachedb_local/doc/cachedb_local.xml
index 22ff863c306..9f9b15e6c77 100644
--- a/modules/cachedb_local/doc/cachedb_local.xml
+++ b/modules/cachedb_local/doc/cachedb_local.xml
@@ -6,6 +6,8 @@
 <!ENTITY admin SYSTEM "cachedb_local_admin.xml">
 <!ENTITY faq SYSTEM "cachedb_local_faq.xml">
 <!ENTITY contrib SYSTEM "contributors.xml">
+<!ENTITY my_cl_sync_cap "cachedb-local-repl">
+<!ENTITY clusterer_sync_cap_para SYSTEM "../../clusterer/doc/clusterer_sync_cap.xml">
 
 <!-- Include general documentation entities -->
 <!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
diff --git a/modules/cachedb_local/doc/cachedb_local_admin.xml b/modules/cachedb_local/doc/cachedb_local_admin.xml
index 3ab0740aca9..b235a03df2c 100644
--- a/modules/cachedb_local/doc/cachedb_local_admin.xml
+++ b/modules/cachedb_local/doc/cachedb_local_admin.xml
@@ -192,6 +192,9 @@ modparam("cachedb_local", "cache_clean_period", 1200)
 		Specifies the cluster ID which this instance will send to and receive
 		cache data.
 		</para>
+
+			&clusterer_sync_cap_para;
+
 		<para>
 			Default value is 0 (replication disabled).
 		</para>
diff --git a/modules/dialog/doc/dialog.xml b/modules/dialog/doc/dialog.xml
index 8aae9aaa238..1a494919c17 100644
--- a/modules/dialog/doc/dialog.xml
+++ b/modules/dialog/doc/dialog.xml
@@ -7,6 +7,8 @@
 <!ENTITY devel SYSTEM "dialog_devel.xml">
 <!ENTITY faq SYSTEM "dialog_faq.xml">
 <!ENTITY contrib SYSTEM "contributors.xml">
+<!ENTITY my_cl_sync_cap "dialog-dlg-repl">
+<!ENTITY clusterer_sync_cap_para SYSTEM "../../clusterer/doc/clusterer_sync_cap.xml">
 
 <!-- Include general documentation entities -->
 <!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
diff --git a/modules/dialog/doc/dialog_admin.xml b/modules/dialog/doc/dialog_admin.xml
index c059ecfee76..f49007e0038 100644
--- a/modules/dialog/doc/dialog_admin.xml
+++ b/modules/dialog/doc/dialog_admin.xml
@@ -1270,6 +1270,9 @@ modparam("dialog", "profile_timeout", "43200")
 			and receiving all the dialog-related events (creation, update and
 			deletion) in the cluster.
 		</para>
+
+			&clusterer_sync_cap_para;
+
 		<para>
 		<emphasis>
 			Default value is <quote>0</quote> (no replication).
diff --git a/modules/load_balancer/doc/load_balancer.xml b/modules/load_balancer/doc/load_balancer.xml
index 9d8504306ad..11f522d3547 100644
--- a/modules/load_balancer/doc/load_balancer.xml
+++ b/modules/load_balancer/doc/load_balancer.xml
@@ -7,6 +7,8 @@
 <!ENTITY devel SYSTEM "load_balancer_devel.xml">
 <!ENTITY faq SYSTEM "load_balancer_faq.xml">
 <!ENTITY contrib SYSTEM "contributors.xml">
+<!ENTITY my_cl_sync_cap "load_balancer-status-repl">
+<!ENTITY clusterer_sync_cap_para SYSTEM "../../clusterer/doc/clusterer_sync_cap.xml">
 
 <!-- Include general documentation entities -->
 <!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
diff --git a/modules/load_balancer/doc/load_balancer_admin.xml b/modules/load_balancer/doc/load_balancer_admin.xml
index 90883d22b83..4a464b3b326 100644
--- a/modules/load_balancer/doc/load_balancer_admin.xml
+++ b/modules/load_balancer/doc/load_balancer_admin.xml
@@ -418,6 +418,9 @@ modparam("load_balancer", "initial_freeswitch_load", 200)
 		destinations. See the
 		<xref linkend="param_cluster_sharing_tag"/> option.
 		</para>
+
+			&clusterer_sync_cap_para;
+
 		<para>
 		For more info on how to define and populate a cluster (with OpenSIPS 
 		nodes) see the "clusterer" module.
diff --git a/modules/presence/doc/presence.xml b/modules/presence/doc/presence.xml
index 914ed63280d..c95bad2c244 100644
--- a/modules/presence/doc/presence.xml
+++ b/modules/presence/doc/presence.xml
@@ -6,6 +6,8 @@
 <!ENTITY admin SYSTEM "presence_admin.xml">
 <!ENTITY devel SYSTEM "presence_devel.xml">
 <!ENTITY contrib SYSTEM "contributors.xml">
+<!ENTITY my_cl_sync_cap "presence">
+<!ENTITY clusterer_sync_cap_para SYSTEM "../../clusterer/doc/clusterer_sync_cap.xml">
 
 <!-- Include general documentation entities -->
 <!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
diff --git a/modules/presence/doc/presence_admin.xml b/modules/presence/doc/presence_admin.xml
index b80e5fa4434..958913a3a2b 100644
--- a/modules/presence/doc/presence_admin.xml
+++ b/modules/presence/doc/presence_admin.xml
@@ -163,6 +163,9 @@ modparam("presence", "fallback2db", 1)
 		understand th concept of a cluster ID, please see the 
 		<emphasis>clusterer</emphasis> module.
 		</para>
+
+			&clusterer_sync_cap_para;
+
 		<para>
 		For more on presence clustering see the 
 		<xref linkend="presence_clustering"/> chapter.
diff --git a/modules/usrloc/doc/usrloc.xml b/modules/usrloc/doc/usrloc.xml
index 324be4725bc..d77cbdef0e8 100644
--- a/modules/usrloc/doc/usrloc.xml
+++ b/modules/usrloc/doc/usrloc.xml
@@ -7,6 +7,8 @@
 <!ENTITY devel SYSTEM "usrloc_devel.xml">
 <!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 <!ENTITY contrib SYSTEM "contributors.xml">
+<!ENTITY my_cl_sync_cap "usrloc-contact-repl">
+<!ENTITY clusterer_sync_cap_para SYSTEM "../../clusterer/doc/clusterer_sync_cap.xml">
 
 <!-- Include general documentation entities -->
 <!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
diff --git a/modules/usrloc/doc/usrloc_admin.xml b/modules/usrloc/doc/usrloc_admin.xml
index cdac98f4f8f..77f0ba62467 100644
--- a/modules/usrloc/doc/usrloc_admin.xml
+++ b/modules/usrloc/doc/usrloc_admin.xml
@@ -1171,6 +1171,9 @@ modparam("usrloc", "cseq_delay", 5)
         (<emphasis>addresses-of-record</emphasis>, <emphasis>contacts</emphasis>),
 		organized into specific events (inserts, deletes or updates).
 		</para>
+
+			&clusterer_sync_cap_para;
+
 		<para>
 		Default value is 0 (replication disabled).
 		</para>