diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/01-About.md | 7 | ||||
| -rw-r--r-- | doc/02-Installation.md.d/From-Source.md | 2 | ||||
| -rw-r--r-- | doc/03-Configuration.md | 47 | ||||
| -rw-r--r-- | doc/10-Migration.md | 13 | ||||
| -rw-r--r-- | doc/TRADEMARKS.md | 13 | ||||
| -rw-r--r-- | doc/res/icingadb-architecture.png | bin | 563761 -> 454289 bytes | |||
| -rw-r--r-- | doc/res/icingadb-web.png | bin | 532529 -> 424776 bytes |
7 files changed, 74 insertions, 8 deletions
diff --git a/doc/01-About.md b/doc/01-About.md index a13333e..9197da3 100644 --- a/doc/01-About.md +++ b/doc/01-About.md @@ -3,12 +3,13 @@ Icinga DB is a set of components for publishing, synchronizing and visualizing monitoring data in the Icinga ecosystem, consisting of: -* Icinga DB Web which connects to both a Redis server and a database to view and work with monitoring data +* Icinga DB Web which connects to both a Redis®[\*](TRADEMARKS.md#redis) server and + a database to view and work with monitoring data * Icinga 2 with its [Icinga DB feature](https://icinga.com/docs/icinga-2/latest/14-features/#icinga-db) enabled, responsible for publishing monitoring configuration, check results, - states changes and history items to the Redis server + states changes and history items to the Redis® server * And the [Icinga DB daemon](https://icinga.com/docs/icinga-db/latest/01-About/), - which synchronizes monitoring data between the Redis server and the database + which synchronizes monitoring data between the Redis® server and the database  diff --git a/doc/02-Installation.md.d/From-Source.md b/doc/02-Installation.md.d/From-Source.md index b430d16..f6e4c12 100644 --- a/doc/02-Installation.md.d/From-Source.md +++ b/doc/02-Installation.md.d/From-Source.md @@ -11,7 +11,7 @@ Make sure you use `icingadb` as the module name. The following requirements must * The following PHP modules must be installed: `cURL`, `dom`, `json`, `libxml` * [Icinga DB](https://github.com/Icinga/icingadb) * [Icinga Web 2](https://github.com/Icinga/icingaweb2) (≥2.9) -* [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (≥0.13) +* [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (≥0.13.2) * [Icinga PHP Thirdparty](https://github.com/Icinga/icinga-php-thirdparty) (≥0.12) <!-- {% include "02-Installation.md" %} --> diff --git a/doc/03-Configuration.md b/doc/03-Configuration.md index ce24277..c79ce66 100644 --- a/doc/03-Configuration.md +++ b/doc/03-Configuration.md @@ -15,17 +15,17 @@ Connection configuration for the database to which Icinga DB synchronizes monito 2. Configure the resource you just created as the database connection for the Icinga DB Web module using the `Configuration → Modules → icingadb → Database` menu. -## Redis Configuration +## Redis® Configuration -Connection configuration for the Redis server where Icinga 2 writes check results. +Connection configuration for the Redis® server where Icinga 2 writes check results. This data is used to display the latest state information in Icinga DB Web. -1. Configure the connection to the Redis server through the `Configuration → Modules → icingadb → Redis` menu. +1. Configure the connection to the Redis® server through the `Configuration → Modules → icingadb → Redis` menu. !!! info If you are running a high-availability Icinga 2 setup, - also configure the secondary master's Redis connection details. + also configure the secondary master's Redis® connection details. Icinga DB Web then uses this connection if the primary one is not available. ## Command Transport Configuration @@ -61,6 +61,45 @@ For this you need an `ApiUser` object with at least the following permissions on also configure the secondary master's API command transport. Icinga DB Web then uses this transport if the primary one is not available. +## General Configuration + +You can adjust some default values of options users have while interacting with particular dialogs in the UI. (e.g. While acknowledging a problem) +These options can not be adjusted in the UI directly, but have to be set in the +configuration file `/etc/icingaweb2/modules/icingadb/config.ini`. + +### Available Settings and defaults + +Option | Description | Default +----------------------------------|-----------------------------------|------------ +acknowledge_expire | Sets "Use Expire Time" in Acknowledgement dialog. | **0 (false)** +acknowledge_expire_time | Sets the value for "Expire Time" in Acknowledgement dialog, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)**. +acknowledge_notify | Sets "Send Notification" in Acknowledgement dialog. | **1 (true)** +acknowledge_persistent | Sets "Persistent Comment" in Acknowledgement dialog. | **0 (false)** +acknowledge_sticky | Sets "Sticky Acknowledgement" in Acknowledgement dialog. | **0 (false)** +comment_expire | Sets "Use Expire Time" in Comment dialog. | **0 (false)** +hostdowntime_comment_text | Sets default text for "Comment" in Host Downtime dialog | "" +servicedowntime_comment_text | Sets default text for "Comment" in Service Downtime dialog. | "" +comment_expire_time | Sets default value for "Expire Time" in Comment dialog, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)** +custom_notification_forced | Sets "Forced" in Custom Notification dialog. | **0 (false)** +hostdowntime_all_services | Sets "All Services" in Schedule Host Downtime dialog. | **0 (false)** +hostdowntime_end_fixed | Sets default value for "End Time" in Schedule Host Downtime dialog for **Fixed** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)**. +hostdowntime_end_flexible | Sets default value for "End Time" in Schedule Host Downtime dialog for **Flexible** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **2 hours (PT2H)**. +hostdowntime_flexible_duration | Sets default value for "Flexible Duration" in Schedule Host Downtime dialog for **Flexible** downtime. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **2 hour (PT2H)**. +servicedowntime_end_fixed | Sets default value for "End Time" in Schedule Service Downtime dialog for **Fixed** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)**. +servicedowntime_end_flexible | Set default value for "End Time" in Schedule Service Downtime dialog for **Flexible** downtime, its calculated as now + this setting. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **1 hour (PT1H)**. +servicedowntime_flexible_duration | Set default value for "Flexible Duration" in Schedule Service Downtime dialog for **Flexible** downtime. Format is a [PHP Dateinterval](http://www.php.net/manual/en/dateinterval.construct.php). | **2 hour (PT2H)**. + + +### Example + +Setting acknowledgements with 2 hours expire time by default. + +``` +[settings] +acknowledge_expire = 1 +acknowledge_expire_time = PT2H +``` + ## Security To grant users permissions to run commands and restrict them to specific views, diff --git a/doc/10-Migration.md b/doc/10-Migration.md index a8ed80f..43fa1db 100644 --- a/doc/10-Migration.md +++ b/doc/10-Migration.md @@ -8,6 +8,18 @@ If that is the case, this chapter has you covered. ## Configuration +### General configuration via config.ini + +Icinga DB Web still uses the same configuration format as the monitoring module. This means that the file +`/etc/icingaweb2/modules/monitoring/config.ini` can simply be copied over to +`/etc/icingaweb2/modules/icingadb/config.ini`: + +``` +cp /etc/icingaweb2/modules/monitoring/config.ini /etc/icingaweb2/modules/icingadb/config.ini +``` + +The behaviour of those options remains the same. + ### Command Transports Icinga DB Web still uses the same configuration format for command transports. This means that the file @@ -158,3 +170,4 @@ general access to the monitoring module, this is not automatically migrated. You It gives you the chance to review the performed changes, before letting them loose on your users. Please also take in mind, that Icinga DB Web handles permissions and restrictions differently. Our blog provides details on that: https://icinga.com/blog/2021/04/07/web-access-control-redefined/#icingadb-permission-linkage + diff --git a/doc/TRADEMARKS.md b/doc/TRADEMARKS.md new file mode 100644 index 0000000..952751d --- /dev/null +++ b/doc/TRADEMARKS.md @@ -0,0 +1,13 @@ +# Third-party Trademarks + +All trademarks, logos, and brand names are the property of their respective owners. +Any mention of company, product, or service names in our documentations, product descriptions, +or websites is solely for identification purposes. The use of these names, trademarks, +and brands does not imply endorsement. This document acknowledges trademarks of companies and products, +which are the property of their respective owners, whether registered or unregistered. + +## Redis® + +Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd. +Any use by Icinga GmbH is for referential purposes only and does not indicate any sponsorship, +endorsement or affiliation between Redis and Icinga GmbH. diff --git a/doc/res/icingadb-architecture.png b/doc/res/icingadb-architecture.png Binary files differindex 3d55ff7..c4af6eb 100644 --- a/doc/res/icingadb-architecture.png +++ b/doc/res/icingadb-architecture.png diff --git a/doc/res/icingadb-web.png b/doc/res/icingadb-web.png Binary files differindex 05a3e31..2d98334 100644 --- a/doc/res/icingadb-web.png +++ b/doc/res/icingadb-web.png |
