Delta-syncrepl doc updates

[openldap] / doc / man / man5 / slapd.conf.5

diff --git a/doc/man/man5/slapd.conf.5 b/doc/man/man5/slapd.conf.5
index 426de2f1fdd1104857c75d9cd07e43413f6af2a0..6e68a849b4cdc106e2106283819ff62902f0ecd0 100644 (file)
--- a/doc/man/man5/slapd.conf.5
+++ b/doc/man/man5/slapd.conf.5
@@ -1422,6 +1422,24 @@ same indices (assuming they support indexing), even for attributes that
 only exist in some of these databases. In general, all of the glued
 databases should be configured as similarly as possible, since the intent
 is to provide the appearance of a single directory.
+
+Note that the \fIsubordinate\fP functionality is implemented internally
+by the \fIglue\fP overlay and as such its behavior will interact with other
+overlays in use. By default, the glue overlay is automatically configured as
+the last overlay on the superior backend. Its position on the backend
+can be explicitly configured by setting an \fBoverlay glue\fP directive
+at the desired position. This explicit configuration is necessary e.g.
+when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
+in order to work over all of the glued databases. E.g.
+.RS
+.nf
+       database bdb
+       suffix dc=example,dc=com
+       ...
+       overlay glue
+       overlay syncprov
+.fi
+.RE
 .HP
 .hy 0
 .B syncrepl rid=<replica ID>
@@ -1446,6 +1464,9 @@ is to provide the appearance of a single directory.
 .B [credentials=<passwd>]
 .B [realm=<realm>]
 .B [secprops=<properties>]
+.B [logbase=<base DN>]
+.B [logfilter=<filter str>]
+.B [syncdata=default|accesslog|changelog]
 .RS
 Specify the current database as a replica which is kept up-to-date with the 
 master content by establishing the current
@@ -1550,6 +1571,22 @@ keyword above) for a SASL bind can be set with the
 option. A non default SASL realm can be set with the
 .B realm 
 option.
+
+Rather than replicating whole entries, the consumer can query logs of
+data modifications. This mode of operation is referred to as \fIdelta
+syncrepl\fP. In addition to the above parameters, the
+.B logbase
+and
+.B logfilter
+parameters must be set appropriately for the log that will be used. The
+.B syncdata
+parameter must be set to either "accesslog" if the log conforms to the
+.BR slapo-accesslog (5)
+log format, or "changelog" if the log conforms
+to the obsolete \fIchangelog\fP format. If the
+.B syncdata
+parameter is omitted or set to "default" then the log parameters are
+ignored.
 .RE
 .TP
 .B updatedn <dn>
@@ -1695,10 +1732,6 @@ It has no effect on any other operations.
 Dynamic List.
 This overlay allows expansion of dynamic groups and more.
 .TP
-.B glue
-Backend Glue.
-This overlay glues multiple databases into a single namingContext.
-.TP
 .B lastmod
 Last Modification.
 This overlay maintains a service entry in the database with the DN,
@@ -1833,7 +1866,6 @@ Known overlays are documented in
 .BR slapo\-auditlog (5),
 .BR slapo\-chain (5),
 .BR slapo\-dynlist (5),
-.BR slapo\-glue (5),
 .BR slapo\-lastmod (5),
 .BR slapo\-pcache (5),
 .BR slapo\-ppolicy (5),