Update documentation and add upgrading notes

diff --git a/doc/06-distributed-monitoring.md b/doc/06-distributed-monitoring.md
index 04d09171665f7c85682bbc29f34817a669874bf8..8795335ed02dcb0819784cf9bc9919067946277f 100644 (file)
--- a/doc/06-distributed-monitoring.md
+++ b/doc/06-distributed-monitoring.md
@@ -2802,17 +2802,15 @@ Two potential scenarios include:
 * Different versions of the same monitoring configuration (e.g. production and testing)
 * Disparate sets of checks for entirely unrelated monitoring environments (e.g. infrastructure and applications)
 
-The configuration is done with global constants and attributes of the
+The configuration is done with the global constants `ApiBindHost` and `ApiBindPort`
+or the `bind_host` and `bind_port` attributes of the
 [ApiListener](09-object-types.md#objecttype-apilistener) object.
 
-Constant       | Attribute
----------------|----------
-ApiEnvironment | environment
-ApiBindHost    | bind_host
-ApiBindPort    | bind_port
+The environment must be set with the global constant `Environment` or as object attribute
+of the [IcingaApplication](#objecttype-icingaapplication) object.
 
-In any case the constant is default value for the attribute and the direct configuration in the ApiListener object
-has more precedence. The constants have been added to allow the values being set from the CLI on startup.
+In any case the constant is default value for the attribute and the direct configuration in the objects
+have more precedence. The constants have been added to allow the values being set from the CLI on startup.
 
 When Icinga establishes a TLS connection to another cluster instance it automatically uses the [SNI extension](https://en.wikipedia.org/wiki/Server_Name_Indication)
 to signal which endpoint it is attempting to connect to. On its own this can already be used to position multiple
@@ -2820,7 +2818,7 @@ Icinga instances behind a load balancer.
 
 SNI example: `icinga2-client1.localdomain`
 
-However, if the environment is configured, Icinga will append the environment name to the SNI hostname like this:
+However, if the environment is configured to `production`, Icinga appends the environment name to the SNI hostname like this:
 
 SNI example with environment: `icinga2-client1.localdomain:production`
 

diff --git a/doc/09-object-types.md b/doc/09-object-types.md
index 06584ef1daed4ad9e914106ac1cfe028e4baa572..d04f781569661e0e21cb274378705d9bfc5d4a21 100644 (file)
--- a/doc/09-object-types.md
+++ b/doc/09-object-types.md
@@ -817,6 +817,7 @@ Configuration Attributes:
   enable\_service\_checks   | Boolean               | **Optional.** Whether active service checks are globally enabled. Defaults to true.
   enable\_perfdata          | Boolean               | **Optional.** Whether performance data processing is globally enabled. Defaults to true.
   vars                      | Dictionary            | **Optional.** A dictionary containing custom attributes that are available globally.
+  environment               | String                | **Optional.** Specify the Icinga environment. This overrides the `Environment` constant specified in the configuration or on the CLI with `--define`. Defaults to empty.
 
 ## IdoMySqlConnection <a id="objecttype-idomysqlconnection"></a>
 

diff --git a/doc/16-upgrading-icinga-2.md b/doc/16-upgrading-icinga-2.md
index cce8cd916ff76059e8cfe5512f9890cc354c3fe1..4e4db7c7f1ec33eefe91a3d3a27e37eed347049c 100644 (file)
--- a/doc/16-upgrading-icinga-2.md
+++ b/doc/16-upgrading-icinga-2.md
@@ -41,6 +41,7 @@ has been removed and this setting has no effect.
 
 New [Icinga constants](17-language-reference.md#icinga-constants) have been added in this release.
 
+* `Environment` for specifying the Icinga environment. Defaults to not set.
 * `ApiBindHost` and `ApiBindPort` to allow overriding the default ApiListener values. This will be used for an Icinga addon only.
 
 ## Upgrading to v2.9 <a id="upgrading-to-2-9"></a>

diff --git a/doc/17-language-reference.md b/doc/17-language-reference.md
index 12a8dd90822a0ad6fe3419144cd799db24cdf0b6..f7fae469576d0552e9acbf284319756efbd2b028 100644 (file)
--- a/doc/17-language-reference.md
+++ b/doc/17-language-reference.md
@@ -407,7 +407,7 @@ Constant            | Description
 --------------------|-------------------
 Vars                |**Read-write.** Contains a dictionary with global custom attributes. Not set by default.
 NodeName            |**Read-write.** Contains the cluster node name. Set to the local hostname by default.
-Environment         |**Read-write**. The name of the Icinga environment. Included in the SNI host name when making outbound connections. Defaults to `production`.
+Environment         |**Read-write.** The name of the Icinga environment. Included in the SNI host name for outbound connections. Not set by default.
 RunAsUser           |**Read-write.** Defines the user the Icinga 2 daemon is running as. Set in the Icinga 2 sysconfig.
 RunAsGroup          |**Read-write.** Defines the group the Icinga 2 daemon is running as. Set in the Icinga 2 sysconfig.
 MaxConcurrentChecks |**Read-write.** The number of max checks run simultaneously. Defaults to `512`.