From: Quanah Gibson-Mount <quanah@openldap.org>
Date: Mon, 6 Feb 2017 23:27:25 +0000 (-0800)
Subject: ITS#8253 - better document options for the syncprov module
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=45018fef1774f670564f4df9c2bdc594c5cc9e95;p=openldap

ITS#8253 - better document options for the syncprov module
---

diff --git a/doc/guide/admin/replication.sdf b/doc/guide/admin/replication.sdf
index 254485cf08..ef5068ceb5 100644
--- a/doc/guide/admin/replication.sdf
+++ b/doc/guide/admin/replication.sdf
@@ -515,34 +515,57 @@ H4: Set up the provider slapd
 
 The provider is implemented as an overlay, so the overlay itself
 must first be configured in {{slapd.conf}}(5) before it can be
-used. The provider has only two configuration directives, for setting
-checkpoints on the {{EX:contextCSN}} and for configuring the session
-log.  Because the LDAP Sync search is subject to access control,
-proper access control privileges should be set up for the replicated
+used. The provider has three primary configuration directives and
+one secondary directive for when delta-syncrepl is being used.
+Because the LDAP Sync search is subject to access control, proper
+access control privileges should be set up for the replicated
 content.
 
+The three primary options to configure are the checkpoint,
+sessionlog, and reloadhint behaviors.
+
 The {{EX:contextCSN}} checkpoint is configured by the
 
 >	syncprov-checkpoint <ops> <minutes>
 
 directive. Checkpoints are only tested after successful write
-operations.  If {{<ops>}} operations or more than {{<minutes>}}
+operations. If {{<ops>}} operations or more than {{<minutes>}}
 time has passed since the last checkpoint, a new checkpoint is
-performed.
+performed. Checkpointing is disabled by default.
 
 The session log is configured by the
 
->	syncprov-sessionlog <size>
+>	syncprov-sessionlog <ops>
 
-directive, where {{<size>}} is the maximum number of session log
-entries the session log can record. When a session log is configured,
-it is automatically used for all LDAP Sync searches within the
-database.
+directive, where {{<ops>}} is the maximum number of session log
+entries the session log can record. All write operations (except Adds)
+are recorded in the log.
 
 Note that using the session log requires searching on the {{entryUUID}}
 attribute. Setting an eq index on this attribute will greatly benefit
 the performance of the session log on the provider.
 
+The reloadhint option is configured by the
+
+>	syncprov-reloadhint <TRUE|FALSE>
+
+directive. This option should be set TRUE when working with releases
+newer than 2.3.11 that properly support this flag. It must be set TRUE
+when using the accesslog overlay for delta-based syncrepl replication
+support. The default is FALSE.
+
+The nonpresent option should only be configured if the overlay is
+being placed on top of a log database, such as when used with
+delta-syncrepl.
+
+The nonpresent option is configured by the
+
+>	syncprov-nopresent <TRUE|FALSE>
+
+directive. This value should only be set TRUE for a syncprov instance
+on top of a log database (such as one managed by the accesslog overlay).
+The default is FALSE.
+
 A more complete example of the {{slapd.conf}}(5) content is thus:
 
 >	database mdb
@@ -560,7 +583,7 @@ A more complete example of the {{slapd.conf}}(5) content is thus:
 H4: Set up the consumer slapd
 
 The syncrepl replication is specified in the database section of
-{{slapd.conf}}(5) for the replica context.  The syncrepl engine
+{{slapd.conf}}(5) for the replica context. The syncrepl engine
 is backend independent and the directive can be defined with any
 database type.