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

Update documentation

This commit is contained in:
Gunnar Beutner 2015-02-12 10:29:21 +01:00
parent e3edcfddde
commit cfe986e9c5
5 changed files with 29 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/10-addons-plugins.md
View File

@ -1,45 +1,36 @@
# <a id="addons-plugins"></a> Icinga 2 Addons and Plugins # <a id="addons-plugins"></a> Icinga 2 Addons and Plugins
## <a id="addons"></a> Addons ## <a id="addons-graphing-pnp"></a> PNP
### <a id="addons-graphing-reporting"></a> Graphing Addons [PNP](http://www.pnp4nagios.org) is a graphing addon. If you're planning to use
it you have to configure it to use the
#### <a id="addons-graphing-pnp"></a> PNP
[PNP](http://www.pnp4nagios.org) must be configured using the
[bulk mode with npcd and npcdmod](http://docs.pnp4nagios.org/pnp-0.6/modes#bulk_mode_with_npcd_and_npcdmod) [bulk mode with npcd and npcdmod](http://docs.pnp4nagios.org/pnp-0.6/modes#bulk_mode_with_npcd_and_npcdmod)
hence Icinga 2's [PerfdataWriter](4-advanced-topics.md#performance-data) acts as npcdmod. NPCD will collect in combination with Icinga 2's [PerfdataWriter](4-advanced-topics.md#performance-data). NPCD collects the performance
the rotated performance data files. data files which Icinga 2 generates.
#### <a id="addons-graphing-ingraph"></a> inGraph ## <a id="addons-graphing-ingraph"></a> inGraph
[inGraph](https://www.netways.org/projects/ingraph/wiki) requires the ingraph-collector addon [inGraph](https://www.netways.org/projects/ingraph/wiki) requires the ingraph-collector addon
to be configured to point at the perfdata files. Icinga 2's [PerfdataWriter](4-advanced-topics.md#performance-data) will to be configured to point at the perfdata files. Icinga 2's [PerfdataWriter](4-advanced-topics.md#performance-data) will
write to the performance data spool directory. write to the performance data spool directory.
#### <a id="addons-graphing-graphite"></a> Graphite ## <a id="addons-graphing-graphite"></a> Graphite
There are Graphite addons available for collecting the performance data files as well. But There are Graphite addons available for collecting the performance data files as well. But
natively you can use the [GraphiteWriter](4-advanced-topics.md#graphite-carbon-cache-writer) feature. natively you can use the [GraphiteWriter](4-advanced-topics.md#graphite-carbon-cache-writer) feature.
#### <a id="addons-reporting"></a> Icinga Reporting ## <a id="addons-reporting"></a> Icinga Reporting
By enabling the DB IDO feature you can use the Icinga Reporting package. By enabling the DB IDO feature you can use the Icinga Reporting package.
## <a id="addons-visualization-nagvis"></a> NagVis
### <a id="addons-visualization"></a> Visualization
#### <a id="addons-visualization-nagvis"></a> NagVis
By using either Livestatus or DB IDO as a backend you can create your own network maps By using either Livestatus or DB IDO as a backend you can create your own network maps
based on your monitoring configuration and status data using [NagVis](http://www.nagvis.org). based on your monitoring configuration and status data using [NagVis](http://www.nagvis.org).
### <a id="addons-web-interfaces"></a> Web Interfaces ## <a id="addons-thruk"></a> Thruk
As well as the Icinga supported web interfaces (Classic UI 1.x, Web 1.x, Web 2) there are a [Thruk](http://www.thruk.org) is an alternative web interface which can be used with Icinga 2.
number of community provided web interfaces too:
* [Thruk](http://www.thruk.org) based on the [Livestatus](12-livestatus.md#setting-up-livestatus) feature
## <a id="plugins"></a> Plugins ## <a id="plugins"></a> Plugins

2
doc/2-getting-started.md
View File

@ -24,7 +24,7 @@ and distribution you are running.
Packages for distributions other than the ones listed above may also be Packages for distributions other than the ones listed above may also be
available. Please contact your distribution packagers. available. Please contact your distribution packagers.
### <a id="installing-requirements"></a> Installing Requirements for Icinga 2 ### <a id="package-repositories"></a> Package Repositories
You need to add the Icinga repository to your package management configuration. You need to add the Icinga repository to your package management configuration.
Below is a list with examples for the various distributions. Below is a list with examples for the various distributions.

2
doc/3-monitoring-basics.md
View File

@ -93,7 +93,7 @@ The `hostalive` command is one of several built-in check commands. It sends ICMP
echo requests to the IP address specified in the `address` attribute to determine echo requests to the IP address specified in the `address` attribute to determine
whether a host is online. whether a host is online.
A number of other [built-in check commands](#plugin-check-comamnds) are also A number of other [built-in check commands](7-icinga-template-library.md#plugin-check-commands) are also
available. In addition to these commands the next few chapters will explain in available. In addition to these commands the next few chapters will explain in
detail how to set up your own check commands. detail how to set up your own check commands.

3
doc/4-advanced-topics.md
View File

@ -273,9 +273,6 @@ a forced service check:
Oct 17 15:01:25 icinga-server icinga2: Executing external command: [1382014885] SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;1382014885 Oct 17 15:01:25 icinga-server icinga2: Executing external command: [1382014885] SCHEDULE_FORCED_SVC_CHECK;localhost;ping4;1382014885
Oct 17 15:01:25 icinga-server icinga2: Rescheduling next check for service 'ping4' Oct 17 15:01:25 icinga-server icinga2: Rescheduling next check for service 'ping4'
### <a id="external-command-list"></a> External Command List
A list of currently supported external commands can be found [here](19-apendix.md#external-commands-list-detail). A list of currently supported external commands can be found [here](19-apendix.md#external-commands-list-detail).
Detailed information on the commands and their required parameters can be found Detailed information on the commands and their required parameters can be found

35
doc/8-cli-commands.md
View File

@ -1,4 +1,4 @@
## <a id="cli-commands"></a> Icinga 2 CLI Commands # <a id="cli-commands"></a> Icinga 2 CLI Commands
Icinga 2 comes with a number of CLI commands which support bash autocompletion. Icinga 2 comes with a number of CLI commands which support bash autocompletion.
@ -76,7 +76,7 @@ options.
Icinga home page: <https://www.icinga.org/> Icinga home page: <https://www.icinga.org/>
### <a id="cli-commands-autocompletion"></a> Icinga 2 CLI Bash Autocompletion ## <a id="cli-commands-autocompletion"></a> Icinga 2 CLI Bash Autocompletion
Bash Auto-Completion (pressing `<TAB>`) is provided only for the corresponding context. Bash Auto-Completion (pressing `<TAB>`) is provided only for the corresponding context.
@ -101,18 +101,18 @@ Debian/Ubuntu:
# apt-get install bash-completion # apt-get install bash-completion
### <a id="cli-commands-global-options"></a> Icinga 2 CLI Global Options ## <a id="cli-commands-global-options"></a> Icinga 2 CLI Global Options
#### Libraries ### Libraries
Instead of loading libraries using the [`library` config directive](16-language-reference.md#library) Instead of loading libraries using the [`library` config directive](16-language-reference.md#library)
you can also use the `--library` command-line option. you can also use the `--library` command-line option.
#### Constants ### Constants
[Global constants](16-language-reference.md#constants) can be set using the `--define` command-line option. [Global constants](16-language-reference.md#constants) can be set using the `--define` command-line option.
#### <a id="config-include-path"></a> Config Include Path ### <a id="config-include-path"></a> 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 configuration file name in angle checked. You can do this by putting your configuration file name in angle
@ -128,7 +128,7 @@ Using the `--include` command-line option additional search directories can be
added. added.
### <a id="cli-command-console"></a> CLI command: Console ## <a id="cli-command-console"></a> CLI command: Console
The CLI command `console` can be used to evaluate Icinga config expressions, e.g. to test The CLI command `console` can be used to evaluate Icinga config expressions, e.g. to test
`assign where` rules. `assign where` rules.
@ -148,7 +148,7 @@ use the `rlwrap` program if you require those features:
$ rlwrap icinga2 console $ rlwrap icinga2 console
### <a id="cli-command-daemon"></a> CLI command: Daemon ## <a id="cli-command-daemon"></a> CLI command: Daemon
The CLI command `daemon` provides the functionality to start/stop Icinga 2. The CLI command `daemon` provides the functionality to start/stop Icinga 2.
Furthermore it provides the [configuration validation](8-cli-commands.md#config-validation). Furthermore it provides the [configuration validation](8-cli-commands.md#config-validation).
@ -182,7 +182,7 @@ Furthermore it provides the [configuration validation](8-cli-commands.md#config-
Report bugs at <https://dev.icinga.org/> Report bugs at <https://dev.icinga.org/>
Icinga home page: <https://www.icinga.org/> Icinga home page: <https://www.icinga.org/>
#### Config Files ### Config Files
Using the `--config` option you can specify one or more configuration files. Using the `--config` option you can specify one or more configuration files.
Config 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.
@ -191,14 +191,14 @@ When no configuration file is specified and the `--no-config` is not used
Icinga 2 automatically falls back to using the configuration file Icinga 2 automatically falls back to using the configuration file
`SysconfDir + "/icinga2/icinga2.conf"` (where SysconfDir is usually `/etc`). `SysconfDir + "/icinga2/icinga2.conf"` (where SysconfDir is usually `/etc`).
#### Config Validation ### Config Validation
The `--validate` option can be used to check if your configuration files The `--validate` option can be used to check if your configuration files
contain errors. If any errors are found the exit status is 1, otherwise 0 contain errors. If any errors are found the exit status is 1, otherwise 0
is returned. More details in the [configuration validation](8-cli-commands.md#config-validation) chapter. is returned. More details in the [configuration validation](8-cli-commands.md#config-validation) chapter.
### <a id="cli-command-feature"></a> CLI command: Feature ## <a id="cli-command-feature"></a> CLI command: Feature
The `feature enable` and `feature disable` commands can be used to enable and disable features: The `feature enable` and `feature disable` commands can be used to enable and disable features:
@ -216,7 +216,7 @@ The `feature list` command shows which features are currently enabled:
Enabled features: api checker livestatus mainlog Enabled features: api checker livestatus mainlog
### <a id="cli-command-node"></a> CLI command: Node ## <a id="cli-command-node"></a> CLI command: Node
Provides the functionality to install and manage master and client Provides the functionality to install and manage master and client
nodes in a [remote monitoring ](9-monitoring-remote-systems.md#icinga2-remote-client-monitoring) or nodes in a [remote monitoring ](9-monitoring-remote-systems.md#icinga2-remote-client-monitoring) or
@ -260,7 +260,7 @@ nodes in a [remote monitoring ](9-monitoring-remote-systems.md#icinga2-remote-cl
Icinga home page: <https://www.icinga.org/> Icinga home page: <https://www.icinga.org/>
### <a id="cli-command-object"></a> CLI command: Object ## <a id="cli-command-object"></a> CLI command: Object
The `object` CLI command can be used to list all configuration objects and their The `object` CLI command can be used to list all configuration objects and their
attributes. The command also shows where each of the attributes was modified. attributes. The command also shows where each of the attributes was modified.
@ -294,7 +294,7 @@ More information can be found in the [troubleshooting](13-troubleshooting.md#lis
### <a id="cli-command-pki"></a> CLI command: Pki ## <a id="cli-command-pki"></a> CLI command: Pki
Provides the CLI commands to Provides the CLI commands to
@ -337,7 +337,7 @@ This functionality is used by the [node setup/wizard](8-cli-commands.md#cli-comm
Icinga home page: <https://www.icinga.org/> Icinga home page: <https://www.icinga.org/>
### <a id="cli-command-repository"></a> CLI command: Repository ## <a id="cli-command-repository"></a> CLI command: Repository
Provides the functionality to manage the Icinga 2 configuration repository in Provides the functionality to manage the Icinga 2 configuration repository in
`/etc/icinga2/repository.d`. All changes are logged and must be committed or `/etc/icinga2/repository.d`. All changes are logged and must be committed or
@ -392,7 +392,7 @@ cleared after review.
### <a id="cli-command-variable"></a> CLI command: Variable ## <a id="cli-command-variable"></a> CLI command: Variable
Lists all configured variables (constants) in a similar fasion like [object list](8-cli-commands.md#cli-command-object). Lists all configured variables (constants) in a similar fasion like [object list](8-cli-commands.md#cli-command-object).
@ -422,9 +422,6 @@ Lists all configured variables (constants) in a similar fasion like [object list
Icinga home page: <https://www.icinga.org/> Icinga home page: <https://www.icinga.org/>
## <a id="features"></a> Enabling/Disabling Features ## <a id="features"></a> Enabling/Disabling Features
Icinga 2 provides configuration files for some commonly used features. These Icinga 2 provides configuration files for some commonly used features. These