doc: Add notes about the `instance_name` IDO field

Related to #7292

diff --git a/doc/06-distributed-monitoring.md b/doc/06-distributed-monitoring.md
index 3f55e7510acd0a557bc4d91acdf9c7022b9d1fe4..08af67d533c523599d8a1bbf4b92bc54c7083413 100644 (file)
--- 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 b8077369ef226924fe36dc5bace3eaf9e1887daa..8de8a8f879ca9137ac3892f2ee101b1e1834ff49 100644 (file)
--- 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`.