Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gunnarbeutner committed Jan 22, 2015
1 parent 78bfd02 commit e09b888
Show file tree
Hide file tree
Showing 16 changed files with 288 additions and 260 deletions.
8 changes: 4 additions & 4 deletions doc/1-about.md
Expand Up @@ -124,7 +124,7 @@ Icinga 2 still supports writing performance data files for graphing addons, but
capability of writing performance data directly into a Graphite TCP socket simplifying realtime
monitoring graphs.

* Native support for writing log events to [GELF](#gelf-writer) receivers (graylog2, Logstash)
* Native support for writing log events to [GELF](11-object-types.md#objecttype-gelfwriter) receivers (graylog2, Logstash)

Icinga 2 will write all check result, state change and notification event logs into a defined
[GELF](3-monitoring-basics.md#gelfwriter) input receiver. Natively provided by [graylog2](http://www.graylog2.org),
Expand All @@ -139,7 +139,7 @@ relationships based on patterns. More advanced features for dynamic object gener
Supported with [duration literals](9-language-reference.md#duration-literals) for interval
attributes, [expression operators](9-language-reference.md#expression-operators), [function calls](9-language-reference.md#function-calls) for
pattern and regex matching and (global) [constants](9-language-reference.md#constants).
[Check command configuration](#plugin-check-commands) for common plugins is shipped with Icinga 2 as part of the [Icinga Template Library](#itl).
[Check command configuration](12-icinga-template-library.md#plugin-check-commands) for common plugins is shipped with Icinga 2 as part of the [Icinga Template Library](12-icinga-template-library.md#icinga-template-library).

* Revamped Commands

Expand Down Expand Up @@ -183,13 +183,13 @@ objects and specify their active time window.

* Embedded Health Checks

No more external statistic tool but an [instance](#itl-icinga) and [cluster](#itl-cluster) health
No more external statistic tool but an [instance](12-icinga-template-library.md#itl-icinga) and [cluster](12-icinga-template-library.md#itl-icinga-cluster) health
check providing direct statistics as performance data for your graphing addon, for example Graphite.

* Compatibility with Icinga 1.x

All known interfaces are optionally available: [status files](3-monitoring-basics.md#status-data), [logs](3-monitoring-basics.md#compat-logging),
[DB IDO](#configuring-ido) MySQL/PostgreSQL, [performance data](3-monitoring-basics.md#performance-data),
[DB IDO](2-getting-started.md#configuring-db-ido) MySQL/PostgreSQL, [performance data](3-monitoring-basics.md#performance-data),
[external command pipe](3-monitoring-basics.md#external-commands) and for migration reasons a
[checkresult file reader](3-monitoring-basics.md#check-result-files) too.
All [Monitoring Plugins](2-getting-started.md#setting-up-check-plugins) can be integrated into Icinga 2 with
Expand Down
4 changes: 2 additions & 2 deletions doc/9-language-reference.md → doc/10-language-reference.md
Expand Up @@ -188,7 +188,7 @@ Functions can be called using the `()` operator:
check_interval = len(MyGroups) * 1m
}

A list of available functions is available in the [Built-in functions and methods](#builtin-functions) chapter.
A list of available functions is available in the [Library Reference](10-library-reference.md#library-reference) chapter.

## <a id="dictionary-operators"></a> Assignments

Expand Down Expand Up @@ -487,7 +487,7 @@ Note the use of angle brackets instead of double quotes. This causes the
config compiler to search the include search paths for the specified
file. By default $PREFIX/share/icinga2/include is included in the list of search
paths. Additional include search paths can be added using
[command-line options](#cmdline).
[command-line options](5-cli-commands.md#config-include-path).

Wildcards are not permitted when using angle brackets.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
79 changes: 13 additions & 66 deletions doc/2-getting-started.md
Expand Up @@ -343,15 +343,15 @@ The custom attribute `os` is evaluated by the `linux-servers` group in
The example host will show you how to

* define http vhost attributes for the `http` service apply rule defined
in [services.conf](#services.conf).
in [services.conf](2-getting-started.md#services-conf).
* define disks (all, specific `/`) and their attributes for the `disk`
service apply rule defined in [services.conf](#services.conf).
service apply rule defined in [services.conf](2-getting-started.md#services-conf).
* define notification types (`mail`) and set the groups attribute. This
will be used by notification apply rules in [notifications.conf](notifications-conf).

If you've installed [Icinga Web 2](2-getting-started.md#setting-up-icingaweb2) you can
uncomment the http vhost attributes and relaod Icinga 2. The apply
rules in [services.conf](#services.conf) will automatically
rules in [services.conf](2-getting-started.md#services-conf) will automatically
generate a new service checking the `/icingaweb2` URI using the `http`
check.

Expand Down Expand Up @@ -438,7 +438,7 @@ Service(s) | Applied on host(s)
The Debian packages also ship an additional `apt` service check applied to the local host.

The command object `icinga` for the embedded health check is provided by the
[Icinga Template Library (ITL)](#itl) while `http_ip`, `ssh`, `load`, `processes`,
[Icinga Template Library (ITL)](12-icinga-template-library.md#icinga-template-library) while `http_ip`, `ssh`, `load`, `processes`,
`users` and `disk` are all provided by the [Plugin Check Commands](12-icinga-template-library.md#plugin-check-commands)
which we enabled earlier by including the `itl` and `plugins` configuration file.

Expand Down Expand Up @@ -597,7 +597,7 @@ The `interval` attribute is not explicitly set - it [defaults to 30 minutes](11-

By setting the `user_groups` to the value provided by the
respective [host.vars.notification.mail](2-getting-started.md#hosts-conf) attribute we'll
implicitely use the`icingaadmins` UserGroup defined in [users.conf](#users.conf).
implicitely use the`icingaadmins` UserGroup defined in [users.conf](2-getting-started.md#users-conf).

apply Notification "mail-icingaadmin" to Host {
import "mail-host-notification"
Expand Down Expand Up @@ -811,8 +811,8 @@ RHEL/CentOS 5/6:
RHEL/CentOS 7 and Fedora 20 prefer MariaDB over MySQL:

# yum install mariadb-server mariadb
# systemctl enable mariadb.service
# systemctl start mariadb.service
# systemctl enable mariadb
# systemctl start mariadb

SUSE:

Expand All @@ -839,8 +839,8 @@ RHEL/CentOS 5/6:
RHEL/CentOS 7 and Fedora 20 use [systemd](2-getting-started.md#systemd-service):

# yum install postgresql-server postgresql
# systemctl enable postgresql.service
# systemctl start postgresql.service
# systemctl enable postgresql
# systemctl start postgresql

SUSE:

Expand Down Expand Up @@ -938,7 +938,7 @@ Debian/Ubuntu, RHEL/CentOS 6 and SUSE:

RHEL/CentOS 7 and Fedora 20:

# systemctl restart icinga2.service
# systemctl restart icinga2

### <a id="configuring-db-ido-postgresql"></a> Configuring DB IDO PostgreSQL

Expand Down Expand Up @@ -1052,7 +1052,7 @@ Debian/Ubuntu, RHEL/CentOS 6 and SUSE:

RHEL/CentOS 7 and Fedora 20:

# systemctl restart icinga2.service
# systemctl restart icinga2


### <a id="setting-up-external-command-pipe"></a> Setting Up External Command Pipe
Expand All @@ -1072,7 +1072,7 @@ Debian/Ubuntu, RHEL/CentOS 6 and SUSE:

RHEL/CentOS 7 and Fedora 20:

# systemctl restart icinga2.service
# systemctl restart icinga2

By default the command pipe file is owned by the group `icingacmd` with read/write
permissions. Add your webserver's user to the group `icingacmd` to
Expand All @@ -1092,59 +1092,6 @@ Change "www-data" to the user you're using to run queries.
> Packages will do that automatically. Verify that by running `id <your-webserver-user>` and skip this
> step.
## <a id="setting-up-livestatus"></a> Setting up Livestatus

The [MK Livestatus](http://mathias-kettner.de/checkmk_livestatus.html) project
implements a query protocol that lets users query their Icinga instance for
status information. It can also be used to send commands.

> **Tip**
>
> Only install the Livestatus feature if your web interface or addon requires
> you to do so (for example, [Icinga Web 2](2-getting-started.md#setting-up-icingaweb2)).
> [Icinga Classic UI](2-getting-started.md#setting-up-icinga-classic-ui) and [Icinga Web](2-getting-started.md#setting-up-icinga-web)
> do not use Livestatus as backend.
The Livestatus component that is distributed as part of Icinga 2 is a
re-implementation of the Livestatus protocol which is compatible with MK
Livestatus.

Details on the available tables and attributes with Icinga 2 can be found
in the [Livestatus](3-monitoring-basics.md#livestatus) section.

You can enable Livestatus using icinga2 feature enable:

# icinga2 feature enable livestatus

After that you will have to restart Icinga 2:

Debian/Ubuntu, RHEL/CentOS 6 and SUSE:

# service icinga2 restart

RHEL/CentOS 7 and Fedora 20:

# systemctl restart icinga2.service

By default the Livestatus socket is available in `/var/run/icinga2/cmd/livestatus`.

In order for queries and commands to work you will need to add your query user
(e.g. your web server) to the `icingacmd` group:

# usermod -a -G icingacmd www-data

The Debian packages use `nagios` as the user and group name. Make sure to change `icingacmd` to
`nagios` if you're using Debian.

Change "www-data" to the user you're using to run queries.

In order to use the historical tables provided by the livestatus feature (for example, the
`log` table) you need to have the `CompatLogger` feature enabled. By default these logs
are expected to be in `/var/log/icinga2/compat`. A different path can be set using the
`compat_log_path` configuration attribute.

# icinga2 feature enable compatlog

## <a id="setting-up-icinga2-user-interfaces"></a> Setting up Icinga 2 User Interfaces

Icinga 2 can be used with [Icinga Web 2](2-getting-started.md#setting-up-icingaweb2), using
Expand Down Expand Up @@ -1294,7 +1241,7 @@ please check the official [Icinga 1.x user interface documentation](http://docs.

Icinga 2 can write to the same schema supplied by `Icinga IDOUtils 1.x` which
is an explicit requirement to run `Icinga Web` next to the external command pipe.
Therefore you need to setup the [DB IDO feature](#configuring-ido) remarked in the previous sections.
Therefore you need to setup the [DB IDO feature](2-getting-started.md#configuring-db-ido) remarked in the previous sections.

#### <a id="installing-icinga-web"></a> Installing Icinga Web 1.x

Expand Down

0 comments on commit e09b888

Please sign in to comment.