mirror of https://github.com/Icinga/icinga2.git
Remove the import of 'legacy-timeperiod' in the docs
2.6.0 introduced default template imports for config objects where this isn't necessary anymore. It also confuses the reader.
This commit is contained in:
Michael Friedrich
parent
4eb5b0967c
commit
0bcda04171
|
|
@ -206,14 +206,6 @@ the `check_period` attribute. Or a notification should be sent to
|
||||||
users or not, filtered by the `period` and `notification_period`
|
users or not, filtered by the `period` and `notification_period`
|
||||||
configuration attributes for `Notification` and `User` objects.
|
configuration attributes for `Notification` and `User` objects.
|
||||||
|
|
||||||
> **Note**
|
|
||||||
>
|
|
||||||
> If you are familiar with Icinga 1.x, these time period definitions
|
|
||||||
> are called `legacy timeperiods` in Icinga 2.
|
|
||||||
>
|
|
||||||
> An Icinga 2 legacy timeperiod requires the `ITL` provided template
|
|
||||||
>`legacy-timeperiod`.
|
|
||||||
|
|
||||||
The `TimePeriod` attribute `ranges` may contain multiple directives,
|
The `TimePeriod` attribute `ranges` may contain multiple directives,
|
||||||
including weekdays, days of the month, and calendar dates.
|
including weekdays, days of the month, and calendar dates.
|
||||||
These types may overlap/override other types in your ranges dictionary.
|
These types may overlap/override other types in your ranges dictionary.
|
||||||
|
|
@ -231,78 +223,80 @@ If you don't set any `check_period` or `notification_period` attribute
|
||||||
on your configuration objects, Icinga 2 assumes `24x7` as time period
|
on your configuration objects, Icinga 2 assumes `24x7` as time period
|
||||||
as shown below.
|
as shown below.
|
||||||
|
|
||||||
object TimePeriod "24x7" {
|
```
|
||||||
import "legacy-timeperiod"
|
object TimePeriod "24x7" {
|
||||||
|
display_name = "Icinga 2 24x7 TimePeriod"
|
||||||
display_name = "Icinga 2 24x7 TimePeriod"
|
ranges = {
|
||||||
ranges = {
|
"monday" = "00:00-24:00"
|
||||||
"monday" = "00:00-24:00"
|
"tuesday" = "00:00-24:00"
|
||||||
"tuesday" = "00:00-24:00"
|
"wednesday" = "00:00-24:00"
|
||||||
"wednesday" = "00:00-24:00"
|
"thursday" = "00:00-24:00"
|
||||||
"thursday" = "00:00-24:00"
|
"friday" = "00:00-24:00"
|
||||||
"friday" = "00:00-24:00"
|
"saturday" = "00:00-24:00"
|
||||||
"saturday" = "00:00-24:00"
|
"sunday" = "00:00-24:00"
|
||||||
"sunday" = "00:00-24:00"
|
}
|
||||||
}
|
}
|
||||||
}
|
```
|
||||||
|
|
||||||
If your operation staff should only be notified during workhours,
|
If your operation staff should only be notified during workhours,
|
||||||
create a new timeperiod named `workhours` defining a work day from
|
create a new timeperiod named `workhours` defining a work day from
|
||||||
09:00 to 17:00.
|
09:00 to 17:00.
|
||||||
|
|
||||||
object TimePeriod "workhours" {
|
```
|
||||||
import "legacy-timeperiod"
|
object TimePeriod "workhours" {
|
||||||
|
display_name = "Icinga 2 8x5 TimePeriod"
|
||||||
|
ranges = {
|
||||||
|
"monday" = "09:00-17:00"
|
||||||
|
"tuesday" = "09:00-17:00"
|
||||||
|
"wednesday" = "09:00-17:00"
|
||||||
|
"thursday" = "09:00-17:00"
|
||||||
|
"friday" = "09:00-17:00"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
display_name = "Icinga 2 8x5 TimePeriod"
|
If you want to specify a notification period across midnight,
|
||||||
ranges = {
|
|
||||||
"monday" = "09:00-17:00"
|
|
||||||
"tuesday" = "09:00-17:00"
|
|
||||||
"wednesday" = "09:00-17:00"
|
|
||||||
"thursday" = "09:00-17:00"
|
|
||||||
"friday" = "09:00-17:00"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Furthermore if you wish to specify a notification period across midnight,
|
|
||||||
you can define it the following way:
|
you can define it the following way:
|
||||||
|
|
||||||
object Timeperiod "across-midnight" {
|
```
|
||||||
import "legacy-timeperiod"
|
object Timeperiod "across-midnight" {
|
||||||
|
display_name = "Nightly Notification"
|
||||||
display_name = "Nightly Notification"
|
ranges = {
|
||||||
ranges = {
|
"saturday" = "22:00-24:00"
|
||||||
"saturday" = "22:00-24:00"
|
"sunday" = "00:00-03:00"
|
||||||
"sunday" = "00:00-03:00"
|
}
|
||||||
}
|
}
|
||||||
}
|
```
|
||||||
|
|
||||||
Below you can see another example for configuring timeperiods across several
|
Below you can see another example for configuring timeperiods across several
|
||||||
days, weeks or months. This can be useful when taking components offline
|
days, weeks or months. This can be useful when taking components offline
|
||||||
for a distinct period of time.
|
for a distinct period of time.
|
||||||
|
|
||||||
object Timeperiod "standby" {
|
```
|
||||||
import "legacy-timeperiod"
|
object Timeperiod "standby" {
|
||||||
|
display_name = "Standby"
|
||||||
display_name = "Standby"
|
ranges = {
|
||||||
ranges = {
|
"2016-09-30 - 2016-10-30" = "00:00-24:00"
|
||||||
"2016-09-30 - 2016-10-30" = "00:00-24:00"
|
}
|
||||||
}
|
}
|
||||||
}
|
```
|
||||||
|
|
||||||
Please note that the spaces before and after the dash are mandatory.
|
Please note that the spaces before and after the dash are mandatory.
|
||||||
|
|
||||||
Once your time period is configured you can Use the `period` attribute
|
Once your time period is configured you can Use the `period` attribute
|
||||||
to assign time periods to `Notification` and `Dependency` objects:
|
to assign time periods to `Notification` and `Dependency` objects:
|
||||||
|
|
||||||
object Notification "mail" {
|
```
|
||||||
import "generic-notification"
|
apply Notification "mail-icingaadmin" to Service {
|
||||||
|
import "mail-service-notification"
|
||||||
|
user_groups = host.vars.notification.mail.groups
|
||||||
|
users = host.vars.notification.mail.users
|
||||||
|
|
||||||
host_name = "localhost"
|
period = "workhours"
|
||||||
|
|
||||||
command = "mail-notification"
|
assign where host.vars.notification.mail
|
||||||
users = [ "icingaadmin" ]
|
}
|
||||||
period = "workhours"
|
```
|
||||||
}
|
|
||||||
|
|
||||||
### Time Periods Inclusion and Exclusion <a id="timeperiods-includes-excludes"></a>
|
### Time Periods Inclusion and Exclusion <a id="timeperiods-includes-excludes"></a>
|
||||||
|
|
||||||
|
|
@ -319,51 +313,51 @@ preferred.
|
||||||
The following example defines a time period called `holidays` where
|
The following example defines a time period called `holidays` where
|
||||||
notifications should be suppressed:
|
notifications should be suppressed:
|
||||||
|
|
||||||
object TimePeriod "holidays" {
|
```
|
||||||
import "legacy-timeperiod"
|
object TimePeriod "holidays" {
|
||||||
|
ranges = {
|
||||||
ranges = {
|
"january 1" = "00:00-24:00" //new year's day
|
||||||
"january 1" = "00:00-24:00" //new year's day
|
"july 4" = "00:00-24:00" //independence day
|
||||||
"july 4" = "00:00-24:00" //independence day
|
"december 25" = "00:00-24:00" //christmas
|
||||||
"december 25" = "00:00-24:00" //christmas
|
"december 31" = "18:00-24:00" //new year's eve (6pm+)
|
||||||
"december 31" = "18:00-24:00" //new year's eve (6pm+)
|
"2017-04-16" = "00:00-24:00" //easter 2017
|
||||||
"2017-04-16" = "00:00-24:00" //easter 2017
|
"monday -1 may" = "00:00-24:00" //memorial day (last monday in may)
|
||||||
"monday -1 may" = "00:00-24:00" //memorial day (last monday in may)
|
"monday 1 september" = "00:00-24:00" //labor day (1st monday in september)
|
||||||
"monday 1 september" = "00:00-24:00" //labor day (1st monday in september)
|
"thursday 4 november" = "00:00-24:00" //thanksgiving (4th thursday in november)
|
||||||
"thursday 4 november" = "00:00-24:00" //thanksgiving (4th thursday in november)
|
}
|
||||||
}
|
}
|
||||||
}
|
```
|
||||||
|
|
||||||
In addition to that the time period `weekends` defines an additional
|
In addition to that the time period `weekends` defines an additional
|
||||||
time window which should be excluded from notifications:
|
time window which should be excluded from notifications:
|
||||||
|
|
||||||
object TimePeriod "weekends-excluded" {
|
```
|
||||||
import "legacy-timeperiod"
|
object TimePeriod "weekends-excluded" {
|
||||||
|
ranges = {
|
||||||
ranges = {
|
"saturday" = "00:00-09:00,18:00-24:00"
|
||||||
"saturday" = "00:00-09:00,18:00-24:00"
|
"sunday" = "00:00-09:00,18:00-24:00"
|
||||||
"sunday" = "00:00-09:00,18:00-24:00"
|
}
|
||||||
}
|
}
|
||||||
}
|
```
|
||||||
|
|
||||||
The time period `prod-notification` defines the default time ranges
|
The time period `prod-notification` defines the default time ranges
|
||||||
and adds the excluded time period names as an array.
|
and adds the excluded time period names as an array.
|
||||||
|
|
||||||
object TimePeriod "prod-notification" {
|
```
|
||||||
import "legacy-timeperiod"
|
object TimePeriod "prod-notification" {
|
||||||
|
excludes = [ "holidays", "weekends-excluded" ]
|
||||||
|
|
||||||
excludes = [ "holidays", "weekends-excluded" ]
|
ranges = {
|
||||||
|
"monday" = "00:00-24:00"
|
||||||
ranges = {
|
"tuesday" = "00:00-24:00"
|
||||||
"monday" = "00:00-24:00"
|
"wednesday" = "00:00-24:00"
|
||||||
"tuesday" = "00:00-24:00"
|
"thursday" = "00:00-24:00"
|
||||||
"wednesday" = "00:00-24:00"
|
"friday" = "00:00-24:00"
|
||||||
"thursday" = "00:00-24:00"
|
"saturday" = "00:00-24:00"
|
||||||
"friday" = "00:00-24:00"
|
"sunday" = "00:00-24:00"
|
||||||
"saturday" = "00:00-24:00"
|
}
|
||||||
"sunday" = "00:00-24:00"
|
}
|
||||||
}
|
```
|
||||||
}
|
|
||||||
|
|
||||||
## External Check Results <a id="external-check-results"></a>
|
## External Check Results <a id="external-check-results"></a>
|
||||||
|
|
||||||
|
|
@ -1077,8 +1071,6 @@ time of the day compared to the defined time period.
|
||||||
|
|
||||||
```
|
```
|
||||||
object TimePeriod "backup" {
|
object TimePeriod "backup" {
|
||||||
import "legacy-timeperiod"
|
|
||||||
|
|
||||||
ranges = {
|
ranges = {
|
||||||
monday = "02:00-03:00"
|
monday = "02:00-03:00"
|
||||||
tuesday = "02:00-03:00"
|
tuesday = "02:00-03:00"
|
||||||
|
|
|
||||||
|
|
@ -1602,10 +1602,6 @@ Facility Constants:
|
||||||
Time periods can be used to specify when hosts/services should be checked or to limit
|
Time periods can be used to specify when hosts/services should be checked or to limit
|
||||||
when notifications should be sent out.
|
when notifications should be sent out.
|
||||||
|
|
||||||
> **Note**
|
|
||||||
>
|
|
||||||
> Icinga 2 versions < 2.6.0 require the import of the [legacy-timeperiod](10-icinga-template-library.md#itl-legacy-timeperiod) template.
|
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue