Changes
The following chapters explain the data organisation of the stoney cloud OpenLDAP directory. In this case we are looking at the '''Load Balancer as a Service''' (lbaas).
= Load Balancer as a Service (lbaasLBaaS) =The sub tree <code>ou=lbaas,ou=services,dc=stoney-cloud,dc=org</code> contains all the HAProxy based '''Load Balancer as a Service''' (lbaasLBaaS) data. The following LDIF shows the '''lbaas''' LDAP entry for the Load Balancer as a Service (lbaas):
<source lang="ldif">
| The name of the leaf.
For the HAProxy based Load Balancer as a Service (lbaasLBaaS) this is: <code>lbaas</code>.
|-
| The description of the leaf.
For the HAProxy based Load Balancer as a Service (lbaasLBaaS) the description ist is: <code>The sub tree for the HAproxy based Load Balancer as a Service (lbaas).</code>
|}
* '''x''': Mandatory in all cases.
== Load Balancer as a Service (lbaasLBaaS) - Configuration ==
The sub tree for the configuration of the Load Balancer as a Service (lbaas):
<source lang="ldif">
| The name of the leaf.
For the configuration of the HAProxy based Load Balancer as a Service (lbaasLBaaS) this is: <code>configuration</code>.
|-
| The description of the leaf.
For the configuration of the HAProxy based Load Balancer as a Service (lbaasLBaaS) this is: <code>The sub tree for the configuration of the HAProxy based Load Balancer as a Service (lbaas).</code>
|}
* '''x''': Mandatory in all cases.
=== Load Balancer as a Service (lbaasLBaaS) - Configuration - Provisioning daemon ===
See the [[stoney_core:_OpenLDAP_directory_data_organisation#Services | Services description]] for the naming convention.
| The name of the leaf.
For the HAProxy based Load Balancer as a Service (lbaasLBaaS) prov-wiki-mediawiki provisioning daemon this is: <code>prov-wiki-mediawiki</code>.
|-
| The description of the leaf.
For the HAProxy based Load Balancer as a Service (lbaasLBaaS) prov-wiki-mediawiki provisioning daemon this is: <code>The sub tree for the configuration of the prov-wiki-mediawiki provisioning daemon.</code>
|-
* '''x''': Mandatory in all cases.
=== Load Balancer as a Service (lbaasLBaaS) - Configuration - Resellers ===The sub tree for the reseller specific Load Balancer as a Service (lbaasLBaaS) settings:
<source lang="ldif">
dn: ou=reseller,ou=configuration,ou=lbaas,ou=services,dc=stoney-cloud,dc=org
| The name of the leaf.
For the reseller specific HAProxy based Load Balancer as a Service (lbaasLBaaS) service this is: <code>reseller</code>.
|-
| The description of the leaf.
For the reseller specific HAProxy based Load Balancer as a Service (lbaasLBaaS) service this is: <code>The sub tree for the configuration of the HAProxy based Load Balancer as a Service (lbaas).</code>
|}
* '''x''': Mandatory in all cases.
The sub tree for the specific Load Balancer as a Service (lbaasLBaaS) settings for the reseller Reseller Ltd. with the uid 4000000.
<source lang="ldif">
dn: uid=4000000,ou=reseller,ou=configuration,ou=lbaas,ou=services,dc=stoney-cloud,dc=org
uid: 4000000
organizationName: Reseller Ltd.
description: The sub tree for the specific Load Balancer as a Service (lbaasLBaaS) settings for the reseller Reseller Ltd. with the uid 4000000.
sstIsActive: TRUE
sstIsCompany: TRUE
| The description of the leaf.
For example: <code>The sub tree for the specific Load Balancer as a Service (lbaasLBaaS) settings for the reseller Reseller Ltd. with the uid 4000000.</code>
|-
| <center>MAY</center>
| <center>x</center>
| Is this leaf a default entry? Either <code>TRUE</code> (yes) or <code>FALSE</code> (no). If <code>sstIsDefault</code> is set to <code>TRUE</code>, this entry acts as a fall back configuration. In other words: If a reseller doesn't have his own Load Balancer as a Service (lbaasLBaaS) configuration, then this one will be used.
As you would normally have only one default configuration per cloud, the default value is <code>FALSE</code>.
* '''x<sup>1</sup>''': If <code>sstIsCompany</code> is set to <code>TRUE</code>, the <code>organizationName</code> must be set. Otherwise <code>givenName</code> and <code>surname</code> must be set.
==== Load Balancer as a Service (lbaasLBaaS) - Configuration - Reseller - Account defaults ====
<span style="color: red">Work in progress ...</span>
The sub tree for the wiki account defaults for the Load Balancer as a Service (lbaasLBaaS) for the reseller Reseller Ltd. with the uid 4000000:
<source lang="ldif">
dn: ou=defaults,uid=4000000,ou=reseller,ou=configuration,ou=lbaas,ou=services,dc=stoney-cloud,dc=org
objectclass: sstWiki
ou: defaults
description: The sub tree for the default settings of the Load Balancer as a Service (lbaasLBaaS) for the reseller Reseller Ltd. with the uid 4000000.
sstIsActive: TRUE
...
* '''x''': Mandatory in all cases.
==== Load Balancer as a Service (lbaasLBaaS) - Configuration - Reseller - Notification settings ====The sub tree stores the notification information for the Load Balancer as a Service (lbaasLBaaS) 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):
<source lang="ldif">
dn: ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=lbaas,ou=services,dc=stoney-cloud,dc=org
objectclass: sstNotificationObjectClass
ou: notifications
description: The sub tree stores the notification information for the Load Balancer as a Service (lbaasLBaaS) 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 AG <support@stepping-stone.ch>
sstNotificationWarningOn: TRUE
| The name of the leaf.
For the notification settings of the HAProxy based Load Balancer as a Service (lbaasLBaaS) this is: <code>notifications</code>.
|-
| The description of the leaf.
For the notification settings of the HAProxy based Load Balancer as a Service (lbaasLBaaS) this is: <code>The sub tree stores the notification information for the Load Balancer as a Service (lbaasLBaaS) for the reseller Reseller Ltd. with the uid 4000000. This information is used independently of the notification settings of the users.</code>
|-
| The description of the leaf.
For the configuration of the HAProxy based Load Balancer as a Service (lbaasLBaaS) this is: <code>Support stepping stone AG <support@stepping-stone.ch></code>
|-
| This multi-valued attribute will be used to turn single notifications on or off. The attribute <code>sstWikiWarningOn</code> must be set to <code>TRUE</code>.
Currently, the Load Balancer as a Service (lbaasLBaaS) only supports <code>quota</code> (the names correspond with the template dn).
|}
* '''x<sup>1</sup>''': The attributes <code>sstNotificationWarningOn</code> and <code>sstNotificationWarning</code> are dependent on each other and must be combined via an AND operation.
==== Load Balancer as a Service (lbaasLBaaS) - Configuration - Reseller - Account Settings ====
<span style="color: red">Work in progress ...</span>
The sub tree stores the information about what can be modified in which scope for the Load Balancer as a Service (lbaasLBaaS) for the reseller Reseller Ltd. with the uid 4000000:
<source lang="ldif">
dn: ou=settings,uid=4000000,ou=reseller,ou=configuration,ou=lbaas,ou=services,dc=stoney-cloud,dc=org
* '''x''': Mandatory in all cases.
==== Load Balancer as a Service (lbaasLBaaS) - Configuration - Reseller - Templates ====
<source lang="ldif">
This sub tree contains the templates for the Load Balancer as a Service (lbaasLBaaS) for the reseller Reseller Ltd. with the uid 4000000:
dn: ou=templates,uid=4000000,ou=reseller,ou=configuration,ou=lbaas,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: templates
description: This sub tree contains the templates for the Load Balancer as a Service (lbaasLBaaS) for the reseller Reseller Ltd. with the uid 4000000.
</source>
===== Load Balancer as a Service (lbaasLBaaS) - Configuration - Reseller - Credentials templates =====
This sub tree contains the credentials templates for the Load Balancer as a Service (lbaas):
<source lang="ldif">
* '''x''': Mandatory in all cases.
====== Load Balancer as a Service (lbaasLBaaS) - Configuration - Reseller - Credentials templates email place holders (txt/html) ======
Address with an example:
<source lang="text">
</source>
====== Load Balancer as a Service (lbaasLBaaS) - 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 <code>{$placeholder}</code> we have <code>{{placeholder}}</code>.
===== Load Balancer as a Service (lbaasLBaaS) - Configuration - Reseller - Quota templates =====
Warns the user when the wiki is running out of space (quota).
* '''x<sup>1</sup>''': Must exist, if <code>sstMailTo</code> is set.
====== Load Balancer as a Service (lbaasLBaaS) - Configuration - Reseller - Quota templates email place holders (txt/html) ======
An example:
<source lang="text">
</source>
====== Load Balancer as a Service (lbaasLBaaS) - 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 <code>{$placeholder}</code> we have <code>{{placeholder}}</code>.
== Load Balancer as a Service (lbaasLBaaS) - Accounts ==
The sub tree for the accounts of the Load Balancer as a Service (lbaas):
<source lang="ldif">
</source>
=== Load Balancer as a Service (lbaasLBaaS) - Account example ===
The following example shows the OpenLDAP directory entry for the stoney wiki account with the uid number 3730083:
<source lang="ldif">
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| This multi-valued attribute will be used to turn single notifications on or off. The attribute <code>sstWikiWarningOn</code> must be set to <code>TRUE</code>.
Currently, the Load Balancer as a Service (lbaasLBaaS) only supports <code>quota</code> (the names correspond with the template dn).
|-
* '''x<sup>3</sup>''': Either <code>sstBelongsToPersonUID</code> or <code>sstBelongsToServiceUID</code> must bei set.
== Load Balancer as a Service (lbaasLBaaS) - Groups ==
The sub tree for the groups of the Load Balancer as a Service (lbaas):
<source lang="ldif">
</source>
=== Load Balancer as a Service (lbaasLBaaS) - Group example ===
<source lang="ldif">
dn: cn=3730083,ou=groups,ou=lbaas,ou=services,dc=stoney-cloud,dc=org
</source>
== Load Balancer as a Service (lbaasLBaaS) - SSL-certificates ==The leaf entries for SSL-certificates of the Load Balancer as a Service (lbaasLBaaS) are located directly below the stoney wiki account entry.
=== Load Balancer as a Service (lbaasLBaaS) - SSL-certificate example ===
<source lang="ldif">
dn: uid=3732364,uid=3730083,ou=accounts,ou=lbaas,ou=services,dc=stoney-cloud,dc=org
</source>
== Load Balancer as a Service (lbaasLBaaS) - Provisioning ==
See the [[stoney core: OpenLDAP provisioning|OpenLDAP provisioning]] page for the overview of the provisioning functionality and [[stoney wiki: prov-wiki-mediawiki]] the actual wiki provisioning.
