[checked revision]

Revision as of 10:19, 5 November 2019

Abstract

This document describes the OpenLDAP directory data organisation for the stoney wiki service.

Data Organisation

The following chapters explain the data organisation of the stoney cloud OpenLDAP directory. In this case we are looking at the stoney wiki service.

Wiki

The sub tree ou=openstack,ou=service,dc=stoney-cloud,dc=org contains all the MediaWiki based stoney wiki service data. The following LDIF shows the wiki LDAP entry for the stoney wiki service:

dn: ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: organizationalUnit
objectclass: top
ou: wiki
description: The sub tree for the MediaWiki based stoney wiki service.

The following table describes the different attributes:

Attribute	Objectclass	Mandatory	Description
ou	organizationalUnit	MUST	x	The name of the leaf. For the MediaWiki based stoney wiki service this is: `wiki`.
description	sstServiceConfigurationObjectClass	MAY	x	The description of the leaf. For the MediaWiki based stoney wiki service this is: `The sub tree for the MediaWiki based stoney wiki service.`.

Legend:

x: Mandatory in all cases.

Wiki - Configuration

The sub tree for the configuration of the stoney wiki service:

dn: ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: configuration
description: The sub tree for the configuration of the MediaWiki based stoney wiki service.

Wiki - Configuration - Provisioning daemon

See the Services description for the naming convention.

The sub tree for the configuration of the prov-wiki-mediawiki daemon:

dn: ou=prov-wiki-mediawiki,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstServiceConfigurationObjectClass
ou: prov-wiki-mediawiki
description: The sub tree for the configuration of the prov-wiki-mediawiki provisioning daemon.
sstIsActive: TRUE

The following table describes the different attributes:

Attribute	Objectclass	Existence	Mandatory	Description
ou	organizationalUnit	MUST	x	The name of the leaf.
description	sstServiceConfigurationObjectClass	MAY	x	The description of the leaf.
sstIsActive	sstServiceConfigurationObjectClass	MAY	x	Is the entry active? Either `TRUE` (yes) or `FALSE` (no). The default value is `TRUE`.

Legend:

x: Mandatory in all cases.

Wiki - Configuration - Resellers

The sub tree for the reseller specific stoney wiki service settings:

dn: ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: reseller
description: The sub tree for the reseller specific configuration of the MediaWiki based stoney wiki service.

The sub tree for the specific stoney wiki service settings for the reseller Reseller Ltd. with the uid 4000000.

dn: uid=4000000,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstReseller
objectclass: sstServiceConfigurationObjectClass
uid: 4000000
organizationName: Reseller Ltd.
description: The sub tree for the specific stoney wiki service settings for the reseller Reseller Ltd. with the uid 4000000.
sstIsActive: TRUE
sstIsCompany: TRUE
sstIsDefault: TRUE
sstBelongsToResellerUID: 4000000

The following table describes the different attributes:

Attribute	Objectclass	Existence	Mandatory	Self-Service	Changeable	Description
uid	sstReseller	MUST	x			A unique integer value with 7 digits or more. For example: `uid: 4000000` corresponds with `sstBelongsToResellerUID: 4000000`.
organizationName	sstReseller	MAY	x¹			The company name. For example: `stepping stone AG`.
givenName	sstReseller	MAY	x¹			Name. For example: `Hans`.
surname	sstReseller	MAY	x¹			Surname. For example: `Muster`.
description	sstReseller	MAY	x			The description of the leaf. For example: `The sub tree for the specific stoney wiki service settings for the reseller Reseller Ltd. with the uid 4000000.`
sstIsActive	sstReseller	MUST	x			Is the entry active? Either `TRUE` (yes) or `FALSE` (no). The default value is `TRUE`.
sstIsCompany	sstReseller	MUST	x			Do we have an organisation or a private person? Either `TRUE` (yes) or `FALSE` (no). The default value is `TRUE`.
sstIsDefault	sstServiceConfigurationObjectClass	MAY	x			Is this leaf a default entry? Either `TRUE` (yes) or `FALSE` (no). If `sstIsDefault` is set to `TRUE`, this entry acts as a fall back configuration. In other words: If a reseller doesn't have his own stoney wiki service configuration, then this one will be used. As you would normally have only one default configuration per cloud, the default value is `FALSE`.
sstBelongsToResellerUID	sstReseller	MUST	x			Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: `sstBelongsToResellerUID: 4000000` corresponds with `uid: 4000000`.

Legend:

x: Mandatory in all cases.
x¹: If sstIsCompany is set to TRUE, the organizationName must be set. Otherwise givenName and surname must be set.

Wiki - Configuration - Reseller - Account defaults

Work in progress ...

The sub tree for the wiki account defaults for the stoney wiki service for the reseller Reseller Ltd. with the uid 4000000:

dn: ou=defaults,uid=4000000,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstWiki
ou: defaults
description: The sub tree for the default settings of the stoney wiki service for the reseller Reseller Ltd. with the uid 4000000.
sstIsActive: TRUE
...
...

The following table describes the different attributes:

Attribute	Existence	Mandatory	Self-Service	Changeable	Description
ou	MUST	x
description	MAY	x
loginShell	MAY	x			The path to the login shell. The default is /bin/sh.
shadowMax	MAY	x			Related to the /etc/shadow file, this attribute specifies the maximum number of days the password is valid. The default is 99999, which corresponds to about 273 years. In reality, this means, that the user does not need to change the password.
shadowWarning	MAY	x			Related to the /etc/shadow file, this attribute specifies the number of days before the password expires that the user is warned. The default is 7.
shadowFlag	MAY	x			Related to the /etc/shadow file, this attribute is currently not used and is reserved for future use. The default is set to 134539460.
sstVolumeCapacityDefault	MAY	x
sstVolumeCapacityMin	MAY	x
sstVolumeCapacityMax	MAY	x
sstVolumeCapacityStep	MAY	x
sstQuotaChange	MAY	x			Can the user change the quota? Either `TRUE` (yes) or `FALSE` (no). Default is FALSE (no).
sstWikiWarningDays	MUST	x			After how many missed storage days should the user be warned. Possible values are between 0 and 99. Default is 1.
sstWikiWarningNumbers	MUST	x			After how many missed storages should the user be warned. Possible values are between 0 and 99. Default is 0.
sstWikiWarningOn	MUST	x			Does the user want to informed about failed storages (TRUE) or not (FALSE).
sstNotificationWarningLevel	MAY	x			The quota notification level in percent, when the owner of the storage needs to warned. A value between 0 and 100. The default is 85 percent.
sstNotificationWarningMedium	MUST	x			The notification medium, either sms (points to the multi-valued attribute `mobileTelephoneNumber`) or mail (points to the multi-valued attribute `mail`). Currently, only mail is supported.
sstNotificationWarningMediumChange	MAY	x			Can a user change the notification warning medium? Either `TRUE` (yes) or `FALSE` (no). The default is `FALSE` (no).
sstNotificationWarningMediumAdd	MAY	x			Can a user add new notification warning mediums (`mobileTelephoneNumber` or `mail`? Either `TRUE` (yes) or `FALSE` (no). The default is `TRUE` (yes). Currently, only adding new `mail` addresses are supported.
sstWikiIntervalHourly	MUST	x			How many hourly storages do we want? The default is 0.
sstWikiIntervalDaily	MUST	x			How many daily storages do we want? The default is 7.
sstWikiIntervalWeekly	MUST	x			How many weekly storages do we want? The default is 4.
sstWikiIntervalMonthly	MUST	x			How many monthly storages do we want? The default is 3.
sstWikiIntervalYearly	MUST	x			How many yearly storages do we want? The default is 0.
sstIsActive	MUST	x			Is the storage account active? Either `TRUE` (yes) or `FALSE` (no). Default is `TRUE` (yes).
sstUseSelfcare	MUST	x			Can the Self-Service interface be used with the credentials of the storage account? Either `TRUE` (yes) or `FALSE` (no). Default is `FALSE` (no).
sstUseSSH	MUST	x			Is the ssh service active for the storage account? Either `TRUE` (yes) or `FALSE` (no). Default is `TRUE` (yes).

Legend:

x: Mandatory in all cases.

Wiki - Configuration - Reseller - Notification settings

The sub tree stores the notification information for the stoney wiki service for the reseller Reseller Ltd. with the uid 4000000. This information is used independently of the notification settings of the users. The idea is, that the reseller can receive notifications for a customer and react on the received information (for example, when the quota has been reached):

dn: ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstNotificationObjectClass
ou: notifications
description: The sub tree stores the notification information for the stoney wiki service for the reseller Reseller Ltd. with the uid 4000000. This information is used independently of the notification settings of the users.
sstMailTo: Support stepping stone GmbH <support@stepping-stone.ch>
sstNotificationWarning: quota
sstNotificationWarning: schedule
sstNotificationWarning: unsuccessful

The following table describes the different attributes:

Attribute	Existence	Mandatory	Self-Service	Changeable	Description
ou	MUST	x
description	MAY	x
sstMailTo	MAY	x
sstNotificationWarning	MAY				This multi-valued attribute will be used to turn single notifications on or off. The attribute sstWikiWarningOn must be set to `TRUE` Possible values are quota, schedule and unsuccessful (the names correspond with the template dn).

Legend:

x: Mandatory in all cases.

Wiki - Configuration - Reseller - Account Settings

The sub tree stores the information about what can be modified in which scope for the stoney wiki service for the reseller Reseller Ltd. with the uid 4000000:

dn: ou=settings,uid=4000000,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstServiceSettingsObjectClass
ou: settings
description: This sub tree stores the information about what can be modified in which scope.
sstVolumeCapacityDefault: 1073741824
sstVolumeCapacityMin: 1073741824
sstVolumeCapacityMax: 536870912000
sstVolumeCapacityStep: 1073741824
sstNotificationWarningMediumChange: FALSE
sstNotificationWarningMediumAdd: TRUE
sstQuotaChange: FALSE
sstSendCredentialsTo: owner
sstMailFrom: Support stepping stone GmbH <support@stepping-stone.ch>
preferredLanguage: de-CH

Human readable format:

sstVolumeCapacityDefault: 1 Gibibyte (GiB)
sstVolumeCapacityMin: 1 Gibibyte (GiB)
sstVolumeCapacityMax: 500 Gibibyte (GiB)
sstVolumeCapacityStep: 1 Gibibyte (GiB)

The following table describes how to calculate the sstVolumeCapacity* attributes:

Size	Calculation	Value
1 Byte	1	1
1 Kibibyte (KiB)	2¹⁰	1 024
1 Mebibyte (MiB)	2²⁰	1 048 576
1 Gibibyte (GiB)	2³⁰	1 073 741 824
5 Gibibyte (GiB)	5 x 2³⁰	5 368 709 120
10 Gibibyte (GiB)	10 x 2³⁰	10 737 418 240
100 Gibibyte (GiB)	100 x 2³⁰	107 374 182 400
500 Gibibyte (GiB)	500 x 2³⁰	536 870 912 000
1 Tebibyte (TiB)	2⁴⁰	1 099 511 627 776
1 Pebibyte (PiB)	2⁵⁰	1 125 899 906 842 624
1 Exbibyte (EiB)	2⁶⁰	1 152 921 504 606 846 976

The following table describes the different attributes:

Attribute	Existence	Mandatory	Self-Service	Changeable	Description
ou	MUST	x
description	MAY	x
sstVolumeCapacityDefault	MAY	x
sstVolumeCapacityMin	MAY	x
sstVolumeCapacityMax	MAY	x
sstVolumeCapacityStep	MAY	x			Arrow left / Arrow right: 1 Gigabyte (sstVolumeCapacityStep) Page up / Page down: 10 Gigabyte (10 x sstVolumeCapacityStep)
sstNotificationWarningMediumChange	MAY	x			Can a user change the notification warning medium? Either `TRUE` (yes) or `FALSE` (no). The default is `FALSE` (no).
sstNotificationWarningMediumAdd	MAY	x			Can a user add new notification warning mediums (`mobileTelephoneNumber` or `mail`? Either `TRUE` (yes) or `FALSE` (no). The default is `TRUE` (yes). Currently, only adding new `mail` addresses are supported.
sstQuotaChange	MAY	x			Can the user change the quota? Either `TRUE` (yes) or `FALSE` (no). Default is FALSE (no).
sstSendCredentialsTo	MAY	x			To whom do we send the access data or credentials. At least one entry must exist. Possible values: `sstSendCredentialsTo: login`: The access data or credentials are sent to the person logged in. `sstSendCredentialsTo: owner`: The access data or credentials are sent to the owner (person), the service belongs to.
sstMailFrom	MAY	x			The mail address, from which the credentials are to be sent from. In the example from above, this value is Support stepping stone GmbH <support@stepping-stone.ch>.
preferredLanguage	MAY	x			The notification language, which will be used to used in the mails, that are sent to the reseller, according to RFC 1766 (ISO 3166-1-alpha-2 code-ISO 639-1 Code. For example de-CH or en-GB.

Legend:

x: Mandatory in all cases.

Wiki - Configuration - Reseller - Templates

This sub tree contains the templates for the stoney wiki service for the reseller Reseller Ltd. with the uid 4000000:
dn: ou=templates,uid=4000000,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: templates
description: This sub tree contains the templates for the stoney wiki service for the reseller Reseller Ltd. with the uid 4000000.

Wiki - Configuration - Reseller - Credentials templates

This sub tree contains the credentials templates for the stoney wiki service:

dn: ou=credentials,ou=templates,uid=4000000,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstTemplateSetup
ou: credentials
description: This leaf contains the credential templates for the stoney wiki service.
sstMailFrom: Support stepping stone GmbH <support@stepping-stone.ch>
sstMailTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/credentials/credentials_mail
sstMailTemplateFormatSource: txt
sstMailTemplateFormatTarget: txt
sstTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/credentials/credentials_attachment
sstTemplateFormatSource: odt
sstTemplateFormatTarget: pdf

The following table describes the different attributes:

Attribute	Existence	Mandatory	Self-Service	Changeable	Description
ou	MUST	x
description	MUST	x
sstMailFrom	MAY	x			The mail address, from which the credentials are sent from. For example: `Support stepping stone GmbH <support@stepping-stone.ch>`). If this attribute does not exist, the `sstMailFrom` from `ou=settings,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org` must be taken.
sstMailTo	MAY				If this multi-valued attribute is set with one or mail address(es), then these recipients will receive the same information as the `login` user or the `owner`, depending on the value of `sstSendCredentialsTo` under `ou=settings,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org`. Normally, this attribute is not set for the credentials.
sstMailTemplate	MAY	x			The template, that is used to create the mail that is sent to either the user logged in (`sstSendCredentialsTo: login`) or to the owner of then newly created service (`sstSendCredentialsTo: owner`. For example: `sstTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/credentials/credentials_mail`.
sstMailTemplateFormatSource	MAY	x			The format of the source template. Supported values: `txt` `html` Place holder: For both `txt` or `html` as a source and `txt` or `html`, the place holders have the form of `{$placeholder}`. Default would normally be `txt`.
sstMailTemplateFormatTarget	MAY	x			The format of the target. Supported values: `txt` `html`
sstTemplate	MAY	x			The template, that is used to create the attachment that is sent with the mail. For example: `sstTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/credentials/credentials_attachment`.
sstTemplateFormatSource	MAY	x			The format of the source template. Supported values: `txt` `odt` Place holders: If we have `txt` or `html` as a source and `txt` or `html`, the place holders have the form of `{$placeholder}`. If we have `odt` as a source and `odt` or `pdf` as a target, then PHP-Easy-Report is used to replace the placeholders. These have the form of `{{placeholder}}`. The complete path and file name is a string concatenation of the values of the attributes `sstTemplate`, `preferredLanguage` and `sstTemplateFormatSource` (with a dot in between the values). For example: `sstTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/credentials/credentials_attachment` `preferredLanguage: en-GB` `sstTemplateFormatSource: odt` This gives us: `file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/credentials/credentials_attachment.en-GB.ode` Default would normally be `odt`.
sstTemplateFormatTarget	MAY	x			The format of the target. Supported values: `txt` `odt` `pdf` Note to Self-Service developer(s). Please be aware of the following issues when using PHP-Easy-Report: Minor: Spaces (and other special characters) in the document file names are going to be a problem since the names don't get escaped. Major: You must provide a manually-created unique temp-directory for the PHP-Easy-Report object, otherwise there will be race-conditions. Default would normally be `pdf`.

Legend:

x: Mandatory in all cases.

Wiki - Configuration - Reseller - Credentials templates email place holders (txt/html)

Address with an example:

{$company}                         stepping stone AG
{$salutation} {$name} {$surname}   Mr. Michael Eichenberger
{$address}                         Wasserwerkgasse79
{$country}-{$zip} {$location}      CH-3012 Bern

Date with an example:

{$day}                             11
{$month}                           August
{$year}                            2019

Storage Service with an example:

{$uid}                             4000124
{$password}                        XlWz4Qa#

Optional Values:

{$externalID}                      12345

Wiki - Configuration - Reseller - Credentials templates LibreOffice place holders (odt)

LibreOffice (odt) templates have the same place holders as the E-Mail (text/html) templates. The only thing that changes, are the definitions. Instead of {$placeholder} we have {{placeholder}}.

Wiki - Configuration - Reseller - Quota templates

Warns the user when the wiki is running out of space (quota).

This sub tree contains the quota templates for the stoney wiki service:

dn: ou=quota,ou=templates,uid=4000000,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstTemplateSetup
ou: quota
description: This leaf contains the quota templates for the stoney wiki service.
sstMailFrom: Support stepping stone GmbH <support@stepping-stone.ch>
sstMailTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/quota/quota_mail
sstMailTemplateFormatSource: txt
sstMailTemplateFormatTarget: txt
sstMailTemplateReseller: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/quota/quota_mail_reseller
sstMailTemplateFormatSource: txt
sstMailTemplateFormatTarget: txt

The following table describes the different attributes:

Attribute	Existence	Mandatory	Self-Service	Changeable	Description
ou	MUST	x
description	MUST	x
sstMailFrom	MAY	x			The mail address, from which the quota mails are sent from. For example: `Support stepping stone GmbH <support@stepping-stone.ch>`. If this attribute does not exist, the `sstMailFrom` from `ou=settings,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org` must be taken.
sstMailTo	MAY				If this multi-valued attribute is set with one or mail address(es), then these recipients will receive the same information as the owner. Normally, this attribute is not set.
sstMailTemplate	MAY	x			The template, that is used to create the mail that is sent to the owner of the service if `sstWikiWarningOn: TRUE` and `sstNotificationWarningMedium: mail`. If the `mail` is not set, you must look for the `mail` in the owners person entry under `uid=<UID>,ou=people,dc=stoney-cloud,dc=org`. For example: `sstTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/credentials/credentials_mail`.
sstMailTemplateFormatSource	MAY	x			The format of the source template. Supported values: `txt` `html` Place holder: For both `txt` or `html` as a source and `txt` or `html`, the place holders have the form of `{$placeholder}`. Default would normally be `txt`.
sstMailTemplateFormatTarget	MAY	x			The format of the target. Supported values: `txt` `html`
sstMailTemplateReseller	MAY	x¹			The path and name to a template file, that is used to inform one or more people if the multi-valued attribute `sstMailTo` is set in the notifications sub tree of the reseller `ou=notifications,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org` `and if <code>sstNotificationWarning` is set to `quota`. In most cased, the attribute `sstMailTo` is set to the support organisations mail address. For example: `sstMailTo: Support stepping stone GmbH <support@stepping-stone.ch&gt>` This way, the support organisation will be pre-informed for when the customer should call or write. The information the recipients will receive, is the same as the owner, but will formatted according to: `sstTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/quota/quota_mail_reseller` `sstMailTemplateResellerFormatSource: txt` `sstMailTemplateResellerFormatTarget: txt`
sstMailTemplateResellerFormatSource	MAY	x¹			The format of the source template. Supported values: `txt` `html` Place holder: For both `txt` or `html` as a source and `txt` or `html`, the place holders have the form of `{$placeholder}`. The complete path and file name is a string concatenation of the values of the attributes `sstTemplate`, `preferredLanguage` and `sstTemplateFormatSource` (with a dot in between the values). For example: `sstTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/quota/quota_mail_reseller` `preferredLanguage: en-GB` `sstTemplateFormatSource: txt` This gives us: `file:///var/www/selfcare/htdocs/themes/selfcare.tombstone.ch/templates/services/storage/quota/quota_mail_reseller.en-GB.txt` Default would normallb be `txt`.
sstMailTemplateResellerFormatTarget	MAY	x¹			The format of the target. Supported values: `txt` `html` Default would normallb be `txt`.

Legend:

x: Mandatory in all cases.
x¹: Must exist, if sstMailTo is set.

Wiki - Configuration - Reseller - Quota templates email place holders (txt/html)

An example:

{$salutation}       Mr.
{$surname}          Eichenberger
{$uid}              3723707
{$percent}          98
{$quota}            100
{$storage_size}     40
{$snapshot_size}    48

Optional Values:

{$externalID}       12345

Wiki - Configuration - Reseller - Quota templates LibreOffice place holders (odt)

LibreOffice (odt) templates have the same place holders as the E-Mail (text/html) templates. The only thing that changes, are the definitions. Instead of {$placeholder} we have {{placeholder}}.

Wiki - Accounts

The sub tree for the accounts of the stoney wiki service:

dn: ou=accounts,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: accounts
description: The sub tree for the accounts of the stoney wiki service.

Wiki - Account example

The following example shows the OpenLDAP directory entry for the stoney wiki account with the uid number 3730083:

dn: uid=3730083,ou=accounts,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: account
objectclass: posixAccount
objectclass: shadowAccount
objectclass: sstWiki
objectclass: sstProvisioning
objectclass: sstRelationship
uid: 3730083
userPassword: {SSHA}E/KLUgeAtApAPQ7mG2GMddCxTE9m9QOS
uidNumber: 3730083
gidNumber: 3730083
cn: 3730083.stoney-wiki.com
gecos: 3730083.stoney-wiki.com
homeDirectory: /var/wiki/3/083/730/3730083
loginShell: /bin/false
shadowFlag: 134539460
shadowLastChange: 11108
shadowMax: 99999
shadowWarning: 7
sstIsActive: TRUE
sstNotificationWarningOn: TRUE
sstNotificationWarning: quota
sstNotificationWarningMedium: mail
sstInformPersonUID: 1000482
sstQuota: 42949672960
sstSoftwareVersion: 1.31.5
sstFileUploadSize: 5368709120
host: kvm-1110
sstProvisioningMode: add
sstProvisioningExecutionDate: 0
sstProvisioningState: 0
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstBelongsToPersonUID: 4000002

The following table describes the different attributes:

Attribute	Objectclass	Existence	Mandatory	Self-Service	Changeable	Description
uid	account	MUST	x	x		The unique identifier (uid). This attribute is created by the Self-Service interface by reading (and incrementing) the next free uid from "cn=nextfreeuid,ou=administration,dc=stoney-cloud,dc=org".
userPassword	posixAccount	MAY	x	x	x	Identifies the entry's password and encryption method in the following format: `{encryption method}encrypted password`. For example: {SSHA}zBiT1dHAZh/8zbCeyocRVWhdP0j9xJ3U. This password will be automatically set through the Self-Service interface. Afterwords, the password can be changed by the user (including the reseller and customer). The initial password is stored in clear text and is encrypted by the provisioning daemon.
uidNumber	posixAccount	MUST	x			Related to the /etc/shadow file, this attribute specifies the user's login ID. Is the same as the uid. For example: 3730083.
gidNumber	posixAccount	MUST	x			Group ID number. Is the same as the uid. For example: 3730083.
cn	posixAccount	MUST	x			Consists of the uid and the domain stoney-wiki.com. For example: 3730083.stoney-wiki.com.
gecos	posixAccount	MAY	x	x	x	Named for historical reasons, the GECOS field is mandatory and is used to store extra information (such as the user's full name). Utilities such as finger or getent access this field to provide additional user information. For a personal account, this entry would consist of `givenName` and `surname`, for example `Michael Eichenberger`. These values are taken from the owners entry (ou=people). For a service account, the attribute `sstDisplayName` from the corresponding service would be used for the content of this attribute. Please be aware, that this attribute is a IA5String (OID=1.3.6.1.4.1.1466.115.121.1.26) IA5 (almost ASCII) character set (7-bit). Does NOT allow extended characters e.g. é, Ø, å etc. The Self-Service interface automatically creates the content of this attribute. Consists of the uid and the domain stoney-wiki.com. For example: 3730083.stoney-wiki.com. You can use: `~ $ echo "Tüpfelhyänenöhrchen" \| iconv -f 'utf-8' -t 'ASCII//TRANSLIT'` which gives you: `Tuepfelhyaenenoehrchen` or: `iconv("UTF-8", "ASCII//TRANSLIT", "Tüpfelhyänenöhrchen")` Please be aware, that some characters don't get converted properly ... For example: Ø and £. The characters $ and € work.
homeDirectory	posixAccount	MUST	x			The directory path corresponds with the 7 digit account uid. The following example describes, how the directory structure is built up for the account with the uid 3730083. `/var/wiki/g/efg/bcd/abcdefg` `/var/wiki/3/083/730/3730083` This attribute is created by the Self-Service interface.
loginShell	posixAccount	MAY	x			The path to the login shell. The default is /bin/false and can no be changed.
shadowFlag	shadowAccount	MAY	x			Related to the /etc/shadow file, this attribute is currently not used and is reserved for future use. The default is set to 134539460 and is taken from the "ou=settings,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org" entry.
shadowLastChange	shadowAccount	MAY	x			Related to the /etc/shadow file, this attribute specifies number of days between January 1, 1970, and the date that the password was last modified. Must be set to the day, that the password was set (must be updated, when the password is changed). This attribute is created by the Self-Service interface.
shadowMax	shadowAccount	MAY	x			Related to the /etc/shadow file, this attribute specifies the maximum number of days the password is valid. The default is 99999, which corresponds to about 273 years. In reality, this means, that the user does not need to change the password. This attribute is created by the Self-Service interface. The value is taken from the "ou=settings,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org" entry.
shadowWarning	shadowAccount	MAY	x			Related to the /etc/shadow file, this attribute specifies the number of days before the password expires that the user is warned. The default is 7 and is taken from the "ou=settings,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org" entry.
sstIsActive	sstWiki	MUST	x			Is the wiki account active? Either `TRUE` (yes) or `FALSE` (no). Default is `TRUE` (yes) and is taken from the "ou=defaults,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org" entry.
sstNotificationWarningOn	sstWiki	MUST	x			Are the users notification warnings turned on or not? Either `TRUE` (yes) or `FALSE` (no). Default is TRUE (yes) and is taken from the "ou=settings,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org" entry.
sstNotificationWarning	sstWiki	MAY				This multi-valued attribute will be used to turn single notifications on or off. The attribute `sstWikiWarningOn` must be set to `TRUE`. Currently, the stoney wiki service only supports `quota` (the names correspond with the template dn).
sstNotificationWarningMedium	sstWiki	MUST	x			The notification medium, either sms (points to the multi-valued attribute `mobileTelephoneNumber`) or mail (points to the multi-valued attribute `mail`). Currently, only mail is supported. This is the default is taken from the "ou=defaults,uid=<UID>,ou=reseller,ou=configuration,ou=wiki,ou=services,dc=stoney-cloud,dc=org" entry.
sstSoftwareVersion	sstWiki	MAY	x			TBD
sstFileUploadSize	sstWiki	MAY	x			TBD
host	sstWiki	MAY	x			TBD
sstProvisioningMode	sstProvisioning	MUST	x			The provisioning mode, either `add`, `modify` or `delete`. For a new account, this attribute must be set to `add`. See Provisioning for details.
sstProvisioningExecutionDate	sstProvisioning	MUST	x			The date the provisioning shall occur in the form of [YYYY][MM][DD] (ISO 8601). For a new account, this attribute must be set to 0. See Provisioning for details.
sstProvisioningReturnValue	sstProvisioning	MAY				The provisioning return value written by the prov-wiki-mediawiki daemon. 0 means success, >0 means failure. See the prov-wiki-mediawiki Exit Codes for detailed information.
sstProvisioningState	sstProvisioning	MUST	x			The provisioning state, either 0 or in the form of [YYYY][MM][DD]T[hh][mm][ss] (ISO 8601). For a new account, this attribute must be set to 0. See Provisioning for details.
sstBelongsToResellerUID		MUST	x			Stores the reseller UID the leaf belongs to.
sstBelongsToCustomerUID	TBD	MUST	x			Stores the customer UID the leaf belongs to.
sstBelongsToPersonUID	sstRelationship	MAY	x³			Stores the person UID the leaf belongs to.

Legend:

x: Mandatory in all cases.
x¹: Only show, if the number is larger than zero.
x²: Only show, if sstWikiWarningOn is set to TRUE.
x³: Either sstBelongsToPersonUID or sstBelongsToServiceUID must bei set.

Wiki - Groups

The sub tree for the groups of the stoney wiki service:

dn: ou=groups,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: groups
description: The sub tree for the groups of the stoney wiki service.

Wiki - Group example

dn: cn=3730083,ou=groups,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: posixGroup
objectclass: sstRelationship
cn: 3730083
gidNumber: 3730083
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstBelongsToPersonUID: 4000002

Wiki - SSL-certificates

The leaf entries for SSL-certificates of the stoney wiki service are located directly below the stoney wiki account entry.

Wiki - SSL-certificate example

dn: uid=3732364,uid=3730083,ou=accounts,ou=wiki,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCertificate
objectclass: sstProvisioning
objectclass: sstRelationship
uid: 3732364
sstWebsiteURL: wiki.stepping-stone.ch
host: kvm-1110
sstIsActive: TRUE
sstProvisioningMode: add
sstProvisioningExecutionDate: 0
sstProvisioningState: 0
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstBelongsToPersonUID: 4000002

Wiki - Provisioning

See the OpenLDAP provisioning page for the overview of the provisioning functionality and stoney wiki: prov-wiki-mediawiki the actual wiki provisioning.

Links

@@ Line 17: / Line 17: @@
 The following table describes the different attributes:
-{| class="wikitable sortable" style="border-collapse: collapse; font-size:80%;" width="100%" border="1"
+{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
-| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| '''Attribute'''
+! Attribute
-| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| '''Objectclass'''
+! Objectclass
-| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Existence'''</center>
+! Mandatory
-| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Mandatory'''</center>
+! Description
-| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''
 |-

Difference between revisions of "stoney wiki: OpenLDAP directory data organisation"

Revision as of 10:19, 5 November 2019

Contents

Abstract

Data Organisation

Wiki

Wiki - Configuration

Wiki - Configuration - Provisioning daemon

Wiki - Configuration - Resellers

Wiki - Configuration - Reseller - Account defaults

Wiki - Configuration - Reseller - Notification settings

Wiki - Configuration - Reseller - Account Settings

Wiki - Configuration - Reseller - Templates

Wiki - Configuration - Reseller - Credentials templates

Wiki - Configuration - Reseller - Credentials templates email place holders (txt/html)

Wiki - Configuration - Reseller - Credentials templates LibreOffice place holders (odt)

Wiki - Configuration - Reseller - Quota templates

Wiki - Configuration - Reseller - Quota templates email place holders (txt/html)

Wiki - Configuration - Reseller - Quota templates LibreOffice place holders (odt)

Wiki - Accounts

Wiki - Account example

Wiki - Groups

Wiki - Group example

Wiki - SSL-certificates

Wiki - SSL-certificate example

Wiki - Provisioning

Links

Navigation menu

Personal tools

Namespaces

Variants

Views

Actions

Search

Navigation

Wiki

Tools