Revision as of 15:09, 17 January 2021

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 stoney 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.
sstIsCompany: TRUE
sstIsActive: TRUE
sstIsDefault: TRUE
sstBelongsToResellerUID: 4000000

The following table describes the different attributes:

Legend:

• x: Mandatory in all cases.

Maintenance 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:

1. Unit: uid=4000003,ou=units,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
2. Customer: ou=notifications,uid=4000001,ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
3. Reseller: ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
4. 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
sstResponsibleDeputyPersonUID: 4000002
sstNotificationWarning: reminder

The following table describes the different attributes:

Legend:

• x: Mandatory in all cases.

Maintenance Reseller Mail 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 Reseller Reminder Mail Templates

This sub tree contains the reminder templates for the stoney maintenance service for the reseller Reseller Ltd. with the uid 4000000:

dn: ou=reminder,ou=templates,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstTemplateSetup
ou: reminder
description: This sub tree contains the reminder templates for the stoney maintenance service for the reseller Reseller Ltd. with the uid 4000000.
sstMailFrom: Support stepping stone GmbH <support@stoney-cloud.org>
sstMailTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.stoney-cloud.org/templates/services/maintenance/reminder/reminder_mail
sstMailTemplateFormatSource: txt
sstMailTemplateFormatTarget: txt
sstMailTemplateReseller: file:///var/www/selfcare/htdocs/themes/selfcare.stoney-cloud.org/templates/services/maintenance/reminder/reminder_mail_reseller
sstMailTemplateResellerFormatSource: txt
sstMailTemplateResellerFormatTarget: txt

The following table describes the different attributes:

Legend:

• x: Mandatory in all cases.
• x¹: Must exist, if sstMailTo is set.

TODO: this is a copy and still needs checking / customizing.

Reminder Mail Placeholders (txt/html)

An example:

{$system}            kvm-0003: stepping stone GmbH: Gentoo (stoney backup Server)
{$salutation}        Dear Mr.
{$surname}           Eichenberger
{$inform}            - Michael Eichenberger <michael.eichenberger@stepping-stone.ch>
{$responsible}       - Christian Affolter <christian.affolter@stepping-stone.ch>
{$deputy}            - Tiziano Müller <tiziano.müllser@stepping-stone.ch>
{$maintenance_date}  2016-08-17
{$maintenance_start} 16:00
{$maintenance_end}   17:00

Optional Values:

none

A Complete Example: reminder_mail.de-CH.txt

Subject: Wartungsarbeiten am {$system}
{$salutation} {$surname}

Am {$maintenance_date} zwischen {$maintenance_start} und {$maintenance_end} finden 
die monatlichen Wartungsarbeiten auf Ihrem Server {$system} statt.

Dabei werden diverse Sicherheitsrisiken behoben.

Während den Wartungsarbeiten kann es zu kurzen Unterbrüchen der Services kommen.

Nach Abschluss der Wartungsarbeiten werden wir Sie nochmals benachrichtigen.

Diese Information geht an:
{$inform}
Falls Sie dieses Wartungsfenster nicht durchführen wollen, bitten wir Sie uns 
telefonisch darüber zu informieren.

Für Fragen stehen wir Ihnen gerne zur Verfügung.


Mit besten Grüssen,

Das Support-Team der stepping stone GmbH

--
stepping stone GmbH
Neufeldstrasse 9
CH-3012 Bern

Telefon: +41 31 332 53 63
www.stepping-stone.ch
support@stepping-stone.ch

A Complete Example: reminder_mail.en-GB.txt

Subject: Maintenance Work for {$system}
{$salutation} {$surname}

The monthly maintenance window for {$system} will be held on the {$maintenance_date} 
between {$maintenance_start} and {$maintenance_end}.

Several security risks will be removed.

Short interruptions of the services can occur during the maintenance window.

We will inform you after the successful completion of the maintenance work.

This information goes to:
{$inform}
If you do not wish to perform this maintenance window, please let us know by 
telephone.

If you have any questions do not hesitate to contact us.


With best regards,

Your stepping stone GmbH support team

--
stepping stone GmbH
Neufeldstrasse 9
CH-3012 Bern

Telefon: +41 31 332 53 63
www.stepping-stone.ch
support@stepping-stone.ch

A Complete Example: reminder_mail_reseller.de-CH.txt

Subject: Wartungsarbeiten am {$system}
{$salutation} {$surname}

Am {$maintenance_date} zwischen {$maintenance_start} und {$maintenance_end} finden 
die monatlichen Wartungsarbeiten auf Ihrem Server {$system} statt.

Verantwortlich für dieses System:
{$responsible}
Stellvertretung:
{$deputy}
Nach Abschluss der Wartungsarbeiten, bitte folgende Persone(n) informieren:
{$inform}

Mit besten Grüssen,

Das Support-Team der stepping stone GmbH

--
stepping stone GmbH
Neufeldstrasse 9
CH-3012 Bern

Telefon: +41 31 332 53 63
www.stepping-stone.ch
support@stepping-stone.ch

A Complete Example: reminder_mail_reseller.en-GB.txt

Subject: Maintenance Work for {$system}
{$salutation} {$surname}

The monthly maintenance window for {$system} will be held on the {$maintenance_date} 
between {$maintenance_start} and {$maintenance_end}.

Responsible for this system:
{$responsible}
Deputy:
{$deputy}
After the successful completion of the maintenance work, please inform the following 
person/people:
{$inform}

With best regards,

Your stepping stone GmbH support team
--
stepping stone GmbH
Neufeldstrasse 9
CH-3012 Bern

Telefon: +41 31 332 53 63
www.stepping-stone.ch
support@stepping-stone.ch

Maintenance Reseller Settings

This sub tree contains the default settings (currently only language and mail from) for the maintenance service for the reseller Reseller Ltd. with the uid 4000000:

dn: ou=settings,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstServiceSettingsObjectClass
ou: settings
description: This sub tree contains the default settings (currently ony language and mail from) 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=4000001,ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstCustomer
objectclass: sstRelationship
objectclass: sstServiceConfigurationObjectClass
uid: 4000001
o: Customer Ltd.
description: The sub tree for the specific maintenance service settings for the customer Customer Ltd. with the uid 4000001.
sstIsCompany: TRUE
sstIsActive: TRUE
sstBelongsToResellerUID: 4000000
sstBelongsToCustomerUID: 4000001

The following table describes the different attributes:

Legend:

• x: Mandatory in all cases.

Maintenance 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:

1. Unit: uid=4000003,ou=units,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
2. Customer: ou=notifications,uid=4000001,ou=customers,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
3. Reseller: ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=maintenance,ou=services,dc=stoney-cloud,dc=org.
4. 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
sstResponsibleDeputyPersonUID: 4000002
sstNotificationWarning: reminder

The following table describes the different attributes:

Legend:

• x: Mandatory in all cases.

Maintenance Customers Mail 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.

The sstBelongsToServiceUID lookup is as follows:

1. OpenStack unit (server): ou=units,ou=openstack,ou=services,dc=stoney-cloud,dc=org.
2. Virtual Machine: ou=virtual machines,ou=virtualization,ou=services,dc=stoney-cloud,dc=org.
3. vServer: ou=vservers,ou=services,dc=stoney-cloud,dc=org.
4. Dedicated Server: ou=dedicated servers,ou=services,dc=stoney-cloud,dc=org (not implemented yet).
5. External Server: ou=external servers,ou=services,dc=stoney-cloud,dc=org (not implemented yet).

The idea is, that we presume, that most of the maintenance units belong to OpenStack units (servers) running on our OpenStack based stoney cloud installation.

In the example below, the service UID sstBelongsToServiceUID: 1234567 points to virtual machine with the b543f88f-dffe-426f-86d3-c7ff85c16d2a and the uid: 1234567.

dn: uid=4000003,ou=units,ou=maintenance,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: sstMaintenanceObjectClass
objectclass: sstRelationship
uid: 4000003
description: The maintenance leaf for the virtual machine with the uid 1234567.
sstIsActive: 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

Other possible maintenance windows range from daily maintenance windows to bi yearly maintenance 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.

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)

Maintenance window every second day between 09:30 and 10:30, starting on Monday, the 5th of January 2015.

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)

Maintenance window every two weeks on Monday between 09:30 and 10:30, starting on Monday, the 13th of April 2015.

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)

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.

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)

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.

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)

Maintenance window every year on the 15th of March between 09:30 and 10:30, starting on Wednesday, the 11th of March 2015.

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)

Maintenance window every year on the third Monday of March between 09:30 and 10:30, starting on Monday, the 16th of March 2015.

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)

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.

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)

The following table describes the different attributes:

Legend:

• x: Mandatory in all cases.