Skip to content

Latest commit

 

History

History
109 lines (73 loc) · 5.21 KB

README.md

File metadata and controls

109 lines (73 loc) · 5.21 KB
Raw

Icinga Notifications

This repository contains Icinga Notification scripts for

  • Enhanced Email
  • Netbox Path
  • Pushover
  • Request Tracker
  • Slack

These notification scripts have been created to work with Icinga configuration on disk or in Director. They pull their configuration from arguments, environment variables and on disk configuration.

This repository contains the notification scripts, shared libraries, dependant python libaries, an installation script, config examples for Icinga2 and Icingaweb2 Director import baskets.

Installation

deploy.sh can be used to install the scripts from this repository.

It performs the following actions

  • Installs repository shared libraries, always overrides existing, and sets permissions(destination: /etc/icinga2/scripts/lib/)
  • Installs python libraries with python3 -m pip install
  • Copies default config if config doesn't exist and sets permissions (destination: /etc/icinga2/scripts/config/)
  • Copies notification script, always overrides existing script, and sets permissions (destination: /etc/icinga2/scripts/)

Deploy.sh Usage

Deploy Everything

deploy.sh --all

Deploy just a single Notification type

deploy.sh --enhanced-email
deploy.sh --netbox-path
deploy.sh --pushover
deploy.sh --request-tracker
deploy.sh --slack

Deploy everything for a specified user (default user: nagios)

deploy.sh --all --icinga2-user icinga2

Notification Script Configuration

Enhanced Email

Once installed you will find the Enhanced Email Notification configuration in the /etc/icinga2/scripts/config/ directory.

The configuration of settings for email, Icinga, Netbox and Grafana can be found in this file.

For configuration of the Notification command in Icinga itself refer to the ./icinga_conf/ examples or import the director baskets ./director_baskets/ available in this repository.

Netbox Path Impact

Once installed you will find the Netbox Path Impact Notification configuration in the /etc/icinga2/scripts/config/ directory.

The configuration of settings for Netbox can be found in this file. This Notification script doesn't manage the notification to enduser itself but instead determines who needs to be notified based on the Netbox Path plugin's impact assesment API then calls other notification scripts. It is assumed the other notification scripts will have the --help option and use the same argument names as this notification script, which is uses to pass through the correct argument and values to the notification script.

For configuration of the Notification command in Icinga itself refer to the ./icinga_conf/ examples or import the director baskets ./director_baskets/ available in this repository.

Pushover

There is no configuration file for this script.

For configuration of the Notification command in Icinga itself refer to the ./icinga_conf/ examples or import the director baskets ./director_baskets/ available in this repository.

Request Tracker

Once installed you will find the Request Tracker Notification configuration in the /etc/icinga2/scripts/config/ directory.

The configuration of connection settings to Request Tracker and Icinga can be found in this file.

For configuration of the Notification command in Icinga itself refer to the ./icinga_conf/ examples or import the director baskets ./director_baskets/ available in this repository.

Slack

There is no configuration files by default with slack notifications, the script will still look for configuration in config/slack-notification.json though.

For configuration of the Notification command in Icinga itself refer to the ./icinga_conf/ examples or import the director baskets ./director_baskets/ available in this repository.

Icinga2 Configuration via config files

Typically the Icinga2 configuration only need to be added once unless new options are added to the script.

Adding Icinga2 configuration is not automated with script installation and should not be used if you have already setup, or intend to setup, Director Configuration.

Add the config files in /etc/icinga2/conf.d/ or /etc/icinga2/zones.d/global-templates/, whatever is the most appropiate for your setup.

Director Configuration via Basket Import

Typically the Director configuration only need to be uploaded once unless new options are added to the script.

Creation of Director configuration is not automated with script installation and should not be used if you have already setup, or intend to setup, Icinga2 Configuration via config files.

  • Select Icinga Director then Configuration Baskets
  • In the Configuration Baskets panel select Upload
  • Add the basket name and select the upload file then Upload to create the basket
  • At the top of the screen select Snapshots
  • Select the listed Snapshot
  • Select Restore to create/update the Director configuration

Contributing

We welcome improvements to this project.

The best way to contribute is Create a ticket explaining the problem you are solving then submit a pull request with your changes.

Please note that these Notification scripts are used by Sol1 in multiple production environments so any changes submitted that aren't backwards compatible are unlikely to be accepted as is.

License

MIT License