usrloc: Document ul_cluster_sync

OpenSIPS · Apr 28, 2018 · a9781e0 · a9781e0
1 parent d481602
commit a9781e0
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/modules/usrloc/README b/modules/usrloc/README
@@ -97,6 +97,7 @@ Liviu Chircu
               1.7.5. ul_add
               1.7.6. ul_show_contact
               1.7.7. ul_sync
+              1.7.8. ul_cluster_sync
 
         1.8. Exported Statistics
 
@@ -1056,6 +1057,19 @@ modparam("usrloc", "latency_event_min_us_delta", 300000)
      * AOR (optional) - user AOR in username[@domain] format
        (domain must be supplied only if use_domain option is on).
 
+1.7.8.  ul_cluster_sync
+
+   This command will only take effect if the module is running
+   under a cluster-enabled working_mode_preset.
+
+   The current node will locate a healthy donor node within the
+   location_cluster and issue a sync request to it. The donor node
+   will then proceed to push all of its user location data over to
+   the current node, via the binary interface. The received data
+   will be merged with existing data. Conflicting contacts
+   (matched according to matching_mode) are overwritten only if
+   the sync data is newer than the current data.
+
 1.8. Exported Statistics
 
    Exported statistics are listed in the next sections.

diff --git a/modules/usrloc/doc/usrloc_admin.xml b/modules/usrloc/doc/usrloc_admin.xml
@@ -1475,6 +1475,25 @@ modparam("usrloc", "latency_event_min_us_delta", 300000)
 		</itemizedlist>
 	</section>
 
+	<section id="mi_ul_cluster_sync" xreflabel="ul_cluster_sync">
+		<title>
+		<function moreinfo="none">ul_cluster_sync</function>
+		</title>
+		<para>
+		This command will only take effect if the module is running under a
+		cluster-enabled <xref linkend="param_working_mode_preset"/>.
+		</para>
+		<para>
+		The current node will locate a healthy donor node within the
+		<xref linkend="param_location_cluster"/> and issue a sync request to
+		it. The donor node will then proceed to push all of its user location
+		data over to the current node, via the binary interface. The received
+		data will be merged with existing data. Conflicting contacts (matched
+		according to <xref linkend="param_matching_mode"/>) are overwritten
+		only if the sync data is newer than the current data.
+		</para>
+	</section>
+
 	</section>