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

From stoney cloud
Jump to: navigation, search
[checked revision][checked revision]
(→‎Maintenance - Configuration - Service (Puppet) roles)
Line 45: Line 45:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
== Maintenance - Units ==
+
== Maintenance - Host groups ==
−
The sub tree for the units of the monitoring service:
+
The sub tree for the host groups of the monitoring service:
 
<syntaxhighlight lang='ldif'>
 
<syntaxhighlight lang='ldif'>
−
dn: ou=units,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
+
dn: ou=host groups,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
 
objectclass: top
 
objectclass: top
 
objectclass: organizationalUnit
 
objectclass: organizationalUnit
 
ou: units
 
ou: units
−
description: The sub tree for the units of the monitoring service.
+
description: The sub tree for the host groups of the monitoring service.
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
=== Maintenance - Units example ===
+
== Maintenance - Hosts ==
−
Each monitoring unit has its own leaf. A monthly monitoring window is the norm.
+
The sub tree for the hosts of the monitoring service:
−
 
+
−
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.
+
−
 
+
−
The '''sstBelongsToServiceUID''' lookup is as follows:
+
−
# '''OpenStack unit''' (server): <code>ou=units,ou=openstack,ou=services,dc=stoney-cloud,dc=org</code>.
+
−
# '''Virtual Machine:''' <code>ou=virtual machines,ou=virtualization,ou=services,dc=stoney-cloud,dc=org</code>.
+
−
# '''vServer:''' <code>ou=vservers,ou=services,dc=stoney-cloud,dc=org</code>.
+
−
# '''Dedicated Server:''' <code>ou=dedicated servers,ou=services,dc=stoney-cloud,dc=org</code> (not implemented yet).
+
−
# '''External Server:''' <code>ou=external servers,ou=services,dc=stoney-cloud,dc=org</code> (not implemented yet).
+
−
 
+
−
The idea is, that we presume, that most of the monitoring units belong to OpenStack units (servers) running on our OpenStack based stoney cloud installation.
+
−
 
+
−
In the example below, the service UID <code>sstBelongsToServiceUID: 1234567</code> points to [[stoney_conductor:_OpenLDAP_directory_data_organisation#Virtual_Machine | virtual machine]] with the <code>b543f88f-dffe-426f-86d3-c7ff85c16d2a</code> and the <code>uid: 1234567</code>.
+
 
<syntaxhighlight lang='ldif'>
 
<syntaxhighlight lang='ldif'>
−
dn: uid=4000003,ou=units,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
+
dn: ou=hosts,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
 
objectclass: top
 
objectclass: top
−
objectclass: sstMaintenanceObjectClass
+
objectclass: organizationalUnit
−
objectclass: sstRelationship
+
ou: units
−
uid: 4000003
+
description: The sub tree for the hosts of the monitoring service.
−
description: The monitoring leaf for the virtual machine with the uid 1234567.
+
−
sstIsActive: TRUE
+
−
sstBillable: TRUE
+
−
sstServicePriority: 3
+
−
sstServiceAutomated: TRUE
+
−
sstCronRepeatType: monthly    # repeat type is monthly
+
−
sstCronInterval: 1            # repeat every month
+
−
sstCronStartDate: 20150414    # starting on Tuesday, the 14th of April 2015
+
−
sstCronOccurrenceInMonth: 2    # second occurence
+
−
sstCronDayOfWeek: 2            # Tuesday
+
−
sstCronMinute: 30              # 30 Minutes past the hour
+
−
sstCronHour: 9                # 9 am
+
−
sstCronDuration: 60            # 60 minutes (one hour)
+
−
sstInformPersonUID: 4000002
+
−
sstResponsiblePersonUID: 4000002
+
−
sstResponsibleDeputyPersonUID: 4000002
+
−
sstNotificationWarning: reminder
+
−
sstIsMultiTenant: FALSE
+
−
sstBelongsToServiceUID: 1234567
+
−
sstBelongsToResellerUID: 4000000
+
−
sstBelongsToCustomerUID: 4000001
+
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
Other possible monitoring windows range from daily monitoring windows to bi yearly monitoring windows. The following examples just show the relevant attributes.
+
== Maintenance - User groups ==
−
 
+
The sub tree for the user groups of the monitoring service:
−
Maintenance window every day between 09:30 and 10:30, starting on Monday, the 5th of January 2015.
+
 
<syntaxhighlight lang='ldif'>
 
<syntaxhighlight lang='ldif'>
−
sstCronRepeatType: daily      # repeat type is daily
+
dn: ou=user groups,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
−
sstCronInterval: 1            # repeated every day
+
objectclass: top
−
sstCronStartDate: 20150105    # starting on the fifth of January 2015
+
objectclass: organizationalUnit
−
sstCronMinute: 30              # 30 Minutes past the hour
+
ou: units
−
sstCronHour: 9                # 9 am
+
description: The sub tree for the user groups of the monitoring service.
−
sstCronDuration: 60            # 60 minutes (one hour)
+
 
</syntaxhighlight>
 
</syntaxhighlight>
−
 
−
Maintenance window every second day between 09:30 and 10:30, starting on Monday, the 5th of January 2015.
 
−
<syntaxhighlight lang='ldif'>
 
−
sstCronRepeatType: daily      # repeat type is daily
 
−
sstCronInterval: 2            # repeat every second 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)
 
−
</syntaxhighlight>
 
−
 
−
Maintenance window every two weeks on Monday between 09:30 and 10:30, starting on Monday, the 13th of April 2015.
 
−
<syntaxhighlight lang='ldif'>
 
−
sstCronRepeatType: weekly      # repeat type is weekly
 
−
sstCronInterval: 2            # repeat every second week
 
−
sstCronStartDate: 20150413    # starting on Monday, the 13th of April 2015
 
−
sstCronDayOfWeek: 1            # on Monday
 
−
sstCronMinute: 30              # 30 Minutes past the hour
 
−
sstCronHour: 9                # 9 am
 
−
sstCronDuration: 60            # 60 minutes (one hour)
 
−
</syntaxhighlight>
 
−
 
−
Maintenance window every six months on the 15. of the month between 09:30 and 10:30, starting on Wednesday, the 15th of April 2015.
 
−
<syntaxhighlight lang='ldif'>
 
−
sstCronRepeatType: monthly    # repeat type is monthly
 
−
sstCronInterval: 6            # repeat every six months
 
−
sstCronStartDate: 20150415    # starting on Wednesday, the 15th of April 2015
 
−
sstCronDayOfMonth: 15          # on the 15th day of the month
 
−
sstCronMinute: 30              # 30 Minutes past the hour
 
−
sstCronHour: 9                # 9 am
 
−
sstCronDuration: 60            # 60 minutes (one hour)
 
−
</syntaxhighlight>
 
−
 
−
Maintenance window every six months on the third Monday of the month between 09:30 and 10:30, starting on Monday, the 20th of April 2015.
 
−
<syntaxhighlight lang='ldif'>
 
−
sstCronRepeatType: monthly    # repeat type is monthly
 
−
sstCronInterval: 6            # repeat every six months
 
−
sstCronStartDate: 20150420    # starting on Monday, the 20th of April 2015
 
−
sstCronOccurrenceInMonth: 3    # third occurence
 
−
sstCronDayOfWeek: 1            # Monday
 
−
sstCronMinute: 30              # 30 Minutes past the hour
 
−
sstCronHour: 9                # 9 am
 
−
sstCronDuration: 60            # 60 minutes (one hour)
 
−
</syntaxhighlight>
 
−
 
−
Maintenance window every year on the 15th of March between 09:30 and 10:30, starting on Wednesday, the 11th of March 2015.
 
−
<syntaxhighlight lang='ldif'>
 
−
sstCronRepeatType: yearly      # repeat type is yearly
 
−
sstCronInterval: 1            # repeat every year
 
−
sstCronStartDate: 20150311    # starting on Wednesday, the 11th of March 2015
 
−
sstCronDayOfMonth: 11          # on the 11th day of the month
 
−
sstCronMinute: 30              # 30 Minutes past the hour
 
−
sstCronHour: 9                # 9 am
 
−
sstCronDuration: 60            # 60 minutes (one hour)
 
−
</syntaxhighlight>
 
−
 
−
Maintenance window every year on the third Monday of March between 09:30 and 10:30, starting on Monday, the 16th of March 2015.
 
−
<syntaxhighlight lang='ldif'>
 
−
sstCronRepeatType: yearly      # repeat type is yearly
 
−
sstCronInterval: 1            # repeat every year
 
−
sstCronStartDate: 20150316    # starting on Monday, the 16th of March 2015
 
−
sstCronMonthOfyear: 3          # third month of the year
 
−
sstCronOccurrenceInMonth: 3    # third occurence
 
−
sstCronDayOfWeek: 1            # Monday
 
−
sstCronMinute: 30              # 30 Minutes past the hour
 
−
sstCronHour: 9                # 9 am
 
−
sstCronDuration: 60            # 60 minutes (one hour)
 
−
</syntaxhighlight>
 
−
 
−
Maintenance window every two years on the third Monday of March between 09:30 and 10:30, starting on Monday, the 16th of March 2015.
 
−
<syntaxhighlight lang='ldif'>
 
−
sstCronRepeatType: yearly      # repeat type is yearly
 
−
sstCronInterval: 2            # repeat every two years
 
−
sstCronStartDate: 20150316    # starting on Monday, the 16th of March 2015
 
−
sstCronMonthOfyear: 3          # third month of the year
 
−
sstCronOccurrenceInMonth: 3    # third occurence
 
−
sstCronDayOfMonth: 1          # Monday
 
−
sstCronMinute: 30              # 30 Minutes past the hour
 
−
sstCronHour: 9                # 9 am
 
−
sstCronDuration: 60            # 60 minutes (one hour)
 
−
</syntaxhighlight>
 
−
 
−
The following table describes the different attributes:
 
−
{| style="border-spacing:0;"
 
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| '''Attribute'''
 
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| '''Objectclass'''
 
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Existence'''</center>
 
−
| style="border-top:0.002cm solid #000000;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>'''Mandatory'''</center>
 
−
| style="border:0.002cm solid #000000;padding:0.097cm;"| '''Description'''
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| uid
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| A unique integer value with 7 digits or more. For example: <code>4000003</code>.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| description
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The description of the leaf.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstIsActive
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Is the entry active? Either <code>TRUE</code> (yes) or <code>FALSE</code> (no).
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstBillable
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| It the entry billable? Either <code>TRUE</code> (yes) or <code>FALSE</code> (no). 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.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCancellationDate
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The cancellation date of a reseller, customer or service in the form of [YYYY][MM][DD] (ISO 8601). For example: '''20201231'''.
 
−
 
−
The attribute <code>sstCancellationDate</code> is used in a logical AND combination with <code>sstIsActive</code>. With other words: Once the cancellation date has passed, it overrides the <code>sstIsActive</code> value.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstServicePriority
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The monitoring service level. The possible monitoring service levels (1, 2 or 3):
 
−
* <code>3</code>: Maintenance P3 [per Unit]: The Security Advisories will be installed once a month at the desired moment during the working hours (Monday to Friday from 09:00 - 12:00 and 13:00 - 17:00).
 
−
* <code>2</code>: Maintenance P2 [per Unit]: The Security Advisories will be installed once a month at the desired moment during the extended working hours (Monday to Friday from 07:00 - 12:00 and 13:00 - 19:00).
 
−
* <code>1</code>: Maintenance P1 [per Unit]: The Security Advisories will be installed once a month at the desired moment around the clock (Monday to Sunday from 00:00 - 24:00).
 
−
For more information on these monitoring service levels, visit stepping stone GmbH [http://www.stepping-stone.ch/infrastructure-as-a-service/monitoring/ web page].
 
−
 
−
If the attribute <code>sstServiceAutomated</code> is set to <code>TRUE</code>, the <code>sstServicePriority</code> will be ignored. And we will have automated monitoring windows in the form of:
 
−
*  Maintenance Automated (vcs_gitlab) [per Unit]: The Security Advisories will be installed once a month at the desired moment around the clock (Monday to Sunday from 00:00 - 24:00).
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstServiceAutomated
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| A monitoring window is either executed automatically:
 
−
* <code>sstServiceAutomated: TRUE</code>
 
−
or manually:
 
−
* <code>sstServiceAutomated: FALSE</code>
 
−
If the attribute <code>sstServiceAutomated</code> does not exist, presume <code>FALSE</code>.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronRepeatType
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| How often is a cron job to be repeated. Valid values are: <code>daily</code>, <code>weekly</code>, <code>monthly</code>, <code>yearly</code>.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronInterval
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The interval of a cron job. This attribute is dependant on the attribute sstCronRepeatType. Valid values are: <code>1</code> - <code>12</code>. For example: <code>2</code> could be every two days, weeks, months or years (depending on the value of the attribute <code>sstCronRepeatType</code>.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronStartDate
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The first time a cron job is executed. This date is stored in the form of [YYYY][MM][DD] ([http://en.wikipedia.org/wiki/ISO_8601 ISO 8601]). For example: <code>2010314</code> (the 14th of March 2015).
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronDuration
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The duration of the monitoring window in minutes. Valid values are: <code>15</code> - <code>1440</code> (15 minutes to 24 hours). For example: <code>60</code>, which means 60 minutes (one hour).
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronMinute
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The number of minutes past the hour that the monitoring window must start.
 
−
 
−
Valid values are: <code>0</code> - <code>59</code>. For example: <code>30</code>, which means 30 minutes past the hour.
 
−
 
−
If the attribute <code>sstCronMinuteEnd</code> is set, then <code>sstCronMinute</code> is interpreted as the start of a monitoring window minute range.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronMinuteEnd
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The number of minutes past the hour that the monitoring window must end (minus the duration defined with attribute <code>sstCronDuration>/code>). Valid values are: <code>0</code> - <code>59</code>.
 
−
 
−
For example: <code>45</code>, which means 45 minutes past the hour.
 
−
 
−
If this attribute is set, it is interpreted as the end of a monitoring window minute range, while <code>sstCronMinute</code> is interpreted as the start of a monitoring window minute range.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronHour
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The hour the monitoring window must start.
 
−
 
−
Valid values are: <code>0</code> - <code>23</code>. For example: <code>9</code>, which means 9 am, while <code>17</code> means 5 pm.
 
−
 
−
If the attribute <code>sstCronHourEnd</code> is set, then <code>sstCronMinute</code> is interpreted as the start of a monitoring window hour range.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronHourEnd
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The hour the monitoring window must end (minus the duration defined with attribute <code>sstCronDuration>/code>).
 
−
 
−
Valid values are: <code>0</code> - <code>23</code>. For example: <code>9</code>, which means 9 am, while <code>17</code> means 5 pm.
 
−
 
−
If this attribute is set, it is interpreted as the end of a monitoring window hour range, while <code>sstCronHour</code> is interpreted as the start of a monitoring window hour range.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronDayOfWeek
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Day of week (<code>0</code> - <code>6</code>), where Sunday is <code>0</code>. For example: <code>1</code>, which means Monday.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronDayOfMonth
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The day of the month a cron job is to be executed. Valid values are: <code>1</code> - <code>31</code>. For example: <code>3</code> is the third of the month.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronMonthOfyear
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The month of the year a cron job is to be executed. Valid values are: <code>1</code> - <code>12</code>. For example: <code>3</code> would be March.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstCronOccurrenceInMonth
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| The occurence of the day in a month a cron job is to be executed. Valid values are: <code>1</code> - <code>4</code>. For example: <code>3</code> would be the third occurence. If you use a value higher than 4, the calculation will fail in months, which only have 4 same days (for example February will never have 5 Mondays ...).
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstInformPersonUID
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the UID of the person to be informed if necessary. This UID can be used to look up the persons mail address, preferred language, name, surname or other information.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstResponsiblePersonUID
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the UID of the person who is responsible for the system or service. This UID can be used to look up the persons mail address, preferred language, name, surname or other information.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstResponsibleDeputyPersonUID
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the UID of the deputy of the person who is responsible for the system or service. This UID can be used to look up the persons mail address, preferred language, name, surname or other information.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstNotificationWarning
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| This multi-valued attribute will be used to turn single notifications on or off. Currently, the only allowed value is <code>reminder</code>. The value (name) corresponds with the template dn.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstIsMultiTenant
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center></center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| If this singe-valued attribute is set to TRUE, we know that this is a multi tenant capable system or service. For example stoney backup, stoney storage or stoney wiki). The monitoring notification system will therefore know, that it must inform the tenants differently.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstBelongsToServiceUID
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceObjectClass
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MAY</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the UID of the service the leaf belongs to. This UID can be used to look up other information. A unique value with 7 digits or more. <code>4000123</code>.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstBelongsToResellerUID
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: <code>4000000</code>.
 
−
 
−
|-
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstBelongsToCustomerUID
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstRelationship
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>MUST</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| <center>x</center>
 
−
| style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:0.002cm solid #000000;padding:0.097cm;"| Stores the customer UID the leaf belongs to. A unique value with 7 digits or more. For example: <code>4000001</code>.
 
−
 
−
|}
 
−
 
−
Legend:
 
−
* '''x''': Mandatory in all cases.
 
  
 
[[Category: OpenLDAP directory]]
 
[[Category: OpenLDAP directory]]
 
[[Category: stoney monitoring]]
 
[[Category: stoney monitoring]]

Revision as of 20:51, 18 January 2024

Abstract

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

Data Organisation

The following chapters explain the data organisation of the stoney cloud OpenLDAP directory, in this case we looking at the stoney monitoring service.

Maintenance

The following LDIF shows the monitoring entry of the whole OpenLDAP directory tree for the stoney cloud: 

dn: ou=monitoring,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: monitoring
description: The sub tree for the monitoring (configuration management) service.

Maintenance - Configuration

The sub tree for the configuration of the monitoring service: 

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

Maintenance - Configuration - Reseller

The sub tree for the reseller specific monitoring service settings: 

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

Maintenance - Configuration - Customers

The sub tree for the customers specific monitoring service settings: 

dn: ou=customers,ou=configuration,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: customer
description: The sub tree for the customer specific monitoring service settings.

Maintenance - Host groups

The sub tree for the host groups of the monitoring service: 

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

Maintenance - Hosts

The sub tree for the hosts of the monitoring service: 

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

Maintenance - User groups

The sub tree for the user groups of the monitoring service: 

dn: ou=user groups,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
ou: units
description: The sub tree for the user groups of the monitoring service.
Retrieved from "https://wiki.stoney-cloud.org/mediawiki/index.php?title=stoney_monitoring:_OpenLDAP_directory_data_organisation&oldid=5426"