tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-07-24 22:24:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Fix remote client commands, formatting, missing attributes

Browse Source 
refs #7254
This commit is contained in:
Michael Friedrich 2014-11-15 15:10:22 +01:00
parent f5d3613a71
commit 99f9dc9c84
3 changed files with 102 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -436,8 +436,10 @@ Available configuration files shipped by default:
#### <a id="hosts-conf"></a> hosts.conf #### <a id="hosts-conf"></a> hosts.conf
The `conf.d/hosts.conf` file contains an example host based on your The `hosts.conf` file contains an example host based on your
`NodeName` setting in [constants.conf](#constants-conf). `NodeName` setting in [constants.conf](#constants-conf). You
can use global constants for your object names instead of string
values.
The `import` keyword is used to import the `generic-host` template which The `import` keyword is used to import the `generic-host` template which
takes care of setting up the host check command to `hostalive`. If you takes care of setting up the host check command to `hostalive`. If you
@ -885,7 +887,12 @@ Further details on the monitoring configuration can be found in the
The DB IDO (Database Icinga Data Output) modules for Icinga 2 take care of exporting The DB IDO (Database Icinga Data Output) modules for Icinga 2 take care of exporting
all configuration and status information into a database. The IDO database is used all configuration and status information into a database. The IDO database is used
by a number of projects including Icinga Web 1.x, Reporting or Icinga Web 2. by a number of projects including [Icinga Web 2](#setting-up-icingaweb2),
Icinga Reporting or Icinga Web 1.x.
Icinga 2 does not read configuration or status data from the database backend
so this interface is fully optional, if not required by your user interfaces
or addons.
There is a separate module for each database back-end. At present support for There is a separate module for each database back-end. At present support for
both MySQL and PostgreSQL is implemented. both MySQL and PostgreSQL is implemented.
@ -1024,13 +1031,14 @@ The Icinga 2 DB IDO module will check for the required database schema version o
and generate an error message if not satisfied. and generate an error message if not satisfied.
**Example:** You are upgrading Icinga 2 from version `2.0.2` to `2.1.0`. Look into **Example:** You are upgrading Icinga 2 from version `2.0.2` to `2.2.0`. Look into
the *upgrade* directory: the *upgrade* directory:
$ ls /usr/share/icinga2-ido-mysql/schema/upgrade/ $ ls /usr/share/icinga2-ido-mysql/schema/upgrade/
2.0.2.sql 2.1.0.sql 2.0.2.sql 2.1.0.sql 2.2.0.sql
There is a new upgrade file called `2.1.0.sql` which must be applied to your IDO database. There are two new upgrade files called `2.1.0.sql` and `2.2.0.sql`
which must be applied incrementially to your IDO database.
#### <a id="installing-ido-mysql"></a> Installing the IDO MySQL module #### <a id="installing-ido-mysql"></a> Installing the IDO MySQL module
@ -1141,9 +1149,10 @@ and generate an error message if not satisfied.
the *upgrade* directory: the *upgrade* directory:
$ ls /usr/share/icinga2-ido-pgsql/schema/upgrade/ $ ls /usr/share/icinga2-ido-pgsql/schema/upgrade/
2.0.2.sql 2.1.0.sql 2.0.2.sql 2.1.0.sql 2.2.0.sql
There is a new upgrade file called `2.1.0.sql` which must be applied to your IDO database. There are two new upgrade files called `2.1.0.sql` and `2.2.0.sql`
which must be applied incrementially to your IDO database.
#### <a id="installing-ido-postgresql"></a> Installing the IDO PostgreSQL module #### <a id="installing-ido-postgresql"></a> Installing the IDO PostgreSQL module

67
doc/5-monitoring-remote-systems.md
View File

@ -154,6 +154,7 @@ graphical installer for Windows based client setup.
Your client setup requires the following Your client setup requires the following
* A ready configured and installed [master node](#icinga2-remote-monitoring-master)
* SSL signed certificate for communication with the master (Use [CSR auto-signing](certifiates-csr-autosigning)). * SSL signed certificate for communication with the master (Use [CSR auto-signing](certifiates-csr-autosigning)).
* Enabled API feature, and a local Endpoint and Zone object configuration * Enabled API feature, and a local Endpoint and Zone object configuration
* Firewall ACLs for the communication port (default 5665) * Firewall ACLs for the communication port (default 5665)
@ -357,20 +358,52 @@ on the master and the remote client(s).
* `command_endpoint` attribute configured for host/service objects pointing to the configured * `command_endpoint` attribute configured for host/service objects pointing to the configured
endpoint endpoint
Example for communication configuration: `CheckCommand` objects are already shipped with the Icinga 2 ITL
as [plugin check commands](#plugin-check-commands). If you are
using your own configuration definitions for example in
[commands.conf](#commands-conf) make sure to copy/sync it
on your remote client.
object Endpoint "remote-client1" { #### <a id="icinga2-remote-monitoring-client-command-execution-client"></a> Client Configuration Remote Client for Command Execution
> **Note**
>
> Remote clients must explicitely accept commands in a similar
> fashion as cluster nodes [accept configuration]#i(cluster-zone-config-sync).
> This is due to security reasons.
Edit the `api` feature configuration in `/etc/icinga2/features-enabled/api.conf`
and set `accept_commands` to `true`.
object ApiListener "api" {
cert_path = SysconfDir + "/icinga2/pki/" + NodeName + ".crt"
key_path = SysconfDir + "/icinga2/pki/" + NodeName + ".key"
ca_path = SysconfDir + "/icinga2/pki/ca.crt"
accept_commands = true
}
#### <a id="icinga2-remote-monitoring-client-command-execution-master"></a> Master Configuration Remote Client for Command Execution
Add an `Endpoint` and `Zone` configuration object for the remote client
in [zones.conf](#zones-conf) and define a trusted master zone as `parent`.
object Endpoint "remote-client1" {
host = "192.168.33.20" host = "192.168.33.20"
} }
object Zone "remote-client1" { object Zone "remote-client1" {
endpoints = [ "remote-client1" ] endpoints = [ "remote-client1" ]
parent = "master" parent = "master"
} }
Example for host and service object configuration running commands on the remote endpoint: More details here:
* [configure endpoints](#configure-cluster-endpoints)
* [configure zones](#configure-cluster-zones)
object Host "host-remote" {
Configuration example for host and service objects running commands on the remote endpoint `remote-client1`:
object Host "host-remote" {
import "generic-host" import "generic-host"
address = "127.0.0.1" address = "127.0.0.1"
@ -383,9 +416,9 @@ object Host "host-remote" {
/* host specific check arguments */ /* host specific check arguments */
vars.users_wgreater = 10 vars.users_wgreater = 10
vars.users_wgreater = 20 vars.users_wgreater = 20
} }
apply Service "users-remote" { apply Service "users-remote" {
import "generic-service" import "generic-service"
check_command = "users" check_command = "users"
@ -397,14 +430,26 @@ apply Service "users-remote" {
/* assign where a remote client is set */ /* assign where a remote client is set */
assign where host.vars.remote_client assign where host.vars.remote_client
} }
That way you can also execute the `icinga` check remotely That way you can also execute the `icinga` check remotely
verifying the health of your remote client(s). As a bonus thus verifying the health of your remote client(s). As a bonus
you'll also get the running Icinga 2 version and may you'll also get the running Icinga 2 version and may
schedule client updates in your management tool (e.g. Puppet). schedule client updates in your management tool (e.g. Puppet).
> **Tip**
>
> [Event commands](#event-commands) are executed on the
> remote command endpoint as well. You do not need
> an additional transport layer such as SSH or similar.
> **Note**
> You cannot add any Icinga 2 features like DB IDO on the remote
> clients. There are no local configured objects available.
>
> If you require this, please install a full-featured
> [local client](#icinga2-remote-monitoring-client-local-config).
### <a id="icinga2-remote-monitoring-client-local-config"></a> Remote Client with Local Configuration ### <a id="icinga2-remote-monitoring-client-local-config"></a> Remote Client with Local Configuration

17
doc/7-configuring-icinga-2.md
View File

@ -649,11 +649,12 @@ Attributes:
flapping\_threshold|**Optional.** The flapping threshold in percent when a host is considered to be flapping. flapping\_threshold|**Optional.** The flapping threshold in percent when a host is considered to be flapping.
volatile |**Optional.** The volatile setting enables always `HARD` state types if `NOT-OK` state changes occur. volatile |**Optional.** The volatile setting enables always `HARD` state types if `NOT-OK` state changes occur.
zone |**Optional.** The zone this object is a member of. zone |**Optional.** The zone this object is a member of.
command\_endpoint|**Optional.** The endpoint where commands are executed on.
notes |**Optional.** Notes for the host. notes |**Optional.** Notes for the host.
notes_url |**Optional.** Url for notes for the host (for example, in notification commands). notes\_url |**Optional.** Url for notes for the host (for example, in notification commands).
action_url |**Optional.** Url for actions for the host (for example, an external graphing tool). action\_url |**Optional.** Url for actions for the host (for example, an external graphing tool).
icon_image |**Optional.** Icon image for the host. Used by external interfaces only. icon\_image |**Optional.** Icon image for the host. Used by external interfaces only.
icon_image_alt |**Optional.** Icon image description for the host. Used by external interface only. icon\_image\_alt|**Optional.** Icon image description for the host. Used by external interface only.
> **Best Practice** > **Best Practice**
> >
@ -736,11 +737,12 @@ Attributes:
flapping\_threshold|**Optional.** The flapping threshold in percent when a service is considered to be flapping. flapping\_threshold|**Optional.** The flapping threshold in percent when a service is considered to be flapping.
volatile |**Optional.** The volatile setting enables always `HARD` state types if `NOT-OK` state changes occur. volatile |**Optional.** The volatile setting enables always `HARD` state types if `NOT-OK` state changes occur.
zone |**Optional.** The zone this object is a member of. zone |**Optional.** The zone this object is a member of.
command\_endpoint|**Optional.** The endpoint where commands are executed on.
notes |**Optional.** Notes for the service. notes |**Optional.** Notes for the service.
notes_url |**Optional.** Url for notes for the service (for example, in notification commands). notes\_url |**Optional.** Url for notes for the service (for example, in notification commands).
action_url |**Optional.** Url for actions for the service (for example, an external graphing tool). action_url |**Optional.** Url for actions for the service (for example, an external graphing tool).
icon_image |**Optional.** Icon image for the service. Used by external interfaces only. icon\_image |**Optional.** Icon image for the service. Used by external interfaces only.
icon_image_alt |**Optional.** Icon image description for the service. Used by external interface only. icon\_image\_alt|**Optional.** Icon image description for the service. Used by external interface only.
Service objects have composite names, i.e. their names are based on the host_name attribute and the name you specified. This means Service objects have composite names, i.e. their names are based on the host_name attribute and the name you specified. This means
@ -1775,6 +1777,7 @@ Attributes:
bind\_host |**Optional.** The IP address the api listener should be bound to. Defaults to `0.0.0.0`. bind\_host |**Optional.** The IP address the api listener should be bound to. Defaults to `0.0.0.0`.
bind\_port |**Optional.** The port the api listener should be bound to. Defaults to `5665`. bind\_port |**Optional.** The port the api listener should be bound to. Defaults to `5665`.
accept\_config |**Optional.** Accept zone configuration. Defaults to `false`. accept\_config |**Optional.** Accept zone configuration. Defaults to `false`.
accept\_commands |**Optional.** Accept remote commands. Defaults to `false`.
### <a id="objecttype-endpoint"></a> Endpoint ### <a id="objecttype-endpoint"></a> Endpoint