icinga2-formula

Travis CI Build Status Semantic Release

A salt formula that installs and configures icinga2, currently on Debian and Ubuntu only, but other installation source can be easily added. Configuration via pillar currently for hosts and services only.

Suggestions, pull-requests, bug reports and comments are welcome.

1. General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

If you need (non-default) configuration, please pay attention to the pillar.example file and/or Special notes section.

2. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

3. Special notes

None

4. Available states

4.1. icinga2

Installs and configures the icinga2 package. Includes icinga.repositories.

4.2. icinga2.icinga-web2

Includes:

  • icinga2.icinga-web2-core

  • icinga2.icinga-web2-database

  • icinga2.pgsql-ido

  • icinga2.postgresql-client

  • icinga2.postgresql-server

4.3. icinga2.nrpe-server (DEPRECATED)

Installs and configures the nrpe-server to perform checks on non-local hosts.

5. States which are independent (reusable) building blocks

5.1. icinga2.icinga-web2-database

Creates the DB user and the DB itself. (Makes only sense if the DB shall run on the same host as Icinga2)

5.2. icinga2.icinga-web2-core

Installs the (new) Icinga Web UI.

5.3. icinga2.pgsql-ido

Installs and configures icinga2-ido-pgsql. You may want to add icinga2.postgresql-client

5.4. icinga2.postgresql-client

Installs PostgreSQL client.

5.5. icinga2.postgresql-server

Installs PostgreSQL server.

5.6. icinga2.repositories

Adds the Debian / Ubuntu repository to get Icinga2 packages from if (and only if) the machine happens to run one of the mentioned operating systems.

5.7. icinga2.check_command.openvpn

Sets up CheckCommand openvpn using https://github.com/liquidat/nagios-icinga-openvpn.

5.8. icinga2.notification.xmpp

Sets up notification via XMPP using slixmpp.

6. Testing

Linux testing is done with kitchen-salt.

6.1. Requirements

  • Ruby

  • Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

6.2. bin/kitchen converge

Creates the docker instance and runs the template main state, ready for testing.

6.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

6.4. bin/kitchen destroy

Removes the docker instance.

6.5. bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge
verify + destroy.

6.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.