From 18c9d91f0cc0a87e283d7a1745cfbb8d857797bc Mon Sep 17 00:00:00 2001 From: Noah Hilverling Date: Fri, 13 Mar 2020 09:48:04 +0100 Subject: [PATCH] Docs: Add Icinga DB installation --- doc/02-installation.md | 50 +++++++++++++++++++++++++++++++++++++----- doc/14-features.md | 7 +----- 2 files changed, 45 insertions(+), 12 deletions(-) diff --git a/doc/02-installation.md b/doc/02-installation.md index f0128a1e4..12e3a78db 100644 --- a/doc/02-installation.md +++ b/doc/02-installation.md @@ -607,11 +607,50 @@ $ nano /etc/icinga2/conf.d/templates.conf Icinga 2 can be used with Icinga Web 2 and a variety of modules. This chapter explains how to set up Icinga Web 2. -The DB IDO (Database Icinga Data Output) feature for Icinga 2 take care of +Either Icinga DB or the DB IDO (Database Icinga Data Output) feature for Icinga 2 takes care of exporting all configuration and status information into a database. -Please choose whether to install [MySQL](02-installation.md#configuring-db-ido-mysql) or -[PostgreSQL](02-installation.md#configuring-db-ido-postgresql). +Please choose whether to install [Icinga DB](02-installation.md#configuring-icinga-db) (MySQL only) +or DB IDO ([MySQL](02-installation.md#configuring-db-ido-mysql) or +[PostgreSQL](02-installation.md#configuring-db-ido-postgresql)). +It's recommended to use the newer Icinga DB feature, if you don't need PostgreSQL. + +### Configuring Icinga DB + +First, make sure to setup Icinga DB itself and its database backends (Redis and MySQL) by following the [installation instructions](https://icinga.com/docs/icingadb/latest/doc/02-Installation/). + +#### Enabling the Icinga DB feature + +Icinga 2 provides a configuration file that is installed in +`/etc/icinga2/features-available/icingadb.conf`. You can update +the Redis credentials in this file. + +All available attributes are explained in the +[IcingaDB object](09-object-types.md#objecttype-icingadb) +chapter. + +You can enable the `icingadb` feature configuration file using +`icinga2 feature enable`: + +``` +# icinga2 feature enable icingadb +Module 'icingadb' was enabled. +Make sure to restart Icinga 2 for these changes to take effect. +``` + +Restart Icinga 2. + +``` +systemctl restart icinga2 +``` + +Alpine Linux: + +``` +rc-service icinga2 restart +``` + +Continue with the [webserver setup](02-installation.md#icinga2-user-interface-webserver). ### Configuring DB IDO MySQL @@ -1037,11 +1076,10 @@ rc-service icinga2 restart ### Installing Icinga Web 2 -Please consult the [installation documentation](https://icinga.com/docs/icingaweb2/latest/doc/02-Installation/) +Please consult the [Icinga Web 2 documentation](https://icinga.com/docs/icingaweb2/latest/doc/) for further instructions on how to install Icinga Web 2. -The Icinga 2 API can be defined as [command transport](https://icinga.com/docs/icingaweb2/latest/modules/monitoring/doc/05-Command-Transports/) -in Icinga Web 2 >= 2.4. +If you decided on using Icinga DB, consult the [Icinga DB Web documentation](https://icinga.com/docs/icingadb/latest/icingadb-web/doc/01-About/) on how to connect Icinga Web 2 with Icinga DB. ## Addons diff --git a/doc/14-features.md b/doc/14-features.md index c91a43ccd..aa7572e3f 100644 --- a/doc/14-features.md +++ b/doc/14-features.md @@ -61,12 +61,7 @@ Requirements: * IcingaDB service requires Redis and MySQL/MariaDB server * Icinga Web module -> TODO: Detailed instructions. - -``` -icinga2 feature enable icingadb -``` - +Consult the [Icinga DB section](02-installation.md#configuring-icinga-db) in the installation chapter for setup instructions. ### IDO Database (DB IDO)