tyler.durden
/
icinga2
mirror of https://github.com/Icinga/icinga2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation and add upgrading notes

This commit is contained in:
Michael Friedrich 2018-08-10 12:53:06 +02:00
parent 97513965e6
commit 02009525a1
4 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/06-distributed-monitoring.md
View File

@ -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`

1
doc/09-object-types.md
View File

@ -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>

1
doc/16-upgrading-icinga-2.md
View File

@ -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>

2
doc/17-language-reference.md
View File

@ -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`.