From 1d714395a674b796f9d73ecfb2ff624efefa3c00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janne=20He=C3=9F?= Date: Mon, 8 Jul 2019 12:18:41 +0200 Subject: [PATCH] doc: Add notes about the `instance_name` IDO field Related to #7292 --- doc/06-distributed-monitoring.md | 1 + doc/09-object-types.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/06-distributed-monitoring.md b/doc/06-distributed-monitoring.md index 3f55e7510..08af67d53 100644 --- a/doc/06-distributed-monitoring.md +++ b/doc/06-distributed-monitoring.md @@ -1487,6 +1487,7 @@ only expose a virtual IP address to Icinga and the IDO feature. By default, only endpoint will actively write to the backend then. Typical setups for MySQL clusters involve Master-Master-Replication (Master-Slave-Replication in both directions) or Galera, more tips can be found on our [community forums](https://community.icinga.com/). +The IDO object must have the same `instance_name` on all master nodes. **Note**: All nodes in the same zone require that you enable the same features for high-availability (HA). diff --git a/doc/09-object-types.md b/doc/09-object-types.md index b8077369e..8de8a8f87 100644 --- a/doc/09-object-types.md +++ b/doc/09-object-types.md @@ -1456,7 +1456,7 @@ Configuration Attributes: ssl\_capath | String | **Optional.** MySQL SSL trusted SSL CA certificates in PEM format directory path. ssl\_cipher | String | **Optional.** MySQL SSL list of allowed ciphers. table\_prefix | String | **Optional.** MySQL database table prefix. Defaults to `icinga_`. - instance\_name | String | **Optional.** Unique identifier for the local Icinga 2 instance. Defaults to `default`. + instance\_name | String | **Optional.** Unique identifier for the local Icinga 2 instance, used for multiple Icinga 2 clusters writing to the same database. Defaults to `default`. instance\_description | String | **Optional.** Description for the Icinga 2 instance. enable\_ha | Boolean | **Optional.** Enable the high availability functionality. Only valid in a [cluster setup](06-distributed-monitoring.md#distributed-monitoring-high-availability-db-ido). Defaults to `true`. failover\_timeout | Duration | **Optional.** Set the failover timeout in a [HA cluster](06-distributed-monitoring.md#distributed-monitoring-high-availability-db-ido). Must not be lower than 30s. Defaults to `30s`. @@ -1550,7 +1550,7 @@ Configuration Attributes: ssl\_cert | String | **Optional.** PostgreSQL SSL certificate file path. ssl\_ca | String | **Optional.** PostgreSQL SSL certificate authority certificate file path. table\_prefix | String | **Optional.** PostgreSQL database table prefix. Defaults to `icinga_`. - instance\_name | String | **Optional.** Unique identifier for the local Icinga 2 instance. Defaults to `default`. + instance\_name | String | **Optional.** Unique identifier for the local Icinga 2 instance, used for multiple Icinga 2 clusters writing to the same database. Defaults to `default`. instance\_description | String | **Optional.** Description for the Icinga 2 instance. enable\_ha | Boolean | **Optional.** Enable the high availability functionality. Only valid in a [cluster setup](06-distributed-monitoring.md#distributed-monitoring-high-availability-db-ido). Defaults to `true`. failover\_timeout | Duration | **Optional.** Set the failover timeout in a [HA cluster](06-distributed-monitoring.md#distributed-monitoring-high-availability-db-ido). Must not be lower than 30s. Defaults to `30s`.