← Back to branch summary

~ttx/openldap/lucid-gssapi-495418

« back to all changes in this revision

Viewing changes to doc/man/man5/slapo-pcache.5

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek, Updated debconf translations
  • Date: 2009-07-28 10:17:15 UTC
  • mfrom: (1.1.4 upstream) (0.2.2 sid)
  • mto: (0.2.4 sid)
  • mto: This revision was merged to the branch mainline in revision 16.
  • Revision ID: james.westby@ubuntu.com-20090728101715-epwmqmsk0d3h22k3
http://bugs.debian.org/524770
http://bugs.debian.org/505191
http://bugs.debian.org/496749
http://bugs.debian.org/498116
http://bugs.debian.org/522965
http://bugs.debian.org/521804
* New upstream version.
  - Fixes FTBFS on ia64 with -fPIE. Closes: #524770.
  - Fixes some TLS issues with GnuTLS.  Closes: #505191.
* Update priority of libldap-2.4-2 to match the archive override.
* Add the missing ldapexop and ldapurl tools to ldap-utils, as well as the
  ldapurl(1) manpage.  Thanks to Peter Marschall for the patch.
  Closes: #496749.
* Bump build-dependency on debhelper to 6 instead of 5, since that's
  what we're using.  Closes: #498116.
* Set the default SLAPD_SERVICES to ldap:/// ldapi:///, instead of using
  the built-in default of ldap:/// only.
* Build-depend on libltdl-dev | libltdl3-dev (>= 1.4.3), for the package
  name change.  Closes: #522965.

[ Updated debconf translations ]
* Spanish, thanks to Francisco Javier Cuadrado <fcocuadrado@gmail.com>.
  Closes: #521804.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man5/slapo-pcache.5
1
1
.TH SLAPO-PCACHE 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2
 
.\" Copyright 1998-2008 The OpenLDAP Foundation, All Rights Reserved.
 
2
.\" Copyright 1998-2009 The OpenLDAP Foundation, All Rights Reserved.
3
3
.\" Copying restrictions apply.  See the COPYRIGHT file.
4
4
.\" Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
5
 
.\" $OpenLDAP: pkg/ldap/doc/man/man5/slapo-pcache.5,v 1.14.2.5 2008/07/08 21:13:31 quanah Exp $
 
5
.\" $OpenLDAP: pkg/ldap/doc/man/man5/slapo-pcache.5,v 1.14.2.10 2009/06/03 01:41:59 quanah Exp $
6
6
.SH NAME
7
 
slapo-pcache \- proxycache overlay to slapd
 
7
slapo\-pcache \- proxycache overlay to slapd
8
8
.SH SYNOPSIS
9
9
ETCDIR/slapd.conf
10
10
.SH DESCRIPTION
69
69
.RE
70
70
 
71
71
.TP
 
72
.B proxyattrset <index> <attrs...>
 
73
Used to associate a set of attributes <attrs..> with an <index>. Each attribute
 
74
set is associated with an integer from 0 to <numattrsets>\-1. These indices are
 
75
used by the \fBproxytemplate\fP directive to define cacheable templates. 
 
76
A set of attributes cannot be empty.  A set of attributes can contain the
 
77
special attributes "*" (all user attributes), "+" (all operational attributes)
 
78
or both; in the latter case, any other attribute is redundant and should
 
79
be avoided for clarity.  A set of attributes can contain "1.1" as the only
 
80
attribute; in this case, only the presence of the entries is cached.
 
81
 
 
82
.TP
72
83
.B proxycachequeries <queries>
73
84
Specify the maximum number of queries to cache. The default is 10000.
74
85
 
75
86
.TP
 
87
.B proxycheckcacheability { TRUE | FALSE }
 
88
Check whether the results of a query being cached can actually be returned
 
89
from the cache by the proxy DSA.  When enabled, the entries being returned
 
90
while caching the results of a query are checked to ensure consistency
 
91
with the schema known to the proxy DSA.  In case of failure, the query
 
92
is not cached.  By default, the check is off.
 
93
 
 
94
.TP
76
95
.B proxysavequeries { TRUE | FALSE }
77
96
Specify whether the cached queries should be saved across restarts
78
97
of the caching proxy, to provide hot startup of the cache.  Only non-expired
91
110
overlay configuration changed, this feature should not be affected.
92
111
 
93
112
.TP
94
 
.B proxyattrset <index> <attrs...>
95
 
Used to associate a set of attributes <attrs..> with an <index>. Each attribute
96
 
set is associated with an integer from 0 to <numattrsets>-1. These indices are
97
 
used by the \fBproxytemplate\fP directive to define cacheable templates. 
98
 
A set of attributes cannot be empty.  A set of attributes can contain the
99
 
special attributes "*" (all user attributes), "+" (all operational attributes)
100
 
or both; in the latter case, any other attribute is redundant and should
101
 
be avoided for clarity.  A set of attributes can contain "1.1" as the only
102
 
attribute; in this case, only the presence of the entries is cached.
103
 
 
104
 
.TP
105
113
.B proxytemplate <template_string> <attrset_index> <ttl> [<negttl> [<limitttl>]]
106
114
Specifies a cacheable template and "time to live" <ttl> of queries 
107
115
belonging to the template. An optional <negttl> can be used to specify
113
121
Results hitting a sizelimit are not cached by default (<limitttl> set to 0).
114
122
 
115
123
.TP
116
 
.B response-callback { head | tail }
 
124
.B response\-callback { head | tail }
117
125
Specifies whether the response callback should be placed at the
118
126
.B tail
119
127
(the default) or at the 
182
190
attribute because the underlying database that actually caches the entries 
183
191
may need it for optimal local processing of the queries.
184
192
 
 
193
The proxy server should contain all the schema information required for caching.
 
194
Significantly, it needs the schema of attributes used in the query templates.
 
195
If the objectClass attribute is used in a query template, it needs the definition
 
196
of the objectClasses of the entries it is supposed to cache.
 
197
It is the responsibility of the proxy administrator to keep the proxy schema
 
198
lined up with that of the proxied server.
 
199
 
185
200
Another potential (and subtle) inconsistency may occur when data is retrieved 
186
201
with different identities and specific per-identity access control
187
202
is enforced by the remote server.
204
219
proxy caching be used in conjunction with the 
205
220
.I identity assertion
206
221
feature of
207
 
.BR slapd-ldap (5)
 
222
.BR slapd\-ldap (5)
208
223
(see the
209
 
.B idassert-bind
 
224
.B idassert\-bind
210
225
and the
211
 
.B idassert-authz
 
226
.B idassert\-authz
212
227
statements), so that remote server interrogation occurs with a vanilla identity 
213
228
that has some relatively high
214
229
.B search
226
241
default slapd configuration file
227
242
.SH SEE ALSO
228
243
.BR slapd.conf (5),
 
244
.BR slapd\-config (5),
229
245
.BR slapd\-ldap (5),
230
246
.BR slapd\-meta (5),
231
247
.BR slapd\-sql (5),