git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-syncprov.5

   1 .TH SLAPO-SYNCPROV 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2004-2006 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo-syncprov \- Sync Provider overlay
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The Sync Provider overlay implements the provider-side support for the
  11 LDAP Content Synchronization (RFC4533) as well as syncrepl replication
  12 support.  The overlay
  13 can be used with any backend that maintains entryCSN and entryUUID
  14 attributes for its entries. It also creates a contextCSN attribute in
  15 the root entry of the database.
  16
  17 The contextCSN is updated for every write operation performed against the
  18 database. To reduce database contention, the contextCSN is only updated in
  19 memory. The value is written to the database on server shutdown and read into
  20 memory on startup, and maintained in memory thereafter. Checkpoints may be
  21 configured to write the contextCSN into the underlying database to minimize
  22 recovery time after an unclean shutdown.
  23
  24 Note that due to deadlock constraints in the LDBM database, this overlay
  25 will only work in RefreshOnly mode, and cannot perform checkpoints, on LDBM.
  26
  27 On databases that support inequality indexing, it is helpful to set an
  28 eq index on the entryCSN attribute when using this overlay.
  29 .SH CONFIGURATION
  30 These
  31 .B slapd.conf
  32 options apply to the Sync Provider overlay.
  33 They should appear after the
  34 .B overlay
  35 directive.
  36 .TP
  37 .B syncprov-checkpoint <ops> <minutes>
  38 After a write operation has succeeded, write the contextCSN to the underlying
  39 database if
  40 .B <ops>
  41 write operations or more than
  42 .B <minutes>
  43 time have passed
  44 since the last checkpoint. Checkpointing is disabled by default.
  45 .TP
  46 .B syncprov-sessionlog <ops>
  47 Specify a session log for recording information about write operations made
  48 on the database.  The
  49 .B <ops>
  50 specifies the number of operations that are recorded in the log. All write
  51 operations (except Adds) are recorded in the log.
  52 When using the session log, it is helpful to set an eq index on the
  53 entryUUID attribute in the underlying database.
  54 .TP
  55 .B syncprov-nopresent TRUE | FALSE
  56 Specify that the Present phase of refreshing should be skipped. This value
  57 should only be set TRUE for a syncprov instance on top of a log database
  58 (such as one managed by the accesslog overlay).
  59 The default is FALSE.
  60 .TP
  61 .B syncprov-reloadhint TRUE | FALSE
  62 Specify that the overlay should honor the reloadHint flag in the Sync
  63 Control. In OpenLDAP releases 2.3.11 and earlier the syncrepl consumer did
  64 not properly set this flag, so the overlay must ignore it. This option
  65 should be set TRUE when working with newer releases that properly support
  66 this flag. It must be set TRUE when using the accesslog overlay for
  67 delta-based syncrepl replication support.  The default is FALSE.
  68 .SH FILES
  69 .TP
  70 ETCDIR/slapd.conf
  71 default slapd configuration file
  72 .SH SEE ALSO
  73 .BR slapd.conf (5),
  74 .BR slapo-accesslog (5).
  75 OpenLDAP Administrator's Guide.