~ubuntu-branches/ubuntu/maverick/openldap/maverick-proposed

« back to all changes in this revision

Viewing changes to doc/man/man5/slapd-ndb.5

  • Committer: Bazaar Package Importer
  • Author(s): Mathias Gug, Steve Langasek, Mathias Gug
  • Date: 2009-02-18 18:44:00 UTC
  • mfrom: (1.1.2 upstream) (0.1.2 lenny)
  • Revision ID: james.westby@ubuntu.com-20090218184400-zw4mjse9eywt5566
Tags: 2.4.14-0ubuntu1
[ Steve Langasek ]
* New upstream version
  - Fixes a bug with the pcache overlay not returning cached entries
    (closes: #497697)
  - Update evolution-ntlm patch to apply to current Makefiles.
  - (tentatively) drop gnutls-ciphers, since this bug was reported to be
    fixed upstream in 2.4.8.  The fix applied in 2.4.8 didn't match the
    patch from the bug report, so this should be watched for regressions.
* Build against db4.7 instead of db4.2 at last!  Closes: #421946.
* Build with --disable-ndb, to avoid a misbuild when libmysqlclient is
  installed in the build environment.
* New patch, no-crlcheck-for-gnutls, to fix a build failure when using
  --with-tls=gnutls.

[ Mathias Gug ]
* Merge from debian unstable, remaining changes:
  - debian/apparmor-profile: add AppArmor profile
  - debian/slapd.postinst: Reload AA profile on configuration
  - updated debian/slapd.README.Debian for note on AppArmor
  - debian/control: Recommends apparmor >= 2.1+1075-0ubuntu6
  - debian/control: Conflicts with apparmor-profiles << 2.1+1075-0ubuntu4
    to make sure that if earlier version of apparmour-profiles gets
    installed it won't overwrite our profile.
  - Modify Maintainer value to match the DebianMaintainerField
    speficication.
  - follow ApparmorProfileMigration and force apparmor compalin mode on 
    some upgrades (LP: #203529)
  - debian/slapd.dirs: add etc/apparmor.d/force-complain
  - debian/slapd.preinst: create symlink for force-complain on pre-feisty
    upgrades, upgrades where apparmor-profiles profile is unchanged (ie
    non-enforcing) and upgrades where apparmor profile does not exist.
  - debian/slapd.postrm: remove symlink in force-complain/ on purge
  - debian/patches/fix-ucred-libc due to changes how newer glibc handle
    the ucred struct now.
  - debian/control:
    - Build-depend on libltdl7-dev rather then libltdl3-dev.
  - debian/patches/autogen.sh:
    - Call libtoolize with the --install option to install config.{guess,sub}
      files.
  - Don't use local statement in config script as it fails if /bin/sh
    points to bash (LP: #286063).
  - Disable the testsuite on hppa. Allows building of packages on this
    architecture again, once this package is in the archive.
    LP: #288908.
  - debian/slapd.postinst, debian/slapd.script-common: set correct ownership
    and permissions on /var/lib/ldap, /etc/ldap/slapd.d (group readable) and
    /var/run/slapd (world readable). (LP: #257667).
  - debian/patches/nssov-build, debian/rules: 
    Build and package the nss overlay.
    debian/schema/misc.ldif: add ldif file for the misc schema, which defines
    rfc822MailMember (required by the nss overlay).
  - debian/{control,rules}: enable PIE hardening
  - Use cn=config as the default configuration backend instead of 
    slapd.conf. Migrate slapd.conf  file to /etc/ldap/slapd.d/ on upgrade
    asking the end user to enter a new password to control the access to the
    cn=config tree.
* debian/patches/corrupt-contextCSN: The contextCSN can get corrupted at
  times. (ITS: #5947)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH SLAPD-NDB 5 "RELEASEDATE" "OpenLDAP LDVERSION"
 
2
.\" Copyright 2008-2009 The OpenLDAP Foundation All Rights Reserved.
 
3
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 
4
.\" $OpenLDAP: pkg/ldap/doc/man/man5/slapd-ndb.5,v 1.4.2.3 2009/01/30 20:08:05 quanah Exp $
 
5
.SH NAME
 
6
slapd-ndb \- MySQL NDB backend to slapd
 
7
.SH SYNOPSIS
 
8
.B ETCDIR/slapd.conf
 
9
.SH DESCRIPTION
 
10
The \fBndb\fP backend to
 
11
.BR slapd (8)
 
12
uses the MySQL Cluster package to store data, through its NDB API.
 
13
It provides fault tolerance with extreme scalability, along with
 
14
a degree of SQL compatibility.
 
15
.LP
 
16
This backend is designed to store LDAP information using tables that
 
17
are also visible from SQL. It uses a higher level SQL API for creating
 
18
these tables, while using the low level NDB API for storing and
 
19
retrieving the data within these tables. The NDB Cluster engine
 
20
allows data to be partitioned across multiple data nodes, and this
 
21
backend allows multiple slapd instances to operate against a given
 
22
database concurrently.
 
23
.LP
 
24
The general approach is to use distinct tables for each LDAP object class.
 
25
Entries comprised of multiple object classes will have their data
 
26
spread across multiple tables. The data tables use a 64 bit entryID
 
27
as their primary key. The DIT hierarchy is maintained in a separate
 
28
table, which maps DNs to entryIDs.
 
29
.LP
 
30
This backend is experimental. While intended to be a general-purpose
 
31
backend, it is currently missing a number of common LDAP features.
 
32
See the \fBTODO\fP file in the source directory for details.
 
33
.SH CONFIGURATION
 
34
These
 
35
.B slapd.conf
 
36
options apply to the \fBndb\fP backend database.
 
37
That is, they must follow a "database ndb" line and
 
38
come before any subsequent "backend" or "database" lines.
 
39
Other database options are described in the
 
40
.BR slapd.conf (5)
 
41
manual page.
 
42
 
 
43
.SH DATA SOURCE CONFIGURATION
 
44
 
 
45
.TP
 
46
.B dbhost <hostname>
 
47
The name or IP address of the host running the MySQL server. The default
 
48
is "localhost". On Unix systems, the connection to a local server is made
 
49
using a Unix Domain socket, whose path is specified using the
 
50
.B dbsocket
 
51
directive.
 
52
.TP
 
53
.B dbuser <username>
 
54
The MySQL login ID to use when connecting to the MySQL server. The chosen
 
55
user must have sufficient privileges to manipulate the SQL tables in the
 
56
target database.
 
57
.TP
 
58
.B dbpasswd <password>
 
59
The password for the \fBdbuser\fP.
 
60
.TP
 
61
.B dbname <database name>
 
62
The name of the MySQL database to use.
 
63
.TP
 
64
.B dbport <port>
 
65
The port number to use for the TCP connection to the MySQL server.
 
66
.TP
 
67
.B dbsocket <path>
 
68
The socket to be used for connecting to a local MySQL server.
 
69
.TP
 
70
.B dbflag <integer>
 
71
Client flags for the MySQL session. See the MySQL documentation for details.
 
72
.TP
 
73
.B dbconnect <connectstring>
 
74
The name or IP address of the host running the cluster manager. The default
 
75
is "localhost".
 
76
.TP
 
77
.B dbconnections <integer>
 
78
The number of cluster connections to establish. Using up to 4 may improve
 
79
performance under heavier load. The default is 1.
 
80
 
 
81
.SH SCHEMA CONFIGURATION
 
82
.TP
 
83
.B attrlen <attribute> <length>
 
84
Specify the column length to use for a particular attribute. LDAP attributes are
 
85
stored in individual columns of the SQL tables. The maximum column lengths for
 
86
each column must be specified when creating these tables. If a length constraint
 
87
was specified in the attribute's LDAP schema definition, that value will be used
 
88
by default. If the schema didn't specify a constraint, the default is 128 bytes.
 
89
Currently the maximum is 1024.
 
90
.TP
 
91
.B index <attr[,attr...]>
 
92
Specify a list of attributes for which indexing should be maintained.
 
93
Currently there is no support for substring indexing; a single index structure
 
94
provides presence, equality, and inequality indexing for the specified attributes.
 
95
.TP
 
96
.B attrset <set> <attrs>
 
97
Specify a list of attributes to be treated as an attribute set. This directive
 
98
creates a table named \fIset\fP which will contain all of the listed attributes.
 
99
Ordinarily an attribute resides in a table named by an object class that uses
 
100
the attribute. However, attributes are only allowed to appear in a single table.
 
101
For attributes that are derived from an inherited object class definition,
 
102
the attribute will only be stored in the superior class's table.
 
103
Attribute sets should be defined for any attributes that are used in multiple
 
104
unrelated object classes, i.e., classes that are not connected by a simple
 
105
inheritance chain.
 
106
.SH ACCESS CONTROL
 
107
The 
 
108
.B ndb
 
109
backend honors most access control semantics as indicated in
 
110
.BR slapd.access (5).
 
111
.SH FILES
 
112
.TP
 
113
.B ETCDIR/slapd.conf
 
114
default 
 
115
.B slapd 
 
116
configuration file
 
117
.SH SEE ALSO
 
118
.BR slapd.conf (5),
 
119
.BR slapd\-config (5),
 
120
.BR slapd (8),
 
121
.BR slapadd (8),
 
122
.BR slapcat (8),
 
123
.BR slapindex (8),
 
124
MySQL Cluster documentation.
 
125
.SH AUTHOR
 
126
Howard Chu, with assistance from Johan Andersson et al @ MySQL.