Difference between revisions of "stoney maintenance: OpenLDAP directory data organisation"
From stoney cloud
| [checked revision] | [checked revision] |
(→Maintenance Unit Example) |
(→Maintenance Unit Example) |
||
| Line 376: | Line 376: | ||
=== Maintenance Unit Example === | === Maintenance Unit Example === | ||
| − | Each maintenance unit has its own leaf. | + | Each maintenance unit has its own leaf. A monthly maintenance window is the norm. |
| − | Maintenance window every | + | Maintenance window every month on the second Tuesday of the month between 09:30 and 10:30, starting on Tuesday, the 14th of April 2015. |
<source lang="ldif"> | <source lang="ldif"> | ||
| − | |||
objectclass: top | objectclass: top | ||
objectclass: sstMaintenanceObjectClass | objectclass: sstMaintenanceObjectClass | ||
| Line 388: | Line 387: | ||
sstIsActive: TRUE | sstIsActive: TRUE | ||
sstServicePriority: 3 | sstServicePriority: 3 | ||
| − | sstCronRepeatType: | + | sstCronRepeatType: monthly # repeat type is monthly |
| − | sstCronInterval: 1 # | + | sstCronInterval: 1 # repeat every month |
| − | sstCronStartDate: | + | sstCronStartDate: 20150414 # starting on Monday, the 14th of April 2015 |
| + | sstCronOccurrenceInMonth: 2 # second occurence | ||
| + | sstCronDayOfWeek: 1 # Monday | ||
sstCronMinute: 30 # 30 Minutes past the hour | sstCronMinute: 30 # 30 Minutes past the hour | ||
sstCronHour: 9 # 9 am | sstCronHour: 9 # 9 am | ||
| Line 402: | Line 403: | ||
</source> | </source> | ||
| − | Maintenance window every | + | Other possible maintenance windows range from daily maintenance windows to biyearly maintenance windows. |
| + | |||
| + | Maintenance window every day between 09:30 and 10:30, starting on Monday, the 5th of January 2015. | ||
<source lang="ldif"> | <source lang="ldif"> | ||
| − | |||
objectclass: top | objectclass: top | ||
| − | objectclass: | + | objectclass: sstMaintenanceObjectClass |
| − | objectclass: | + | objectclass: sstRelationship |
uid: 4000003 | uid: 4000003 | ||
description: The maintenance leaf for the virtual machine with the uid 1234567. | description: The maintenance leaf for the virtual machine with the uid 1234567. | ||
| Line 413: | Line 415: | ||
sstServicePriority: 3 | sstServicePriority: 3 | ||
sstCronRepeatType: daily # repeat type is daily | sstCronRepeatType: daily # repeat type is daily | ||
| − | sstCronInterval: | + | sstCronInterval: 1 # repeated every day |
| − | sstCronStartDate: | + | sstCronStartDate: 20150105 # starting on the fifth of January 2015 |
sstCronMinute: 30 # 30 Minutes past the hour | sstCronMinute: 30 # 30 Minutes past the hour | ||
sstCronHour: 9 # 9 am | sstCronHour: 9 # 9 am | ||
| − | sstCronDuration: 60 # 60 minutes (one hour | + | sstCronDuration: 60 # 60 minutes (one hour |
sstInformPersonUID: 4000002 | sstInformPersonUID: 4000002 | ||
sstResponsiblePersonUID: 4000002 | sstResponsiblePersonUID: 4000002 | ||
Revision as of 12:14, 19 April 2015
Contents
Abstract
This document describes the OpenLDAP directory data organisation for the stoney maintenance service.
Data Organisation
The following chapters explain the data organisation of the stoney cloud OpenLDAP directory, in this case we looking at the maintenance service.
Maintenance
The following LDIF shows the maintenance entry of the whole OpenLDAP directory tree for the stoney cloud:
dn: ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: organizationalUnit ou: maintenance description: The sub tree for the maintenance (configuration management) service.
Maintenance Configuration
The sub tree for the configuration of the maintenance service:
dn: ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: organizationalUnit ou: configuration description: The sub tree for the configuration of the maintenance service.
Maintenance Configuration Reseller
The sub tree for the reseller specific maintenance service settings:
dn: ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: organizationalUnit ou: reseller description: The sub tree for the reseller specific maintenance service settings.
The sub tree for the specific maintenance service settings for the reseller Reseller Ltd. with the uid 4000000.
dn: uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: sstReseller objectclass: sstServiceConfigurationObjectClass uid: 4000000 o: Reseller Ltd. description: The sub tree for the specific maintenance service settings for the reseller Reseller Ltd. with the uid 4000000. sstIsActive: TRUE sstIsDefault: TRUE sstBelongsToResellerUID: 4000000
The following table describes the different attributes:
| Attribute | |
|
|
|
Description |
| uid | |
|
|
|
A unique integer value with 7 digits or more. For example: 4000000.
|
| o | |
|
|
|
The company name, for example: Reseller Ltd..
|
| description | |
|
|
|
The description of the leaf. |
| sstIsActive | |
|
|
|
Is the entry active? Either TRUE (yes) or FALSE (no).
|
| sstIsDefault | |
|
|
|
Contains the leaf a default entry? Either TRUE (yes) or FALSE (no). If sstIsDefault is set to TRUE, this entry acts as a fall back configuration. In other words: If a reseller doesn't have his own maintenance service configuration, then this on will be used.
|
| sstBelongsToResellerUID | |
|
|
|
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.
Maintenance Configuration Reseller Notification Settings
The sub tree stores the notification information for the maintenance service for the reseller Reseller Ltd. with the uid 4000000. This information is used as a fallback. The lookup is as follows:
- Unit:
uid=4000003,ou=units,ou=maintenance,ou=services,dc=stoney-cloud,dc=org. - Customer:
ou=notifications,uid=4000001,ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org. - Reseller:
ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org. - Default Reseller:
ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
The idea is, that even if somebody forgot to define something, no maintenance window will be lost or forgotten.
dn: ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: organizationalUnit objectclass: sstNotificationObjectClass ou: notifications description: The sub tree stores the notification information for the maintenance service for the reseller Reseller Ltd. with the uid 4000000. sstInformPersonUID: 4000002 sstResponsiblePersonUID: 4000002 sstNotificationWarning: maintenance
The following table describes the different attributes:
| Attribute | |
|
|
|
Description |
| ou | |
|
|
|
The name of this leaf. |
| description | |
|
|
|
The description of the leaf. |
| sstInformPersonUID | |
|
|
|
Stores the persons UID the notification will be sent to. For example: 4000002. This means the information of the person is stored under the dn: uid=4000002,ou=people,dc=stoney-cloud,dc=org.
|
| sstResponsiblePersonUID | |
|
|
|
Stores the persons UID, who is responsible for the maintenance. The notification will be sent to this person. For example: 4000002. This means the information of the person is stored under the dn: uid=4000002,ou=people,dc=stoney-cloud,dc=org.
|
| sstNotificationWarning | |
|
|
|
This multi-valued attribute will be used to turn single notifications on or off. Currently, the only allowed value is maintenance. The value (name) corresponds with the template dn. For example: ou=maintenance,ou=templates,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
|
Legend:
- x: Mandatory in all cases.
Maintenance Configuration Reseller Notification Templates
This sub tree contains the notification templates for the maintenance service for the reseller Reseller Ltd. with the uid 4000000:
dn: ou=templates,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: organizationalUnit ou: templates description: This sub tree contains the templates for the maintenance service for the reseller Reseller Ltd. with the uid 4000000.
Maintenance Configuration Customers
The sub tree for the customers specific maintenance service settings:
dn: ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: organizationalUnit ou: customer description: The sub tree for the customer specific maintenance service settings.
The sub tree for the specific maintenance service settings for the customer Customer Ltd. with the uid 4000001.
dn: uid=4000000,ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: sstCustomer objectclass: sstServiceConfigurationObjectClass uid: 4000000 o: Customer Ltd. description: The sub tree for the specific maintenance service settings for the customer Customer Ltd. with the uid 4000001. sstIsActive: TRUE sstBelongsToResellerUID: 4000000 sstBelongsToCustomerUID: 4000001
The following table describes the different attributes:
| Attribute | |
|
|
|
Description |
| uid | |
|
|
|
A unique integer value with 7 digits or more. For example: 4000001.
|
| o | |
|
|
|
The company name, for example: Customer Ltd..
|
| description | |
|
|
|
The description of the leaf. |
| sstIsActive | |
|
|
|
Is the entry active? Either TRUE (yes) or FALSE (no).
|
| sstBelongsToResellerUID | |
|
|
|
Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000.
|
| sstBelongsToResellerUID | |
|
|
|
Stores the customer UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000001.
|
Legend:
- x: Mandatory in all cases.
Maintenance Configuration Customers Notification Settings
The sub tree stores the notification information for the maintenance service for the customer Customer Ltd. with the uid 4000001. This information is used as a fallback. The lookup is as follows:
- Unit:
uid=4000003,ou=units,ou=maintenance,ou=services,dc=stoney-cloud,dc=org. - Customer:
ou=notifications,uid=4000001,ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org. - Reseller:
ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org. - Default Reseller:
ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
The idea is, that even if somebody forgot to define something, no maintenance window will be lost or forgotten.
dn: ou=notifications,uid=4000001,ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: organizationalUnit objectclass: sstNotificationObjectClass ou: notifications description: The sub tree stores the notification information for the maintenance service for the customer Customer Ltd. with the uid 4000001. sstInformPersonUID: 4000002 sstResponsiblePersonUID: 4000002 sstNotificationWarning: maintenance
The following table describes the different attributes:
| Attribute | |
|
|
|
Description |
| ou | |
|
|
|
The name of this leaf. |
| description | |
|
|
|
The description of the leaf. |
| sstInformPersonUID | |
|
|
|
Stores the persons UID the notification will be sent to. For example: 4000002. This means the information of the person is stored under the dn: uid=4000002,ou=people,dc=stoney-cloud,dc=org.
|
| sstResponsiblePersonUID | |
|
|
|
Stores the persons UID, who is responsible for the maintenance. The notification will be sent to this person. For example: 4000002. This means the information of the person is stored under the dn: uid=4000002,ou=people,dc=stoney-cloud,dc=org.
|
| sstNotificationWarning | |
|
|
|
This multi-valued attribute will be used to turn single notifications on or off. Currently, the only allowed value is maintenance. The value (name) corresponds with the template dn. For example: ou=maintenance,ou=templates,uid=4000001,ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
|
Legend:
- x: Mandatory in all cases.
Maintenance Configuration Customers Notification Templates
This sub tree contains the notification templates for the maintenance service for the customer Customer Ltd. with the uid 4000001:
dn: ou=templates,uid=4000001,ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: organizationalUnit ou: templates description: This sub tree contains the templates for the maintenance service for the customer Customer Ltd. with the uid 4000001.
Maintenance Units
The sub tree for the units of the maintenance service:
dn: ou=units,ou=maintenance,ou=services,dc=stoney-cloud,dc=org objectclass: top objectclass: organizationalUnit ou: units description: The sub tree for the units of the maintenance service.
Maintenance Unit Example
Each maintenance unit has its own leaf. A monthly maintenance window is the norm.
Maintenance window every month on the second Tuesday of the month between 09:30 and 10:30, starting on Tuesday, the 14th of April 2015.
objectclass: top objectclass: sstMaintenanceObjectClass objectclass: sstRelationship uid: 4000003 description: The maintenance leaf for the virtual machine with the uid 1234567. sstIsActive: TRUE sstServicePriority: 3 sstCronRepeatType: monthly # repeat type is monthly sstCronInterval: 1 # repeat every month sstCronStartDate: 20150414 # starting on Monday, the 14th of April 2015 sstCronOccurrenceInMonth: 2 # second occurence sstCronDayOfWeek: 1 # Monday sstCronMinute: 30 # 30 Minutes past the hour sstCronHour: 9 # 9 am sstCronDuration: 60 # 60 minutes (one hour) sstInformPersonUID: 4000002 sstResponsiblePersonUID: 4000002 sstNotificationWarning: maintenance sstBelongsToServiceUID: 1234567 sstBelongsToResellerUID: 4000000 sstBelongsToCustomerUID: 4000001
Other possible maintenance windows range from daily maintenance windows to biyearly maintenance windows.
Maintenance window every day between 09:30 and 10:30, starting on Monday, the 5th of January 2015.
objectclass: top objectclass: sstMaintenanceObjectClass objectclass: sstRelationship uid: 4000003 description: The maintenance leaf for the virtual machine with the uid 1234567. sstIsActive: TRUE sstServicePriority: 3 sstCronRepeatType: daily # repeat type is daily sstCronInterval: 1 # repeated every day sstCronStartDate: 20150105 # starting on the fifth of January 2015 sstCronMinute: 30 # 30 Minutes past the hour sstCronHour: 9 # 9 am sstCronDuration: 60 # 60 minutes (one hour sstInformPersonUID: 4000002 sstResponsiblePersonUID: 4000002 sstNotificationWarning: maintenance sstBelongsToServiceUID: 1234567 sstBelongsToResellerUID: 4000000 sstBelongsToCustomerUID: 4000001
The following table describes the different attributes:
| Attribute | |
|
|
|
Description |
| uid | |
|
|
|
A unique integer value with 7 digits or more. For example: 4000003.
|
| description | |
|
|
|
The description of the leaf. |
| sstIsActive | |
|
|
|
Is the entry active? Either TRUE (yes) or FALSE (no).
|
| sstServicePriority | |
|
|
|
The maintenance service level. The possible maintenance service levels:
For more information on these maintenance service levels, visit stepping stone GmbH web page. |
| sstCronMinute | |
|
|
|
|
| sstCronHour | |
|
|
|
|
| sstCronDuration | |
|
|
|
|
| sstCronDayOfMonth | |
|
|
|
We have the day of week (0 - 6) (Sunday=0) plus the dividing sign "#' and then the occurrence (1 - 5). For example:
|
| sstInformPersonUID | |
|
|
|
Stores the persons UID the notification will be sent to. For example: 4000002. This means the information of the person is stored under the dn: uid=4000002,ou=people,dc=stoney-cloud,dc=org.
|
| sstResponsiblePersonUID | |
|
|
|
Stores the persons UID, who is responsible for the maintenance. The notification will be sent to this person. For example: 4000002. This means the information of the person is stored under the dn: uid=4000002,ou=people,dc=stoney-cloud,dc=org.
|
| sstNotificationWarning | |
|
|
|
This multi-valued attribute will be used to turn single notifications on or off. Currently, the only allowed value is maintenance. The value (name) corresponds with the template dn. For example: ou=maintenance,ou=templates,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
|
| sstBelongsToServiceUID | |
|
|
|
|
| sstBelongsToResellerUID | |
|
|
|
Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000.
|
| sstBelongsToCustomerUID | |
|
|
|
Stores the customer UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000001.
|
Legend:
- x: Mandatory in all cases.
