Documentation: Add a note about multiple cluster nodes and LocalStateDir.

Fixes #5619
This commit is contained in:
Michael Friedrich 2014-02-20 16:56:37 +01:00
parent f890a7ae8c
commit 28ab19731a
2 changed files with 41 additions and 0 deletions

View File

@ -113,3 +113,27 @@ You can disable features using the `icinga2-disable-feature` command:
> **Note** > **Note**
> >
> The `icinga2-enable-feature` and `icinga2-disable-feature` commands do not restart Icinga 2. > The `icinga2-enable-feature` and `icinga2-disable-feature` commands do not restart Icinga 2.
### <a id="runtime-locations"></a> Runtime Locations
This list describes the default package installation locations. Additional subdirectories
may be required.
These paths may differ depending on your installation method, or changed
[global constants](#global-constants) regarding path settings.
Name | Description
--------------------------------------|--------------------------
/etc/icinga2 | Icinga 2 configuration.
/usr/sbin/icinga2* | Icinga 2 daemon and feature enable/disable scripts.
/usr/bin/icinga2* | Helper scripts for Icinga 2.
/var/cache/icinga2 | Runtime files written such as status files.
/var/lib/icinga2 | Icinga 2 state file, cluster feature replay log and configuration files.
/var/log/icinga2 | Used for application, debug and compat log files.
/var/spool/icinga2 | Used for performance data spool files.
/var/run/icinga2 | Runtime data such as PID file, or ExternalCommandListener/LivestatusListener pipes/sockets.
/usr/lib/icinga2 | Icinga 2 Libraries.
/usr/share/icinga2 | [ITL](#itl) and [certificate helpers](#cluster).
/usr/share/doc/icinga2* | This documentation.

View File

@ -257,6 +257,7 @@ If you update the configuration files on the configured file sender, it will
force a restart on all receiving nodes after validating the new config. force a restart on all receiving nodes after validating the new config.
By default these configuration files are saved in /var/lib/icinga2/cluster/config. By default these configuration files are saved in /var/lib/icinga2/cluster/config.
In order to load configuration files which were received from a remote Icinga 2 In order to load configuration files which were received from a remote Icinga 2
instance you will have to add the following include directive to your instance you will have to add the following include directive to your
`icinga2.conf` configuration file: `icinga2.conf` configuration file:
@ -320,6 +321,22 @@ Example:
> point of views. Use the `authorities` attribute to assign the service > point of views. Use the `authorities` attribute to assign the service
> check to the configured node. > check to the configured node.
### <a id="host-multiple-cluster-nodes"></a> Host With Multiple Cluster Nodes
Special scenarios might require multiple cluster nodes running on a single host.
By default Icinga 2 and its features will drop their runtime data below the prefix
`IcingaLocalStateDir`. By default packages will set that path to `/var`.
You can either set that variable as constant configuration
definition in [icinga2.conf](#icinga2-conf) or pass it as runtime variable to
the Icinga 2 daemon.
# icinga2 -c /etc/icinga2/node1/icinga2.conf -DIcingaLocalStateDir=/opt/node1/var
> **Note**
>
> You are required to ship the same directory layout known from a default
> Icinga 2 installation. Details in [Runtime Locations](#runtime-locations).
## <a id="dependencies"></a> Dependencies ## <a id="dependencies"></a> Dependencies
Icinga 2 uses host and service dependencies as attribute directly on the host or Icinga 2 uses host and service dependencies as attribute directly on the host or