Clustered modules: Add sections on clusterer's "seed" mechanism

* b2b_entities * cachedb_local * dialog * load_balancer * presence * usrloc (cherry picked from commit 7723f0e)
OpenSIPS · Sep 23, 2024 · 0cd76bd · 0cd76bd
1 parent 3a1baaa
commit 0cd76bd
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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>