stoney-cloud.org - User contributions [en]

MediaWiki:Sidebar

2024-06-10T09:36:28Z

Administrator:

stoney core: OpenLDAP directory data organisation

2024-02-02T14:54:29Z

Administrator: /* Services */

= Abstract =
This document describes the [[:Category:stoney core|stoney core]] relevant OpenLDAP directory data organisation.

= Data Organisation =
The following chapters explain the data organisation of the stoney cloud OpenLDAP directory. This document describes the [[:Category:stoney core|stoney core]] relevant OpenLDAP directory data organisation.

== Administration ==
The subtree '''ou=administration,dc=stoney-cloud,dc=org''' contains all the administrative data.

=== nextfreeuid ===
The entry <code>cn=nextfreeuid,ou=administration,dc=stoney-cloud,dc=org</code> stores the next free UID (Unique Identifier). The <code><uid></code> is unique over the whole directory and is enforced through the directory and is incremented by one.
<source lang='ldif'>
dn: cn=nextfreeuid,ou=administration,dc=stoney-cloud,dc=org
objectclass: sstNextFreeUID
cn: nextfreeuid
uid: 3724591
uidNumber: 3724591
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
! style="text-align:left; width: 180px" | Attribute
! style="text-align:left; width: 220px" | Objectclass
! style="width: 80px" | Existance
! style="width: 80px" | Mandatory
! style="text-align:left;" | Description

|-
| cn
| ...
| <center>MUST</center>
| <center>x</center>
| The name of the leaf.

For the next free uid, this is: <code>nextfreeuid</code>.

|-
| uid
| ...
| <center>...</center>
| <center>x</center>
| ...

|}

Legend:
* '''x''': Mandatory in all cases.

Before using this attribute <code>uidNumber</code>, you need to be sure, that your directory server actually supports atomic increments (LDAP Modify-Increment). See [https://www.iana.org/assignments/ldap-parameters/ldap-parameters.xhtml Lightweight Directory Access Protocol (LDAP) Parameters] and [https://tools.ietf.org/html/rfc4525 Lightweight Directory Access Protocol (LDAP) Modify-Increment Extension (RFC4525)].

The following search should tell you, if you LDAP server supports the LDAP Modify-Increment Object Identifier Descriptor (OID 1.3.6.1.1.14):
<source lang='bash'>
ldapsearch -H ldaps://ldapm.stepping-stone.ch -b "" -s base -D "cn=Manager,dc=stoney-cloud,dc=org" -W \* + | grep 1.3.6.1.1.14
</source>

The result should look as follows:
<source lang='text'>
supportedFeatures: 1.3.6.1.1.14
</source>

Options:
<source lang='text'>
-H ldapuri
-b searchbase
-D binddn
-W Prompt for simple authentication.
\* All user attributes are returned.
+ All operational attributes are returned.
</source>

=== Billing ===
The sub tree <code>ou=billing,ou=administration,dc=stoney-cloud,dc=org</code> stores all the billing relevant data. Each billable item (bundle, service or service item) is stored in this sub tree.
<source lang='ldif'>
dn: ou=billing,ou=administration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: billing
</source>

The following LDIF extract shows the billing schema for the product "Mail Account".
<source lang='ldif'>
dn: uid=100001,ou=billing,ou=administration,dc=stoney-cloud,dc=org
description: Default pricing schema for the product Mail Account.
objectclass: top
objectclass: sstBillingPriceSchema
sstbaseprice: 0
sstbelongstouid: 1
sstbillingunit: Gigabyte
sstfreeunit: 0
sstpriceformula: sstPricePerUnit * sstQuota
sstpriceperunit: 4.00
sstproductname: Mail Account
uid: 100001
sstBelongsToUID: 1
</source>

The finale price is calculated with the help of the stored formula (sstPriceFormula). The customer price for a "Mail Account" with a 2 Gigabyte large mailbox (quota) is calculated as follows:
'''Price''' = sstPricePerUnit * sstQuota = 4.00 CHF/(Gigabyte * Month) * 2 Gigabyte = '''8 CHF/Month'''

All prices are stored in Swiss Francs (because the company stepping stone GmbH resides in Switzerland). You can decide about the default currency yourself. Once a month a billing run is executed, which scans the whole directory. The billing run is a currently "work in progress". For more information, please contact our [mailto:accounting@stepping-stone.ch Accounting] departement.

=== Group Mapping ===
Used for the group mapping from the given readable format to the local group UID format.
<source lang='ldif'>
dn: ou=group mapping,ou=administration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
objectclass: sstLDAPSearchObjectClass
ou: group mapping
description: This entry describes, how to map a given group name to an UID in the local LDAP directory.
sstDisplayName: Group Mapping
sstLDAPBaseDn: ou=groups,dc=stoney-cloud,dc=org
sstLDAPFilter: (&(objectClass=sstGroupObjectClass)(sstGroupName=%s)(sstBelongsToResellerUID=%sstBelongsToResellerUID)(sstBelongsToCustomerUID=%sstBelongsToCustomerUID))
sstLDAPStaticAttribute: uid
</source>

==== Example Mapping for the Technology Group ====
The following search maps the group Technology belonging to the reseller with the sstBelongsToResellerUID 4000000 and the customer with the sstBelongsToCustomerUID 4000001 to the uid 4000014:
<source lang='bash'>
ldapsearch -D "cn=Manager,dc=stoney-cloud,dc=org" -w admin -H "ldap://10.1.130.14:389" -b "ou=groups,dc=stoney-cloud,dc=org" "(&(objectClass=sstGroupObjectClass)(sstGroupName=Technology)(sstBelongsToResellerUID=4000000)(sstBelongsToCustomerUID=4000001))" uid
</source>

<source lang='text'>
# extended LDIF
#
# LDAPv3
# base <ou=groups,dc=stoney-cloud,dc=org> with scope subtree
# filter: (&(objectClass=sstGroupObjectClass)(sstGroupName=Technology)(sstBelongsToResellerUID=4000000)(sstBelongsToCustomerUID=4000001))
# requesting: uid
#
# 4000014, groups, stoney-cloud.org
dn: uid=4000014,ou=groups,dc=stoney-cloud,dc=org
uid: 4000014

# search result
search: 2
result: 0 Success

# numResponses: 2
# numEntries: 1
</source>

==== Example Mapping for all Groups ====
The following search lists all the existing Groups to belonging to the reseller with the sstBelongsToResellerUID 4000000 and the customer with the sstBelongsToCustomerUID 4000001 with the corresponding uids:
<source lang='bash'>
ldapsearch -D "cn=Manager,dc=stoney-cloud,dc=org" -w admin -H "ldap://10.1.130.14:389" -b "ou=groups,dc=stoney-cloud,dc=org" "(&(objectClass=sstGroupObjectClass)(sstGroupName=*)(sstBelongsToResellerUID=4000000)(sstBelongsToCustomerUID=4000001))" uid
</source>

<source lang='text'>
# extended LDIF
#
# LDAPv3
# base <ou=groups,dc=stoney-cloud,dc=org> with scope subtree
# filter: (&(objectClass=sstGroupObjectClass)(sstGroupName=*)(sstBelongsToResellerUID=4000000)(sstBelongsToCustomerUID=4000001))
# requesting: uid
#

# 4000014, groups, stoney-cloud.org
dn: uid=4000014,ou=groups,dc=stoney-cloud,dc=org
uid: 4000014

# 4000015, groups, stoney-cloud.org
dn: uid=4000015,ou=groups,dc=stoney-cloud,dc=org
uid: 4000015

# search result
search: 2
result: 0 Success

# numResponses: 3
# numEntries: 2
</source>

=== People (Superuser) ===
The sub tree <code>ou=people,ou=administration,dc=stoney-cloud,dc=org</code> list all users, which have super user richts (users with the attribute <code>sstBelongsToUID=1</code>). This entry uses the functionality of the the dynlist overlay. The attribut '''labeleduri''' contains a pre-defined search, which leads to a automatically created list.
<source lang='ldif'>
dn: ou=people,ou=administration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: people
labeleduri: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstBelongsToUID=1)
member: uid=1000000,ou=people,dc=stoney-cloud,dc=org
member: uid=1000003,ou=people,dc=stoney-cloud,dc=org
member: uid=1000004,ou=people,dc=stoney-cloud,dc=org
</source>

As you can see, the OpenLDAP has three people withe Superuser rights.

=== Services ===
The sub tree '''ou=services,ou=administration,dc=stoney-cloud,dc=org''' contains all the service users. Each service and/or application has its own authentication user. The authentication user is used in the [[HTTP Basic authentication against OpenLDAP directory|OpenLDAP Directory Access Control Lists]] (ACLs) to allow or restrict access to the data.

Naming Convention '''Notification user''':
* <SERVICE>-notification
** backup-notification
** cloud-notification
** lbaas-notification
** mail-notification
** storage-notification

Naming Convention '''Service user''':
* <SERVICE>-<DAEMON>
** backup-pam-ldap
** cloud-openstack
** crm-suitecrm
** billing-cyclops
** cm-puppetboard ('''c'''onfiguration '''m'''anagement - Puppetboard Service)
** dms-alfresco ('''d'''ocument '''m'''anagement '''s'''ystem - Alfresco)
** iac-terraform ('''i'''nfrastructure '''a'''s '''c'''ode - Terraform)
** <s>lbaas-haproxy</s>
** <s>lbaas-pam-ldap</s>
** monitoring-zabbix
** phabricator
** pm-kanboard
** qos-rally
** storage-nextcloud
** storage-pam_ldap
** timetracking-kimai
** vault-cryptopus (A vault is a place where secrets are stored - in other words a password management system)
** vcs-gitlab ('''v'''ersion '''c'''ontrol '''s'''ystem - GitLab Service)
** virtualization-sc-brokerd
** wiki-int

Naming Convention '''API user''':
* <SERVICE>-api
** lbaas-api

Naming Convention '''Provisioning user''':
* prov-<SERVICE>-<TYPE>
** prov-backup-kvm
** prov-backup-zsnapshot
** prov-cloud-openstack
** prov-configuration-management-puppet
** <s>prov-lbaas-haproxy</s>
** prov-mail-ox ('''O'''pen-'''X'''change)
** prov-monitoring-zabbix
** prov-storage-nextcloud

==== backup Service User (stoney backup) ====
The following LDIF shows the backup service user entry:
dn: cn=backup,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: dhcp
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: backup
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

==== dhcp (DHCP) Service User (stoney conductor) ====
The following LDIF shows the dhcp service user entry:
dn: cn=dhcp,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: dhcp
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: dhcp
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

==== libvirtd Service User (stoney conductor) ====
The following LDIF shows the libvirtd service user entry:
dn: cn=libvirtd,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: libvirtd
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: dhcp
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

==== prov-backup-kvm (Provisioning-Backup-KVM Daemon) Service User (stoney conductor) ====
The following LDIF shows the prov-backup-kvm service user entry:
dn: cn=prov-backup-kvm,ou=services,ou=administration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
cn: prov-backup-kvm
sn: prov-backup-kvm
userPassword: <STONEY-CLOUD-PROV-BACKUP-KVM-PASSWORD>

==== slapd-mirrormode Service User (stoney core) ====
The following LDIF shows the slapd-mirrormode service user entry:
dn: cn=slapd-mirrormode,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: slapd-mirrormode
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: slapd-mirrormode
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

==== billing-cyclops Service User (stoney core) ====
The following LDIF shows the billing service user entry:
dn: cn=billing-cyclops,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: slapd-mirrormode
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: billing-cyclops
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

== Configuration ==
=== Configuration management ===
The sub tree '''ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org''' contains the configuration management system relevant entries of the whole stoney cloud installation. They can be extended by the administrator.
<source lang='ldif'>
# This sub tree contains the configuration management system relevant entries of the whole stoney cloud installation.
dn: ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: configuration management
description: This sub tree contains the configuration management system relevant entries of the whole stoney cloud installation.
</source>

==== Configuration management - Regions ====
The sub tree '''ou=regions,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org''' contains the configuration management system region entries of the whole stoney cloud installation. They can be extended by the administrator.
<source lang='ldif'>
# This sub tree contains the configuration management system region entries of the whole stoney cloud installation.
dn: ou=regions,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: regions
description: This sub tree contains the configuration management system region entries of the whole stoney cloud installation.
</source>

===== Configuration management - Regions - Region example =====
The following LDIF example shows a typical region.
<source lang='ldif'>
dn: cn=duedingen_production,ou=regions,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalRole
cn: duedingen_production
description: This region contains the two data centres located in Düdingen and is used for production systems.
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
! style="text-align:left; width: 180px" | Attribute
! style="text-align:left; width: 220px" | Objectclass
! style="width: 80px" | Existance
! style="width: 80px" | Mandatory
! style="text-align:left;" | Description

|-
| cn
| organizationalRole
| <center>MUST</center>
| <center>x</center>
| The region used by the configuration management system Puppet via enc.

For example: <code>cn: duedingen_production</code>.

|-
| description
| organizationalRole
| <center>MAY</center>
| <center>x</center>
| The human readable description of region.

For example: <code>description: This region contains the two data centres located in Düdingen and is used for production systems.</code>.

|}

Legend:
* '''x''': Mandatory in all cases.

==== Configuration management - Roles ====
The sub tree '''ou=roles,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org''' contains the configuration management system role entries of the whole stoney cloud installation. They can be extended by the administrator.
<source lang='ldif'>
# This sub tree contains the configuration management system role entries of the whole stoney cloud installation.
dn: ou=roles,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: roles
description: This sub tree contains the configuration management system role entries of the whole stoney cloud installation.
</source>

===== Configuration management - Roles - Roles example =====
The following LDIF example shows a typical role.
<source lang='ldif'>
dn: cn=base,ou=roles,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstConfigurationManagementRole
cn: base
displayName: Base
sstProfiles: - base
description: This is the base role used by all new servers managed by Puppet, but without a final role decided.
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
! style="text-align:left; width: 180px" | Attribute
! style="text-align:left; width: 220px" | Objectclass
! style="width: 80px" | Existance
! style="width: 80px" | Mandatory
! style="text-align:left;" | Description

|-
| cn
| sstConfigurationManagementRole
| <center>MUST</center>
| <center>x</center>
| The role name used by the configuration management system Puppet via enc.

For example: <code>cn: base</code>.

|-
| displayName
| sstConfigurationManagementRole
| <center>MUST</center>
| <center>x</center>
| The role display name (human readable).

For example: <code>displayName: Base</code>.

|-
| sstProfiles
| sstConfigurationManagementRole
| <center>MUST</center>
| <center>x</center>
| The role definition (profile list) used by the configuration management system Puppet via enc. The profiles are listed, one per line. Multiple lines must be base64 endoded:

For example: <code>sstProfiles: - base</code> or <code>sstProfiles:: LSBiYXNlCi0gY2VydGJvdAo=</code>.

Encode:
<source lang="bash">
cat << EOF | base64
- base
- certbot
EOF
</source>
Decode:
<source lang="bash">
echo LSBiYXNlCi0gY2VydGJvdAo= | base64 --decode
</source>

|-
| description
| organizationalRole
| <center>MAY</center>
| <center></center>
| The human readable description of region.

For example: <code>description: This region contains the two data centres located in Düdingen and is used for production systems.</code>.

|}

=== Operating System ===
The sub tree '''ou=operating system,ou=configuration,dc=stoney-cloud,dc=org''' contains the operating system choices for the whole stoney cloud installation. They can be extended by the administrator.
# This sub tree contains the operating system choices for the whole stoney cloud installation.
dn: ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: operating system
description: This sub tree contains the operating system choices for the whole stoney cloud installation.

==== Linux ====
The sub tree '''uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org''' contains the Linux based operating system choices for the whole stoney cloud installation.
# This sub tree contains the Linux based operating system choices for the whole stoney cloud installation.
dn: uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000019
sstDisplayName: Linux
description: This sub tree contains the Linux based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Debian Linux based operating system choices for the whole stoney cloud installation.
dn: uid=4000020,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000020
sstDisplayName: Debian
description: This sub tree contains the Debian Linux based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000021,uid=4000020,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000021
sstDisplayName: 5
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000022,uid=4000020,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000022
sstDisplayName: 6
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000023,uid=4000020,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000023
sstDisplayName: 7
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Fedora Linux based operating system choices for the whole stoney cloud installation.
dn: uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000024
sstDisplayName: Fedora
description: This sub tree contains the Fedora Linux based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000025,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000025
sstDisplayName: 12
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000026,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000026
sstDisplayName: 13
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000027,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000027
sstDisplayName: 14
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000028,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000028
sstDisplayName: 15
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000029,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000029
sstDisplayName: 16
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000030,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000030
sstDisplayName: 17
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000031,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000031
sstDisplayName: 18
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000032,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000032
sstDisplayName: 19
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Gentoo Linux based operating system choices for the whole stoney cloud installation.
dn: uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000033
sstDisplayName: Gentoo
description: This sub tree contains the Gentoo Linux based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000034,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000034
sstDisplayName: 2012.0
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000035,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000035
sstDisplayName: 2013.0
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

==== Windows ====
The sub tree '''uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org''' contains the Windows based operating system choices for the whole stoney cloud installation.
# This sub tree contains the Windows based operating system choices for the whole stoney cloud installation.
dn: uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000036
sstDisplayName: Windows
description: This sub tree contains the Windows based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Windows Server 2008 based operating system choices for the whole stoney cloud installation.
dn: uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000037
sstDisplayName: Server 2008
description: This sub tree contains the Windows Server 2008 based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000038,uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000038
sstDisplayName: Datacenter
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000039,uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000039
sstDisplayName: Enterprise
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000040,uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000040
sstDisplayName: Foundation
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000041,uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000041
sstDisplayName: Standard
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Windows Server 2008 R2 based operating system choices for the whole stoney cloud installation.
dn: uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000042
sstDisplayName: Server 2008 R2
description: This sub tree contains the Windows Server 2008 R2 based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000043,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000043
sstDisplayName: Datacenter
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000044,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000044
sstDisplayName: Enterprise
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000045,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000045
sstDisplayName: Foundation
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000046,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000046
sstDisplayName: Standard
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000047,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000047
sstDisplayName: Web
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Windows Server 2012 based operating system choices for the whole stoney cloud installation.
dn: uid=4000048,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000048
sstDisplayName: Server 2012
description: This sub tree contains the Windows Server 2012 based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000049,uid=4000048,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000049
sstDisplayName: Datacenter
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000050,uid=4000048,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000050
sstDisplayName: Standard
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

=== Software Stack ===
The sub tree '''ou=software stack,ou=configuration,dc=foss-cloud,dc=org''' contains the software stack choices for the whole stoney cloud installation. They can be extended by the administrator.
# This sub tree contains the software stack choices for the whole stoney cloud installation.
dn: ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: software stack
description: This sub tree contains the software stack choices for the whole stoney cloud installation.

dn: ou=environments,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: environments
description: This sub tree contains the software stack environment choices for the whole stoney cloud installation.

dn: uid=4000054,ou=environments,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000054
sstDisplayName: Test Environment
description: This is the environment used for testing (pre-production).
sstEnvironmentName: Test
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000055,ou=environments,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000055
sstDisplayName: Development Environment
description: This is the environment used for development (sandbox).
sstEnvironmentName: Development
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000056,ou=environments,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000056
sstDisplayName: Production Environment
description: This is the environment used for production.
sstEnvironmentName: Production
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

The multi-valued '''labeledURI''' attribute contains the '''operating system(s)''' for which a software stack works and therefore can be shown to the customer. The following three attributes tell us, who is allowed to access this leaf:
* '''sstAllowResellerUID''': Stores the reseller UID(s) that are allowed access to this leaf. If set to 0 (zero), all resellers have access.
* '''sstAllowCustomerUID''': Stores the customer UID(s) that are allowed access to this leaf. If set to 0 (zero), all customers belonging to the allowed resellers have access.
* '''sstAllowPersonUID''': Stores the person UID(s) that are allowed access to this leaf. If set to 0 (zero), all people belonging to the allowed resellers and the allowed customers have access.
dn: uid=4000051,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
objectclass: labeledURIObject
uid: 4000051
sstDisplayName: Django (Version 1)
description: Django Python Web Framework Version 1.
labeledURI: ldap://uid=4000034,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=foss-cloud,dc=org
labeledURI: ldap://uid=4000035,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=foss-cloud,dc=org
sstEnvironmentName: Test
sstEnvironmentName: Development
sstEnvironmentName: Production
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000052,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
objectclass: labeledURIObject
uid: 4000052
sstDisplayName: Django (Version 2)
description: Django Python Web Framework Version 2.
labeledURI: ldap://uid=4000034,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=foss-cloud,dc=org
labeledURI: ldap://uid=4000035,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=foss-cloud,dc=org
sstEnvironmentName: Test
sstEnvironmentName: Development
sstEnvironmentName: Production
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

== Customers ==
The sub tree '''ou=customers,dc=stoney-cloud,dc=org''' contains all the customers. Each customer has a unique uid, which is used for later reference.

=== Customers - Customer ===
We have two kinds of customers:
* '''Company customer''': This is the normal case, as we target companies.
* '''Private customer''': A private customer does not have a company/organisation name.

The following LDIF examples will show both cases where necessary. The first LDIF shows you the default '''company customer''' entry after a fresh stoney cloud installation. All relevant data belonging to this customer is stored below this dn.
<source lang='ldif'>
dn: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCustomer
objectclass: sstRelationship
uid: 4000001
organizationName: Customer Ltd.
sstIsCompany: TRUE
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
</source>

The following LDIF shows you the '''private customer''' entry. All relevant data belonging to this customer are stored below this dn.
<source lang='ldif'>
dn: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCustomer
objectclass: sstRelationship
uid: 4000001
givenName: Name
surname: Surname
sstIsCompany: FALSE
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| organizationName
| <center>MAY</center>
| <center>x1</center>
| The organisation name of the customer. For example: Customer Ltd..

|-
| givenName
| <center>MAY</center>
| <center>x1</center>
| Givenname, example: Hans.

|-
| surname
| <center>MAY</center>
| <center>x1</center>
| Surname, example: Muster.

|-
| sstIsCompany
| <center>MUST</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstBelongsToResellerUID
| <center>MUST</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000.

|-
| sstBelongsToCustomerUID
| <center>MAY</center>
| <center>x</center>
| Stores the customer UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000001.

|}

Legend:
* '''x''': Mandatory in all cases.
* '''x1''': 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.

==== Customers - Customer - Billing address ====
The sub tree '''ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the billing address for a '''company customer''':
<source lang='ldif'>
dn: ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: address
organizationName: Customer Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: Name Surname <name.surname@example.com>
sstMailCc: Info Customer Ltd. <info@example.com>
sstMailBcc: Accounting Service Provider Ltd. <accounting@example.org>
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The sub tree '''ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the billing address for a '''private customer''':
<source lang='ldif'>
dn: ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: address
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: Name Surname <name.surname@example.com>
sstMailCc: Info <info@example.com>
sstMailBcc: Accounting Service Provider Ltd. <accounting@example.org>
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute Name'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Interface Equivalent'''
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| organizationName
| <center>MAY</center>
| <center>x1</center>
| Customer Name
| Customer name, for example: '''stepping stone GmbH'''.

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Gender
| Either 'm' for male or 'f' for female. For example: '''m'''.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Name
| Name, for example: '''Hans'''.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname
| Surname, for example: '''Muster'''.

|-
| postalAddress
| <center>MAY</center>
| <center>x3</center>
| Address
| Multi-lined address, for example: '''Neufeldstrasse 9'''.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x3</center>
| Post Office Box
| Post Office Box, for example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x4</center>
| State or Province Name
| This pull down menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country
| Country code according to [http://www.iso.org/iso/home/standards/country_codes.htm ISO 3166-1]. The English short name (upper/lower case) is used for the interface and the corresponding ISO 3166-1-alpha-2 code (a two-letter code that represents a country name, recommended as the general purpose code) is used for the LDAP entry). For example: '''Switzerland''' in the interface and '''CH''' in the LDAP directory.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Postal Code
| Postal Code without the country code, for example: '''3012'''.

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| Location
| Location, for example: '''Berne'''.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Language
| Display language of the user according to [http://www.ietf.org/rfc/rfc1766.txt RFC 1766]. For example: '''de-CH'''. The following languages are currently supported:
* de-CH
* de-DE
* en-GB
* en-US
* fr-CH
* fr-FR

|-
| mail
| <center>MUST</center>
| <center>x</center>
| Mail Address
| The customers "To:" billing mail address, for example: '''Hans Muster <hans.muster@example.com>'''. This is a multi-valued attribute and it MUST contain at least one "To:" billing mail address.

|-
| sstMailCc
| <center>MAY</center>
| <center></center>
| Mail Address
| The customers "CC:" billing mail address, for example: '''Info Customer Ltd. <info@example.com>'''. This is a multi-valued attribute and can contain zero or more "CC:" billing mail addresses.

|-
| sstMailBcc
| <center>MAY</center>
| <center></center>
| Mail Address
| The customers "BCC:" billing mail address, for example: '''Accounting Service Provider Ltd. <accounting@example.org>'''. This is a multi-valued attribute and can contain zero or more "BCC:" billing mail addresses. Here we'd expect the Accounting mail address of the service provider (for accountability reasons).

|-
| telephoneNumber
| <center>MAY</center>
| <center>x2</center>
| Telephone
| Telephone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 31 222 33 44'''.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x2</center>
| Mobile
| Mobile phone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 76 222 33 44'''.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| Website
| Website URL according to [http://tools.ietf.org/html/rfc3986 RFC-3986]. For example: '''http://www.stepping-stone.ch'''/.

|}
Legend:

* '''x1''': If the attribute <code>sstIsCompany</code> of the parent entry is set to <code>TRUE</code>, the <code>organizationName</code> must be set.
* '''x2''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x3''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x4''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

==== Customers - Customer - Shipping address (optional) ====
The sub tree '''ou=shipping,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the shipping address and is optional (it is only needed, if the shipping address differs from the billing Address).
<source lang='ldif'>
dn: ou=shipping,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: shipping
organizationName: Customer Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

==== Customers - Customer - Billing ====
The sub tree '''ou=billing,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains billing relevant data. The following example shows a customer, receiving a monthly bill.
<source lang='ldif'>
dn: ou=billing,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstBillingCustomer
ou: billing
sstBillable: TRUE
sstBillingCycle: 1
sstCurrency: CHF
sstPaymentMethod: invoice
sstDeliveryMethod: post
sstDiscount: 20
sstCancellationDate: 20181231
sstMailToUID: 4000002
sstMailCcUID: 4000064
sstMailBccUID: 4000066
sstMailBccUID: 4000069
</source>

The following example shows a customer, which receives their bill via their reseller (no billing done by us):
<source lang='ldif'>
dn: ou=billing,uid=4000001,ou=customers,o=stepping-stone,c=ch
objectclass: top
objectclass: organizationalUnit
objectclass: sstBillingCustomer
ou: billing
sstBillable: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| sstBillable
| <center>MAY</center>
| <center>x2</center>
| All hierarchical levels must have <code>sstBillable: TRUE</code> to actually have an invoice generated and sent. If the attribute <code>sstBillable</code> doesn't exist, the default is <code>TRUE</code>. This way, we are forced to set a reseller, customer or product manually to <code>sstBillable: FALSE</code> if we want to avoid sending them an invoice.
|-
| sstBillingCycle
| <center>MAY</center>
| <center></center>
| Billing cycle in months. This attribute <code>sstBillingCycle</code> is only checked (evaluated), if the reseller the customer belongs to, has <code>sstResellerBill</code> set to <code>FALSE</code> (as is the case for the reseller stepping stone GmbH). Possible values:
* 1: Monthly invoice.
* 3: Quarterly invoice.
* 6: Semi-annually invoice.
* '''12''': Yearly invoice (this is the default billing period if no <code>sstBillingCycle</code> is set).

|-
| sstCurrency
| <center>MAY</center>
| <center></center>
| Three-letter currency code according to [https://en.wikipedia.org/wiki/ISO_4217 ISO 4217]. Possible values are:
* '''CHF''': Swiss franc (this is the default currency if no <code>sstCurrency</code> is set).
* EUR: Euro
* GBP: Pound sterling
* USD: United States dollar

|-
| sstPaymentMethod
| <center>MAY</center>
| <center></center>
| Payment method of the invoice. Possible values are:
* '''invoice''': Classic invoice, sent according to the delivery method defined in <code>sstDeliveryMethod</code> (this is the default payment method if no <code>sstPaymentMethod</code> is set).
* postcard: Electronic invoice via PostFinance.
* creditcard: Credit card payment.

|-
| sstDeliveryMethod
| <center>MAY</center>
| <center></center>
| Delivery method of invoices or access data. Possible values are:
* email: The invoice or access data is sent via email to the recipient.
* '''post''': The invoice or access data is sent via snail mail to the recipient (this is the default delivery method if no <code>sstDeliveryMethod</code> is set).

|-
| sstDiscount
| <center>MAY</center>
| <center></center>
| An optional customer discount (an integer value between 0 and 100). Default is '''0'''.

|-
| sstCancellationDate
| <center>MAY</center>
| <center></center>
| The cancellation date of a reseller, customer or service in the form of [YYYY][MM][DD] (ISO 8601). For example: '''20181231'''. The attribute <code>sstCancellationDate</code> is used in a logical AND combination with <code>sstIsActive</code>.

|-
| sstMailToUID
| <center>MAY</center>
| <center>x1</center>
| This attribute <code>sstMailToUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Even though this attribute is multi-valued, we expect on recipient only. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via To. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000002'''.

|-
| sstMailCcUID
| <center>MAY</center>
| <center></center>
| This attribute <code>sstMailCcUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Please be aware, that this attribure ist multi-valued and multiple recipients are to be expected. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via CC. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000064'''.

|-
| sstMailBccUID
| <center>MAY</center>
| <center></center>
| This attribute <code>sstMailBccUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Please be aware, that this attribure ist multi-valued and multiple recipients are to be expected. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via BCC. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000066''' or '''4000069'''.

|}

Legend:
* '''x''': Mandatory in all cases.
* '''x1''': The attribute <code>sstMailToUID</code> is mandatory, if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>.
* '''x2''': As the default of the attribute <code>sstBillable</code> is <code>TRUE</code>, it's not really mandatory. For better readability, please always add the attribute <code>sstBillable</code>.

==== Customers - Customer - Employees ====
The sub tree '''ou=employees,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the employees belonging to the reseller '''Customer Ltd.''' (all the employees with the the attribute sstBelongsToEmployeeUID=4000001). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of employees belonging to this customer. The number of employees is always the same or smaller than the number of people belonging to a customer (they are a subset).
<source lang='ldif'>
dn: ou=employees,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: employees
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstEmployeeOfUID=4000001)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org
</source>

In this example, the customer '''Customer Ltd.''' has one employee (with the uid=4000002).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

==== Customers - Customer - People ====
The sub tree '''ou=people,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the all the people belonging to the customer '''Customer Ltd.''' (all the people, including the employees, with the the attribute sstBelongsToCustomerUID=4000001). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of employees belonging to this reseller. The number of people is always the same or larger than the number of employees belonging to a reseller.
<source lang='ldif'>
dn: ou=people,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: people
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstBelongsToCustomerUID=4000001)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org
member: uid=4000064,ou=people,dc=stoney-cloud,dc=org
member: uid=4000066,ou=people,dc=stoney-cloud,dc=org
member: uid=4000069,ou=people,dc=stoney-cloud,dc=org
</source>

In this example, four people the customer '''Customer Ltd.''' (including the employee with the uid=4000002).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

=== Customers - Customer (LEGACY) ===
We have two kinds of customers:
* '''Company customer''': This is the normal case, as we target companies.
* '''Private customer''': A private customer does not have a company/organisation name.

The following LDIF examples will show both cases where necessary. The first LDIF shows you the default '''company customer''' entry after a fresh stoney cloud installation. All relevant data belonging to this reseller is stored below this leaf.
<source lang='ldif'>
dn: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCustomerCompany
uid: 4000001
organizationName: Customer Ltd.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstIsActive: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| organizationName
| <center>MUST</center>
| <center>x</center>
| The organisation name of the reseller. For example: Customer Ltd..

|-
| sstBelongsToResellerUID
| <center>MUST</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000.

|-
| sstBelongsToCustomerUID
| <center>MAY</center>
| <center>x</center>
| Stores the customer UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000001.

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|}

Legend:
* '''x''': Mandatory in all cases.

The following LDIF shows you the '''private customer''' entry. All relevant data belonging to this reseller are stored below this leaf.
<source lang='ldif'>
dn: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCustomerPerson
uid: 4000001
givenName: Name
surname: Surname
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstIsActive: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Givenname, example: Hans.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname, example: Muster.

|-
| sstBelongsToResellerUID
| <center>MUST</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000000.

|-
| sstBelongsToCustomerUID
| <center>MAY</center>
| <center>x</center>
| Stores the customer UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000001.

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|}

Legend:
* '''x''': Mandatory in all cases.

==== Customers - Customer (LEGACY) - Billing address ====
The sub tree '''ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the billing address for a '''company customer''':
<source lang='ldif'>
dn: ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddressCompany
ou: address
organizationName: Customer Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| organizationName
| <center>MUST</center>
| <center>x</center>
| Company name, example: stepping stone GmbH

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Either 'm' for male or 'f' for female.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Givenname, example: Hans.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname, example: Muster.

|-
| postalAddress
| <center>MAY</center>
| <center>x2</center>
| Street Number, example: Neufeldstrasse 9. Multi-lined field.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x2</center>
| Postbox, example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x3</center>
| This pulldown menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country code according to ISO 3166-1 (for the web interface) and the corresponding [https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1-alpha-2] code (as the LDAP entry). Example: For Switzerland the value is CH.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Zipcode, example: 3012

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| City, example: Bern.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Display language of the user according to RFC 1766, example: de-CH. Currently supported:
* de-CH
* en-GB

|-
| mail
| <center>MUST</center>
| <center>x</center>
| E-mail address of the user, example: hans.muster@example.com.

|-
| telephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Fixnet phone number, example: +41 31 222 33 44.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Mobile phone number, example: +41 76 222 33 44.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| URL gemäss RFC-3986 http://tools.ietf.org/html/rfc3986. For example http://www.stepping-stone.ch/.

|}
Legend:

* '''x1''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x2''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x3''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

The sub tree '''ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the billing address for a '''private customer''':
<source lang='ldif'>
dn: ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddressPerson
ou: address
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Either 'm' for male or 'f' for female.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Givenname, example: Hans.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname, example: Muster.

|-
| postalAddress
| <center>MAY</center>
| <center>x2</center>
| Street Number, example: Neufeldstrasse 9. Multi-lined field.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x2</center>
| Postbox, example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x3</center>
| This pulldown menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country code according to ISO 3166-1 (for the web interface) and the corresponding ISO 3166-1-alpha-2 code (as the LDAP entry). Example: For Switzerland the value is CH.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Zipcode, example: 3012

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| City, example: Bern.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Display language of the user according to RFC 1766, example: de-CH. Currently supported:
* de-CH
* en-GB

|-
| mail
| <center>MUST</center>
| <center>x</center>
| E-mail address of the user, example: hans.muster@example.com.

|-
| telephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Fixnet phone number, example: +41 31 222 33 44.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Mobile phone number, example: +41 76 222 33 44.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| URL gemäss RFC-3986 http://tools.ietf.org/html/rfc3986. For example http://www.stepping-stone.ch/.

|}
Legend:

* '''x1''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x2''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x3''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

== Groups ==

== People ==
The sub tree which contains all the people. Each person has a unique identifier (uid):
<source lang='ldif'>
dn: ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: people
description: The sub tree which contains all the people.
</source>

=== People - Person ===
Each person hat its own leaf with a unique identifier (uid). The following LDIF shows you a typical '''person''' entry. All relevant data belonging to this person is stored below this leaf.

<source lang='ldif'>
dn: uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstPerson
uid: 4000002
sstGender: m
sstTitle: CEO
givenName: Name
surname: Surname
displayName: Name Surname
preferredLanguage: en-GB
userPassword: {SSHA}UgrBHVhKxFQInWWpzf1ddgEVmSg5vKUm
mail: name.surname@example.com
cn: admin
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstTimeZoneOffset: UTC+01
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstEmployeeOfUID: 4000000
sstEmployeeOfUID: 4000001
</source>

The person '''Name Surname''' (with the uid=4000002) belongs to the reseller '''Reseller Ltd.''' (with sstBelongsToResellerUID=4000000) and is an employee of the same company (sstEmployeeOfUID=4000000). The person also belongs the customer '''Customer Ltd.''' (with sstBelongsToCustomerUID=4000001) and is an employee of the same company (sstEmployeeOfUID=4000001).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| style="width:200px; border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| '''AttributeType'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Interface Equivalent'''
| <center>'''User alterable'''</center>
| style="width:600px; border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| UID
| <center></center>
| Unique Identifier. For example: '''4000002'''.

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Gender
| <center></center>
| Either 'm' for male or 'f' for female. For example: '''m'''.

|-
| sstTitle
| <center>MAY</center>
| <center>x</center>
| Title
| <center>x</center>
| The title of a person as a [http://en.wikipedia.org/wiki/UTF-8 UTF-8]] formatted string. For example: '''CEO''' or '''Technician'''.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Name
| <center>x</center>
| Name, for example: '''Hans'''.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname
| <center>x</center>
| Surname, for example: '''Muster'''.

|-
| displayName
| <center>MAY</center>
| <center>x2</center>
| Display name
| <center></center>
| Display name, for example: ''' Hans Muster'''.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Language
| <center>x</center>
| Display language of the user according to RFC 1766: <nowiki>[</nowiki>[http://www.loc.gov/standards/iso639-2/php/code_list.php ISO 639-1 Code]<nowiki>]</nowiki>-<nowiki>[</nowiki>[http://www.iso.org/iso/english_country_names_and_code_elements ISO 3166-1-alpha-2 code]<nowiki>]</nowiki> . For example: <code>de-CH</code>

|-
| userPassword
| <center>MUST</center>
| <center>x</center>
| Password
| <center>x</center>
| SSHA user password. {SSHA} is a [http://www.ietf.org/rfc/rfc2307.txt RFC 2307] password scheme which uses the SHA1 secure hash algorithm. For example: '''{SSHA}h+qbh3pFWrZxmz02H5tXhOr+0/wrmHFF'''.

|-
| mail
| <center>MUST</center>
| <center>x</center>
| Mail Address
| <center>x</center>
| The users mail address, for example: '''hans.muster@example.com'''.

|-
| cn
| <center>MAY</center>
| <center></center>
|
|
| Common name of the user, for example: '''sst-mei'''.

|-
| telephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Telephone
| <center>x1</center>
| Telephone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 31 222 33 44'''.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Mobile
| <center>x1</center>
| Mobile phone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 76 222 33 44'''.

|-
| sstTimeZoneOffset
| <center>MUST</center>
| <center>x</center>
|
|
| Time zone as an offset from UTC. For example: '''UTC+01'''

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
|
|
| Is the entry active? Either '''true''' (yes) or '''false''' (no).

|-
| sstBelongsToUID
| <center>MAY</center>
| <center></center>
|
| <center></center>
| If this value is set to '''1''', the user is the super user of the whole stoney cloud installation. Therefore this user can add and remove resellers. Use with caution.

|-
| sstBelongsToResellerUID
| <center>MAY</center>
| <center>x</center>
|
| <center></center>
| Stores the reseller UID the person belongs to. A unique value with 7 digits or more. For example: '''4000000'''.

|-
| sstBelongsToCustomerUID
| <center>MUST</center>
| <center>x</center>
|
| <center></center>
| Stores the customer UID the person belongs to. A unique value with 7 digits or more. For example: '''4000001'''.

|-
| sstEmployeeOfUID
| <center>MAY</center>
| <center></center>
| Employee of
| <center></center>
| Stores the UID(s) the person is an employee of. The UID(s) can belong to one or more resellers or also to one or more customers. A unique value with 7 digits or more. For example: '''4000001'''.

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| External ID
| <center></center>
| The ID (or number) of a customer, person or product in an external database. For example: '''234567'''.

|}

Legend:
* '''x1''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x2''': Mandatory, if the person belongs to customer that has subscribed a [https://wwww.stoney-storage.com/ stoney storage] service.

==== People - Person - Session tokens ====
Using session tokens, when the user logs out, the client sends a logout request to the server. The session token is then removed from LDAP by the server and the client discards the session token.

Special cases:
* If the user's password is changed, all session tokens must be removed from LDAP in order to force the user to re-login.
* If any attributes are changed which control the user's affiliation (reseller, company, etc), all session tokens must be removed from LDAP in order to force the user to re-login. Specific attributes:
** sstBelongsToResellerUID
** sstBelongsToCustomerUID
** sstEmployeeOfUID
** sstEmployeeOfUID

In our case, we store the session tokens in a leaf beneath the person (as these tokens are personal).

===== People - Person - Session tokens example =====
Below each person entry, we have a tokens sub tree, which stores the session tokens:
<source lang='ldif'>
dn: ou=tokens,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: tokens
description: The sub tree for the session tokens of the person with the uid '4000002'.
</source>

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

|-
| ou
| organizationalUnit
| <center>MUST</center>
| <center>x</center>
| The sub tree containing all the session tokens.

For example: <code>ou: tokens</code>.

|-
| description
| organizationalUnit
| <center>MAY</center>
| <center></center>
| The description of the leaf. As this sub tree is created by the stoney API, we don't really need a human readable description.

For example: <code>description: The sub tree for the session tokens of the person with the uid '4000002'.</code>

|}

Legend:
* '''x''': Mandatory in all cases.

Each session token receives its own child-entry to store additional meta data, such as the token's create date, last utilisation date, ... In the example below, the session token <code>sstToken: 2e211493-41e6-4c74-9431-b5d990b177a4</code> was created on the 13th of April 2021 at 08:10:27 UTC (<code>sstCreationDate: 20210413T081027Z</code>) and two clients have used this token (the first with an IPv4 address, the second with an IPv6 address):
<source lang='ldif'>
dn: sstToken=2e211493-41e6-4c74-9431-b5d990b177a4,ou=tokens,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstTokenObjectClass
sstToken: 2e211493-41e6-4c74-9431-b5d990b177a4
description: The sub tree for the JSON Web Token with the id '2e211493-41e6-4c74-9431-b5d990b177a4'.
sstCreationDate: 20210413T081027Z
sstClient: 20210413T081027Z: 194.176.109.13 Mozilla/5.0 (X11; Linux x86_64; rv:85.0) Gecko/20100101 Firefox/85.0
sstClient: 20210413T132805Z: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4456.0 Safari/537.36 Edg/91.0.845.2
</source>

The API will make sure, that the amount of registered remote IP addresses and requesting User-Agents doesn't exceed a certain configurable limit (for example: 2). If the limit is exceeded, the session will be invalidated.

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

|-
| sstToken
| sstTokenObjectClass
| <center>MUST</center>
| <center>x</center>
| The sub tree containing all the information of a session (creation date, access date, IPv4 or IPv6 address and the clients user agent). The session token has the form of a UUID (Universally Unique Identifier)..

For example: <code>sstToken: 2e211493-41e6-4c74-9431-b5d990b177a4</code>.

|-
| description
| sstTokenObjectClass
| <center>MAY</center>
| <center></center>
| The description of the leaf. As this sub tree is created by the stoney API, we don't really need a human readable description.

For example: <code>description: The sub tree for the JSON Web Token with the id '2e211493-41e6-4c74-9431-b5d990b177a4'.</code>

|-
| sstCreationDate
| sstTokenObjectClass
| <center>MUST</center>
| <center>x</center>
| The session token creation time (UTC) in the form of <code>[YYYY][MM][DD]T[hh][mm][ss]Z</code> according to the [http://en.wikipedia.org/wiki/ISO_8601 ISO 8601] definition.

For example: <code>sstCreationDate: 20210413T081027Z</code>.

|-
| sstClient
| sstTokenObjectClass
| <center>MUST</center>
| <center>x</center>
| The multi-valued attribute containing client information. This attribute contains the following information:
* The access time (UTC) in the form of <code>[YYYY][MM][DD]T[hh][mm][ss]Z</code> according to the [http://en.wikipedia.org/wiki/ISO_8601 ISO 8601] definition.
* The IPv4 or IPv6 address, from which the client has accessed the stoney API.
* The user agent of the client.

This information is separated by spaces: <code>sstClient: [YYYY][MM][DD]T[hh][mm][ss]Z" "IPv4 or IPv6" "User-Agent"</code>.

For example: <code>sstClient: 20210413T081027Z 194.176.109.13 Mozilla/5.0 (X11; Linux x86_64; rv:85.0) Gecko/20100101 Firefox/85.0</code>.

Please be aware, that the maximal length of a sstClient string is restricted to 256 characters.

|}

Legend:
* '''x''': Mandatory in all cases.

==== People - Person - Roles (LEGACY) ====
<source lang='ldif'>
dn: sstRole=Monitoring Administrator,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstRoles
sstProduct: 0
sstRole: Monitoring Administrator
</source>

<source lang='ldif'>
dn: sstRole=User,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstRoles
sstProduct: 0
sstRole: User
</source>

<source lang='ldif'>
dn: sstRole=Virtualization Administrator,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstRoles
sstProduct: 0
sstRole: Virtualization Administrator
</source>

== Reseller ==
The sub tree '''ou=reseller,dc=stoney-cloud,dc=org''' contains all the resellers. Each reseller has a unique uid, which is used for later reference.

=== Reseller - Reseller ===
The following LDIF shows a typical reseller entry. All relevant data belonging to this reseller is stored below this leaf.
<source lang='ldif'>
dn: uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstReseller
uid: 4000000
organizationName: Reseller Ltd.
sstIsCompany: TRUE
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| organizationName
| <center>MAY</center>
| <center>x</center>
| The organisation name of the reseller. For example: '''Reseller Ltd.'''. A reseller must be a company (<code>sstIsCompany: TRUE</code>).

|-
| description
| <center>MAY</center>
| <center></center>
| The description of the leaf.

|-
| sstIsCompany
| <center>MUST</center>
| <center>x</center>
| Is the entry a company? Either true (yes) or false (no).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstBelongsToResellerUID
| <center>MUST</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000.

|}

Legend:
* '''x''': Mandatory in all cases.

==== Reseller - Reseller - Billing address ====
The sub tree '''ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the billing address:
<source lang='ldif'>
dn: ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: address
organizationName: Reseller Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: Name Surname <name.surname@example.com>
sstMailCc: Info Reseller Ltd. <info@example.com>
sstMailBcc: Accounting Service Provider Ltd. <accounting@example.org>
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute Name'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Interface Equivalent'''
| '''Description'''

|-
| organizationName
| <center>MAY</center>
| <center>x1</center>
| Reseller Name
| Reseller name, for example: '''stepping stone GmbH'''.

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Gender
| Either 'm' for male or 'f' for female. For example: '''m'''.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Name
| Name, for example: '''Hans'''.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname
| Surname, for example: '''Muster'''.

|-
| postalAddress
| <center>MAY</center>
| <center>x3</center>
| Address
| Multi-lined address, for example: '''Neufeldstrasse 9'''.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x3</center>
| Post Office Box
| Post Office Box, for example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x4</center>
| State or Province Name
| This pull down menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country
| Country code according to [http://www.iso.org/iso/home/standards/country_codes.htm ISO 3166-1]. The English short name (upper/lower case) is used for the interface and the corresponding ISO 3166-1-alpha-2 code (a two-letter code that represents a country name, recommended as the general purpose code) is used for the LDAP entry). For example: '''Switzerland''' in the interface and '''CH''' in the LDAP directory.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Postal Code
| Postal Code without the country code, for example: '''3012'''.

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| Location
| Location, for example: '''Berne'''.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Language
| Display language of the user according to [http://www.ietf.org/rfc/rfc1766.txt RFC 1766]. For example: '''de-CH'''. The following languages are currently supported:
* de-CH
* de-DE
* en-GB
* en-US
* fr-CH
* fr-FR

|-
| mail
| <center>MUST</center>
| <center>x</center>
| Mail Address
| The resellers "To:" billing mail address, for example: '''Hans Muster <hans.muster@example.com>'''. This is a multi-valued attribute and it MUST contain at least one "To:" billing mail address.

|-
| sstMailCc
| <center>MAY</center>
| <center></center>
| Mail Address
| The resellers "CC:" billing mail address, for example: '''Info Reseller Ltd. <info@example.com>'''. This is a multi-valued attribute and can contain zero or more "CC:" billing mail addresses.

|-
| sstMailBcc
| <center>MAY</center>
| <center></center>
| Mail Address
| The customers "BCC:" billing mail address, for example: '''Accounting Service Provider Ltd. <accounting@example.org>'''. This is a multi-valued attribute and can contain zero or more "BCC:" billing mail addresses. Here we'd expect the Accounting mail address of the service provider (for accountability reasons).

|-
| telephoneNumber
| <center>MAY</center>
| <center>x2</center>
| Telephone
| Telephone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 31 222 33 44'''.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x2</center>
| Mobile
| Mobile phone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 76 222 33 44'''.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| Website
| Website URL according to [http://tools.ietf.org/html/rfc3986 RFC-3986]. For example: '''http://www.stepping-stone.ch'''/.

|}
Legend:

* '''x1''': If the attribute <code>sstIsCompany</code> of the parent entry is set to <code>TRUE</code>, the <code>organizationName</code> must be set.
* '''x2''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x3''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x4''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

==== Reseller - Reseller - Shipping address (optional) ====
The sub tree '''ou=shipping,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the shipping address and is optional (it is only needed, if the shipping address differs from the billing Address).
<source lang='ldif'>
dn: ou=shipping,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: shipping
organizationName: Reseller Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

==== Reseller - Reseller - Billing ====
The sub tree '''ou=billing,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains billing relevant data. The following example shows a reseller, receiving a monthly bill.
<source lang='ldif'>
dn: ou=billing,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstBillingReseller
ou: billing
sstResellerBill: TRUE
sstBillable: TRUE
sstBillingCycle: 1
sstCurrency: CHF
sstPaymentMethod: invoice
sstDeliveryMethod: post
sstDiscount: 32
sstCancellationDate: 20181231
sstMailToUID: 4000002
sstMailCcUID: 4000064
sstMailBccUID: 4000066
sstMailBccUID: 4000069
</source>

The following example shows a reseller, where their customers receive a bill directly:
<source lang='ldif'>
dn: ou=billing,uid=4000000,ou=reseller,o=stepping-stone,c=ch
objectclass: top
objectclass: organizationalUnit
objectclass: sstBillingReseller
ou: billing
sstResellerBill: FALSE
sstBillable: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Description'''

|-
| sstResellerBill
| <center>MUST</center>
| <center>x</center>
| Should the the reseller receive a consolidated invoice for all their customers? This can be either <code>TRUE</code> or <code>FALSE</code>. The default value is <code>TRUE</code>, meaning that the resellers receives a consolidated invoice for all their customers.

|-
| sstBillable
| <center>MAY</center>
| <center>x2</center>
| All hierarchical levels must have <code>sstBillable: TRUE</code> to actually have an invoice generated and sent. If the attribute <code>sstBillable</code> doesn't exist, the default is <code>TRUE</code>. This way, we are forced to set a reseller, customer or product manually to <code>sstBillable: FALSE</code> if we want to avoid sending them an invoice.

|-
| sstBillingCycle
| <center>MAY</center>
| <center></center>
| Billing cycle in months. This attribute <code>sstBillingCycle</code> is only checked (evaluated), if the reseller has <code>sstResellerBill</code> set to <code>TRUE</code> (as is the case for the resellers except for stepping stone GmbH). Possible values:
* 1: Monthly invoice (this is the default billing period if no <code>sstBillingCycle</code> is set).
* 3: Quarterly invoice.
* 6: Semi-annually invoice.
* 12: Yearly invoice.

|-
| sstCurrency
| <center>MAY</center>
| <center></center>
| Three-letter currency code according to [https://en.wikipedia.org/wiki/ISO_4217 ISO 4217]. Possible values are:
* '''CHF''': Swiss franc (this is the default currency if no <code>sstCurrency</code> is set).
* EUR: Euro
* GBP: Pound sterling
* USD: United States dollar

|-
| sstPaymentMethod
| <center>MAY</center>
| <center></center>
| Payment method of the invoice. Possible values are:
* '''invoice''': Classic invoice, sent according to the delivery method defined in <code>sstDeliveryMethod</code> (this is the default payment method if no <code>sstPaymentMethod</code> is set).
* postcard: Electronic invoice via PostFinance.
* creditcard: Credit card payment.

|-
| sstDeliveryMethod
| <center>MAY</center>
| <center></center>
| Delivery method of invoices or access data. Possible values are:
* email: The invoice or access data is sent via email to the recipient.
* '''post''': The invoice or access data is sent via snail mail to the recipient (this is the default delivery method if no <code>sstDeliveryMethod</code> is set).

|-
| sstDiscount
| <center>MAY</center>
| <center></center>
| An optional customer discount (an integer value between 0 and 100). Default is '''0'''.

|-
| sstCancellationDate
| <center>MAY</center>
| <center></center>
| The cancellation date of a reseller, customer or service in the form of [YYYY][MM][DD] (ISO 8601). For example: '''20181231'''. The attribute <code>sstCancellationDate</code> is used in a logical AND combination with <code>sstIsActive</code>.

|-
| sstMailToUID
| <center>MAY</center>
| <center>x1</center>
| This attribute <code>sstMailToUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Even though this attribute is multi-valued, we expect on recipient only. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via To. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000002'''.

|-
| sstMailCcUID
| <center>MAY</center>
| <center></center>
| This attribute <code>sstMailCcUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Please be aware, that this attribure ist multi-valued and multiple recipients are to be expected. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via CC. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000064'''.

|-
| sstMailBccUID
| <center>MAY</center>
| <center></center>
| This attribute <code>sstMailBccUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Please be aware, that this attribure ist multi-valued and multiple recipients are to be expected. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via BCC. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000066''' or '''4000069'''.

|}

Legend:
* '''x''': Mandatory in all cases.
* '''x1''': The attribute <code>sstMailToUID</code> is mandatory, if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>.
* '''x2''': As the default of the attribute <code>sstBillable</code> is <code>TRUE</code>, it's not really mandatory. For better readability, please always add the attribute <code>sstBillable</code>.

==== Reseller - Reseller - Customers ====
The sub tree '''ou=customers,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the customers belonging to the reseller '''Reseller Ltd.''' (all the customers with the the attribute sstBelongsToResellerUID=4000000). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of customers belonging to this reseller.
<source lang='ldif'>
dn: ou=customers,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: customers
labeledURI: ldap:///ou=customers,dc=stoney-cloud,dc=org??one?(sstBelongsToResellerUID=4000000)
member: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
</source>

In this example, the reseller '''Reseller Ltd.''' has one customer (with the uid=4000001).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

==== Reseller - Reseller - Employees ====
The sub tree '''ou=employees,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the employees belonging to the reseller '''Reseller Ltd.''' (all the employees with the the attribute sstBelongsToEmployeeUID=4000000). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of employees belonging to this reseller. The number of employees is always the same or smaller than the number of people belonging to a reseller (they are a subset).
<source lang='ldif'>
dn: ou=employees,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: employees
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstEmployeeOfUID=4000000)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org
</source>

In this example, the reseller '''Reseller Ltd.''' has one employee (with the uid=4000002).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

==== Reseller - Reseller - People ====
The sub tree '''ou=people,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the all the people belonging to the reseller '''Reseller Ltd.''' (all the people, including the employees, with the the attribute sstBelongsToResellerUID=4000000). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of employees belonging to this reseller. The number of people is always the same or larger than the number of employees belonging to a reseller.

<source lang='ldif'>
dn: ou=people,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: employees
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstBelongsToResellerUID=4000000)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org
member: uid=4000064,ou=people,dc=stoney-cloud,dc=org
member: uid=4000066,ou=people,dc=stoney-cloud,dc=org
member: uid=4000069,ou=people,dc=stoney-cloud,dc=org
</source>

In this example, four people the reseller '''Reseller Ltd.''' (including the employee with the uid=4000002).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

=== Reseller - Reseller (LEGACY) ===
The following LDIF shows you the default reseller entry after a fresh stoney cloud installation. All relevant data belonging to this reseller is stored below this leaf.
<source lang='ldif'>
dn: uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstReseller
uid: 4000000
organizationName: Reseller Ltd.
sstBelongsToResellerUID: 4000000
sstIsActive: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| organizationName
| <center>MUST</center>
| <center>x</center>
| The organisation name of the reseller. For example: Reseller Ltd..

|-
| sstBelongsToResellerUID
| <center>MAY</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000000.

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|}

Legend:
* '''x''': Mandatory in all cases.

==== Reseller - Reseller - Billing address (LEGACY) ====
The sub tree '''ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the billing address:
<source lang='ldif'>
dn: ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddressCompany
ou: address
organizationName: Reseller Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| organizationName
| <center>MUST</center>
| <center>x</center>
| Company name, example: stepping stone GmbH

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Either 'm' for male or 'f' for female.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Givenname, example: Hans.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname, example: Muster.

|-
| postalAddress
| <center>MAY</center>
| <center>x2</center>
| Street Number, example: Neufeldstrasse 9. Multi-lined field.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x2</center>
| Postbox, example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x3</center>
| This pulldown menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country code according to ISO 3166-1 (for the web interface) and the corresponding ISO 3166-1-alpha-2 code (as the LDAP entry). Example: For Switzerland the value is CH.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Zipcode, example: 3012

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| City, example: Bern.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Display language of the user according to RFC 1766, example: de-CH. Currently supported:
* de-CH
* en-GB

|-
| mail
| <center>MUST</center>
| <center>x</center>
| E-mail address of the user, example: hans.muster@example.com.

|-
| telephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Fixnet phone number, example: +41 31 222 33 44.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Mobile phone number, example: +41 76 222 33 44.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| URL gemäss RFC-3986 http://tools.ietf.org/html/rfc3986. For example http://www.stepping-stone.ch/.

|}
Legend:

* '''x1''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x2''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x3''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

[[Category:stoney core]][[Category:OpenLDAP directory]]

stoney core: OpenLDAP directory data organisation

2024-02-02T14:54:16Z

Administrator: /* Services */

= Abstract =
This document describes the [[:Category:stoney core|stoney core]] relevant OpenLDAP directory data organisation.

= Data Organisation =
The following chapters explain the data organisation of the stoney cloud OpenLDAP directory. This document describes the [[:Category:stoney core|stoney core]] relevant OpenLDAP directory data organisation.

== Administration ==
The subtree '''ou=administration,dc=stoney-cloud,dc=org''' contains all the administrative data.

=== nextfreeuid ===
The entry <code>cn=nextfreeuid,ou=administration,dc=stoney-cloud,dc=org</code> stores the next free UID (Unique Identifier). The <code><uid></code> is unique over the whole directory and is enforced through the directory and is incremented by one.
<source lang='ldif'>
dn: cn=nextfreeuid,ou=administration,dc=stoney-cloud,dc=org
objectclass: sstNextFreeUID
cn: nextfreeuid
uid: 3724591
uidNumber: 3724591
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
! style="text-align:left; width: 180px" | Attribute
! style="text-align:left; width: 220px" | Objectclass
! style="width: 80px" | Existance
! style="width: 80px" | Mandatory
! style="text-align:left;" | Description

|-
| cn
| ...
| <center>MUST</center>
| <center>x</center>
| The name of the leaf.

For the next free uid, this is: <code>nextfreeuid</code>.

|-
| uid
| ...
| <center>...</center>
| <center>x</center>
| ...

|}

Legend:
* '''x''': Mandatory in all cases.

Before using this attribute <code>uidNumber</code>, you need to be sure, that your directory server actually supports atomic increments (LDAP Modify-Increment). See [https://www.iana.org/assignments/ldap-parameters/ldap-parameters.xhtml Lightweight Directory Access Protocol (LDAP) Parameters] and [https://tools.ietf.org/html/rfc4525 Lightweight Directory Access Protocol (LDAP) Modify-Increment Extension (RFC4525)].

The following search should tell you, if you LDAP server supports the LDAP Modify-Increment Object Identifier Descriptor (OID 1.3.6.1.1.14):
<source lang='bash'>
ldapsearch -H ldaps://ldapm.stepping-stone.ch -b "" -s base -D "cn=Manager,dc=stoney-cloud,dc=org" -W \* + | grep 1.3.6.1.1.14
</source>

The result should look as follows:
<source lang='text'>
supportedFeatures: 1.3.6.1.1.14
</source>

Options:
<source lang='text'>
-H ldapuri
-b searchbase
-D binddn
-W Prompt for simple authentication.
\* All user attributes are returned.
+ All operational attributes are returned.
</source>

=== Billing ===
The sub tree <code>ou=billing,ou=administration,dc=stoney-cloud,dc=org</code> stores all the billing relevant data. Each billable item (bundle, service or service item) is stored in this sub tree.
<source lang='ldif'>
dn: ou=billing,ou=administration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: billing
</source>

The following LDIF extract shows the billing schema for the product "Mail Account".
<source lang='ldif'>
dn: uid=100001,ou=billing,ou=administration,dc=stoney-cloud,dc=org
description: Default pricing schema for the product Mail Account.
objectclass: top
objectclass: sstBillingPriceSchema
sstbaseprice: 0
sstbelongstouid: 1
sstbillingunit: Gigabyte
sstfreeunit: 0
sstpriceformula: sstPricePerUnit * sstQuota
sstpriceperunit: 4.00
sstproductname: Mail Account
uid: 100001
sstBelongsToUID: 1
</source>

The finale price is calculated with the help of the stored formula (sstPriceFormula). The customer price for a "Mail Account" with a 2 Gigabyte large mailbox (quota) is calculated as follows:
'''Price''' = sstPricePerUnit * sstQuota = 4.00 CHF/(Gigabyte * Month) * 2 Gigabyte = '''8 CHF/Month'''

All prices are stored in Swiss Francs (because the company stepping stone GmbH resides in Switzerland). You can decide about the default currency yourself. Once a month a billing run is executed, which scans the whole directory. The billing run is a currently "work in progress". For more information, please contact our [mailto:accounting@stepping-stone.ch Accounting] departement.

=== Group Mapping ===
Used for the group mapping from the given readable format to the local group UID format.
<source lang='ldif'>
dn: ou=group mapping,ou=administration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
objectclass: sstLDAPSearchObjectClass
ou: group mapping
description: This entry describes, how to map a given group name to an UID in the local LDAP directory.
sstDisplayName: Group Mapping
sstLDAPBaseDn: ou=groups,dc=stoney-cloud,dc=org
sstLDAPFilter: (&(objectClass=sstGroupObjectClass)(sstGroupName=%s)(sstBelongsToResellerUID=%sstBelongsToResellerUID)(sstBelongsToCustomerUID=%sstBelongsToCustomerUID))
sstLDAPStaticAttribute: uid
</source>

==== Example Mapping for the Technology Group ====
The following search maps the group Technology belonging to the reseller with the sstBelongsToResellerUID 4000000 and the customer with the sstBelongsToCustomerUID 4000001 to the uid 4000014:
<source lang='bash'>
ldapsearch -D "cn=Manager,dc=stoney-cloud,dc=org" -w admin -H "ldap://10.1.130.14:389" -b "ou=groups,dc=stoney-cloud,dc=org" "(&(objectClass=sstGroupObjectClass)(sstGroupName=Technology)(sstBelongsToResellerUID=4000000)(sstBelongsToCustomerUID=4000001))" uid
</source>

<source lang='text'>
# extended LDIF
#
# LDAPv3
# base <ou=groups,dc=stoney-cloud,dc=org> with scope subtree
# filter: (&(objectClass=sstGroupObjectClass)(sstGroupName=Technology)(sstBelongsToResellerUID=4000000)(sstBelongsToCustomerUID=4000001))
# requesting: uid
#
# 4000014, groups, stoney-cloud.org
dn: uid=4000014,ou=groups,dc=stoney-cloud,dc=org
uid: 4000014

# search result
search: 2
result: 0 Success

# numResponses: 2
# numEntries: 1
</source>

==== Example Mapping for all Groups ====
The following search lists all the existing Groups to belonging to the reseller with the sstBelongsToResellerUID 4000000 and the customer with the sstBelongsToCustomerUID 4000001 with the corresponding uids:
<source lang='bash'>
ldapsearch -D "cn=Manager,dc=stoney-cloud,dc=org" -w admin -H "ldap://10.1.130.14:389" -b "ou=groups,dc=stoney-cloud,dc=org" "(&(objectClass=sstGroupObjectClass)(sstGroupName=*)(sstBelongsToResellerUID=4000000)(sstBelongsToCustomerUID=4000001))" uid
</source>

<source lang='text'>
# extended LDIF
#
# LDAPv3
# base <ou=groups,dc=stoney-cloud,dc=org> with scope subtree
# filter: (&(objectClass=sstGroupObjectClass)(sstGroupName=*)(sstBelongsToResellerUID=4000000)(sstBelongsToCustomerUID=4000001))
# requesting: uid
#

# 4000014, groups, stoney-cloud.org
dn: uid=4000014,ou=groups,dc=stoney-cloud,dc=org
uid: 4000014

# 4000015, groups, stoney-cloud.org
dn: uid=4000015,ou=groups,dc=stoney-cloud,dc=org
uid: 4000015

# search result
search: 2
result: 0 Success

# numResponses: 3
# numEntries: 2
</source>

=== People (Superuser) ===
The sub tree <code>ou=people,ou=administration,dc=stoney-cloud,dc=org</code> list all users, which have super user richts (users with the attribute <code>sstBelongsToUID=1</code>). This entry uses the functionality of the the dynlist overlay. The attribut '''labeleduri''' contains a pre-defined search, which leads to a automatically created list.
<source lang='ldif'>
dn: ou=people,ou=administration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: people
labeleduri: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstBelongsToUID=1)
member: uid=1000000,ou=people,dc=stoney-cloud,dc=org
member: uid=1000003,ou=people,dc=stoney-cloud,dc=org
member: uid=1000004,ou=people,dc=stoney-cloud,dc=org
</source>

As you can see, the OpenLDAP has three people withe Superuser rights.

=== Services ===
The sub tree '''ou=services,ou=administration,dc=stoney-cloud,dc=org''' contains all the service users. Each service and/or application has its own authentication user. The authentication user is used in the [[HTTP Basic authentication against OpenLDAP directory|OpenLDAP Directory Access Control Lists]] (ACLs) to allow or restrict access to the data.

Naming Convention '''Notification user''':
* <SERVICE>-notification
** backup-notification
** cloud-notification
** lbaas-notification
** mail-notification
** storage-notification

Naming Convention '''Service user''':
* <SERVICE>-<DAEMON>
** backup-pam-ldap
** cloud-openstack
** cm-suitecrm
** billing-cyclops
** cm-puppetboard ('''c'''onfiguration '''m'''anagement - Puppetboard Service)
** dms-alfresco ('''d'''ocument '''m'''anagement '''s'''ystem - Alfresco)
** iac-terraform ('''i'''nfrastructure '''a'''s '''c'''ode - Terraform)
** <s>lbaas-haproxy</s>
** <s>lbaas-pam-ldap</s>
** monitoring-zabbix
** phabricator
** pm-kanboard
** qos-rally
** storage-nextcloud
** storage-pam_ldap
** timetracking-kimai
** vault-cryptopus (A vault is a place where secrets are stored - in other words a password management system)
** vcs-gitlab ('''v'''ersion '''c'''ontrol '''s'''ystem - GitLab Service)
** virtualization-sc-brokerd
** wiki-int

Naming Convention '''API user''':
* <SERVICE>-api
** lbaas-api

Naming Convention '''Provisioning user''':
* prov-<SERVICE>-<TYPE>
** prov-backup-kvm
** prov-backup-zsnapshot
** prov-cloud-openstack
** prov-configuration-management-puppet
** <s>prov-lbaas-haproxy</s>
** prov-mail-ox ('''O'''pen-'''X'''change)
** prov-monitoring-zabbix
** prov-storage-nextcloud

==== backup Service User (stoney backup) ====
The following LDIF shows the backup service user entry:
dn: cn=backup,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: dhcp
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: backup
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

==== dhcp (DHCP) Service User (stoney conductor) ====
The following LDIF shows the dhcp service user entry:
dn: cn=dhcp,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: dhcp
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: dhcp
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

==== libvirtd Service User (stoney conductor) ====
The following LDIF shows the libvirtd service user entry:
dn: cn=libvirtd,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: libvirtd
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: dhcp
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

==== prov-backup-kvm (Provisioning-Backup-KVM Daemon) Service User (stoney conductor) ====
The following LDIF shows the prov-backup-kvm service user entry:
dn: cn=prov-backup-kvm,ou=services,ou=administration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
cn: prov-backup-kvm
sn: prov-backup-kvm
userPassword: <STONEY-CLOUD-PROV-BACKUP-KVM-PASSWORD>

==== slapd-mirrormode Service User (stoney core) ====
The following LDIF shows the slapd-mirrormode service user entry:
dn: cn=slapd-mirrormode,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: slapd-mirrormode
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: slapd-mirrormode
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

==== billing-cyclops Service User (stoney core) ====
The following LDIF shows the billing service user entry:
dn: cn=billing-cyclops,ou=services,ou=administration,dc=stoney-cloud,dc=org
cn: slapd-mirrormode
objectclass: top
objectclass: organizationalPerson
objectclass: inetOrgPerson
sn: billing-cyclops
userPassword: {SSHA}pJpqL95nlFi78rnAstmn6VvZCXWTjVHZ

== Configuration ==
=== Configuration management ===
The sub tree '''ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org''' contains the configuration management system relevant entries of the whole stoney cloud installation. They can be extended by the administrator.
<source lang='ldif'>
# This sub tree contains the configuration management system relevant entries of the whole stoney cloud installation.
dn: ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: configuration management
description: This sub tree contains the configuration management system relevant entries of the whole stoney cloud installation.
</source>

==== Configuration management - Regions ====
The sub tree '''ou=regions,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org''' contains the configuration management system region entries of the whole stoney cloud installation. They can be extended by the administrator.
<source lang='ldif'>
# This sub tree contains the configuration management system region entries of the whole stoney cloud installation.
dn: ou=regions,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: regions
description: This sub tree contains the configuration management system region entries of the whole stoney cloud installation.
</source>

===== Configuration management - Regions - Region example =====
The following LDIF example shows a typical region.
<source lang='ldif'>
dn: cn=duedingen_production,ou=regions,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalRole
cn: duedingen_production
description: This region contains the two data centres located in Düdingen and is used for production systems.
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
! style="text-align:left; width: 180px" | Attribute
! style="text-align:left; width: 220px" | Objectclass
! style="width: 80px" | Existance
! style="width: 80px" | Mandatory
! style="text-align:left;" | Description

|-
| cn
| organizationalRole
| <center>MUST</center>
| <center>x</center>
| The region used by the configuration management system Puppet via enc.

For example: <code>cn: duedingen_production</code>.

|-
| description
| organizationalRole
| <center>MAY</center>
| <center>x</center>
| The human readable description of region.

For example: <code>description: This region contains the two data centres located in Düdingen and is used for production systems.</code>.

|}

Legend:
* '''x''': Mandatory in all cases.

==== Configuration management - Roles ====
The sub tree '''ou=roles,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org''' contains the configuration management system role entries of the whole stoney cloud installation. They can be extended by the administrator.
<source lang='ldif'>
# This sub tree contains the configuration management system role entries of the whole stoney cloud installation.
dn: ou=roles,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: roles
description: This sub tree contains the configuration management system role entries of the whole stoney cloud installation.
</source>

===== Configuration management - Roles - Roles example =====
The following LDIF example shows a typical role.
<source lang='ldif'>
dn: cn=base,ou=roles,ou=configuration management,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstConfigurationManagementRole
cn: base
displayName: Base
sstProfiles: - base
description: This is the base role used by all new servers managed by Puppet, but without a final role decided.
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
! style="text-align:left; width: 180px" | Attribute
! style="text-align:left; width: 220px" | Objectclass
! style="width: 80px" | Existance
! style="width: 80px" | Mandatory
! style="text-align:left;" | Description

|-
| cn
| sstConfigurationManagementRole
| <center>MUST</center>
| <center>x</center>
| The role name used by the configuration management system Puppet via enc.

For example: <code>cn: base</code>.

|-
| displayName
| sstConfigurationManagementRole
| <center>MUST</center>
| <center>x</center>
| The role display name (human readable).

For example: <code>displayName: Base</code>.

|-
| sstProfiles
| sstConfigurationManagementRole
| <center>MUST</center>
| <center>x</center>
| The role definition (profile list) used by the configuration management system Puppet via enc. The profiles are listed, one per line. Multiple lines must be base64 endoded:

For example: <code>sstProfiles: - base</code> or <code>sstProfiles:: LSBiYXNlCi0gY2VydGJvdAo=</code>.

Encode:
<source lang="bash">
cat << EOF | base64
- base
- certbot
EOF
</source>
Decode:
<source lang="bash">
echo LSBiYXNlCi0gY2VydGJvdAo= | base64 --decode
</source>

|-
| description
| organizationalRole
| <center>MAY</center>
| <center></center>
| The human readable description of region.

For example: <code>description: This region contains the two data centres located in Düdingen and is used for production systems.</code>.

|}

=== Operating System ===
The sub tree '''ou=operating system,ou=configuration,dc=stoney-cloud,dc=org''' contains the operating system choices for the whole stoney cloud installation. They can be extended by the administrator.
# This sub tree contains the operating system choices for the whole stoney cloud installation.
dn: ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: operating system
description: This sub tree contains the operating system choices for the whole stoney cloud installation.

==== Linux ====
The sub tree '''uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org''' contains the Linux based operating system choices for the whole stoney cloud installation.
# This sub tree contains the Linux based operating system choices for the whole stoney cloud installation.
dn: uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000019
sstDisplayName: Linux
description: This sub tree contains the Linux based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Debian Linux based operating system choices for the whole stoney cloud installation.
dn: uid=4000020,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000020
sstDisplayName: Debian
description: This sub tree contains the Debian Linux based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000021,uid=4000020,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000021
sstDisplayName: 5
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000022,uid=4000020,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000022
sstDisplayName: 6
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000023,uid=4000020,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000023
sstDisplayName: 7
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Fedora Linux based operating system choices for the whole stoney cloud installation.
dn: uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000024
sstDisplayName: Fedora
description: This sub tree contains the Fedora Linux based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000025,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000025
sstDisplayName: 12
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000026,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000026
sstDisplayName: 13
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000027,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000027
sstDisplayName: 14
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000028,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000028
sstDisplayName: 15
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000029,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000029
sstDisplayName: 16
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000030,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000030
sstDisplayName: 17
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000031,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000031
sstDisplayName: 18
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000032,uid=4000024,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000032
sstDisplayName: 19
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Gentoo Linux based operating system choices for the whole stoney cloud installation.
dn: uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000033
sstDisplayName: Gentoo
description: This sub tree contains the Gentoo Linux based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000034,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000034
sstDisplayName: 2012.0
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000035,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000035
sstDisplayName: 2013.0
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

==== Windows ====
The sub tree '''uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org''' contains the Windows based operating system choices for the whole stoney cloud installation.
# This sub tree contains the Windows based operating system choices for the whole stoney cloud installation.
dn: uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000036
sstDisplayName: Windows
description: This sub tree contains the Windows based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Windows Server 2008 based operating system choices for the whole stoney cloud installation.
dn: uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000037
sstDisplayName: Server 2008
description: This sub tree contains the Windows Server 2008 based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000038,uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000038
sstDisplayName: Datacenter
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000039,uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000039
sstDisplayName: Enterprise
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000040,uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000040
sstDisplayName: Foundation
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000041,uid=4000037,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000041
sstDisplayName: Standard
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Windows Server 2008 R2 based operating system choices for the whole stoney cloud installation.
dn: uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000042
sstDisplayName: Server 2008 R2
description: This sub tree contains the Windows Server 2008 R2 based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000043,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000043
sstDisplayName: Datacenter
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000044,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000044
sstDisplayName: Enterprise
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000045,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000045
sstDisplayName: Foundation
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000046,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000046
sstDisplayName: Standard
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000047,uid=4000042,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000047
sstDisplayName: Web
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

# This sub tree contains the Windows Server 2012 based operating system choices for the whole stoney cloud installation.
dn: uid=4000048,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000048
sstDisplayName: Server 2012
description: This sub tree contains the Windows Server 2012 based operating system choices for the whole stoney cloud installation.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000049,uid=4000048,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000049
sstDisplayName: Datacenter
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000050,uid=4000048,uid=4000036,ou=operating system,ou=configuration,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000050
sstDisplayName: Standard
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

=== Software Stack ===
The sub tree '''ou=software stack,ou=configuration,dc=foss-cloud,dc=org''' contains the software stack choices for the whole stoney cloud installation. They can be extended by the administrator.
# This sub tree contains the software stack choices for the whole stoney cloud installation.
dn: ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: software stack
description: This sub tree contains the software stack choices for the whole stoney cloud installation.

dn: ou=environments,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: environments
description: This sub tree contains the software stack environment choices for the whole stoney cloud installation.

dn: uid=4000054,ou=environments,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000054
sstDisplayName: Test Environment
description: This is the environment used for testing (pre-production).
sstEnvironmentName: Test
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000055,ou=environments,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000055
sstDisplayName: Development Environment
description: This is the environment used for development (sandbox).
sstEnvironmentName: Development
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000056,ou=environments,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
uid: 4000056
sstDisplayName: Production Environment
description: This is the environment used for production.
sstEnvironmentName: Production
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

The multi-valued '''labeledURI''' attribute contains the '''operating system(s)''' for which a software stack works and therefore can be shown to the customer. The following three attributes tell us, who is allowed to access this leaf:
* '''sstAllowResellerUID''': Stores the reseller UID(s) that are allowed access to this leaf. If set to 0 (zero), all resellers have access.
* '''sstAllowCustomerUID''': Stores the customer UID(s) that are allowed access to this leaf. If set to 0 (zero), all customers belonging to the allowed resellers have access.
* '''sstAllowPersonUID''': Stores the person UID(s) that are allowed access to this leaf. If set to 0 (zero), all people belonging to the allowed resellers and the allowed customers have access.
dn: uid=4000051,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
objectclass: labeledURIObject
uid: 4000051
sstDisplayName: Django (Version 1)
description: Django Python Web Framework Version 1.
labeledURI: ldap://uid=4000034,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=foss-cloud,dc=org
labeledURI: ldap://uid=4000035,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=foss-cloud,dc=org
sstEnvironmentName: Test
sstEnvironmentName: Development
sstEnvironmentName: Production
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

dn: uid=4000052,ou=software stack,ou=configuration,dc=foss-cloud,dc=org
objectclass: top
objectclass: sstGroupObjectClass
objectclass: sstRelationship
objectclass: labeledURIObject
uid: 4000052
sstDisplayName: Django (Version 2)
description: Django Python Web Framework Version 2.
labeledURI: ldap://uid=4000034,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=foss-cloud,dc=org
labeledURI: ldap://uid=4000035,uid=4000033,uid=4000019,ou=operating system,ou=configuration,dc=foss-cloud,dc=org
sstEnvironmentName: Test
sstEnvironmentName: Development
sstEnvironmentName: Production
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstAllowResellerUID: 0
sstAllowCustomerUID: 0
sstAllowPersonUID: 0

== Customers ==
The sub tree '''ou=customers,dc=stoney-cloud,dc=org''' contains all the customers. Each customer has a unique uid, which is used for later reference.

=== Customers - Customer ===
We have two kinds of customers:
* '''Company customer''': This is the normal case, as we target companies.
* '''Private customer''': A private customer does not have a company/organisation name.

The following LDIF examples will show both cases where necessary. The first LDIF shows you the default '''company customer''' entry after a fresh stoney cloud installation. All relevant data belonging to this customer is stored below this dn.
<source lang='ldif'>
dn: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCustomer
objectclass: sstRelationship
uid: 4000001
organizationName: Customer Ltd.
sstIsCompany: TRUE
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
</source>

The following LDIF shows you the '''private customer''' entry. All relevant data belonging to this customer are stored below this dn.
<source lang='ldif'>
dn: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCustomer
objectclass: sstRelationship
uid: 4000001
givenName: Name
surname: Surname
sstIsCompany: FALSE
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| organizationName
| <center>MAY</center>
| <center>x1</center>
| The organisation name of the customer. For example: Customer Ltd..

|-
| givenName
| <center>MAY</center>
| <center>x1</center>
| Givenname, example: Hans.

|-
| surname
| <center>MAY</center>
| <center>x1</center>
| Surname, example: Muster.

|-
| sstIsCompany
| <center>MUST</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstBelongsToResellerUID
| <center>MUST</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000.

|-
| sstBelongsToCustomerUID
| <center>MAY</center>
| <center>x</center>
| Stores the customer UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000001.

|}

Legend:
* '''x''': Mandatory in all cases.
* '''x1''': 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.

==== Customers - Customer - Billing address ====
The sub tree '''ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the billing address for a '''company customer''':
<source lang='ldif'>
dn: ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: address
organizationName: Customer Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: Name Surname <name.surname@example.com>
sstMailCc: Info Customer Ltd. <info@example.com>
sstMailBcc: Accounting Service Provider Ltd. <accounting@example.org>
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The sub tree '''ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the billing address for a '''private customer''':
<source lang='ldif'>
dn: ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: address
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: Name Surname <name.surname@example.com>
sstMailCc: Info <info@example.com>
sstMailBcc: Accounting Service Provider Ltd. <accounting@example.org>
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute Name'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Interface Equivalent'''
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| organizationName
| <center>MAY</center>
| <center>x1</center>
| Customer Name
| Customer name, for example: '''stepping stone GmbH'''.

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Gender
| Either 'm' for male or 'f' for female. For example: '''m'''.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Name
| Name, for example: '''Hans'''.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname
| Surname, for example: '''Muster'''.

|-
| postalAddress
| <center>MAY</center>
| <center>x3</center>
| Address
| Multi-lined address, for example: '''Neufeldstrasse 9'''.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x3</center>
| Post Office Box
| Post Office Box, for example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x4</center>
| State or Province Name
| This pull down menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country
| Country code according to [http://www.iso.org/iso/home/standards/country_codes.htm ISO 3166-1]. The English short name (upper/lower case) is used for the interface and the corresponding ISO 3166-1-alpha-2 code (a two-letter code that represents a country name, recommended as the general purpose code) is used for the LDAP entry). For example: '''Switzerland''' in the interface and '''CH''' in the LDAP directory.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Postal Code
| Postal Code without the country code, for example: '''3012'''.

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| Location
| Location, for example: '''Berne'''.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Language
| Display language of the user according to [http://www.ietf.org/rfc/rfc1766.txt RFC 1766]. For example: '''de-CH'''. The following languages are currently supported:
* de-CH
* de-DE
* en-GB
* en-US
* fr-CH
* fr-FR

|-
| mail
| <center>MUST</center>
| <center>x</center>
| Mail Address
| The customers "To:" billing mail address, for example: '''Hans Muster <hans.muster@example.com>'''. This is a multi-valued attribute and it MUST contain at least one "To:" billing mail address.

|-
| sstMailCc
| <center>MAY</center>
| <center></center>
| Mail Address
| The customers "CC:" billing mail address, for example: '''Info Customer Ltd. <info@example.com>'''. This is a multi-valued attribute and can contain zero or more "CC:" billing mail addresses.

|-
| sstMailBcc
| <center>MAY</center>
| <center></center>
| Mail Address
| The customers "BCC:" billing mail address, for example: '''Accounting Service Provider Ltd. <accounting@example.org>'''. This is a multi-valued attribute and can contain zero or more "BCC:" billing mail addresses. Here we'd expect the Accounting mail address of the service provider (for accountability reasons).

|-
| telephoneNumber
| <center>MAY</center>
| <center>x2</center>
| Telephone
| Telephone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 31 222 33 44'''.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x2</center>
| Mobile
| Mobile phone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 76 222 33 44'''.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| Website
| Website URL according to [http://tools.ietf.org/html/rfc3986 RFC-3986]. For example: '''http://www.stepping-stone.ch'''/.

|}
Legend:

* '''x1''': If the attribute <code>sstIsCompany</code> of the parent entry is set to <code>TRUE</code>, the <code>organizationName</code> must be set.
* '''x2''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x3''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x4''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

==== Customers - Customer - Shipping address (optional) ====
The sub tree '''ou=shipping,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the shipping address and is optional (it is only needed, if the shipping address differs from the billing Address).
<source lang='ldif'>
dn: ou=shipping,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: shipping
organizationName: Customer Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

==== Customers - Customer - Billing ====
The sub tree '''ou=billing,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains billing relevant data. The following example shows a customer, receiving a monthly bill.
<source lang='ldif'>
dn: ou=billing,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstBillingCustomer
ou: billing
sstBillable: TRUE
sstBillingCycle: 1
sstCurrency: CHF
sstPaymentMethod: invoice
sstDeliveryMethod: post
sstDiscount: 20
sstCancellationDate: 20181231
sstMailToUID: 4000002
sstMailCcUID: 4000064
sstMailBccUID: 4000066
sstMailBccUID: 4000069
</source>

The following example shows a customer, which receives their bill via their reseller (no billing done by us):
<source lang='ldif'>
dn: ou=billing,uid=4000001,ou=customers,o=stepping-stone,c=ch
objectclass: top
objectclass: organizationalUnit
objectclass: sstBillingCustomer
ou: billing
sstBillable: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| sstBillable
| <center>MAY</center>
| <center>x2</center>
| All hierarchical levels must have <code>sstBillable: TRUE</code> to actually have an invoice generated and sent. If the attribute <code>sstBillable</code> doesn't exist, the default is <code>TRUE</code>. This way, we are forced to set a reseller, customer or product manually to <code>sstBillable: FALSE</code> if we want to avoid sending them an invoice.
|-
| sstBillingCycle
| <center>MAY</center>
| <center></center>
| Billing cycle in months. This attribute <code>sstBillingCycle</code> is only checked (evaluated), if the reseller the customer belongs to, has <code>sstResellerBill</code> set to <code>FALSE</code> (as is the case for the reseller stepping stone GmbH). Possible values:
* 1: Monthly invoice.
* 3: Quarterly invoice.
* 6: Semi-annually invoice.
* '''12''': Yearly invoice (this is the default billing period if no <code>sstBillingCycle</code> is set).

|-
| sstCurrency
| <center>MAY</center>
| <center></center>
| Three-letter currency code according to [https://en.wikipedia.org/wiki/ISO_4217 ISO 4217]. Possible values are:
* '''CHF''': Swiss franc (this is the default currency if no <code>sstCurrency</code> is set).
* EUR: Euro
* GBP: Pound sterling
* USD: United States dollar

|-
| sstPaymentMethod
| <center>MAY</center>
| <center></center>
| Payment method of the invoice. Possible values are:
* '''invoice''': Classic invoice, sent according to the delivery method defined in <code>sstDeliveryMethod</code> (this is the default payment method if no <code>sstPaymentMethod</code> is set).
* postcard: Electronic invoice via PostFinance.
* creditcard: Credit card payment.

|-
| sstDeliveryMethod
| <center>MAY</center>
| <center></center>
| Delivery method of invoices or access data. Possible values are:
* email: The invoice or access data is sent via email to the recipient.
* '''post''': The invoice or access data is sent via snail mail to the recipient (this is the default delivery method if no <code>sstDeliveryMethod</code> is set).

|-
| sstDiscount
| <center>MAY</center>
| <center></center>
| An optional customer discount (an integer value between 0 and 100). Default is '''0'''.

|-
| sstCancellationDate
| <center>MAY</center>
| <center></center>
| The cancellation date of a reseller, customer or service in the form of [YYYY][MM][DD] (ISO 8601). For example: '''20181231'''. The attribute <code>sstCancellationDate</code> is used in a logical AND combination with <code>sstIsActive</code>.

|-
| sstMailToUID
| <center>MAY</center>
| <center>x1</center>
| This attribute <code>sstMailToUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Even though this attribute is multi-valued, we expect on recipient only. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via To. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000002'''.

|-
| sstMailCcUID
| <center>MAY</center>
| <center></center>
| This attribute <code>sstMailCcUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Please be aware, that this attribure ist multi-valued and multiple recipients are to be expected. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via CC. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000064'''.

|-
| sstMailBccUID
| <center>MAY</center>
| <center></center>
| This attribute <code>sstMailBccUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Please be aware, that this attribure ist multi-valued and multiple recipients are to be expected. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via BCC. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000066''' or '''4000069'''.

|}

Legend:
* '''x''': Mandatory in all cases.
* '''x1''': The attribute <code>sstMailToUID</code> is mandatory, if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>.
* '''x2''': As the default of the attribute <code>sstBillable</code> is <code>TRUE</code>, it's not really mandatory. For better readability, please always add the attribute <code>sstBillable</code>.

==== Customers - Customer - Employees ====
The sub tree '''ou=employees,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the employees belonging to the reseller '''Customer Ltd.''' (all the employees with the the attribute sstBelongsToEmployeeUID=4000001). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of employees belonging to this customer. The number of employees is always the same or smaller than the number of people belonging to a customer (they are a subset).
<source lang='ldif'>
dn: ou=employees,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: employees
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstEmployeeOfUID=4000001)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org
</source>

In this example, the customer '''Customer Ltd.''' has one employee (with the uid=4000002).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

==== Customers - Customer - People ====
The sub tree '''ou=people,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the all the people belonging to the customer '''Customer Ltd.''' (all the people, including the employees, with the the attribute sstBelongsToCustomerUID=4000001). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of employees belonging to this reseller. The number of people is always the same or larger than the number of employees belonging to a reseller.
<source lang='ldif'>
dn: ou=people,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: people
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstBelongsToCustomerUID=4000001)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org
member: uid=4000064,ou=people,dc=stoney-cloud,dc=org
member: uid=4000066,ou=people,dc=stoney-cloud,dc=org
member: uid=4000069,ou=people,dc=stoney-cloud,dc=org
</source>

In this example, four people the customer '''Customer Ltd.''' (including the employee with the uid=4000002).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

=== Customers - Customer (LEGACY) ===
We have two kinds of customers:
* '''Company customer''': This is the normal case, as we target companies.
* '''Private customer''': A private customer does not have a company/organisation name.

The following LDIF examples will show both cases where necessary. The first LDIF shows you the default '''company customer''' entry after a fresh stoney cloud installation. All relevant data belonging to this reseller is stored below this leaf.
<source lang='ldif'>
dn: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCustomerCompany
uid: 4000001
organizationName: Customer Ltd.
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstIsActive: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| organizationName
| <center>MUST</center>
| <center>x</center>
| The organisation name of the reseller. For example: Customer Ltd..

|-
| sstBelongsToResellerUID
| <center>MUST</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000.

|-
| sstBelongsToCustomerUID
| <center>MAY</center>
| <center>x</center>
| Stores the customer UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000001.

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|}

Legend:
* '''x''': Mandatory in all cases.

The following LDIF shows you the '''private customer''' entry. All relevant data belonging to this reseller are stored below this leaf.
<source lang='ldif'>
dn: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCustomerPerson
uid: 4000001
givenName: Name
surname: Surname
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstIsActive: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Givenname, example: Hans.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname, example: Muster.

|-
| sstBelongsToResellerUID
| <center>MUST</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000000.

|-
| sstBelongsToCustomerUID
| <center>MAY</center>
| <center>x</center>
| Stores the customer UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000001.

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|}

Legend:
* '''x''': Mandatory in all cases.

==== Customers - Customer (LEGACY) - Billing address ====
The sub tree '''ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the billing address for a '''company customer''':
<source lang='ldif'>
dn: ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddressCompany
ou: address
organizationName: Customer Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| organizationName
| <center>MUST</center>
| <center>x</center>
| Company name, example: stepping stone GmbH

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Either 'm' for male or 'f' for female.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Givenname, example: Hans.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname, example: Muster.

|-
| postalAddress
| <center>MAY</center>
| <center>x2</center>
| Street Number, example: Neufeldstrasse 9. Multi-lined field.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x2</center>
| Postbox, example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x3</center>
| This pulldown menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country code according to ISO 3166-1 (for the web interface) and the corresponding [https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1-alpha-2] code (as the LDAP entry). Example: For Switzerland the value is CH.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Zipcode, example: 3012

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| City, example: Bern.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Display language of the user according to RFC 1766, example: de-CH. Currently supported:
* de-CH
* en-GB

|-
| mail
| <center>MUST</center>
| <center>x</center>
| E-mail address of the user, example: hans.muster@example.com.

|-
| telephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Fixnet phone number, example: +41 31 222 33 44.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Mobile phone number, example: +41 76 222 33 44.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| URL gemäss RFC-3986 http://tools.ietf.org/html/rfc3986. For example http://www.stepping-stone.ch/.

|}
Legend:

* '''x1''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x2''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x3''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

The sub tree '''ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org''' contains the billing address for a '''private customer''':
<source lang='ldif'>
dn: ou=address,uid=4000001,ou=customers,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddressPerson
ou: address
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Either 'm' for male or 'f' for female.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Givenname, example: Hans.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname, example: Muster.

|-
| postalAddress
| <center>MAY</center>
| <center>x2</center>
| Street Number, example: Neufeldstrasse 9. Multi-lined field.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x2</center>
| Postbox, example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x3</center>
| This pulldown menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country code according to ISO 3166-1 (for the web interface) and the corresponding ISO 3166-1-alpha-2 code (as the LDAP entry). Example: For Switzerland the value is CH.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Zipcode, example: 3012

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| City, example: Bern.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Display language of the user according to RFC 1766, example: de-CH. Currently supported:
* de-CH
* en-GB

|-
| mail
| <center>MUST</center>
| <center>x</center>
| E-mail address of the user, example: hans.muster@example.com.

|-
| telephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Fixnet phone number, example: +41 31 222 33 44.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Mobile phone number, example: +41 76 222 33 44.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| URL gemäss RFC-3986 http://tools.ietf.org/html/rfc3986. For example http://www.stepping-stone.ch/.

|}
Legend:

* '''x1''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x2''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x3''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

== Groups ==

== People ==
The sub tree which contains all the people. Each person has a unique identifier (uid):
<source lang='ldif'>
dn: ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: people
description: The sub tree which contains all the people.
</source>

=== People - Person ===
Each person hat its own leaf with a unique identifier (uid). The following LDIF shows you a typical '''person''' entry. All relevant data belonging to this person is stored below this leaf.

<source lang='ldif'>
dn: uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstPerson
uid: 4000002
sstGender: m
sstTitle: CEO
givenName: Name
surname: Surname
displayName: Name Surname
preferredLanguage: en-GB
userPassword: {SSHA}UgrBHVhKxFQInWWpzf1ddgEVmSg5vKUm
mail: name.surname@example.com
cn: admin
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstTimeZoneOffset: UTC+01
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001
sstEmployeeOfUID: 4000000
sstEmployeeOfUID: 4000001
</source>

The person '''Name Surname''' (with the uid=4000002) belongs to the reseller '''Reseller Ltd.''' (with sstBelongsToResellerUID=4000000) and is an employee of the same company (sstEmployeeOfUID=4000000). The person also belongs the customer '''Customer Ltd.''' (with sstBelongsToCustomerUID=4000001) and is an employee of the same company (sstEmployeeOfUID=4000001).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| style="width:200px; border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| '''AttributeType'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Interface Equivalent'''
| <center>'''User alterable'''</center>
| style="width:600px; border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| UID
| <center></center>
| Unique Identifier. For example: '''4000002'''.

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Gender
| <center></center>
| Either 'm' for male or 'f' for female. For example: '''m'''.

|-
| sstTitle
| <center>MAY</center>
| <center>x</center>
| Title
| <center>x</center>
| The title of a person as a [http://en.wikipedia.org/wiki/UTF-8 UTF-8]] formatted string. For example: '''CEO''' or '''Technician'''.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Name
| <center>x</center>
| Name, for example: '''Hans'''.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname
| <center>x</center>
| Surname, for example: '''Muster'''.

|-
| displayName
| <center>MAY</center>
| <center>x2</center>
| Display name
| <center></center>
| Display name, for example: ''' Hans Muster'''.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Language
| <center>x</center>
| Display language of the user according to RFC 1766: <nowiki>[</nowiki>[http://www.loc.gov/standards/iso639-2/php/code_list.php ISO 639-1 Code]<nowiki>]</nowiki>-<nowiki>[</nowiki>[http://www.iso.org/iso/english_country_names_and_code_elements ISO 3166-1-alpha-2 code]<nowiki>]</nowiki> . For example: <code>de-CH</code>

|-
| userPassword
| <center>MUST</center>
| <center>x</center>
| Password
| <center>x</center>
| SSHA user password. {SSHA} is a [http://www.ietf.org/rfc/rfc2307.txt RFC 2307] password scheme which uses the SHA1 secure hash algorithm. For example: '''{SSHA}h+qbh3pFWrZxmz02H5tXhOr+0/wrmHFF'''.

|-
| mail
| <center>MUST</center>
| <center>x</center>
| Mail Address
| <center>x</center>
| The users mail address, for example: '''hans.muster@example.com'''.

|-
| cn
| <center>MAY</center>
| <center></center>
|
|
| Common name of the user, for example: '''sst-mei'''.

|-
| telephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Telephone
| <center>x1</center>
| Telephone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 31 222 33 44'''.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Mobile
| <center>x1</center>
| Mobile phone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 76 222 33 44'''.

|-
| sstTimeZoneOffset
| <center>MUST</center>
| <center>x</center>
|
|
| Time zone as an offset from UTC. For example: '''UTC+01'''

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
|
|
| Is the entry active? Either '''true''' (yes) or '''false''' (no).

|-
| sstBelongsToUID
| <center>MAY</center>
| <center></center>
|
| <center></center>
| If this value is set to '''1''', the user is the super user of the whole stoney cloud installation. Therefore this user can add and remove resellers. Use with caution.

|-
| sstBelongsToResellerUID
| <center>MAY</center>
| <center>x</center>
|
| <center></center>
| Stores the reseller UID the person belongs to. A unique value with 7 digits or more. For example: '''4000000'''.

|-
| sstBelongsToCustomerUID
| <center>MUST</center>
| <center>x</center>
|
| <center></center>
| Stores the customer UID the person belongs to. A unique value with 7 digits or more. For example: '''4000001'''.

|-
| sstEmployeeOfUID
| <center>MAY</center>
| <center></center>
| Employee of
| <center></center>
| Stores the UID(s) the person is an employee of. The UID(s) can belong to one or more resellers or also to one or more customers. A unique value with 7 digits or more. For example: '''4000001'''.

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| External ID
| <center></center>
| The ID (or number) of a customer, person or product in an external database. For example: '''234567'''.

|}

Legend:
* '''x1''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x2''': Mandatory, if the person belongs to customer that has subscribed a [https://wwww.stoney-storage.com/ stoney storage] service.

==== People - Person - Session tokens ====
Using session tokens, when the user logs out, the client sends a logout request to the server. The session token is then removed from LDAP by the server and the client discards the session token.

Special cases:
* If the user's password is changed, all session tokens must be removed from LDAP in order to force the user to re-login.
* If any attributes are changed which control the user's affiliation (reseller, company, etc), all session tokens must be removed from LDAP in order to force the user to re-login. Specific attributes:
** sstBelongsToResellerUID
** sstBelongsToCustomerUID
** sstEmployeeOfUID
** sstEmployeeOfUID

In our case, we store the session tokens in a leaf beneath the person (as these tokens are personal).

===== People - Person - Session tokens example =====
Below each person entry, we have a tokens sub tree, which stores the session tokens:
<source lang='ldif'>
dn: ou=tokens,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: tokens
description: The sub tree for the session tokens of the person with the uid '4000002'.
</source>

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

|-
| ou
| organizationalUnit
| <center>MUST</center>
| <center>x</center>
| The sub tree containing all the session tokens.

For example: <code>ou: tokens</code>.

|-
| description
| organizationalUnit
| <center>MAY</center>
| <center></center>
| The description of the leaf. As this sub tree is created by the stoney API, we don't really need a human readable description.

For example: <code>description: The sub tree for the session tokens of the person with the uid '4000002'.</code>

|}

Legend:
* '''x''': Mandatory in all cases.

Each session token receives its own child-entry to store additional meta data, such as the token's create date, last utilisation date, ... In the example below, the session token <code>sstToken: 2e211493-41e6-4c74-9431-b5d990b177a4</code> was created on the 13th of April 2021 at 08:10:27 UTC (<code>sstCreationDate: 20210413T081027Z</code>) and two clients have used this token (the first with an IPv4 address, the second with an IPv6 address):
<source lang='ldif'>
dn: sstToken=2e211493-41e6-4c74-9431-b5d990b177a4,ou=tokens,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstTokenObjectClass
sstToken: 2e211493-41e6-4c74-9431-b5d990b177a4
description: The sub tree for the JSON Web Token with the id '2e211493-41e6-4c74-9431-b5d990b177a4'.
sstCreationDate: 20210413T081027Z
sstClient: 20210413T081027Z: 194.176.109.13 Mozilla/5.0 (X11; Linux x86_64; rv:85.0) Gecko/20100101 Firefox/85.0
sstClient: 20210413T132805Z: 2001:0db8:85a3:0000:0000:8a2e:0370:7334 Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4456.0 Safari/537.36 Edg/91.0.845.2
</source>

The API will make sure, that the amount of registered remote IP addresses and requesting User-Agents doesn't exceed a certain configurable limit (for example: 2). If the limit is exceeded, the session will be invalidated.

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

|-
| sstToken
| sstTokenObjectClass
| <center>MUST</center>
| <center>x</center>
| The sub tree containing all the information of a session (creation date, access date, IPv4 or IPv6 address and the clients user agent). The session token has the form of a UUID (Universally Unique Identifier)..

For example: <code>sstToken: 2e211493-41e6-4c74-9431-b5d990b177a4</code>.

|-
| description
| sstTokenObjectClass
| <center>MAY</center>
| <center></center>
| The description of the leaf. As this sub tree is created by the stoney API, we don't really need a human readable description.

For example: <code>description: The sub tree for the JSON Web Token with the id '2e211493-41e6-4c74-9431-b5d990b177a4'.</code>

|-
| sstCreationDate
| sstTokenObjectClass
| <center>MUST</center>
| <center>x</center>
| The session token creation time (UTC) in the form of <code>[YYYY][MM][DD]T[hh][mm][ss]Z</code> according to the [http://en.wikipedia.org/wiki/ISO_8601 ISO 8601] definition.

For example: <code>sstCreationDate: 20210413T081027Z</code>.

|-
| sstClient
| sstTokenObjectClass
| <center>MUST</center>
| <center>x</center>
| The multi-valued attribute containing client information. This attribute contains the following information:
* The access time (UTC) in the form of <code>[YYYY][MM][DD]T[hh][mm][ss]Z</code> according to the [http://en.wikipedia.org/wiki/ISO_8601 ISO 8601] definition.
* The IPv4 or IPv6 address, from which the client has accessed the stoney API.
* The user agent of the client.

This information is separated by spaces: <code>sstClient: [YYYY][MM][DD]T[hh][mm][ss]Z" "IPv4 or IPv6" "User-Agent"</code>.

For example: <code>sstClient: 20210413T081027Z 194.176.109.13 Mozilla/5.0 (X11; Linux x86_64; rv:85.0) Gecko/20100101 Firefox/85.0</code>.

Please be aware, that the maximal length of a sstClient string is restricted to 256 characters.

|}

Legend:
* '''x''': Mandatory in all cases.

==== People - Person - Roles (LEGACY) ====
<source lang='ldif'>
dn: sstRole=Monitoring Administrator,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstRoles
sstProduct: 0
sstRole: Monitoring Administrator
</source>

<source lang='ldif'>
dn: sstRole=User,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstRoles
sstProduct: 0
sstRole: User
</source>

<source lang='ldif'>
dn: sstRole=Virtualization Administrator,uid=4000002,ou=people,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstRoles
sstProduct: 0
sstRole: Virtualization Administrator
</source>

== Reseller ==
The sub tree '''ou=reseller,dc=stoney-cloud,dc=org''' contains all the resellers. Each reseller has a unique uid, which is used for later reference.

=== Reseller - Reseller ===
The following LDIF shows a typical reseller entry. All relevant data belonging to this reseller is stored below this leaf.
<source lang='ldif'>
dn: uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstReseller
uid: 4000000
organizationName: Reseller Ltd.
sstIsCompany: TRUE
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| organizationName
| <center>MAY</center>
| <center>x</center>
| The organisation name of the reseller. For example: '''Reseller Ltd.'''. A reseller must be a company (<code>sstIsCompany: TRUE</code>).

|-
| description
| <center>MAY</center>
| <center></center>
| The description of the leaf.

|-
| sstIsCompany
| <center>MUST</center>
| <center>x</center>
| Is the entry a company? Either true (yes) or false (no).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstBelongsToResellerUID
| <center>MUST</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000.

|}

Legend:
* '''x''': Mandatory in all cases.

==== Reseller - Reseller - Billing address ====
The sub tree '''ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the billing address:
<source lang='ldif'>
dn: ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: address
organizationName: Reseller Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: Name Surname <name.surname@example.com>
sstMailCc: Info Reseller Ltd. <info@example.com>
sstMailBcc: Accounting Service Provider Ltd. <accounting@example.org>
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute Name'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Interface Equivalent'''
| '''Description'''

|-
| organizationName
| <center>MAY</center>
| <center>x1</center>
| Reseller Name
| Reseller name, for example: '''stepping stone GmbH'''.

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Gender
| Either 'm' for male or 'f' for female. For example: '''m'''.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Name
| Name, for example: '''Hans'''.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname
| Surname, for example: '''Muster'''.

|-
| postalAddress
| <center>MAY</center>
| <center>x3</center>
| Address
| Multi-lined address, for example: '''Neufeldstrasse 9'''.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x3</center>
| Post Office Box
| Post Office Box, for example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x4</center>
| State or Province Name
| This pull down menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country
| Country code according to [http://www.iso.org/iso/home/standards/country_codes.htm ISO 3166-1]. The English short name (upper/lower case) is used for the interface and the corresponding ISO 3166-1-alpha-2 code (a two-letter code that represents a country name, recommended as the general purpose code) is used for the LDAP entry). For example: '''Switzerland''' in the interface and '''CH''' in the LDAP directory.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Postal Code
| Postal Code without the country code, for example: '''3012'''.

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| Location
| Location, for example: '''Berne'''.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Language
| Display language of the user according to [http://www.ietf.org/rfc/rfc1766.txt RFC 1766]. For example: '''de-CH'''. The following languages are currently supported:
* de-CH
* de-DE
* en-GB
* en-US
* fr-CH
* fr-FR

|-
| mail
| <center>MUST</center>
| <center>x</center>
| Mail Address
| The resellers "To:" billing mail address, for example: '''Hans Muster <hans.muster@example.com>'''. This is a multi-valued attribute and it MUST contain at least one "To:" billing mail address.

|-
| sstMailCc
| <center>MAY</center>
| <center></center>
| Mail Address
| The resellers "CC:" billing mail address, for example: '''Info Reseller Ltd. <info@example.com>'''. This is a multi-valued attribute and can contain zero or more "CC:" billing mail addresses.

|-
| sstMailBcc
| <center>MAY</center>
| <center></center>
| Mail Address
| The customers "BCC:" billing mail address, for example: '''Accounting Service Provider Ltd. <accounting@example.org>'''. This is a multi-valued attribute and can contain zero or more "BCC:" billing mail addresses. Here we'd expect the Accounting mail address of the service provider (for accountability reasons).

|-
| telephoneNumber
| <center>MAY</center>
| <center>x2</center>
| Telephone
| Telephone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 31 222 33 44'''.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x2</center>
| Mobile
| Mobile phone number of the user according to [http://en.wikipedia.org/wiki/E.164 E.164] (international dialling code, <s>trunk code</s>, area code, subscriber line). For example: '''+41 76 222 33 44'''.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| Website
| Website URL according to [http://tools.ietf.org/html/rfc3986 RFC-3986]. For example: '''http://www.stepping-stone.ch'''/.

|}
Legend:

* '''x1''': If the attribute <code>sstIsCompany</code> of the parent entry is set to <code>TRUE</code>, the <code>organizationName</code> must be set.
* '''x2''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x3''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x4''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

==== Reseller - Reseller - Shipping address (optional) ====
The sub tree '''ou=shipping,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the shipping address and is optional (it is only needed, if the shipping address differs from the billing Address).
<source lang='ldif'>
dn: ou=shipping,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddress
ou: shipping
organizationName: Reseller Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

==== Reseller - Reseller - Billing ====
The sub tree '''ou=billing,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains billing relevant data. The following example shows a reseller, receiving a monthly bill.
<source lang='ldif'>
dn: ou=billing,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstBillingReseller
ou: billing
sstResellerBill: TRUE
sstBillable: TRUE
sstBillingCycle: 1
sstCurrency: CHF
sstPaymentMethod: invoice
sstDeliveryMethod: post
sstDiscount: 32
sstCancellationDate: 20181231
sstMailToUID: 4000002
sstMailCcUID: 4000064
sstMailBccUID: 4000066
sstMailBccUID: 4000069
</source>

The following example shows a reseller, where their customers receive a bill directly:
<source lang='ldif'>
dn: ou=billing,uid=4000000,ou=reseller,o=stepping-stone,c=ch
objectclass: top
objectclass: organizationalUnit
objectclass: sstBillingReseller
ou: billing
sstResellerBill: FALSE
sstBillable: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| '''Description'''

|-
| sstResellerBill
| <center>MUST</center>
| <center>x</center>
| Should the the reseller receive a consolidated invoice for all their customers? This can be either <code>TRUE</code> or <code>FALSE</code>. The default value is <code>TRUE</code>, meaning that the resellers receives a consolidated invoice for all their customers.

|-
| sstBillable
| <center>MAY</center>
| <center>x2</center>
| All hierarchical levels must have <code>sstBillable: TRUE</code> to actually have an invoice generated and sent. If the attribute <code>sstBillable</code> doesn't exist, the default is <code>TRUE</code>. This way, we are forced to set a reseller, customer or product manually to <code>sstBillable: FALSE</code> if we want to avoid sending them an invoice.

|-
| sstBillingCycle
| <center>MAY</center>
| <center></center>
| Billing cycle in months. This attribute <code>sstBillingCycle</code> is only checked (evaluated), if the reseller has <code>sstResellerBill</code> set to <code>TRUE</code> (as is the case for the resellers except for stepping stone GmbH). Possible values:
* 1: Monthly invoice (this is the default billing period if no <code>sstBillingCycle</code> is set).
* 3: Quarterly invoice.
* 6: Semi-annually invoice.
* 12: Yearly invoice.

|-
| sstCurrency
| <center>MAY</center>
| <center></center>
| Three-letter currency code according to [https://en.wikipedia.org/wiki/ISO_4217 ISO 4217]. Possible values are:
* '''CHF''': Swiss franc (this is the default currency if no <code>sstCurrency</code> is set).
* EUR: Euro
* GBP: Pound sterling
* USD: United States dollar

|-
| sstPaymentMethod
| <center>MAY</center>
| <center></center>
| Payment method of the invoice. Possible values are:
* '''invoice''': Classic invoice, sent according to the delivery method defined in <code>sstDeliveryMethod</code> (this is the default payment method if no <code>sstPaymentMethod</code> is set).
* postcard: Electronic invoice via PostFinance.
* creditcard: Credit card payment.

|-
| sstDeliveryMethod
| <center>MAY</center>
| <center></center>
| Delivery method of invoices or access data. Possible values are:
* email: The invoice or access data is sent via email to the recipient.
* '''post''': The invoice or access data is sent via snail mail to the recipient (this is the default delivery method if no <code>sstDeliveryMethod</code> is set).

|-
| sstDiscount
| <center>MAY</center>
| <center></center>
| An optional customer discount (an integer value between 0 and 100). Default is '''0'''.

|-
| sstCancellationDate
| <center>MAY</center>
| <center></center>
| The cancellation date of a reseller, customer or service in the form of [YYYY][MM][DD] (ISO 8601). For example: '''20181231'''. The attribute <code>sstCancellationDate</code> is used in a logical AND combination with <code>sstIsActive</code>.

|-
| sstMailToUID
| <center>MAY</center>
| <center>x1</center>
| This attribute <code>sstMailToUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Even though this attribute is multi-valued, we expect on recipient only. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via To. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000002'''.

|-
| sstMailCcUID
| <center>MAY</center>
| <center></center>
| This attribute <code>sstMailCcUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Please be aware, that this attribure ist multi-valued and multiple recipients are to be expected. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via CC. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000064'''.

|-
| sstMailBccUID
| <center>MAY</center>
| <center></center>
| This attribute <code>sstMailBccUID</code> is only checked (evaluated), if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>. Please be aware, that this attribure ist multi-valued and multiple recipients are to be expected. Stores the UID (Unique Identifier in the form integer value with 7 digits) of the person an email is sent to via BCC. This UID is used to look up the persons mail address, preferred language, name, surname or other information in the sub tree ou=people,dc=stoney-cloud,dc=org. For example: '''4000066''' or '''4000069'''.

|}

Legend:
* '''x''': Mandatory in all cases.
* '''x1''': The attribute <code>sstMailToUID</code> is mandatory, if the delivery method <code>sstDeliveryMethod</code> is set to <code>email</code>.
* '''x2''': As the default of the attribute <code>sstBillable</code> is <code>TRUE</code>, it's not really mandatory. For better readability, please always add the attribute <code>sstBillable</code>.

==== Reseller - Reseller - Customers ====
The sub tree '''ou=customers,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the customers belonging to the reseller '''Reseller Ltd.''' (all the customers with the the attribute sstBelongsToResellerUID=4000000). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of customers belonging to this reseller.
<source lang='ldif'>
dn: ou=customers,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: customers
labeledURI: ldap:///ou=customers,dc=stoney-cloud,dc=org??one?(sstBelongsToResellerUID=4000000)
member: uid=4000001,ou=customers,dc=stoney-cloud,dc=org
</source>

In this example, the reseller '''Reseller Ltd.''' has one customer (with the uid=4000001).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

==== Reseller - Reseller - Employees ====
The sub tree '''ou=employees,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the employees belonging to the reseller '''Reseller Ltd.''' (all the employees with the the attribute sstBelongsToEmployeeUID=4000000). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of employees belonging to this reseller. The number of employees is always the same or smaller than the number of people belonging to a reseller (they are a subset).
<source lang='ldif'>
dn: ou=employees,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: employees
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstEmployeeOfUID=4000000)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org
</source>

In this example, the reseller '''Reseller Ltd.''' has one employee (with the uid=4000002).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

==== Reseller - Reseller - People ====
The sub tree '''ou=people,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the all the people belonging to the reseller '''Reseller Ltd.''' (all the people, including the employees, with the the attribute sstBelongsToResellerUID=4000000). With the attribute labeledURI we use the functionality of the [http://www.openldap.org/doc/admin24/overlays.html#Dynamic%20Lists dynamic lists overlay] to automatically give us a list of employees belonging to this reseller. The number of people is always the same or larger than the number of employees belonging to a reseller.

<source lang='ldif'>
dn: ou=people,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: labeledURIObject
ou: employees
labeledURI: ldap:///ou=people,dc=stoney-cloud,dc=org??one?(sstBelongsToResellerUID=4000000)
member: uid=4000002,ou=people,dc=stoney-cloud,dc=org
member: uid=4000064,ou=people,dc=stoney-cloud,dc=org
member: uid=4000066,ou=people,dc=stoney-cloud,dc=org
member: uid=4000069,ou=people,dc=stoney-cloud,dc=org
</source>

In this example, four people the reseller '''Reseller Ltd.''' (including the employee with the uid=4000002).

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| attribure
| <center>MUST</center>
| <center>x</center>
| TBD.
|}

Legend:
* '''x''': Mandatory in all cases.

=== Reseller - Reseller (LEGACY) ===
The following LDIF shows you the default reseller entry after a fresh stoney cloud installation. All relevant data belonging to this reseller is stored below this leaf.
<source lang='ldif'>
dn: uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstReseller
uid: 4000000
organizationName: Reseller Ltd.
sstBelongsToResellerUID: 4000000
sstIsActive: TRUE
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| uid
| <center>MUST</center>
| <center>x</center>
| A unique integer value with 7 digits or more. For example: 4000000.

|-
| organizationName
| <center>MUST</center>
| <center>x</center>
| The organisation name of the reseller. For example: Reseller Ltd..

|-
| sstBelongsToResellerUID
| <center>MAY</center>
| <center>x</center>
| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. For example: 4000000.

|-
| sstExternalID
| <center>MAY</center>
| <center></center>
| The ID (or number) of a customer, person or product in an external database (for example: 234567).

|-
| sstIsActive
| <center>MAY</center>
| <center>x</center>
| Is the entry active? Either true (yes) or false (no).

|}

Legend:
* '''x''': Mandatory in all cases.

==== Reseller - Reseller - Billing address (LEGACY) ====
The sub tree '''ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org''' contains the billing address:
<source lang='ldif'>
dn: ou=address,uid=4000000,ou=reseller,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstAddressCompany
ou: address
organizationName: Reseller Ltd.
sstGender: m
givenName: Name
surname: Surname
postalAddress: Street Number
countryName: CH
postalCode: Postal Code
localityName: Locality
preferredLanguage: en-GB
mail: name.surname@example.com
telephoneNumber: +41 00 000 00 00
mobileTelephoneNumber: +41 00 000 00 00
sstWebsiteURL: https://www.example.com/
</source>

The following table describes the different attributes:
{| border="1" style="border-collapse: collapse; font-size:80%;" width="100%" class="wikitable sortable"
| '''Attribute'''
| <center>'''Existence'''</center>
| <center>'''Mandatory'''</center>
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''

|-
| organizationName
| <center>MUST</center>
| <center>x</center>
| Company name, example: stepping stone GmbH

|-
| sstGender
| <center>MUST</center>
| <center>x</center>
| Either 'm' for male or 'f' for female.

|-
| givenName
| <center>MUST</center>
| <center>x</center>
| Givenname, example: Hans.

|-
| surname
| <center>MUST</center>
| <center>x</center>
| Surname, example: Muster.

|-
| postalAddress
| <center>MAY</center>
| <center>x2</center>
| Street Number, example: Neufeldstrasse 9. Multi-lined field.

|-
| postOfficeBox
| <center>MAY</center>
| <center>x2</center>
| Postbox, example: 3456.

|-
| stateOrProvinceName
| <center>MAY</center>
| <center>x3</center>
| This pulldown menu is only active (appears to the user), if the country is set to Canada or the USA.

|-
| countryName
| <center>MUST</center>
| <center>x</center>
| Country code according to ISO 3166-1 (for the web interface) and the corresponding ISO 3166-1-alpha-2 code (as the LDAP entry). Example: For Switzerland the value is CH.

|-
| postalCode
| <center>MUST</center>
| <center>x</center>
| Zipcode, example: 3012

|-
| localityName
| <center>MUST</center>
| <center>x</center>
| City, example: Bern.

|-
| preferredLanguage
| <center>MUST</center>
| <center>x</center>
| Display language of the user according to RFC 1766, example: de-CH. Currently supported:
* de-CH
* en-GB

|-
| mail
| <center>MUST</center>
| <center>x</center>
| E-mail address of the user, example: hans.muster@example.com.

|-
| telephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Fixnet phone number, example: +41 31 222 33 44.

|-
| mobileTelephoneNumber
| <center>MAY</center>
| <center>x1</center>
| Mobile phone number, example: +41 76 222 33 44.

|-
| sstWebsiteURL
| <center>MAY</center>
|
| URL gemäss RFC-3986 http://tools.ietf.org/html/rfc3986. For example http://www.stepping-stone.ch/.

|}
Legend:

* '''x1''': Either telephoneNumber or mobileTelephoneNumber need to be present. Both attributes can exist together.
* '''x2''': Either postalAddress or postOfficeBox need to be present. Both attributes can exist together.
* '''x3''': If the countryName is either Canada or the USA, the stateOrProvinceName needs to be present.

[[Category:stoney core]][[Category:OpenLDAP directory]]

stoney cloud: Upgrade

2017-08-11T09:03:08Z

Administrator: /* Basic Testing Steps */

= Overview =
This guide explains, what you need to do during the installation of your Multi-Node Installation.

== Prepare your stoney cloud installation for the update ==

=== <= 1.2.10.3 ===

If you have a '''productive''' (releases) stoney cloud Installation, execute the following command:
<source lang="bash">
echo 'PORTAGE_BINHOST="http://packages.stoney-cloud.org/stoney-cloud/releases/1.2/packages"' >> /etc/portage/make.conf
</source>

If you have a '''test''' (pre-releases) stoney cloud Installation instead, execute the following command:
<source lang="bash">
echo 'PORTAGE_BINHOST="http://packages.stoney-cloud.org/stoney-cloud/pre-releases/1.2/packages"' >> /etc/portage/make.conf
</source>

'''IMPORTANT:''' Even a pre-release ISO may result in a stable installation, depending on when it was generated in the release cycle. Please verify by executing <code>git branch</code> in <code>/usr/portage</code> and <code>/var/lib/layman/foss-cloud</code> whether this is the case, and [[stoney_cloud:_Switch_to_testing_branch|switch to the testing branch]] if needed (that is: if the branch displayed does not contain the words <code>pre</code> or <code>testing</code>. If the branch is empty, that means you have a brand new installation without anything yet. In that case, directly check the configuration files <code>/usr/portage/.git/config</code> and/or <code>/var/lib/layman/foss-cloud/.git/config</code> to see which branch it would check out upon <code>emerge --sync</code> and from where.).

=== >= 1.2.10.4 ===

Execute the following command to register the binary package mirror (since for now there will be only pre-releases, but with better quality than FOSS-Cloud releases):

<source lang="bash">
echo 'PORTAGE_BINHOST="http://packages.stoney-cloud.org/stoney-cloud/pre-releases/1.2/packages"' >> /etc/portage/make.conf

# Disable the SYNC from rsync since newer portage versions otherwise won't accept a portage tree via git
sed -i -e 's|^SYNC|#SYNC|' /etc/portage/make.conf
</source>

== Update ==

=== Updating from 1.2.10.7 or earlier to 1.2.10.8_rc4 or newer ===

A complete rebuild of all packages was required, therefore the update guide is different:

<source lang='bash'>
emerge --sync

emerge -eK world -va

# sst-libvirt-hooks is not part of the stoney-cloud anymore since it requires further configuration
# make sure that it still gets updated and not removed later, if you have it installed and enabled
emerge -K app-emulation/sst-libvirt-hooks

dispatch-conf

# Switch runtime switchable options
eselect python set python3.3
eselect php set cli php5.5
eselect php set apache2 php5.5
gcc-config x86_64-pc-linux-gnu-4.7.3
</source>

During the dispatch-conf the following may appear:
* /etc/libvirt/libvirt.conf: you may get the suggestion to remove almost all content. Quit dispatch-conf and do: <code>rm /etc/libvirt/._mrg*</code> and start dispatch-conf again.
* /etc/libvirt/libvirt.conf: merge all whitespace/comment changes but make sure you don't overwrite the <code>listen_addr</code>
* /etc/portage/make.conf: merge all changes beside the <code>PORTAGE_BINHOST</code>
* /var/www/localhost/htdocs/vm-manager/vm_config.php: merge the versions, newly added lines and comments. Avoid changes on sstSourceHostName array

To make sure everything works, reboot and then cleanup:

<source lang='bash'>
emerge --depclean -va
</source>

* If the cleanup fails stating that <code>Locale-gettext</code> and <code>dev-libs/boost</code> depends on some version of perl, reinstall that package manually once and try again:
<source lang='bash'>
emerge -1Kva dev-libs/boost Locale-gettext

# same for autoconf-/automake-wrapper if host was used to build stuff:
emerge -1K sys-devel/autoconf-wrapper sys-devel/automake-wrapper
</source>
* '''WARNING''': this also removes the current kernel. If you want to play it safe, reboot first, then depclean, then reboot again
* Rebuilde separately installed perl modules and remove traces of the old perl version:
<source lang='bash'>
perl-cleaner --all -- -va
rm -rf /usr/lib64/perl5/{vendor_perl,}/5.12.4
</source>

==== Emulator ====
* u=devices,sstVirtualMachine=*,ou=virtual machines,ou=virtualization,ou=services,o=stepping-stone,c=ch

Change
<pre>
sstEmulator: /usr/bin/qemu-kvm
</pre>
to
<pre>
sstEmulator: /usr/bin/qemu-system-x86_64
</pre>

==== Source Port ====
* sstDisk=vda,ou=devices,sstVirtualMachine=*,ou=virtual machines,ou=virtualization,ou=services,dc=stoney-cloud,dc=org
* sstDisk=vdb,ou=devices,sstVirtualMachine=*,ou=virtual machines,ou=virtualization,ou=services,dc=stoney-cloud,dc=org

Add
<pre>
sstSourcePort: 24007
</pre>

==== Firewall / Subversion ====
If you are using our firewall scripts (libvirt-hooks based), you'll also have to upgrade subversion (on all the stoney cloud nodes):
<source lang='bash'>
cd /usr/local/scripts/netfilter/local/chains/vms
svn upgrade
cd /usr/local/scripts/netfilter/local/chains/$(hostname -s)
svn upgrade
</source>

=== Regular Update ===

Makes sure, your local portage tree is updated:
emerge --sync

Now you can make sure, that you've got the current stoney cloud version installed:
emerge -KuDva virtual/foss-cloud

<pre>
Local copy of remote index is up-to-date and will be used.

These are the packages that would be merged, in order:

Calculating dependencies... done!

Total: 0 packages, Size of downloads: 0 kB

* virtual/foss-cloud-1.2.10.4

Would you like to add these packages to your world favorites? [Yes/No] '''no'''
</pre>

If you have updated you stoney cloud, you might want to sanely update your configuration files after emerging new packages (including updates):
dispatch-conf

== Installing Software Examples ==
Per default, the stoney cloud expects you to install binary packages. So if you don't pass any special parameters to the emerge command, the binary package (if it exists) will be used.

=== Binary Package ===
Per default, the stoney cloud expects you to install binary packages, which can be seen with '''[binary R ]''' output.
emerge -va git

<pre>
These are the packages that would be merged, in order:

Calculating dependencies... done!
[binary R ] dev-vcs/git-1.7.12.4 USE="blksha1 curl iconv nls pcre perl threads webdav -cgi -cvs -doc -emacs -gpg -gtk -highlight (-ppcsha1) -python -subversion {-test} -tk -xinetd" 5,295 kB

Total: 1 package (1 reinstall, 1 binary), Size of downloads: 5,295 kB

Would you like to merge these packages? [Yes/No] no

Quitting.
</pre>

=== Force Non-Binary Package ===
If you force a non-binary package, the output will be in the form of '''[ebuild R ]'''.
FEATURES="-getbinpkg" emerge -va git

<pre>
These are the packages that would be merged, in order:

Calculating dependencies... done!
[ebuild N ] app-arch/cpio-2.11 USE="nls" 995 kB
[ebuild R ] dev-vcs/git-1.7.12.4 USE="blksha1 curl iconv nls pcre perl threads webdav -cgi -cvs -doc -emacs -gpg -gtk -highlight (-ppcsha1) -python -subversion {-test} -tk -xinetd" 4,523 kB

Total: 2 packages (1 new, 1 reinstall), Size of downloads: 5,518 kB

Would you like to merge these packages? [Yes/No]
</pre>

=== No Binary Package Exists ===
The following example shows you a package with no existing binary package, therefore the package must be compiled on the fly, shown with '''[ebuild N ]'''.
emerge -va htop

<pre>
Local copy of remote index is up-to-date and will be used.

These are the packages that would be merged, in order:

Calculating dependencies... done!
[ebuild N ] sys-process/htop-1.0.2 USE="unicode -openvz -vserver" 380 kB

Total: 1 package (1 new), Size of downloads: 380 kB

Would you like to merge these packages? [Yes/No]
</pre>

== Multi-Node Installation ==
Follow the [[Multi-Node_Installation#Specialized_Installation | Specialized Installation]] Guide.

== Basic Testing Steps ==
Get your stoney cloud image:
<source lang='bash'>
version=1.2.10.7 # stoney cloud version

cd /var/virtualization/iso-choosable/
wget http://packages.stoney-cloud.org/stoney-cloud/pre-releases/1.2/iso/foss-cloud-installer-${version}.iso
chown apache:vm-storage foss-cloud-installer-${version}.iso
chmod 644 foss-cloud-installer-${version}.iso
</source>

Get the [http://www.sysresccd.org/SystemRescueCd_Homepage SystemRescueCd] ISO:
<source lang='bash'>
version=4.5.1 # SystemRescueCd version
sha256="4fda2fce55a46c7b258fba10c88a4a337821c8b801a8cd3c344cc223a9c4436d" # SHA256 checksum of the ISO
isoFile="systemrescuecd-x86-${version}.iso"

cd /var/virtualization/iso-choosable/

wget http://sourceforge.net/projects/systemrescuecd/files/sysresccd-x86/${version}/${isoFile}

# Check that the file was downloaded correctly
echo "${sha256} ${isoFile}" | sha256sum -c -

chown apache:vm-storage ${isoFile}
chmod 644 ${isoFile}
</source>

Get a Fedora ISO image:
<source lang='bash'>
version=21 # Fedora version

cd /var/virtualization/iso-choosable/
wget http://mirror.switch.ch/ftp/mirror/fedora/linux/releases/${version}/Server/x86_64/iso/Fedora-Server-netinst-x86_64-${version}.iso
chown apache:vm-storage Fedora-Server-netinst-x86_64-${version}.iso
chmod 644 Fedora-Server-netinst-x86_64-${version}.iso
</source>

Lernstick (Test):
<source lang='bash'>
cd /var/virtualization/iso-choosable/
wget http://www.imedias.ch/dateien/lernstick-testversion/lernstick_debian7_2013-12-12.iso
chown apache:vm-storage lernstick_debian7_2013-12-12.iso
chmod 644 lernstick_debian7_2013-12-12.iso
</source>

Get your debian image:
<source lang='bash'>
version=8.0.0 # Debian version

cd /var/virtualization/iso-choosable/
wget http://cdimage.debian.org/debian-cd/${version}/amd64/iso-cd/debian-${version}-amd64-netinst.iso
chown apache:vm-storage debian-${version}-amd64-netinst.iso
chmod 644 debian-${version}-amd64-netinst.iso
</source>

Get your ubuntu desktop image:
<source lang='bash'>
version=14.04 # ubuntu version

cd /var/virtualization/iso-choosable/
wget http://mirror.switch.ch/ftp/mirror/ubuntu-cdimage/${version}/ubuntu-${version}-desktop-amd64.iso
chown apache:vm-storage ubuntu-${version}-desktop-amd64.iso
chmod 644 ubuntu-${version}-desktop-amd64.iso
</source>

Get your ubuntu server image:
<source lang='bash'>
version=14.04 # ubuntu version

cd /var/virtualization/iso-choosable/
wget http://mirror.switch.ch/ftp/mirror/ubuntu-cdimage/${version}/ubuntu-${version}-server-amd64.iso
chown apache:vm-storage ubuntu-${version}-server-amd64.iso
chmod 644 ubuntu-${version}-server-amd64.iso
</source>

Get a Windows 2012 Server R2 ISO image:
<source lang='bash'>
cd /var/virtualization/iso-choosable/
wget http://care.dlservice.microsoft.com/dl/download/6/2/A/62A76ABB-9990-4EFC-A4FE-C7D698DAEB96/9600.17050.WINBLUE_REFRESH.140317-1640_X64FRE_SERVER_EVAL_EN-US-IR3_SSS_X64FREE_EN-US_DV9.ISO -O windows_server_2012_r2_64bit_en.iso
chown apache:vm-storage windows_server_2012_r2_64bit_en.iso
chmod 644 windows_server_2012_r2_64bit_en.iso
</source>

If you need the newest Windows Drivers ISO image, visit https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/archive-virtio/

Set three network ranges under https://192.168.140.10/vm-manager/subnet/index.html
192.168.140.64
26
Template Range
template

192.168.140.128
26
Persistent Range
persistent

192.168.140.192
26
Dynamic Range
dynamic

Add the three newly creates network ranges to the VM-Pools under https://192.168.140.10/vm-manager/vmPool/index.html

Create a Virtual Machine Profile under https://192.168.140.10/vm-manager/vmProfile/create.html

Create a Virtual Machine Template under https://192.168.140.10/vm-manager/vmTemplate/create.html and install a basic operating system.

Create a persistent Virtual Machine from the newly created Virtual Machine Template.

== Known Issues ==
None.

[[Category:Installation]]
[[Category:stoney cloud]]

MediaWiki:Revreview-version-2

2014-08-26T08:50:08Z

Administrator: Created page with "v1"

MediaWiki:Revreview-version-0

2014-08-26T08:49:54Z

Administrator: Created page with "Draft"

Draft

MediaWiki:Revreview-version-1

2014-08-26T08:49:40Z

Administrator:

v0.9

MediaWiki:Revreview-version-1

2014-08-26T08:49:12Z

Administrator: Created page with "Draft"

Draft

MediaWiki:Revreview-version

2014-08-26T08:48:45Z

Administrator: Created page with "Version"

Version

MediaWiki:Revreview-accuracy-0

2014-08-26T08:31:24Z

Administrator: Created page with "Draft"

Draft

Template:Documentation

2014-08-22T07:44:42Z

Administrator: Reverted edits by Administrator (talk) to last revision by A3li

{{documentation/core2
| heading = {{{heading|¬}}} 
| heading-style = {{{heading-style|}}}
| content = {{{content|}}}
| link box = {{{link box|}}} 


| docspace =
{{#switch: {{SUBJECTSPACE}}
| {{ns:0}}
| {{ns:File}}
| {{ns:MediaWiki}}
| {{ns:Category}} = {{TALKSPACE}}
| #default = {{SUBJECTSPACE}}
}}

| 1 = {{{1|}}} 


| template page =
{{#switch: {{SUBPAGENAME}}
| sandbox
| testcases = {{BASEPAGENAME}}
| #default = {{PAGENAME}}
}}

}}<noinclude>


</noinclude>

Template:Documentation

2014-08-22T07:43:23Z

Administrator:

{{Documentation/core2
| heading = {{{heading|¬}}} 
| heading-style = {{{heading-style|}}}
| content = {{{content|}}}
| link box = {{{link box|}}} 


| docspace =
{{#switch: {{SUBJECTSPACE}}
| {{ns:0}}
| {{ns:File}}
| {{ns:MediaWiki}}
| {{ns:Category}} = {{TALKSPACE}}
| #default = {{SUBJECTSPACE}}
}}

| 1 = {{{1|}}} 


| template page =
{{#switch: {{SUBPAGENAME}}
| sandbox
| testcases = {{BASEPAGENAME}}
| #default = {{PAGENAME}}
}}

}}<noinclude>


</noinclude>

Template:Documentation/core2

2014-08-22T07:42:15Z

Administrator: 4 revisions from :gentoo-wiki:Template:Documentation/core2: import from wiki.gentoo.org

<includeonly>{{documentation/core
| heading = {{{heading|¬}}} 
| heading-style = {{{heading-style|}}}
| content = {{{content|}}}
| link box = {{{link box|}}} 

| docpage =
{{#if: {{{1|}}}
| {{{1|}}}
| {{{docspace|{{NAMESPACE}}}}}:{{{template page|{{PAGENAME}}}}}/doc
}}
| doc exist =
{{#ifexist:
{{#if: {{{1|}}}
| {{{1|}}} 
| {{{docspace|{{NAMESPACE}}}}}:{{{template page|{{PAGENAME}}}}}/doc
}}
| yes
}}
| docname fed =
{{#if: {{{1|}}}
| yes
}}

| sandbox =
{{{docspace|{{NAMESPACE}}}}}:{{{template page|{{PAGENAME}}}}}/sandbox
| testcases =
{{{docspace|{{NAMESPACE}}}}}:{{{template page|{{PAGENAME}}}}}/testcases

| template page =
{{NAMESPACE}}:{{{template page|{{PAGENAME}}}}}

}}</includeonly><noinclude>
[[Category:Template cores]]
</noinclude>

Template:MessageBox

2014-08-22T07:42:00Z

Administrator: 5 revisions from :gentoo-wiki:Template:MessageBox: import from wiki.gentoo.org

<div class="gw-msgbox" style="border: 1px solid {{{color|#333}}}; background-color: {{{bgcol|#F3F3F3}}}; overflow: auto"><div class="gw-msgbox-title" style="margin: -3px 3px -3px -3px; background-color: {{{color|#333}}}; color: {{{titlecol|white}}}">{{{1}}}</div><div class="gw-msgbox-content">{{{2}}}</div></div><noinclude>
{{Documentation}}
</noinclude>

Template:Warning/core

2014-08-22T07:41:18Z

Administrator: 1 revision from :gentoo-wiki:Template:Warning/core: import from wiki.gentoo.org

{{MessageBox|{{{1}}}|{{{2}}}|color=#A40000}}<noinclude>
[[Category:Template cores]]
</noinclude>

Template:Documentation

2014-08-22T07:41:00Z

Administrator: 2 revisions from :gentoo-wiki:Template:Documentation

Template:Warning

2014-08-22T07:40:38Z

Administrator: 13 revisions from :gentoo-wiki:Template:Warning: import from wiki.gentoo.org

{{Warning/core|Warning|{{{1}}}|color=#A40000}}<noinclude>
{{Documentation}}
</noinclude>

MediaWiki:Sidebar

2014-04-21T17:38:28Z

Administrator:

MediaWiki:Sidebar

2014-03-11T09:09:00Z

Administrator:

Category:Mapping (REST - LDAP)

2014-01-08T11:50:29Z

Administrator: Created page with "Category: Development"

[[Category: Development]]

MediaWiki:Sidebar

2013-12-24T07:54:55Z

Administrator:

MediaWiki:Sidebar

2013-12-23T16:00:20Z

Administrator:

MediaWiki:Sidebar

2013-12-23T15:58:45Z

Administrator:

Category:Self-Service Modules

2013-12-23T15:57:12Z

Administrator: Created page with "The functionality of the stoney cloud can be expanded with the help of modules. All the main modules have stoney and their functionality in their names. For example '''stoney ..."

The functionality of the stoney cloud can be expanded with the help of modules. All the main modules have stoney and their functionality in their names. For example '''stoney cloud''' or '''stoney safe'''.

== Existing modules ==
* [[:Category:stoney core|stoney core]]: Main framework responsible for shared functionality (also called self-care):
** User management, rights and roles.
** A consistent look and feel between modules.
** Internationalization.
* [[:Category:stoney backup|stoney backup]]: A on-line backup service for desktops, servers and virtual machines.

== Work in progress ==
* [[:Category:stoney vm|stoney vm]]: A simplified sub set of the [[:Category:stoney conductor|stoney conductor]] functionality.
* [[:Category:stoney mail|stoney mail]]: Mail service with or without group-ware (based on Open-Xchange).

== Planned ==
* [[:Category:stoney conductor|stoney conductor]]: Responsible for:
** Storage allocation
** Network configuration
** Virtual machine profiles
** Virtual machine templates
** Virtual machines
** Virtual machine snapshots
** Virtual machine full backups
* [[:Category:stoney monitor|stoney monitor]]: Monitoring (with Zabbix). ((monitoring, control, inspection, interception, surveillance)
* [[:Category:stoney orchestra|stoney orchestra]]: Configuration Management (with Puppet).
* [[:Category:stoney box|stoney box]]: An on-line storage service (will support WebDAV via HTTPS and SFTP, later CIFS as well).
* [[:Category:stoney web|stoney web]]: Web & Database hosting service (based on Apache and MariaDB).

stoney core: Resellers Resource Mapping (REST - LDAP)

2013-12-12T15:05:42Z

Administrator: Created page with "Category:Mapping (LDAP - JSON)"

[[Category:Mapping (LDAP - JSON)]]

stoney core: Resellers Resource - REST API

2013-12-12T15:01:49Z

Administrator: Administrator moved page stoney core: REST API - Resellers Resource to stoney core: Resellers Resource - REST API without leaving a redirect

= Overview =
The reseller resource represents the bla, bla, bla...

= Reseller resource methods =
== Reseller creation (POST) ==
To create a new reseller the client needs to send a HTTP <code>POST</code> request on the reseller collection resource URI <code>https://api.example.com/v1/resellers</code> (also see [[Application_Programming_Interface_(API)#Base_URI|Base URI]]), including the associated reseller informations.
The service will generate a new reseller and responds with a HTTP status code <code>201</code> (Created) on success. The newly created reseller URI is returned within the HTTP location header, which can be used by the client to gather informations about the new reseller.

=== Reseller creation request message ===
{| class="wikitable sortable" style="width: 100%;"
|-
! HTTP request part
! Content
! Example

|-
| Request lines
|<pre>
POST <Request-URI> HTTP 1.1
HOST: <Host>
</pre>
|<pre>
POST /v1/resellers/ HTTP 1.1
HOST: api.example.com
</pre>

|-
| Request headers
| <pre>
Accept: <Type>/<Subtype>
Content-Type: <Type>/<Subtype>
</pre>
| <pre>
Accept: application/json
Content-Type: application/json
</pre>

|-
| [[#Reseller_creation_request_message_body|Request body]]
| JSON object
| <pre>{ ... }</pre>

|}

==== Reseller creation request message body ====
{| class="wikitable sortable" style="width: 100%;" id="reseller_object"
|-
|+ align="top" style="text-align:left;"|Reseller Object
! Parameter name
! Data type
! Mandatory
! Description
! Allowed content
! Default value
! Example

|-
|<code>isCompany</code>
|boolean
|yes
|<code>true</code> if the reseller represents a company, <code>false</code> if it's an individual person.
|<code>true</code> or <code>false</code>
|
|<pre>isCompany: true</pre>

|-
|[[#billingAddress_object|<code>billingAddress</code>]]
|object
|yes
|An object holding the billing address informations for the given reseller. Refere to the [[#billingAddress_object|billingAddress object table]] for more informations.
|
|
|<pre>
"billingAddress":
{
"organizationName": "Reseller Ltd.",
"gender": 'm',
"givenName": "Name",
"surname": "Surname",
"postalAddress": "Street Number",
"countryCode": "CH",
"postalCode": "Postal Code",
"localityName": "Locality",
"preferredLanguage": "en-GB",
"mail": "name.surname@example.com",
"telephoneNumber": "+41 00 000 00 00",
"mobileTelephoneNumber": "+41 00 000 00 00",
"websiteURL": "https://www.example.com/"
}
</pre>

|}

{| class="wikitable sortable" style="width: 100%;" id="billingAddress_object"
|-
|+ align="top" style="text-align:left;"|billingAddress Object
!Parameter name
!Data type
!Mandatory
!Description
!Allowed content
!Default value
!Example

|-
|<code>organizationName</code>
|string
|no
|The name of the organization.
|@TODO: Add regex
|
|<pre>"organizationName": "Reseller Ltd."</pre>

|-
|<code>gender</code>
|string
|yes
|The gender of the address holder
|Either <code>f</code> for female, <code>m</code> for male or <code>n</code> for neutral.
|
|<pre>"gender": "f"</pre>

|-
|<code>givenName</code>
|string
|yes
|The given name (first name or forename) of the address holder.
|@TODO: Add regex
|
|<pre>"givenName": "Name"</pre>

|-
|<code>surname</code>
|string
|yes
|The surname (last name or family name) of the address holder.
|@TODO: Add regex
|
|<pre>"surname": "Surname"</pre>

|-
|<code>postalAddress</code>
|string
|yes
|
|@TODO: Add regex
|
|<pre>"postalAddress": ""</pre>

|-
|<code>countryCode</code>
|string
|yes
|
|@TODO: Add regex
|
|<pre>"countryCode": ""</pre>

|-
|<code>postalCode</code>
|string
|yes
|
|@TODO: Add regex
|
|<pre>"postalCode": ""</pre>

|-
|<code>localityName</code>
|string
|yes
|
|@TODO: Add regex
|
|<pre>"localityName": ""</pre>

|-
|<code>preferredLanguage</code>
|string
|yes
|
|@TODO: Add regex
|
|<pre>"preferredLanguage": ""</pre>

|-
|<code>mail</code>
|string
|yes
|
|@TODO: Add regex
|
|<pre>"mail": ""</pre>

|-
|<code>telephoneNumber</code>
|string
|yes
|
|@TODO: Add regex
|
|<pre>"telephoneNumber": ""</pre>

|-
|<code>mobileTelephoneNumber</code>
|string
|yes
|
|@TODO: Add regex
|
|<pre>"mobileTelephoneNumber": ""</pre>

|-
|<code>websiteURL</code>
|string
|yes
|
|@TODO: Add regex
|
|<pre>"websiteURL": ""</pre>

|}

=== Reseller creation response message ===
{| class="wikitable sortable" style="width: 100%;"
|-
! Status Line
! Content
! Example

|-
| Request lines
| <pre>HTTP/1.1 <HTTP-Status-Code> <HTTP-Status-Message></pre>
| <pre>HTTP/1.1 201 Created</pre>

|-
| Response headers
|<pre>
Content-Type: <Type>/<Subtype>; charset=<Charset>
Location: <Location-URI>
</pre>
|<pre>
Content-Type: Content-Type: application/json; charset=UTF-8
Location: https://api.example.com/v1/resellers/4000001
</pre>

|-
| [[#Reseller_creation_response_message_body|Response body]]
| JSON object
| <pre>{ ... }</pre>

|}

==== Reseller creation response message body ====
{| class="wikitable sortable" style="width: 100%;" id="reseller_creation_response_object"
|-
|+ align="top" style="text-align:left;"|Reseller Creation Response Object
! Parameter name
! Data type
! Mandatory
! Description
! Allowed content
! Default value
! Example

|-
|<code>id</code>
|integer
|yes
|The identification number of the newly created reseller resource.
|@TODO add regex
|
|<pre>id: 4000001</pre>

|-
|<code>location</code>
|string
|yes
|The location URI of the newly created reseller resource, corresponds with the HTTP location header.
|@TODO add link to URI RFC
|
|<pre>location: https://api.example.com/v1/resellers/4000001</pre>

|-
|[[Application_Programming_Interface_(API)#Error_codes_and_responses|<code>error</code>]]
|object
|no
|In case of a failure, an error object with the appropriate error messages will be returned. Refer to the [[Application_Programming_Interface_(API)#Error_codes_and_response|Error codes and response chapter]] for more informations.
|
|
|<pre>error { ... }</pre>

|}

== Reseller retrieval (GET) ==
== Reseller update (PUT) ==
== Reseller partly update (PATCH) ==
== Reseller deletion (DELETE) ==
= Links =

[[Category:REST API]]

stoney core: Resellers Resource - REST API

2013-12-12T14:58:33Z

Administrator: Administrator moved page stoney core: REST API - Reseller Resource to stoney core: REST API - Resellers Resource without leaving a redirect

stoney core: Resellers Resource - REST API

2013-12-12T14:57:23Z

Administrator: Administrator moved page REST API - Reseller Resource to stoney core: REST API - Reseller Resource without leaving a redirect

MediaWiki:Sidebar

2013-10-15T13:21:46Z

Administrator:

MediaWiki:Sidebar

2013-10-13T11:09:51Z

Administrator:

MediaWiki:Sidebar

2013-10-12T17:37:48Z

Administrator:

Category:stoney conductor

2013-10-12T14:52:01Z

Administrator: Created page with "Category:Modules"

[[Category:Modules]]

MediaWiki:Sidebar

2013-10-06T13:00:33Z

Administrator:

MediaWiki:Sidebar

2013-07-31T08:11:04Z

Administrator:

MediaWiki:Sidebar

2013-07-18T08:42:45Z

Administrator:

Presentations

2013-05-26T17:30:15Z

Administrator:

== 2013 ==
* [[Media:Cloud_Management_und_Automatisierung_2013.pdf | Cloud Management und Automatisierung mit Open Source Software]] in German at the yearly [http://www.stepping-stone.ch/ stepping stone GmbH] event in Bern on the 24th of May 2013.

== 2012 ==
* [[Media:Open_Source_Cloud_Software_–_Made_in_Switzerland.pdf‎ | Open Source Cloud Software – Made in Switzerland]] in English at the first [http://www.ch-open.ch/events/archiv/2012/190612-open-cloud-day/ Open Cloud Day]] in Bern on the 19th of June 2012.
* [[Media:Managed_Cloud_Services_2012_two_master.pdf | Managed Cloud Services]] in German at the yearly [http://www.stepping-stone.ch/ stepping stone GmbH] event in Bern on the 11th of May 2012.

== 2011 ==
* [[Media:FOSS-Cloud.pdf| FOSS-Cloud presentation]] in German at the 20 year Linux party at the [http://www.puzzle.ch/ Puzzle ITC premises] in Bern on the 30th of November 2011.
* [[Media:2011_Cloud_Computing_-_Chancen_und_Risiken.pdf‎ | Cloud Computing – Chancen und Risiken]] in German at the yearly [http://www.stepping-stone.ch/ stepping stone GmbH] event in Bern on the 13th of May 2011.

File:Cloud Management und Automatisierung 2013.pdf

2013-05-26T17:27:53Z

Administrator:

File:Open Source Cloud Software – Made in Switzerland.pdf

2013-05-26T17:27:19Z

Administrator:

File:Managed Cloud Services 2012 two master.pdf

2013-05-26T17:26:57Z

Administrator:

File:FOSS-Cloud.pdf

2013-05-26T17:26:20Z

Administrator:

File:2011 Cloud Computing - Chancen und Risiken.pdf

2013-05-26T17:25:38Z

Administrator:

Presentations

2013-05-26T17:21:59Z

Administrator: Created page with "* Open Source Cloud Software – Made in Switzerland in English at the first [http://www.ch-open.ch/event..."

* [[Media:Open_Source_Cloud_Software_–_Made_in_Switzerland.pdf‎ | Open Source Cloud Software – Made in Switzerland]] in English at the first [http://www.ch-open.ch/events/archiv/2012/190612-open-cloud-day/ Open Cloud Day]] in Bern on the 19th of June 2012.
* [[Media:Managed_Cloud_Services_2012_two_master.pdf | Managed Cloud Services]] in German at the yearly [http://www.stepping-stone.ch/ stepping stone GmbH] event in Bern on the 11th of May 2012.
* [[Media:FOSS-Cloud.pdf| FOSS-Cloud presentation]] in German at the 20 year Linux party at the [http://www.puzzle.ch/ Puzzle ITC premises] in Bern on the 30th of November 2011.
* [[Media:2011_Cloud_Computing_-_Chancen_und_Risiken.pdf‎ | Cloud Computing – Chancen und Risiken]] in German at the yearly [http://www.stepping-stone.ch/ stepping stone GmbH] event in Bern on the 13th of May 2011.

Main Page

2013-05-26T17:20:50Z

Administrator:

The stoney cloud is an Open Source Cloud Management turnkey solution to build public and private clouds.

Thanks to the intuitive and simple graphical user interface, the operation of your stoney cloud is a mere child's play.

= Characteristics =
* Turnkey solution to build public and private clouds.
* Runs unmodified Windows and Linux servers as well as desktops on commodity hardware.
* Persistent and non-persistent virtual machines.
* User friendly web interface to manage every aspect of your cloud.
* Backups configurable via web interface.
* Clear separation between the infrastructure and application and service layer.
* Integration and provisioning of the [http://www.zabbix.com/ Zabbix] Monitoring solution.
* Integration and provisioning of the [https://puppetlabs.com/ Puppet] Configuration Management solution.
* Multi-tenant capable (not yet implemented in the web interface).

__NOTOC__
__NOEDITSECTION__

MediaWiki:Sidebar

2013-05-26T17:20:15Z

Administrator:

MediaWiki:Sidebar

2013-05-26T17:19:48Z

Administrator:

MediaWiki:Sidebar

2013-05-26T17:14:41Z

Administrator: Created page with "* Navigation ** stoney cloud – Open Source Cloud Management|Home ** Category:Documentation|Documentation ** Presentations|Presentations ** Roadmap|Roadmap * Wiki ** recentch..."