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

   1 .TH SLAPO-SYNCPROV 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2004-2014 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo\-syncprov \- Sync Provider overlay to slapd
   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 On databases that support inequality indexing, it is helpful to set an
  25 eq index on the entryCSN attribute when using this overlay.
  26 .SH CONFIGURATION
  27 These
  28 .B slapd.conf
  29 options apply to the Sync Provider overlay.
  30 They should appear after the
  31 .B overlay
  32 directive.
  33 .TP
  34 .B syncprov\-checkpoint <ops> <minutes>
  35 After a write operation has succeeded, write the contextCSN to the underlying
  36 database if
  37 .B <ops>
  38 write operations or more than
  39 .B <minutes>
  40 time have passed
  41 since the last checkpoint. Checkpointing is disabled by default.
  42 .TP
  43 .B syncprov\-sessionlog <ops>
  44 Configures an in-memory session log for recording information about write
  45 operations made on the database.  The
  46 .B <ops>
  47 specifies the number of operations that are recorded in the log. All write
  48 operations (except Adds) are recorded in the log.
  49 When using the session log, it is helpful to set an eq index on the
  50 entryUUID attribute in the underlying database.
  51 .TP
  52 .B syncprov\-nopresent TRUE | FALSE
  53 Specify that the Present phase of refreshing should be skipped. This value
  54 should only be set TRUE for a syncprov instance on top of a log database
  55 (such as one managed by the accesslog overlay).
  56 The default is FALSE.
  57 .TP
  58 .B syncprov\-reloadhint TRUE | FALSE
  59 Specify that the overlay should honor the reloadHint flag in the Sync
  60 Control. In OpenLDAP releases 2.3.11 and earlier the syncrepl consumer did
  61 not properly set this flag, so the overlay must ignore it. This option
  62 should be set TRUE when working with newer releases that properly support
  63 this flag. It must be set TRUE when using the accesslog overlay for
  64 delta-based syncrepl replication support.  The default is FALSE.
  65 .SH FILES
  66 .TP
  67 ETCDIR/slapd.conf
  68 default slapd configuration file
  69 .SH SEE ALSO
  70 .BR slapd.conf (5),
  71 .BR slapd\-config (5),
  72 .BR slapo\-accesslog (5).
  73 OpenLDAP Administrator's Guide.
  74 .SH ACKNOWLEDGEMENTS
  75 .so ../Project