mirror of
https://github.com/Icinga/icinga2.git
synced 2025-07-29 08:34:20 +02:00
Update documentation.
This commit is contained in:
parent
b25facafb9
commit
e1a1f13038
@ -50,7 +50,7 @@ By default Icinga 2 uses the following files and directories:
|
|||||||
/usr/share/doc/icinga2 | Documentation files that come with Icinga 2.
|
/usr/share/doc/icinga2 | Documentation files that come with Icinga 2.
|
||||||
/usr/share/icinga2/itl | The Icinga Template Library.
|
/usr/share/icinga2/itl | The Icinga Template Library.
|
||||||
/var/run/icinga2 | PID file.
|
/var/run/icinga2 | PID file.
|
||||||
/var/run/icinga2/cmd | Command pipe and livestatus socket.
|
/var/run/icinga2/cmd | Command pipe and Livestatus socket.
|
||||||
/var/cache/icinga2 | Performance data files and status.dat/objects.cache.
|
/var/cache/icinga2 | Performance data files and status.dat/objects.cache.
|
||||||
/var/lib/icinga2 | The Icinga 2 state file.
|
/var/lib/icinga2 | The Icinga 2 state file.
|
||||||
|
|
||||||
@ -58,7 +58,7 @@ By default Icinga 2 uses the following files and directories:
|
|||||||
|
|
||||||
An example configuration file is installed for you in `/etc/icinga2/icinga2.conf`.
|
An example configuration file is installed for you in `/etc/icinga2/icinga2.conf`.
|
||||||
|
|
||||||
Here's a brief description of the example config:
|
Here's a brief description of the example configuration:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Icinga 2 configuration file
|
* Icinga 2 configuration file
|
||||||
|
@ -4,7 +4,7 @@ The IDO (Icinga Data Output) modules for Icinga 2 takes care of exporting all
|
|||||||
configuration and status information into a database. The IDO database is used
|
configuration and status information into a database. The IDO database is used
|
||||||
by a number of projects including Icinga Web.
|
by a number of projects including Icinga Web.
|
||||||
|
|
||||||
There is a separate module for each database backend. At present only support
|
There is a separate module for each database back-end. At present only support
|
||||||
for MySQL is implemented.
|
for MySQL is implemented.
|
||||||
|
|
||||||
### Setting up the database
|
### Setting up the database
|
||||||
@ -43,7 +43,7 @@ The package provides a new configuration file that is installed in
|
|||||||
`/etc/icinga2/features-available/ido-mysql.conf`. You will need to update the
|
`/etc/icinga2/features-available/ido-mysql.conf`. You will need to update the
|
||||||
database credentials in this file.
|
database credentials in this file.
|
||||||
|
|
||||||
You can enable the ido-mysql feature configuration file using `i2enfeature`:
|
You can enable the `ido-mysql` feature configuration file using `i2enfeature`:
|
||||||
|
|
||||||
# i2enfeature ido-mysql
|
# i2enfeature ido-mysql
|
||||||
Module 'ido-mysql' was enabled.
|
Module 'ido-mysql' was enabled.
|
||||||
|
@ -12,7 +12,7 @@ Icinga 2's init script is installed in `/etc/init.d/icinga2` by default:
|
|||||||
start | The `start` action starts the Icinga 2 daemon.
|
start | The `start` action starts the Icinga 2 daemon.
|
||||||
stop | The `stop` action stops the Icinga 2 daemon.
|
stop | The `stop` action stops the Icinga 2 daemon.
|
||||||
restart | The `restart` action is a shortcut for running the `stop` action followed by `start`.
|
restart | The `restart` action is a shortcut for running the `stop` action followed by `start`.
|
||||||
reload | The `reload` action sends the HUP signal to Icinga 2 which causes it to restart. Unlike the `restart` action `reload` does not wait until Icinga 2 has restarted.
|
reload | The `reload` action sends the `HUP` signal to Icinga 2 which causes it to restart. Unlike the `restart` action `reload` does not wait until Icinga 2 has restarted.
|
||||||
checkconfig | The `checkconfig` action checks if the `/etc/icinga2/icinga2.conf` configuration file contains any errors.
|
checkconfig | The `checkconfig` action checks if the `/etc/icinga2/icinga2.conf` configuration file contains any errors.
|
||||||
status | The `status` action checks if Icinga 2 is running.
|
status | The `status` action checks if Icinga 2 is running.
|
||||||
|
|
||||||
@ -46,8 +46,8 @@ you can also use the `--library` command-line option.
|
|||||||
#### Config Include Path
|
#### Config Include Path
|
||||||
|
|
||||||
When including files you can specify that the include search path should be
|
When including files you can specify that the include search path should be
|
||||||
checked. You can do this by putting your config file name in angle brackets
|
checked. You can do this by putting your configuration file name in angle
|
||||||
like this:
|
brackets like this:
|
||||||
|
|
||||||
include <test.conf>
|
include <test.conf>
|
||||||
|
|
||||||
@ -60,8 +60,8 @@ added.
|
|||||||
|
|
||||||
#### Config Files
|
#### Config Files
|
||||||
|
|
||||||
Using the `--config` option you can specify one or more config files. Config
|
Using the `--config` option you can specify one or more configuration files.
|
||||||
files are processed in the order they're specified on the command-line.
|
Config files are processed in the order they're specified on the command-line.
|
||||||
|
|
||||||
#### Config Validation
|
#### Config Validation
|
||||||
|
|
||||||
|
@ -31,9 +31,9 @@ Here is an example of a command definition which uses user-defined macros:
|
|||||||
> **Note**
|
> **Note**
|
||||||
>
|
>
|
||||||
> If you have previously used Icinga 1.x you may already be familiar with
|
> If you have previously used Icinga 1.x you may already be familiar with
|
||||||
> user and argument macros (e.g., USER1 or ARG1). Unlike in Icinga 1.x macros
|
> user and argument macros (e.g., `USER1` or `ARG1`). Unlike in Icinga 1.x macros
|
||||||
> may have arbitrary names and arguments are no longer specified in the
|
> may have arbitrary names and arguments are no longer specified in the
|
||||||
> check_command setting.
|
> `check_command` setting.
|
||||||
|
|
||||||
Macro names must be enclosed in two `$` signs, e.g. `$plugindir$`. When
|
Macro names must be enclosed in two `$` signs, e.g. `$plugindir$`. When
|
||||||
executing commands Icinga 2 checks the following objects in this
|
executing commands Icinga 2 checks the following objects in this
|
||||||
@ -67,7 +67,7 @@ emitted to the Icinga 2 log.
|
|||||||
|
|
||||||
> **Note**
|
> **Note**
|
||||||
>
|
>
|
||||||
> Macros in capital letters (e.g. HOSTNAME) are reserved for use by Icinga 2
|
> Macros in capital letters (e.g. `HOSTNAME`) are reserved for use by Icinga 2
|
||||||
> and should not be overwritten by users.
|
> and should not be overwritten by users.
|
||||||
|
|
||||||
By convention every host should have an `address` macro. Hosts
|
By convention every host should have an `address` macro. Hosts
|
||||||
@ -85,16 +85,16 @@ hosts or services:
|
|||||||
Name | Description
|
Name | Description
|
||||||
-----------------------|--------------
|
-----------------------|--------------
|
||||||
HOSTNAME | The name of the host object.
|
HOSTNAME | The name of the host object.
|
||||||
HOSTDISPLAYNAME | The value of the display_name attribute.
|
HOSTDISPLAYNAME | The value of the `display_name` attribute.
|
||||||
HOSTALIAS | This is an alias for the `HOSTDISPLAYNAME` macro.
|
HOSTALIAS | This is an alias for the `HOSTDISPLAYNAME` macro.
|
||||||
HOSTSTATE | The host's current state. Can be one of UNREACHABLE, UP and DOWN.
|
HOSTSTATE | The host's current state. Can be one of `UNREACHABLE`, `UP` and `DOWN`.
|
||||||
HOSTSTATEID | The host's current state. Can be one of 0 (up), 1 (down) and 2 (unreachable).
|
HOSTSTATEID | The host's current state. Can be one of `0` (up), `1` (down) and `2` (unreachable).
|
||||||
HOSTSTATETYPE | The host's current state type. Can be one of SOFT and HARD.
|
HOSTSTATETYPE | The host's current state type. Can be one of `SOFT` and `HARD`.
|
||||||
HOSTATTEMPT | The current check attempt number.
|
HOSTATTEMPT | The current check attempt number.
|
||||||
MAXHOSTATTEMPT | The maximum number of checks which are executed before changing to a hard state.
|
MAXHOSTATTEMPT | The maximum number of checks which are executed before changing to a hard state.
|
||||||
LASTHOSTSTATE | The host's previous state. Can be one of UNREACHABLE, UP and DOWN.
|
LASTHOSTSTATE | The host's previous state. Can be one of `UNREACHABLE`, `UP` and `DOWN`.
|
||||||
LASTHOSTSTATEID | The host's previous state. Can be one of 0 (up), 1 (down) and 2 (unreachable).
|
LASTHOSTSTATEID | The host's previous state. Can be one of `0` (up), `1` (down) and `2` (unreachable).
|
||||||
LASTHOSTSTATETYPE | The host's previous state type. Can be one of SOFT and HARD.
|
LASTHOSTSTATETYPE | The host's previous state type. Can be one of `SOFT` and `HARD`.
|
||||||
HOSTLATENCY | The host's check latency.
|
HOSTLATENCY | The host's check latency.
|
||||||
HOSTEXECUTIONTIME | The host's check execution time.
|
HOSTEXECUTIONTIME | The host's check execution time.
|
||||||
HOSTOUTPUT | The last check's output.
|
HOSTOUTPUT | The last check's output.
|
||||||
@ -111,16 +111,16 @@ services:
|
|||||||
Name | Description
|
Name | Description
|
||||||
-----------------------|--------------
|
-----------------------|--------------
|
||||||
SERVICEDESC | The short name of the service object.
|
SERVICEDESC | The short name of the service object.
|
||||||
SERVICEDISPLAYNAME | The value of the display_name attribute.
|
SERVICEDISPLAYNAME | The value of the `display_name` attribute.
|
||||||
SERVICECHECKCOMMAND | This is an alias for the `SERVICEDISPLAYNAME` macro.
|
SERVICECHECKCOMMAND | This is an alias for the `SERVICEDISPLAYNAME` macro.
|
||||||
SERVICESTATE | The service's current state. Can be one of OK, WARNING, CRITICAL, UNCHECKABLE and UNKNOWN.
|
SERVICESTATE | The service's current state. Can be one of `OK`, `WARNING`, `CRITICAL` and `UNKNOWN`.
|
||||||
SERVICESTATEID | The service's current state. Can be one of 0 (ok), 1 (warning), 2 (critical), 3 (unknown) and 4 (uncheckable).
|
SERVICESTATEID | The service's current state. Can be one of `0` (ok), `1` (warning), `2` (critical) and `3` (unknown).
|
||||||
SERVICESTATETYPE | The service's current state type. Can be one of SOFT and HARD.
|
SERVICESTATETYPE | The service's current state type. Can be one of `SOFT` and `HARD`.
|
||||||
SERVICEATTEMPT | The current check attempt number.
|
SERVICEATTEMPT | The current check attempt number.
|
||||||
MAXSERVICEATTEMPT | The maximum number of checks which are executed before changing to a hard state.
|
MAXSERVICEATTEMPT | The maximum number of checks which are executed before changing to a hard state.
|
||||||
LASTSERVICESTATE | The service's previous state. Can be one of OK, WARNING, CRITICAL, UNCHECKABLE and UNKNOWN.
|
LASTSERVICESTATE | The service's previous state. Can be one of `OK`, `WARNING`, `CRITICAL` and `UNKNOWN`.
|
||||||
LASTSERVICESTATEID | The service's previous state. Can be one of 0 (ok), 1 (warning), 2 (critical), 3 (unknown) and 4 (uncheckable).
|
LASTSERVICESTATEID | The service's previous state. Can be one of `0` (ok), `1` (warning), `2` (critical) and `3` (unknown).
|
||||||
LASTSERVICESTATETYPE | The service's previous state type. Can be one of SOFT and HARD.
|
LASTSERVICESTATETYPE | The service's previous state type. Can be one of `SOFT` and `HARD`.
|
||||||
LASTSERVICESTATECHANGE | The last state change's timestamp.
|
LASTSERVICESTATECHANGE | The last state change's timestamp.
|
||||||
SERVICELATENCY | The service's check latency.
|
SERVICELATENCY | The service's check latency.
|
||||||
SERVICEEXECUTIONTIME | The service's check execution time.
|
SERVICEEXECUTIONTIME | The service's check execution time.
|
||||||
|
@ -5,7 +5,7 @@ object.
|
|||||||
|
|
||||||
For example, rather than manually creating a `ping` service object for each of
|
For example, rather than manually creating a `ping` service object for each of
|
||||||
your hosts you can use templates to avoid having to copy & paste parts of your
|
your hosts you can use templates to avoid having to copy & paste parts of your
|
||||||
config:
|
configuration:
|
||||||
|
|
||||||
template Host "linux-server" {
|
template Host "linux-server" {
|
||||||
services["ping"] = {
|
services["ping"] = {
|
||||||
|
@ -15,7 +15,7 @@ define objects the `object` keyword is used:
|
|||||||
|
|
||||||
> **Note**
|
> **Note**
|
||||||
>
|
>
|
||||||
> The Icinga 2 configuration format is agnostic to whitespaces and
|
> The Icinga 2 configuration format is agnostic to white space characters and
|
||||||
> new-lines.
|
> new-lines.
|
||||||
|
|
||||||
> **Note**
|
> **Note**
|
||||||
@ -72,7 +72,7 @@ In addition to these pre-defined escape sequences you can specify
|
|||||||
arbitrary ASCII characters using the backslash character (\\) followed
|
arbitrary ASCII characters using the backslash character (\\) followed
|
||||||
by an ASCII character in octal encoding.
|
by an ASCII character in octal encoding.
|
||||||
|
|
||||||
#### Multiline String Literals
|
#### Multi-line String Literals
|
||||||
|
|
||||||
Strings spanning multiple lines can be specified by enclosing them in
|
Strings spanning multiple lines can be specified by enclosing them in
|
||||||
{{{ and }}}.
|
{{{ and }}}.
|
||||||
@ -262,7 +262,7 @@ Example:
|
|||||||
|
|
||||||
The `default-host` and `test-host` objects are marked as templates
|
The `default-host` and `test-host` objects are marked as templates
|
||||||
using the `template` keyword. Unlike ordinary objects templates are not
|
using the `template` keyword. Unlike ordinary objects templates are not
|
||||||
instantiated at runtime. Parent objects do not necessarily have to be
|
instantiated at run-time. Parent objects do not necessarily have to be
|
||||||
templates though in general they are.
|
templates though in general they are.
|
||||||
|
|
||||||
> **Note**
|
> **Note**
|
||||||
@ -290,7 +290,7 @@ Simple calculations can be performed using the constant expression syntax:
|
|||||||
}
|
}
|
||||||
|
|
||||||
Valid operators include +, -, * and /. The default precedence rules can be
|
Valid operators include +, -, * and /. The default precedence rules can be
|
||||||
overriden by grouping expressions using parentheses:
|
overridden by grouping expressions using parentheses:
|
||||||
|
|
||||||
{
|
{
|
||||||
check_interval ((15 * 60) / 2)
|
check_interval ((15 * 60) / 2)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user