OpenLDAP
OpenLDAP Lightweight Directory Access Protocol Server
Overview
OpenLDAP:
OpenLDAP Lightweight Directory Access Protocol Server
This is a minimal implementation of a service module to support deployment of the OpenLDAP "slapd" process.
The assumption is made that "slapd" will run as the ControlTier framework user on a non-standard, non-privileged port.
Additionally, the OpenLDAP package must be pre-installed on the system and the "slapd.conf" file manually configured. A future version of this module will no doubt generate this configuration file from model data and a template.
Design
- Super Type
- Service
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name |
Constraints
Allowed Child Dependencies
- OpenLDAPArgsFile 1
- OpenLDAPConfigFile 1
- OpenLDAPDirectory 1
- OpenLDAPPidFile 1
- OpenLDAPRootDn 1
- OpenLDAPRootPw 1
- OpenLDAPSuffix 1
- OpenLDAPTimeout 1
- OpenLDAPUrlList 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Node
- Site
Attributes
Exported Attributes
| Name | Property | Description |
|---|---|---|
| basedir | deployment-basedir |
Base directory location for "etc/openldap/slapd.conf" and other runtime files. |
| install-root | deployment-install-root |
OpenLDAP installation directory locating "libexec/slapd". |
Defaults for Imported Attributes
| Name | Default | Description |
|---|---|---|
| argsFile | ${entity.attribute.basedir}/var/run/slapd.args | |
| configFile | ${entity.attribute.basedir}/etc/slapd.conf | |
| directory | ${entity.attribute.basedir}/var/lib/ldap | |
| pidFile | ${entity.attribute.basedir}/var/run/slapd.pid | |
| rootDn | cn=Manager,dc=controltier,dc=com | |
| rootPw | secret | |
| suffix | dc=controltier,dc=com | |
| timeout | 10 |
Start/stop command default timeout in seconds. |
| urlList | ldap://*:3890/ |
Default URL list used to start "slapd" on a non-privileged port. |
Commands
assertServiceIsDown
Check whether the OpenLDAP "slapd" process is down
- Usage
- assertServiceIsDown [-basedir <>] [-pidfile <>]
Options
| Option | Description |
|---|---|
| basedir | Base directory |
| pidfile | PID file |
assertServiceIsUp
Check whether the OpenLDAP "slapd" process is up
- Usage
- assertServiceIsUp [-basedir <>] [-pidfile <>]
Options
| Option | Description |
|---|---|
| basedir | Base directory |
| pidfile | PID file |
startService
Start the OpenLDAP "slapd" process
- Usage
- startService [-basedir <>] [-configfile <>] [-installroot <>] [-pidfile <>] [-timeout <>] [-urllist <>]
Options
| Option | Description |
|---|---|
| basedir | Base directory |
| configfile | PID file |
| installroot | Installation directory |
| pidfile | PID file |
| timeout | Timeout in seconds |
| urllist | List of URLs to serve |
stopService
Stop the OpenLDAP "slapd" process
- Usage
- stopService [-basedir <>] [-pidfile <>] [-timeout <>]
Options
| Option | Description |
|---|---|
| basedir | Base directory |
| pidfile | PID file |
| timeout | Timeout in seconds |
Docs-Generate
Generate the OpenLDAP "slapd" configuration files
- Usage
- Docs-Generate [-archivedir <${entity.instance.dir}/var>] [-argsfile <>] [-basedir <>] [-buildstamp <>] [-directory <>] [-pidfile <>] [-rootdn <>] [-rootpw <>] [-suffix <>]
Options
| Option | Description |
|---|---|
| archivedir | dir to store current output docs |
| argsfile | Arguments file |
| basedir | Base directory |
| buildstamp | build identifer. currently ignored |
| directory | Database directory |
| pidfile | PID file |
| rootdn | Root distinguished name |
| rootpw | Root password |
| suffix | Directory suffix |
Related Types
The following types are defined for use with OpenLDAP.
OpenLDAPSetting
Overview
OpenLDAPSetting:
OpenLDAP configuration setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
OpenLDAPConfigFile
Overview
OpenLDAPConfigFile:
OpenLDAP config file
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| configFile | settingValue |
OpenLDAPRootDn
Overview
OpenLDAPRootDn:
domain suffix for opendlap
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rootDn | settingValue |
OpenLDAPRootPw
Overview
OpenLDAPRootPw:
openldap root password
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rootPw | settingValue |
OpenLDAPDirectory
Overview
OpenLDAPDirectory:
openldap root password
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| directory | settingValue |
OpenLDAPSuffix
Overview
OpenLDAPSuffix:
domain suffix for opendlap
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| suffix | settingValue |
OpenLDAPArgsFile
Overview
OpenLDAPArgsFile:
argsfile for opendlap
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| argsFile | settingValue |
OpenLDAPPidFile
Overview
OpenLDAPPidFile:
pidfile for opendlap
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| pidFile | settingValue |
OpenLDAPTimeout
Overview
OpenLDAPTimeout:
Startup and shutdown timeout period in seconds
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| timeout | settingValue |
OpenLDAPUrlList
Overview
OpenLDAPUrlList:
Startup and shutdown timeout period in seconds
Design
- Super Type
- OpenLDAPSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| urlList | settingValue |