Merge pull request #7913 from Icinga/feature/icingadb-docs

Docs: Icinga DB installation
This commit is contained in:
Noah Hilverling 2020-03-13 10:03:12 +01:00 committed by GitHub
commit d073d62b03
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 45 additions and 12 deletions

View File

@ -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 <a id="configuring-icinga-db"></a>
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 <a id="enabling-icinga-db"></a>
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 <a id="configuring-db-ido-mysql"></a>
@ -1037,11 +1076,10 @@ rc-service icinga2 restart
### Installing Icinga Web 2 <a id="installing-icingaweb2"></a>
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 <a id="install-addons"></a>

View File

@ -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) <a id="db-ido"></a>