|
|
Line 44: |
Line 44: |
| description: The sub tree for the customer specific monitoring service settings. | | description: The sub tree for the customer specific monitoring service settings. |
| </syntaxhighlight> | | </syntaxhighlight> |
− |
| |
− | === Maintenance - Configuration - Service (Puppet) roles ===
| |
− | The sub tree for the service (Puppet) roles specific monitoring service settings:
| |
− | <syntaxhighlight lang='ldif'>
| |
− | dn: ou=roles,ou=configuration,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
| |
− | objectclass: top
| |
− | objectclass: organizationalUnit
| |
− | ou: roles
| |
− | description: The sub tree for the service (Puppet) roles specific monitoring service settings.
| |
− | </syntaxhighlight>
| |
− |
| |
− | The sub tree of the specific monitoring service settings for the stoney office service (Puppet) role called 'stoney_office' (Puppet roles don't contain spaces).
| |
− | <syntaxhighlight lang='ldif'>
| |
− | dn: ou=stoney_office,ou=roles,ou=configuration,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
| |
− | objectclass: top
| |
− | objectclass: organizationalUnit
| |
− | objectclass: sstServiceConfigurationObjectClass
| |
− | ou: stoney_office
| |
− | description: The sub tree of the specific monitoring service settings for the stoney office service (Puppet) role called 'stoney_office'.
| |
− | sstIsActive: TRUE
| |
− | sstIsDefault: TRUE
| |
− | </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;"| ou
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| organizationalUnit
| |
− | | 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;"| The name of the service (Puppet) role.
| |
− |
| |
− | For example: <code>ou: stoney_office</code> (Puppet roles don't contain spaces).
| |
− |
| |
− | |-
| |
− | | 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;"| organizationalUnit
| |
− | | 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.
| |
− |
| |
− | For example: <code>The sub tree of the specific monitoring service settings for the stoney office service (Puppet) role called 'stoney_office'.</code>
| |
− |
| |
− | |-
| |
− | | 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;"| sstServiceConfigurationObjectClass
| |
− | | 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).
| |
− |
| |
− | The default value is <code>TRUE</code>.
| |
− |
| |
− | |-
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstIsDefault
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstServiceConfigurationObjectClass
| |
− | | 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;"| Contains the leaf a default entry? Either <code>TRUE</code> (yes) or <code>FALSE</code> (no).
| |
− |
| |
− | If <code>sstIsDefault</code> is set to <code>TRUE</code>, the information of this subtree must alway be used (to make sure, that all automated monitoring windows are executed in the same time frame).
| |
− |
| |
− | |}
| |
− |
| |
− | Legend:
| |
− | * '''x''': Mandatory in all cases.
| |
− |
| |
− | ==== Maintenance - Configuration - service (Puppet) roles - Defaults ====
| |
− | This sub tree stores the default settings for the stoney monitoring service settings for the stoney office service (Puppet) role called 'stoney_office'.
| |
− |
| |
− | The configuration below tells us the following:
| |
− | * We have a monitoring window range (as <code>sstCronMinuteEnd</code> and <code>sstCronHourEnd</code> are set).
| |
− | * The monitoring window is executed every 2nd Wednesday of every month.
| |
− | * The monitoring windows can start a 03:00 and must end at 05:00 and takes half an hour (30 minutes).
| |
− | * A reminder will be sent to 'Support stepping stone AG <support@stepping-stone.ch>'.
| |
− |
| |
− | The lookup of the default settings for the stoney monitoring service is as follows:
| |
− | # '''Service roles:''' <code>ou=defaults,ou=stoney_office,ou=roles,ou=configuration,ou=monitoring,ou=services,dc=stoney-cloud,dc=org</code>.
| |
− | # '''OpenStack project:''' <code>ou=defaults,uid=4100000,ou=roles,ou=configuration,ou=monitoring,ou=services,dc=stoney-cloud,dc=org</code>.
| |
− | # '''Customer:''' <code>ou=defaults,uid=4000001,ou=roles,ou=configuration,ou=monitoring,ou=services,dc=stoney-cloud,dc=org</code>.
| |
− | # '''Reseller:''' <code>ou=defaults,uid=4000000,ou=reseller,ou=configuration,ou=monitoring,ou=services,dc=stoney-cloud,dc=org</code>.
| |
− |
| |
− | For example: If no monitoring values or only a subset of monitoring values are set by the provisioning api (or provisioning script), an missing values are first looked up in the '''service roles''' sub tree. If there are still missing values, the next lookup occurs in the '''OpenStack project''' subtree. Once again, if there are still missing values, the next lookup occurs in the '''customer''' sub tree. If there are still missing values, the final lookup occurs in the '''reseller''' sub tree. If there are still missing values, the provisioning api (or provisioning script) must inform the calling instance (this would normally be a human).
| |
− |
| |
− | <syntaxhighlight lang='ldif'>
| |
− | dn: ou=defaults,ou=stoney_office,ou=roles,ou=configuration,ou=monitoring,ou=services,dc=stoney-cloud,dc=org
| |
− | objectclass: top
| |
− | objectclass: organizationalUnit
| |
− | objectclass: sstMaintenanceDefaultsObjectClass
| |
− | objectclass: sstNotificationObjectClass
| |
− | objectclass: sstRelationship
| |
− | ou: defaults
| |
− | description: This sub tree stores the default settings for the stoney monitoring service settings for the stoney office service (Puppet) role called 'stoney_office'. Please be aware, that this is the production definition. The integration (test) definition is the same, except that the sstCronOccurrenceInMonth attribute is 1 instead of 2 (a week before).
| |
− | sstIsActive: TRUE # MAY: The default is always TRUE, otherwise why bother?
| |
− | sstServicePriority: 3 # MAY: We always set this, in case sstServiceAutomated is set to FALSE (as a fall-back position)
| |
− | sstServiceAutomated: TRUE # MAY: Depending on the reseller, we either have TRUE or FALSE. If sstServiceAutomated is not set, we presume FALSE
| |
− | sstCronRepeatType: monthly # MAY: repeat type is monthly
| |
− | sstCronInterval: 1 # MAY: repeat every month
| |
− | sstCronOccurrenceInMonth: 2 # MAY: second occurence
| |
− | sstCronDayOfWeek: 3 # MAY: Wednesday
| |
− | sstCronMinute: 0 # MAY: 0 Minutes past the hour
| |
− | sstCronMinuteEnd: 0 # MAY: 0 Minutes past the hour (new attribute, for if we have a range: 03:00 - 05:00)
| |
− | sstCronHour: 3 # MAY: 3 am
| |
− | sstCronHourEnd: 5 # MAY: 5 am (new attribute, for if we have a range: 03:00 - 05:00)
| |
− | sstCronDuration: 30 # MAY: 30 minutes (half an hour)
| |
− | sstNotificationWarning: reminder # MAY: We alway set this (Multi-valued attribute).
| |
− | sstInformPersonUID: 1000482 # MAY: Support stepping stone AG (support@stepping-stone.ch)
| |
− | sstResponsiblePersonUID: 1000482 # MAY: Support stepping stone AG (support@stepping-stone.ch)
| |
− | sstResponsibleDeputyPersonUID: 1000482 # MAY: Support stepping stone AG (support@stepping-stone.ch)
| |
− | </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;"| description
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| 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;"| sstServicePriority
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| 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;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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 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;"| sstCronOccurrenceInMonth
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| sstCronDayOfWeek
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| sstCronMinute
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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;"| sstCronDuration
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstMaintenanceDefaultsObjectClass
| |
− | | 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 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;"| sstNotificationWarning
| |
− | | style="border-top:none;border-bottom:0.002cm solid #000000;border-left:0.002cm solid #000000;border-right:none;padding:0.097cm;"| sstNotificationObjectClass
| |
− | | 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;"| 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;"| 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></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.
| |
− |
| |
− | As this attribute is multi-valued, the lookups will continue, even if this attribute is set.
| |
− |
| |
− | |-
| |
− | | 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>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 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;"| 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>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 reseller UID the leaf belongs to. A unique integer value with 7 digits or more. In the case of OpenStack Domains (resellers), the value of <code>sstBelongsToResellerUID</code> corresponds with the value of <code>uid</code>.
| |
− |
| |
− | For example: <code>sstBelongsToResellerUID: 4000000</code> corresponds with <code>uid: 4000000</code>.
| |
− |
| |
− | For the service (Puppet) roles this attribute must not be set, as the content of this value must be taken from either the OpenStack project, the customer or the reseller.
| |
− |
| |
− | |-
| |
− | | 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>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 customer UID the leaf belongs to. A unique value with 7 digits or more, must correspond with the uid entry. Each reseller is also a customer in the LDAP directory. Therefore, the value of the attribute <code>sstBelongsToCustomerUID</code> should always be set to the customer UID, that reflects the reseller for the OpenStack Domains.
| |
− |
| |
− | For example: <code>sstBelongsToCustomerUID: 4000001</code>.
| |
− |
| |
− | For the service (Puppet) roles this attribute must not be set, as the content of this value must be taken from either the OpenStack project, the customer or the reseller.
| |
− |
| |
− | |}
| |
− |
| |
− | Legend:
| |
− | * '''x''': Mandatory in all cases.
| |
| | | |
| == Maintenance - Units == | | == Maintenance - Units == |
The following chapters explain the data organisation of the stoney cloud OpenLDAP directory, in this case we looking at the stoney monitoring service.
Each monitoring unit has its own leaf. A monthly monitoring 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.
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.
Other possible monitoring windows range from daily monitoring windows to bi yearly monitoring windows. The following examples just show the relevant attributes.
Maintenance window every day between 09:30 and 10:30, starting on Monday, the 5th of January 2015.
Maintenance window every second day between 09:30 and 10:30, starting on Monday, the 5th of January 2015.
Maintenance window every two weeks on Monday between 09:30 and 10:30, starting on Monday, the 13th of April 2015.
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.
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.
Maintenance window every year on the 15th of March between 09:30 and 10:30, starting on Wednesday, the 11th of March 2015.
Maintenance window every year on the third Monday of March between 09:30 and 10:30, starting on Monday, the 16th of March 2015.
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.
Attribute
|
Objectclass
|
Existence
|
Mandatory
|
Description
|
uid
|
sstMaintenanceObjectClass
|
MUST
|
x
|
A unique integer value with 7 digits or more. For example: 4000003 .
|
description
|
sstMaintenanceObjectClass
|
MAY
|
x
|
The description of the leaf.
|
sstIsActive
|
sstMaintenanceObjectClass
|
MUST
|
x
|
Is the entry active? Either TRUE (yes) or FALSE (no).
|
sstBillable
|
sstRelationship
|
MAY
|
x
|
It the entry billable? Either TRUE (yes) or FALSE (no). All hierarchical levels must have sstBillable: TRUE to actually have an invoice generated and sent. If the attribute sstBillable doesn't exist, the default is TRUE . This way, we are forced to set a reseller, customer or product manually to sstBillable: FALSE if we want to avoid sending them an invoice.
|
sstCancellationDate
|
sstRelationship
|
MAY
|
|
The cancellation date of a reseller, customer or service in the form of [YYYY][MM][DD] (ISO 8601). For example: 20201231.
The attribute sstCancellationDate is used in a logical AND combination with sstIsActive . With other words: Once the cancellation date has passed, it overrides the sstIsActive value.
|
sstServicePriority
|
sstMaintenanceObjectClass
|
MAY
|
x
|
The monitoring service level. The possible monitoring service levels (1, 2 or 3):
-
3 : 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).
-
2 : 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).
-
1 : 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 web page.
If the attribute sstServiceAutomated is set to TRUE , the sstServicePriority 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).
|
sstServiceAutomated
|
sstMaintenanceObjectClass
|
MAY
|
|
A monitoring window is either executed automatically:
-
sstServiceAutomated: TRUE
or manually:
-
sstServiceAutomated: FALSE
If the attribute sstServiceAutomated does not exist, presume FALSE .
|
sstCronRepeatType
|
sstMaintenanceObjectClass
|
MAY
|
x
|
How often is a cron job to be repeated. Valid values are: daily , weekly , monthly , yearly .
|
sstCronInterval
|
sstMaintenanceObjectClass
|
MAY
|
x
|
The interval of a cron job. This attribute is dependant on the attribute sstCronRepeatType. Valid values are: 1 - 12 . For example: 2 could be every two days, weeks, months or years (depending on the value of the attribute sstCronRepeatType .
|
sstCronStartDate
|
sstMaintenanceObjectClass
|
MAY
|
x
|
The first time a cron job is executed. This date is stored in the form of [YYYY][MM][DD] (ISO 8601). For example: 2010314 (the 14th of March 2015).
|
sstCronDuration
|
sstMaintenanceObjectClass
|
MAY
|
x
|
The duration of the monitoring window in minutes. Valid values are: 15 - 1440 (15 minutes to 24 hours). For example: 60 , which means 60 minutes (one hour).
|
sstCronMinute
|
sstMaintenanceObjectClass
|
MAY
|
|
The number of minutes past the hour that the monitoring window must start.
Valid values are: 0 - 59 . For example: 30 , which means 30 minutes past the hour.
If the attribute sstCronMinuteEnd is set, then sstCronMinute is interpreted as the start of a monitoring window minute range.
|
sstCronMinuteEnd
|
sstMaintenanceObjectClass
|
MAY
|
|
The number of minutes past the hour that the monitoring window must end (minus the duration defined with attribute sstCronDuration>/code>). Valid values are: <code>0 - 59 .
For example: 45 , 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 sstCronMinute is interpreted as the start of a monitoring window minute range.
|
sstCronHour
|
sstMaintenanceObjectClass
|
MAY
|
|
The hour the monitoring window must start.
Valid values are: 0 - 23 . For example: 9 , which means 9 am, while 17 means 5 pm.
If the attribute sstCronHourEnd is set, then sstCronMinute is interpreted as the start of a monitoring window hour range.
|
sstCronHourEnd
|
sstMaintenanceObjectClass
|
MAY
|
|
The hour the monitoring window must end (minus the duration defined with attribute sstCronDuration>/code>).
Valid values are: <code>0 - 23 . For example: 9 , which means 9 am, while 17 means 5 pm.
If this attribute is set, it is interpreted as the end of a monitoring window hour range, while sstCronHour is interpreted as the start of a monitoring window hour range.
|
sstCronDayOfWeek
|
sstMaintenanceObjectClass
|
MAY
|
|
Day of week (0 - 6 ), where Sunday is 0 . For example: 1 , which means Monday.
|
sstCronDayOfMonth
|
sstMaintenanceObjectClass
|
MAY
|
|
The day of the month a cron job is to be executed. Valid values are: 1 - 31 . For example: 3 is the third of the month.
|
sstCronMonthOfyear
|
sstMaintenanceObjectClass
|
MAY
|
|
The month of the year a cron job is to be executed. Valid values are: 1 - 12 . For example: 3 would be March.
|
sstCronOccurrenceInMonth
|
sstMaintenanceObjectClass
|
MAY
|
|
The occurence of the day in a month a cron job is to be executed. Valid values are: 1 - 4 . For example: 3 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 ...).
|
sstInformPersonUID
|
sstRelationship
|
MAY
|
x
|
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.
|
sstResponsiblePersonUID
|
sstRelationship
|
MAY
|
x
|
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.
|
sstResponsibleDeputyPersonUID
|
sstRelationship
|
MAY
|
|
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.
|
sstNotificationWarning
|
sstMaintenanceObjectClass
|
MUST
|
x
|
This multi-valued attribute will be used to turn single notifications on or off. Currently, the only allowed value is reminder . The value (name) corresponds with the template dn.
|
sstIsMultiTenant
|
sstMaintenanceObjectClass
|
MAY
|
|
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.
|
sstBelongsToServiceUID
|
sstMaintenanceObjectClass
|
MAY
|
x
|
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. 4000123 .
|
sstBelongsToResellerUID
|
sstRelationship
|
MUST
|
x
|
Stores the reseller UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000000 .
|
sstBelongsToCustomerUID
|
sstRelationship
|
MUST
|
x
|
Stores the customer UID the leaf belongs to. A unique value with 7 digits or more. For example: 4000001 .
|