2004-12-05 04:42:04 +08:00
|
|
|
.TH SLAPO-SYNCPROV 5 "RELEASEDATE" "OpenLDAP LDVERSION"
|
2006-01-04 07:11:52 +08:00
|
|
|
.\" Copyright 2004-2006 The OpenLDAP Foundation All Rights Reserved.
|
2004-12-05 04:42:04 +08:00
|
|
|
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
|
|
|
|
|
.\" $OpenLDAP$
|
|
|
|
|
.SH NAME
|
|
|
|
|
slapo-syncprov \- Syncrepl Provider overlay
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
ETCDIR/slapd.conf
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The Syncrepl Provider overlay implements the provider-side support for
|
|
|
|
|
syncrepl replication, including persistent search functionality. The overlay
|
|
|
|
|
can be used with any backend that maintains entryCSN and entryUUID
|
|
|
|
|
attributes for its entries. It also creates a contextCSN attribute in
|
|
|
|
|
the root entry of the database.
|
|
|
|
|
|
|
|
|
|
The contextCSN is updated for every write operation performed against the
|
|
|
|
|
database. To reduce database contention, the contextCSN is only updated in
|
2005-07-04 14:57:10 +08:00
|
|
|
memory. The value is written to the database on server shutdown and read into
|
2004-12-05 04:42:04 +08:00
|
|
|
memory on startup, and maintained in memory thereafter. Checkpoints may be
|
|
|
|
|
configured to write the contextCSN into the underlying database to minimize
|
|
|
|
|
recovery time after an unclean shutdown.
|
|
|
|
|
|
|
|
|
|
Note that due to deadlock constraints in the LDBM database, this overlay
|
|
|
|
|
will only work in RefreshOnly mode, and cannot perform checkpoints, on LDBM.
|
|
|
|
|
|
|
|
|
|
On databases that support inequality indexing, it is helpful to set an
|
|
|
|
|
eq index on the entryCSN attribute when using this overlay.
|
|
|
|
|
.SH CONFIGURATION
|
|
|
|
|
These
|
|
|
|
|
.B slapd.conf
|
|
|
|
|
options apply to the Syncrepl Provider overlay.
|
|
|
|
|
They should appear after the
|
|
|
|
|
.B overlay
|
|
|
|
|
directive and before any subsequent
|
|
|
|
|
.B database
|
|
|
|
|
directive.
|
|
|
|
|
.TP
|
|
|
|
|
.B syncprov-checkpoint <ops> <minutes>
|
|
|
|
|
After a write operation has succeeded, write the contextCSN to the underlying
|
2005-08-14 16:20:54 +08:00
|
|
|
database if
|
|
|
|
|
.B <ops>
|
|
|
|
|
write operations or more than
|
|
|
|
|
.B <minutes>
|
|
|
|
|
time have passed
|
2004-12-05 04:42:04 +08:00
|
|
|
since the last checkpoint. Checkpointing is disabled by default.
|
2004-12-08 12:57:43 +08:00
|
|
|
.TP
|
2005-08-14 16:35:31 +08:00
|
|
|
.B syncprov-sessionlog <ops>
|
2005-08-14 16:20:54 +08:00
|
|
|
Specify a session log for recording information about write operations made
|
|
|
|
|
on the database. The
|
2005-08-14 16:35:31 +08:00
|
|
|
.B <ops>
|
2005-08-14 16:20:54 +08:00
|
|
|
specifies the number of operations that are recorded in the log. All write
|
|
|
|
|
operations (except Adds) are recorded in the log.
|
2004-12-08 12:57:43 +08:00
|
|
|
When using the session log, it is helpful to set an eq index on the
|
|
|
|
|
entryUUID attribute in the underlying database.
|
2005-10-18 11:25:57 +08:00
|
|
|
.TP
|
|
|
|
|
.B syncprov-nopresent TRUE | FALSE
|
|
|
|
|
Specify that the Present phase of refreshing should be skipped. 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.
|
|
|
|
|
.TP
|
|
|
|
|
.B syncprov-reloadhint TRUE | FALSE
|
|
|
|
|
Specify that the overlay should honor the reloadHint flag in the Syncrepl
|
|
|
|
|
Control. In OpenLDAP releases 2.3.11 and earlier the Syncrepl consumer did
|
|
|
|
|
not properly set this flag, so the overlay must ignore it. This option
|
|
|
|
|
should be set TRUE when working with newer releases that properly support
|
|
|
|
|
this flag. It must be set TRUE when using the accesslog overlay for
|
|
|
|
|
delta-based Syncrepl support. The default is FALSE.
|
2004-12-05 04:42:04 +08:00
|
|
|
.SH FILES
|
|
|
|
|
.TP
|
|
|
|
|
ETCDIR/slapd.conf
|
|
|
|
|
default slapd configuration file
|
|
|
|
|
.SH SEE ALSO
|
2005-10-18 11:25:57 +08:00
|
|
|
.BR slapd.conf (5),
|
|
|
|
|
.BR slapo-accesslog (5).
|
2004-12-08 12:57:43 +08:00
|
|
|
OpenLDAP Administrator's Guide.
|
