tyler.durden
/
icinga2
mirror of https://github.com/Icinga/icinga2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
icinga2/doc/06-distributed-monitoring.md

2796 lines
120 KiB
Markdown
Raw Normal View History

Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
# Distributed Monitoring with Master, Satellites, and Clients <a id="distributed-monitoring"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
This chapter will guide you through the setup of a distributed monitoring
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
environment, including high-availability clustering and setup details
for the Icinga 2 client.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Roles: Master, Satellites, and Clients <a id="distributed-monitoring-roles"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Icinga 2 nodes can be given names for easier understanding:
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
* A `master` node which is on top of the hierarchy.
* A `satellite` node which is a child of a `satellite` or `master` node.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* A `client` node which works as an `agent` connected to `master` and/or `satellite` nodes.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
![Icinga 2 Distributed Roles](images/distributed-monitoring/icinga2_distributed_roles.png)
Rephrasing this picture into more details:
* A `master` node has no parent node.
* A `master`node is where you usually install Icinga Web 2.
* A `master` node can combine executed checks from child nodes into backends and notifications.
* A `satellite` node has a parent and a child node.
* A `satellite` node may execute checks on its own or delegate check execution to child nodes.
* A `satellite` node can receive configuration for hosts/services, etc. from the parent node.
* A `satellite` node continues to run even if the master node is temporarily unavailable.
* A `client` node only has a parent node.
* A `client` node will either run its own configured checks or receive command execution events from the parent node.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The following sections will refer to these roles and explain the
differences and the possibilities this kind of setup offers.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Tip**: If you just want to install a single master node that monitors several hosts
(i.e. Icinga 2 clients), continue reading -- we'll start with
simple examples.
In case you are planning a huge cluster setup with multiple levels and
lots of clients, read on -- we'll deal with these cases later on.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The installation on each system is the same: You need to install the
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
[Icinga 2 package](02-getting-started.md#setting-up-icinga2) and the required [plugins](02-getting-started.md#setting-up-check-plugins).
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
The required configuration steps are mostly happening
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
on the command line. You can also [automate the setup](06-distributed-monitoring.md#distributed-monitoring-automation).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The first thing you need learn about a distributed setup is the hierarchy of the single components.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Zones <a id="distributed-monitoring-zones"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
The Icinga 2 hierarchy consists of so-called [zone](09-object-types.md#objecttype-zone) objects.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Zones depend on a parent-child relationship in order to trust each other.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Distributed Zones](images/distributed-monitoring/icinga2_distributed_zones.png)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Have a look at this example for the `satellite` zones which have the `master` zone as a parent zone:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Zone "master" {
//...
}
object Zone "satellite region 1" {
parent = "master"
//...
}
object Zone "satellite region 2" {
parent = "master"
//...
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
There are certain limitations for child zones, e.g. their members are not allowed
to send configuration commands to the parent zone members. Vice versa, the
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
trust hierarchy allows for example the `master` zone to send
configuration files to the `satellite` zone. Read more about this
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
in the [security section](06-distributed-monitoring.md#distributed-monitoring-security).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
`client` nodes also have their own unique zone. By convention you
can use the FQDN for the zone name.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Endpoints <a id="distributed-monitoring-endpoints"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Nodes which are a member of a zone are so-called [Endpoint](09-object-types.md#objecttype-endpoint) objects.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Distributed Endpoints](images/distributed-monitoring/icinga2_distributed_endpoints.png)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Here is an example configuration for two endpoints in different zones:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Endpoint "icinga2-master1.localdomain" {
host = "192.168.56.101"
}
object Endpoint "icinga2-satellite1.localdomain" {
host = "192.168.56.105"
}
object Zone "master" {
endpoints = [ "icinga2-master1.localdomain" ]
}
object Zone "satellite" {
endpoints = [ "icinga2-satellite1.localdomain" ]
parent = "master"
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
All endpoints in the same zone work as high-availability setup. For
example, if you have two nodes in the `master` zone, they will load-balance the check execution.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Endpoint objects are important for specifying the connection
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
information, e.g. if the master should actively try to connect to a client.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
The zone membership is defined inside the `Zone` object definition using
the `endpoints` attribute with an array of `Endpoint` names.
Docs: Small addition for endpoint explanation refs #12498 refs #12386
2016-08-22 09:59:44 +02:00
If you want to check the availability (e.g. ping checks) of the node
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
you still need a [Host](09-object-types.md#objecttype-host) object.
Docs: Small addition for endpoint explanation refs #12498 refs #12386
2016-08-22 09:59:44 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## ApiListener <a id="distributed-monitoring-apilistener"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
In case you are using the CLI commands later, you don't have to write
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
this configuration from scratch in a text editor.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
The [ApiListener](09-object-types.md#objecttype-apilistener)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
object is used to load the SSL certificates and specify restrictions, e.g.
for accepting configuration commands.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
It is also used for the [Icinga 2 REST API](12-icinga2-api.md#icinga2-api) which shares
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
the same host and port with the Icinga 2 Cluster protocol.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
The object configuration is stored in the `/etc/icinga2/features-enabled/api.conf`
file. Depending on the configuration mode the attributes `accept_commands`
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
and `accept_config` can be configured here.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
In order to use the `api` feature you need to enable it and restart Icinga 2.
icinga2 feature enable api
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Conventions <a id="distributed-monitoring-conventions"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
By convention all nodes should be configured using their FQDN.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Furthermore, you must ensure that the following names
are exactly the same in all configuration files:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* Host certificate common name (CN).
* Endpoint configuration object for the host.
* NodeName constant for the local host.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Setting this up on the command line will help you to minimize the effort.
Just keep in mind that you need to use the FQDN for endpoints and for
common names when asked.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Security <a id="distributed-monitoring-security"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
While there are certain mechanisms to ensure a secure communication between all
nodes (firewalls, policies, software hardening, etc.), Icinga 2 also provides
additional security:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
* SSL certificates are mandatory for communication between nodes. The CLI commands
Update Security section in the Distributed Monitoring chapter fixes #5057
2017-03-10 18:19:22 +01:00
help you create those certificates.
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
* Child zones only receive updates (check results, commands, etc.) for their configured objects.
Update Security section in the Distributed Monitoring chapter fixes #5057
2017-03-10 18:19:22 +01:00
* Child zones are not allowed to push configuration updates to parent zones.
doc/6-distributed-monitoring.md: Fix typo fixes #4944
2017-01-23 14:34:47 +01:00
* Zones cannot interfere with other zones and influence each other. Each checkable host or service object is assigned to **one zone** only.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
* All nodes in a zone trust each other.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
* [Config sync](06-distributed-monitoring.md#distributed-monitoring-top-down-config-sync) and [remote command endpoint execution](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint) is disabled by default.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update Security section in the Distributed Monitoring chapter fixes #5057
2017-03-10 18:19:22 +01:00
The underlying protocol uses JSON-RPC event notifications exchanged by nodes.
The connection is secured by TLS. The message protocol uses an internal API,
and as such message types and names may change internally and are not documented.
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Enhance Security chapter for Distributed Monitoring documentation https://monitoring-portal.org/index.php?thread/42175-newbie-zones/
2017-10-20 17:22:51 +02:00
Zones build the trust relationship in a distributed environment. If you do not specify
a zone for a client and specify the parent zone, its zone members e.g. the master instance
won't trust the client.
Building this trust is key in your distributed environment. That way the parent node
knows that it is able to send messages to the child zone, e.g. configuration objects,
configuration in global zones, commands to be executed in this zone/for this endpoint.
It also receives check results from the child zone for checkable objects (host/service).
Vice versa, the client trusts the master and accepts configuration and commands if enabled
in the api feature. If the client would send configuration to the parent zone, the parent nodes
will deny it. The parent zone is the configuration entity, and does not trust clients in this matter.
A client could attempt to modify a different client for example, or inject a check command
with malicious code.
While it may sound complicated for client setups, it removes the problem with different roles
and configurations for a master and a client. Both of them work the same way, are configured
in the same way (Zone, Endpoint, ApiListener), and you can troubleshoot and debug them in just one go.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Master Setup <a id="distributed-monitoring-setup-master"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
This section explains how to install a central single master node using
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
the `node wizard` command. If you prefer to do an automated installation, please
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
refer to the [automated setup](06-distributed-monitoring.md#distributed-monitoring-automation) section.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Install the [Icinga 2 package](02-getting-started.md#setting-up-icinga2) and setup
the required [plugins](02-getting-started.md#setting-up-check-plugins) if you haven't done
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
so already.
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Note**: Windows is not supported for a master node setup.
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
The next step is to run the `node wizard` CLI command. Prior to that
ensure to collect the required information:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Parameter | Description
--------------------|--------------------
Common name (CN) | **Required.** By convention this should be the host's FQDN. Defaults to the FQDN.
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Master zone name | **Optional.** Allows to specify the master zone name. Defaults to `master`.
Adding documentation for configurable global zones during setup This adds the documentation for the configurable global zones during the node wizard/setup. refs #5767
2018-02-27 21:22:29 +01:00
Global zones | **Optional.** Allows to specify more global zones in addition to `global-templates` and `director-global`. Defaults to `n`.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
API bind host | **Optional.** Allows to specify the address the ApiListener is bound to. For advanced usage only.
API bind port | **Optional.** Allows to specify the port the ApiListener is bound to. For advanced usage only (requires changing the default port 5665 everywhere).
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
Disable conf.d | **Optional.** Allows to disable the `include_recursive "conf.d"` directive except for the `api-users.conf` file in the `icinga2.conf` file. Defaults to `y`. Configuration on the master is discussed below.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
The setup wizard will ensure that the following steps are taken:
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* Enable the `api` feature.
* Generate a new certificate authority (CA) in `/var/lib/icinga2/ca` if it doesn't exist.
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
* Create a certificate for this node signed by the CA key.
* Update the [zones.conf](04-configuring-icinga-2.md#zones-conf) file with the new zone hierarchy.
* Update the [ApiListener](06-distributed-monitoring.md#distributed-monitoring-apilistener) and [constants](04-configuring-icinga-2.md#constants-conf) configuration.
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
* Update the [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) to disable the `conf.d` inclusion, and add the `api-users.conf` file inclusion.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Here is an example of a master setup for the `icinga2-master1.localdomain` node on CentOS 7:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
```
[root@icinga2-master1.localdomain /]# icinga2 node wizard
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
Welcome to the Icinga 2 Setup Wizard!
We will guide you through all required configuration details.
Please specify if this is a satellite/client setup ('n' installs a master setup) [Y/n]: n
Starting the Master setup routine...
Please specify the common name (CN) [icinga2-master1.localdomain]: icinga2-master1.localdomain
Reconfiguring Icinga...
Adding documentation for configurable global zones during setup This adds the documentation for the configurable global zones during the node wizard/setup. refs #5767
2018-02-27 21:22:29 +01:00
Checking for existing certificates for common name 'icinga2-master1.localdomain'...
Certificates not yet generated. Running 'api setup' now.
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
Generating master configuration for Icinga 2.
Adding documentation for configurable global zones during setup This adds the documentation for the configurable global zones during the node wizard/setup. refs #5767
2018-02-27 21:22:29 +01:00
Enabling feature api. Make sure to restart Icinga 2 for these changes to take effect.
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Master zone name [master]:
Fix style and logging from review; enhance output refs #4508
2018-05-08 16:06:10 +02:00
Default global zones: global-templates director-global
Adding documentation for configurable global zones during setup This adds the documentation for the configurable global zones during the node wizard/setup. refs #5767
2018-02-27 21:22:29 +01:00
Do you want to specify additional global zones? [y/N]: N
Fix style and logging from review; enhance output refs #4508
2018-05-08 16:06:10 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
Please specify the API bind host/port (optional):
Bind Host []:
Bind Port []:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
Do you want to disable the inclusion of the conf.d directory [Y/n]:
Disabling the inclusion of the conf.d directory...
Checking if the api-users.conf file exists...
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
Done.
Now restart your Icinga 2 daemon to finish the installation!
```
You can verify that the CA public and private keys are stored in the `/var/lib/icinga2/ca` directory.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Keep this path secure and include it in your [backups](02-getting-started.md#install-backup).
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Docs: Fix typo fixes #12831 Signed-off-by: Michael Friedrich <michael.friedrich@netways.de>
2016-09-30 05:37:02 +02:00
In case you lose the CA private key you have to generate a new CA for signing new client
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
certificate requests. You then have to also re-create new signed certificates for all
existing nodes.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Once the master setup is complete, you can also use this node as primary [CSR auto-signing](06-distributed-monitoring.md#distributed-monitoring-setup-csr-auto-signing)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
master. The following section will explain how to use the CLI commands in order to fetch their
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
signed certificate from this master node.
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
## Signing Certificates on the Master <a id="distributed-monitoring-setup-sign-certificates-master"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
All certificates must be signed by the same certificate authority (CA). This ensures
that all nodes trust each other in a distributed monitoring environment.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
This CA is generated during the [master setup](06-distributed-monitoring.md#distributed-monitoring-setup-master)
and should be the same on all master instances.
Fix wrong anchors in the documentation refs #5732
2017-11-15 11:10:52 +01:00
You can avoid signing and deploying certificates [manually](06-distributed-monitoring.md#distributed-monitoring-advanced-hints-certificates-manual)
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
by using built-in methods for auto-signing certificate signing requests (CSR):
* [CSR Auto-Signing](06-distributed-monitoring.md#distributed-monitoring-setup-csr-auto-signing) which uses a client ticket generated on the master as trust identifier.
* [On-Demand CSR Signing](06-distributed-monitoring.md#distributed-monitoring-setup-on-demand-csr-signing) which allows to sign pending certificate requests on the master.
Both methods are described in detail below.
> **Note**
>
> [On-Demand CSR Signing](06-distributed-monitoring.md#distributed-monitoring-setup-on-demand-csr-signing) is available in Icinga 2 v2.8+.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### CSR Auto-Signing <a id="distributed-monitoring-setup-csr-auto-signing"></a>
API: Implement 'generate-ticket' action and update distributed monitoring docs fixes #12433
2016-08-15 14:32:41 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
A client which sends a certificate signing request (CSR) must authenticate itself
in a trusted way. The master generates a client ticket which is included in this request.
That way the master can verify that the request matches the previously trusted ticket
and sign the request.
> **Note**
>
> Icinga 2 v2.8 adds the possibility to forward signing requests on a satellite
> to the master node. This helps with the setup of [three level clusters](#06-distributed-monitoring.md#distributed-monitoring-scenarios-master-satellite-client)
> and more.
Advantages:
* Nodes can be installed by different users who have received the client ticket.
* No manual interaction necessary on the master node.
* Automation tools like Puppet, Ansible, etc. can retrieve the pre-generated ticket in their client catalog
and run the node setup directly.
API: Implement 'generate-ticket' action and update distributed monitoring docs fixes #12433
2016-08-15 14:32:41 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
Disadvantages:
* Tickets need to be generated on the master and copied to client setup wizards.
* No central signing management.
Setup wizards for satellite/client nodes will ask you for this specific client ticket.
API: Implement 'generate-ticket' action and update distributed monitoring docs fixes #12433
2016-08-15 14:32:41 +02:00
There are two possible ways to retrieve the ticket:
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* [CLI command](11-cli-commands.md#cli-command-pki) executed on the master node.
* [REST API](12-icinga2-api.md#icinga2-api) request against the master node.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Required information:
Parameter | Description
--------------------|--------------------
Common name (CN) | **Required.** The common name for the satellite/client. By convention this should be the FQDN.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The following example shows how to generate a ticket on the master node `icinga2-master1.localdomain` for the client `icinga2-client1.localdomain`:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# icinga2 pki ticket --cn icinga2-client1.localdomain
API: Implement 'generate-ticket' action and update distributed monitoring docs fixes #12433
2016-08-15 14:32:41 +02:00
Querying the [Icinga 2 API](12-icinga2-api.md#icinga2-api) on the master requires an [ApiUser](12-icinga2-api.md#icinga2-api-authentication)
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
object with at least the `actions/generate-ticket` permission.
API: Implement 'generate-ticket' action and update distributed monitoring docs fixes #12433
2016-08-15 14:32:41 +02:00
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/conf.d/api-users.conf
object ApiUser "client-pki-ticket" {
password = "bea11beb7b810ea9ce6ea" //change this
permissions = [ "actions/generate-ticket" ]
}
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
Retrieve the ticket on the master node `icinga2-master1.localdomain` with `curl`, for example:
API: Implement 'generate-ticket' action and update distributed monitoring docs fixes #12433
2016-08-15 14:32:41 +02:00
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
[root@icinga2-master1.localdomain /]# curl -k -s -u client-pki-ticket:bea11beb7b810ea9ce6ea -H 'Accept: application/json' \
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
-X POST 'https://localhost:5665/v1/actions/generate-ticket' -d '{ "cn": "icinga2-client1.localdomain" }'
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Store that ticket number for the satellite/client setup below.
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
> **Note**
>
> Never expose the ticket salt and/or ApiUser credentials to your client nodes.
> Example: Retrieve the ticket on the Puppet master node and send the compiled catalog
> to the authorized Puppet agent node which will invoke the
> [automated setup steps](06-distributed-monitoring.md#distributed-monitoring-automation-cli-node-setup).
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
### On-Demand CSR Signing <a id="distributed-monitoring-setup-on-demand-csr-signing"></a>
Icinga 2 v2.8 adds the possibility to sign certificates from clients without
requiring a client ticket for auto-signing.
Instead, the client sends a certificate signing request to specified parent node.
This could either be directly the master, or a satellite which forwards the request
to the signing master.
Advantages:
* Central certificate request signing management.
* No pre-generated ticket is required for client setups.
Disadvantages:
* Asynchronous step for automated deployments.
* Needs client verification on the master.
You can list certificate requests by using the `ca list` CLI command. This also shows
which requests already have been signed.
```
[root@icinga2-master1.localdomain /]# icinga2 ca list
Fingerprint | Timestamp | Signed | Subject
-----------------------------------------------------------------|---------------------|--------|--------
403da5b228df384f07f980f45ba50202529cded7c8182abf96740660caa09727 | 2017/09/06 17:02:40 | * | CN = icinga2-client1.localdomain
71700c28445109416dd7102038962ac3fd421fbb349a6e7303b6033ec1772850 | 2017/09/06 17:20:02 | | CN = icinga2-client2.localdomain
```
**Tip**: Add `--json` to the CLI command to retrieve the details in JSON format.
If you want to sign a specific request, you need to use the `ca sign` CLI command
and pass its fingerprint as argument.
```
[root@icinga2-master1.localdomain /]# icinga2 ca sign 71700c28445109416dd7102038962ac3fd421fbb349a6e7303b6033ec1772850
information/cli: Signed certificate for 'CN = icinga2-client2.localdomain'.
```
## Client/Satellite Setup <a id="distributed-monitoring-setup-satellite-client"></a>
This section describes the setup of a satellite and/or client connected to an
existing master node setup. If you haven't done so already, please [run the master setup](06-distributed-monitoring.md#distributed-monitoring-setup-master).
Icinga 2 on the master node must be running and accepting connections on port `5665`.
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
### Client/Satellite Setup on Linux <a id="distributed-monitoring-setup-client-linux"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Please ensure that you've run all the steps mentioned in the [client/satellite section](06-distributed-monitoring.md#distributed-monitoring-setup-satellite-client).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Install the [Icinga 2 package](02-getting-started.md#setting-up-icinga2) and setup
the required [plugins](02-getting-started.md#setting-up-check-plugins) if you haven't done
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
so already.
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
The next step is to run the `node wizard` CLI command.
In this example we're generating a ticket on the master node `icinga2-master1.localdomain` for the client `icinga2-client1.localdomain`:
[root@icinga2-master1.localdomain /]# icinga2 pki ticket --cn icinga2-client1.localdomain
4f75d2ecd253575fe9180938ebff7cbca262f96e
Note: You don't need this step if you have chosen to use [On-Demand CSR Signing](06-distributed-monitoring.md#distributed-monitoring-setup-on-demand-csr-signing).
Start the wizard on the client `icinga2-client1.localdomain`:
```
[root@icinga2-client1.localdomain /]# icinga2 node wizard
Welcome to the Icinga 2 Setup Wizard!
We will guide you through all required configuration details.
```
Press `Enter` or add `y` to start a satellite or client setup.
```
Please specify if this is a satellite/client setup ('n' installs a master setup) [Y/n]:
```
Press `Enter` to use the proposed name in brackets, or add a specific common name (CN). By convention
this should be the FQDN.
```
Starting the Client/Satellite setup routine...
Please specify the common name (CN) [icinga2-client1.localdomain]: icinga2-client1.localdomain
```
Specify the direct parent for this node. This could be your primary master `icinga2-master1.localdomain`
or a satellite node in a multi level cluster scenario.
```
Please specify the parent endpoint(s) (master or satellite) where this node should connect to:
Master/Satellite Common Name (CN from your master/satellite node): icinga2-master1.localdomain
```
Press `Enter` or choose `y` to establish a connection to the parent node.
```
Do you want to establish a connection to the parent node from this node? [Y/n]:
```
> **Note:**
>
> If this node cannot connect to the parent node, choose `n`. The setup
> wizard will provide instructions for this scenario -- signing questions are disabled then.
Add the connection details for `icinga2-master1.localdomain`.
```
Please specify the master/satellite connection information:
Master/Satellite endpoint host (IP address or FQDN): 192.168.56.101
Master/Satellite endpoint port [5665]: 5665
```
You can add more parent nodes if necessary. Press `Enter` or choose `n`
if you don't want to add any. This comes in handy if you have more than one
parent node, e.g. two masters or two satellites.
```
Add more master/satellite endpoints? [y/N]:
```
Verify the parent node's certificate:
```
Parent certificate information:
Subject: CN = icinga2-master1.localdomain
Issuer: CN = Icinga CA
Valid From: Sep 7 13:41:24 2017 GMT
Valid Until: Sep 3 13:41:24 2032 GMT
Fingerprint: AC 99 8B 2B 3D B0 01 00 E5 21 FA 05 2E EC D5 A9 EF 9E AA E3
Is this information correct? [y/N]: y
```
The setup wizard fetches the parent node's certificate and ask
you to verify this information. This is to prevent MITM attacks or
any kind of untrusted parent relationship.
Note: The certificate is not fetched if you have chosen not to connect
to the parent node.
Proceed with adding the optional client ticket for [CSR auto-signing](06-distributed-monitoring.md#distributed-monitoring-setup-csr-auto-signing):
```
Please specify the request ticket generated on your Icinga 2 master (optional).
(Hint: # icinga2 pki ticket --cn 'icinga2-client1.localdomain'):
4f75d2ecd253575fe9180938ebff7cbca262f96e
```
In case you've chosen to use [On-Demand CSR Signing](06-distributed-monitoring.md#distributed-monitoring-setup-on-demand-csr-signing)
you can leave the ticket question blank.
Instead, Icinga 2 tells you to approve the request later on the master node.
```
No ticket was specified. Please approve the certificate signing request manually
on the master (see 'icinga2 ca list' and 'icinga2 ca sign --help' for details).
```
You can optionally specify a different bind host and/or port.
```
Please specify the API bind host/port (optional):
Bind Host []:
Bind Port []:
```
The next step asks you to accept configuration (required for [config sync mode](06-distributed-monitoring.md#distributed-monitoring-top-down-config-sync))
and commands (required for [command endpoint mode](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint)).
```
Accept config from parent node? [y/N]: y
Accept commands from parent node? [y/N]: y
```
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Next you can optionally specify the local and parent zone names. This will be reflected
in the generated zone configuration file.
Set the local zone name to something else, if you are installing a satellite or secondary master instance.
```
Local zone name [icinga2-client1.localdomain]:
```
Set the parent zone name to something else than `master` if this client connects to a satellite instance instead of the master.
```
Parent zone name [master]:
```
You can add more global zones in addition to `global-templates` and `director-global` if necessary.
Press `Enter` or choose `n`, if you don't want to add any additional.
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
```
Reconfiguring Icinga...
Fix style and logging from review; enhance output refs #4508
2018-05-08 16:06:10 +02:00
Default global zones: global-templates director-global
Adding documentation for configurable global zones during setup This adds the documentation for the configurable global zones during the node wizard/setup. refs #5767
2018-02-27 21:22:29 +01:00
Do you want to specify additional global zones? [y/N]: N
```
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
Last but not least the wizard asks you whether you want to disable the inclusion of the local configuration
directory in `conf.d`, or not. Defaults to disabled, as clients either are checked via command endpoint, or
they receive configuration synced from the parent zone.
```
Do you want to disable the inclusion of the conf.d directory [Y/n]: Y
Disabling the inclusion of the conf.d directory...
```
Adding documentation for configurable global zones during setup This adds the documentation for the configurable global zones during the node wizard/setup. refs #5767
2018-02-27 21:22:29 +01:00
The wizard proceeds and you are good to go.
```
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
Done.
Now restart your Icinga 2 daemon to finish the installation!
```
> **Note**
>
> If you have chosen not to connect to the parent node, you cannot start
> Icinga 2 yet. The wizard asked you to manually copy the master's public
> CA certificate file into `/var/lib/icinga2/certs/ca.crt`.
>
> You need to manually sign the CSR on the master node.
Restart Icinga 2 as requested.
```
[root@icinga2-client1.localdomain /]# systemctl restart icinga2
```
Here is an overview of all parameters in detail:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Parameter | Description
--------------------|--------------------
Common name (CN) | **Required.** By convention this should be the host's FQDN. Defaults to the FQDN.
Master common name | **Required.** Use the common name you've specified for your master node before.
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
Establish connection to the parent node | **Optional.** Whether the node should attempt to connect to the parent node or not. Defaults to `y`.
Master/Satellite endpoint host | **Required if the the client needs to connect to the master/satellite.** The parent endpoint's IP address or FQDN. This information is included in the `Endpoint` object configuration in the `zones.conf` file.
Master/Satellite endpoint port | **Optional if the the client needs to connect to the master/satellite.** The parent endpoints's listening port. This information is included in the `Endpoint` object configuration.
Add more master/satellite endpoints | **Optional.** If you have multiple master/satellite nodes configured, add them here.
Parent Certificate information | **Required.** Verify that the connecting host really is the requested master node.
Request ticket | **Optional.** Add the [ticket](06-distributed-monitoring.md#distributed-monitoring-setup-csr-auto-signing) generated on the master.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
API bind host | **Optional.** Allows to specify the address the ApiListener is bound to. For advanced usage only.
API bind port | **Optional.** Allows to specify the port the ApiListener is bound to. For advanced usage only (requires changing the default port 5665 everywhere).
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Accept config | **Optional.** Whether this node accepts configuration sync from the master node (required for [config sync mode](06-distributed-monitoring.md#distributed-monitoring-top-down-config-sync)). For [security reasons](06-distributed-monitoring.md#distributed-monitoring-security) this defaults to `n`.
Accept commands | **Optional.** Whether this node accepts command execution messages from the master node (required for [command endpoint mode](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint)). For [security reasons](06-distributed-monitoring.md#distributed-monitoring-security) this defaults to `n`.
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Local zone name | **Optional.** Allows to specify the name for the local zone. This comes in handy when this instance is a satellite, not a client. Defaults to the FQDN.
Parent zone name | **Optional.** Allows to specify the name for the parent zone. This is important if the client has a satellite instance as parent, not the master. Defaults to `master`.
Adding documentation for configurable global zones during setup This adds the documentation for the configurable global zones during the node wizard/setup. refs #5767
2018-02-27 21:22:29 +01:00
Global zones | **Optional.** Allows to specify more global zones in addition to `global-templates` and `director-global`. Defaults to `n`.
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
Disable conf.d | **Optional.** Allows to disable the inclusion of the `conf.d` directory which holds local example configuration. Clients should retrieve their configuration from the parent node, or act as command endpoint execution bridge. Defaults to `y`.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
The setup wizard will ensure that the following steps are taken:
* Enable the `api` feature.
* Create a certificate signing request (CSR) for the local node.
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
* Request a signed certificate i(optional with the provided ticket number) on the master node.
* Allow to verify the parent node's certificate.
Docs: Update certs path refs #5450
2017-09-07 16:55:42 +02:00
* Store the signed client certificate and ca.crt in `/var/lib/icinga2/certs`.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* Update the `zones.conf` file with the new zone hierarchy.
* Update `/etc/icinga2/features-enabled/api.conf` (`accept_config`, `accept_commands`) and `constants.conf`.
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
* Update `/etc/icinga2/icinga2.conf` and comment out `include_recursive "conf.d"`.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
You can verify that the certificate files are stored in the `/var/lib/icinga2/certs` directory.
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
Implement support for migrating certificates to /var/lib/icinga2/certs This commit includes documentation too. Signed-off-by: Michael Friedrich <michael.friedrich@icinga.com>
2017-10-16 15:32:57 +02:00
> **Note**
>
> The certificate location changed in v2.8 to `/var/lib/icinga2/certs`. Please read the [upgrading chapter](16-upgrading-icinga-2.md#upgrading-to-2-8-certificate-paths)
> for more details.
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
> **Note**
>
> If the client is not directly connected to the certificate signing master,
> signing requests and responses might need some minutes to fully update the client certificates.
>
> If you have chosen to use [On-Demand CSR Signing](06-distributed-monitoring.md#distributed-monitoring-setup-on-demand-csr-signing)
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
> certificates need to be signed on the master first. Ticket-less setups require at least Icinga 2 v2.8+ on all involved instances.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Now that you've successfully installed a Linux/Unix satellite/client instance, please proceed to
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
the [configuration modes](06-distributed-monitoring.md#distributed-monitoring-configuration-modes).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
### Client Setup on Windows <a id="distributed-monitoring-setup-client-windows"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Change http:// links to https:// links where a website exists fixes #5149 Signed-off-by: Michael Friedrich <michael.friedrich@icinga.com>
2017-04-06 22:03:48 +02:00
Download the MSI-Installer package from [https://packages.icinga.com/windows/](https://packages.icinga.com/windows/).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Requirements:
* Windows Vista/Server 2008 or higher
Update docs for Windows Client requirements for 2.8
2017-11-17 10:59:04 +01:00
* Versions older than Windows 10/Server 2016 require the [Universal C Runtime for Windows](https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-runtime-in-windows)
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
* [Microsoft .NET Framework 2.0](https://www.microsoft.com/de-de/download/details.aspx?id=1639) for the setup wizard
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Change http:// links to https:// links where a website exists fixes #5149 Signed-off-by: Michael Friedrich <michael.friedrich@icinga.com>
2017-04-06 22:03:48 +02:00
The installer package includes the [NSClient++](https://www.nsclient.org/) package
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
so that Icinga 2 can use its built-in plugins. You can find more details in
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
[this chapter](06-distributed-monitoring.md#distributed-monitoring-windows-nscp).
The Windows package also installs native [monitoring plugin binaries](06-distributed-monitoring.md#distributed-monitoring-windows-plugins)
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
to get you started more easily.
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
> **Note**
>
> Please note that Icinga 2 was designed to run as light-weight client on Windows.
> There is no support for satellite instances.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### Windows Client Setup Start <a id="distributed-monitoring-setup-client-windows-start"></a>
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
Run the MSI-Installer package and follow the instructions shown in the screenshots.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_installer_01.png)
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_installer_02.png)
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_installer_03.png)
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_installer_04.png)
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_installer_05.png)
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
The graphical installer offers to run the Icinga 2 setup wizard after the installation. Select
the check box to proceed.
> **Tip**
>
> You can also run the Icinga 2 setup wizard from the Start menu later.
On a fresh installation the setup wizard guides you through the initial configuration.
It also provides a mechanism to send a certificate request to the [CSR signing master](distributed-monitoring-setup-sign-certificates-master).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
The following configuration details are required:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Parameter | Description
--------------------|--------------------
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Instance name | **Required.** By convention this should be the host's FQDN. Defaults to the FQDN.
Setup ticket | **Optional.** Paste the previously generated [ticket number](06-distributed-monitoring.md#distributed-monitoring-setup-csr-auto-signing). If left blank, the certificate request must be [signed on the master node](06-distributed-monitoring.md#distributed-monitoring-setup-on-demand-csr-signing).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fill in the required information and click `Add` to add a new master connection.
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_01.png)
Add the following details:
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Parameter | Description
-------------------------------|-------------------------------
Instance name | **Required.** The master/satellite endpoint name where this client is a direct child of.
Master/Satellite endpoint host | **Required.** The master or satellite's IP address or FQDN. This information is included in the `Endpoint` object configuration in the `zones.conf` file.
Master/Satellite endpoint port | **Optional.** The master or satellite's listening port. This information is included in the `Endpoint` object configuration.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_02.png)
Update Windows wizard documentation for global zones This updates the screenshots for the windows wizard.
2018-03-26 19:30:37 +02:00
When needed you can add an additional global zone (the zones `global-templates` and `director-global` are added by default):
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_02_global_zone.png)
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Optionally enable the following settings:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Parameter | Description
----------------------------------|----------------------------------
Accept config | **Optional.** Whether this node accepts configuration sync from the master node (required for [config sync mode](06-distributed-monitoring.md#distributed-monitoring-top-down-config-sync)). For [security reasons](06-distributed-monitoring.md#distributed-monitoring-security) this is disabled by default.
Accept commands | **Optional.** Whether this node accepts command execution messages from the master node (required for [command endpoint mode](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint)). For [security reasons](06-distributed-monitoring.md#distributed-monitoring-security) this is disabled by default.
Run Icinga 2 service as this user | **Optional.** Specify a different Windows user. This defaults to `NT AUTHORITY\Network Service` and is required for more privileged service checks.
Install NSClient++ | **Optional.** The Windows installer bundles the NSClient++ installer for additional [plugin checks](06-distributed-monitoring.md#distributed-monitoring-windows-nscp).
Docs: Add option 'disable conf.d' to windows wizard docs
2018-06-19 15:59:44 +02:00
Disable conf.d | **Optional.** Allows to disable the `include_recursive "conf.d"` directive except for the `api-users.conf` file in the `icinga2.conf` file. Defaults to `true`.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_03.png)
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Verify the certificate from the master/satellite instance where this node should connect to.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_04.png)
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### Bundled NSClient++ Setup <a id="distributed-monitoring-setup-client-windows-nsclient"></a>
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
If you have chosen to install/update the NSClient++ package, the Icinga 2 setup wizard asks
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
you to do so.
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_01.png)
Choose the `Generic` setup.
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_02.png)
Choose the `Custom` setup type.
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_03.png)
NSClient++ does not install a sample configuration by default. Change this as shown in the screenshot.
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_04.png)
Generate a secure password and enable the web server module. **Note**: The webserver module is
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
available starting with NSClient++ 0.5.0. Icinga 2 v2.6+ is required which includes this version.
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_05.png)
Finish the installation.
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_06.png)
Open a web browser and navigate to `https://localhost:8443`. Enter the password you've configured
during the setup. In case you lost it, look into the `C:\Program Files\NSClient++\nsclient.ini`
configuration file.
![Icinga 2 Windows Setup NSClient++](images/distributed-monitoring/icinga2_windows_setup_wizard_05_nsclient_07.png)
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
The NSClient++ REST API can be used to query metrics. [check_nscp_api](06-distributed-monitoring.md#distributed-monitoring-windows-nscp-check-api)
uses this transport method.
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### Finish Windows Client Setup <a id="distributed-monitoring-setup-client-windows-finish"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Finish the Windows setup wizard.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_06_finish_with_ticket.png)
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
If you did not provide a setup ticket, you need to sign the certificate request on the master.
The setup wizards tells you to do so. The Icinga 2 service is running at this point already
and will automatically receive and update a signed client certificate.
> **Note**
>
> Ticket-less setups require at least Icinga 2 v2.8+ on all involved instances.
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_06_finish_no_ticket.png)
Icinga 2 is automatically started as a Windows service.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_running_service.png)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The Icinga 2 configuration is stored inside the `C:\ProgramData\icinga2` directory.
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Click `Examine Config` in the setup wizard to open a new Explorer window.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Windows Setup](images/distributed-monitoring/icinga2_windows_setup_wizard_examine_config.png)
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
The configuration files can be modified with your favorite editor e.g. Notepad.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
In order to use the [top down](06-distributed-monitoring.md#distributed-monitoring-top-down) client
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
configuration prepare the following steps.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Add a [global zone](06-distributed-monitoring.md#distributed-monitoring-global-zone-config-sync)
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
for syncing check commands later. Navigate to `C:\ProgramData\icinga2\etc\icinga2` and open
the `zones.conf` file in your preferred editor. Add the following lines if not existing already:
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
```
object Zone "global-templates" {
global = true
}
```
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
> **Note:**
>
> Packages >= 2.8 provide this configuration by default.
zones.conf: Add global-templates & director-global by default This makes it easier for cluster and client setups with or without the Icinga Director. Note: Clients will still not receive synced configuration if accept_config is not enabled (which is the default, and can be changed during setup). fixes #5106
2017-06-02 10:52:47 +02:00
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
You don't need any local configuration on the client except for
CheckCommand definitions which can be synced using the global zone
above. Therefore disable the inclusion of the `conf.d` directory
in the `icinga2.conf` file.
Navigate to `C:\ProgramData\icinga2\etc\icinga2` and open
the `icinga2.conf` file in your preferred editor. Remove or comment (`//`)
the following line:
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
```
// Commented out, not required on a client with top down mode
//include_recursive "conf.d"
```
> **Note**
>
> Packages >= 2.9 provide an option in the setup wizard to disable this.
> Defaults to disabled.
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
Validate the configuration on Windows open an administrator terminal
and run the following command:
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
```
C:\WINDOWS\system32>cd "C:\Program Files\ICINGA2\sbin"
C:\Program Files\ICINGA2\sbin>icinga2.exe daemon -C
```
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
**Note**: You have to run this command in a shell with `administrator` privileges.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
Now you need to restart the Icinga 2 service. Run `services.msc` from the start menu
and restart the `icinga2` service. Alternatively, you can use the `net {start,stop}` CLI commands.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
![Icinga 2 Windows Service Start/Stop](images/distributed-monitoring/icinga2_windows_cmd_admin_net_start_stop.png)
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Now that you've successfully installed a Windows client, please proceed to
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
the [detailed configuration modes](06-distributed-monitoring.md#distributed-monitoring-configuration-modes).
Update Windows setup wizard screenshots; add NSClient++ 0.5.0 setup fixes #13443
2016-12-08 16:32:47 +01:00
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
> **Note**
>
> The certificate location changed in v2.8 to `%ProgramData%\var\lib\icinga2\certs`.
> Please read the [upgrading chapter](16-upgrading-icinga-2.md#upgrading-to-2-8-certificate-paths)
> for more details.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Configuration Modes <a id="distributed-monitoring-configuration-modes"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
There are different ways to ensure that the Icinga 2 cluster nodes execute
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
checks, send notifications, etc.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Remove bottom-up from docs and add hints for Director, Puppet, etc. refs #4799
2017-09-20 11:32:26 +02:00
The preferred method is to configure monitoring objects on the master
and distribute the configuration to satellites and clients.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Remove bottom-up from docs and add hints for Director, Puppet, etc. refs #4799
2017-09-20 11:32:26 +02:00
The following chapters will explain this in detail with hands-on manual configuration
examples. You should test and implement this once to fully understand how it works.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Remove bottom-up from docs and add hints for Director, Puppet, etc. refs #4799
2017-09-20 11:32:26 +02:00
Once you are familiar with Icinga 2 and distributed monitoring, you
can start with additional integrations to manage and deploy your
configuration:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fixed grammer and spelling mistakes
2017-10-30 17:02:42 +01:00
* [Icinga Director](https://github.com/icinga/icingaweb2-module-director) provides a web interface to manage configuration and also allows to sync imported resources (CMDB, PuppetDB, etc.)
Remove bottom-up from docs and add hints for Director, Puppet, etc. refs #4799
2017-09-20 11:32:26 +02:00
* [Ansible Roles](https://github.com/Icinga/icinga2-ansible)
* [Puppet Module](https://github.com/Icinga/puppet-icinga2)
* [Chef Cookbook](https://github.com/Icinga/chef-icinga2)
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Enhance documentation with more details on value types for object attributes Main focus: Object attributes and their value types. Originates from the API Event Streams patch to document their value types. Now applied to the entire configuration objects chapter. The API chapter and their value types has been changed to capitalized type identifiers. Value types are now explicitly told about inside monitoring basics. This has been adopted into the Icinga 2 training material a long time ago and finds its way into the docs too. The CheckResult and PerfdataValue value types have been moved into the advanced topics chapter. mkdocs doesn't like multiple `#` headings in one file and did just hide it. Also moved the Influxdb details into the features documentation where it belongs. Many small references and URLs to other chapters added. E.g. dedicated chapters for object accessor examples, to better link against time dependent thresholds. Can serve as patch basis and reference for ITL documentation where the value types are missing too. This commit also fixes the non-requirement of "legacy-timeperiod" which also is a default template import since 2.6. This also fixes the state mapping issue. fixes #4015
2017-10-09 21:09:12 +02:00
More details can be found [here](13-addons.md#configuration-tools).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Remove bottom-up from docs and add hints for Director, Puppet, etc. refs #4799
2017-09-20 11:32:26 +02:00
### Top Down <a id="distributed-monitoring-top-down"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
There are two different behaviors with check execution:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* Send a command execution event remotely: The scheduler still runs on the parent node.
* Sync the host/service objects directly to the child node: Checks are executed locally.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Again, technically it does not matter whether this is a `client` or a `satellite`
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
which is receiving configuration or command execution events.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Top Down Command Endpoint <a id="distributed-monitoring-top-down-command-endpoint"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
This mode will force the Icinga 2 node to execute commands remotely on a specified endpoint.
The host/service object configuration is located on the master/satellite and the client only
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
needs the CheckCommand object definitions being used there.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Add documentation for remote check queue refs #4841
2018-01-29 14:40:40 +01:00
Every endpoint has its own remote check queue. The amount of checks executed simultaneously
can be limited on the endpoint with the `MaxConcurrentChecks` constant defined in [constants.conf](04-configuring-icinga-2.md#constants-conf). Icinga 2 may discard check requests,
if the remote check queue is full.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Distributed Top Down Command Endpoint](images/distributed-monitoring/icinga2_distributed_top_down_command_endpoint.png)
Advantages:
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* No local checks need to be defined on the child node (client).
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* Light-weight remote check execution (asynchronous events).
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
* No [replay log](06-distributed-monitoring.md#distributed-monitoring-advanced-hints-command-endpoint-log-duration) is necessary for the child node.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* Pin checks to specific endpoints (if the child zone consists of 2 endpoints).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Disadvantages:
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* If the child node is not connected, no more checks are executed.
* Requires additional configuration attribute specified in host/service objects.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
* Requires local `CheckCommand` object configuration. Best practice is to use a [global config zone](06-distributed-monitoring.md#distributed-monitoring-global-zone-config-sync).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
To make sure that all nodes involved will accept configuration and/or
commands, you need to configure the `Zone` and `Endpoint` hierarchy
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
on all nodes.
* `icinga2-master1.localdomain` is the configuration master in this scenario.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
* `icinga2-client1.localdomain` acts as client which receives command execution messages via command endpoint from the master. In addition, it receives the global check command configuration from the master.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Include the endpoint and zone configuration on **both** nodes in the file `/etc/icinga2/zones.conf`.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The endpoint configuration could look like this, for example:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Deprecate the client 'bottom up' mode w/ node update-config This includes deprecation warnings and migration documentation. fixes #13255
2016-11-23 15:33:28 +01:00
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/zones.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Endpoint "icinga2-master1.localdomain" {
host = "192.168.56.101"
}
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
object Endpoint "icinga2-client1.localdomain" {
host = "192.168.56.111"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Next, you need to define two zones. There is no naming convention, best practice is to either use `master`, `satellite`/`client-fqdn` or to choose region names for example `Europe`, `USA` and `Asia`, though.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Note**: Each client requires its own zone and endpoint configuration. Best practice
is to use the client's FQDN for all object names.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
The `master` zone is a parent of the `icinga2-client1.localdomain` zone:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Deprecate the client 'bottom up' mode w/ node update-config This includes deprecation warnings and migration documentation. fixes #13255
2016-11-23 15:33:28 +01:00
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/zones.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Zone "master" {
endpoints = [ "icinga2-master1.localdomain" ] //array with endpoint names
}
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
object Zone "icinga2-client1.localdomain" {
endpoints = [ "icinga2-client1.localdomain" ]
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
parent = "master" //establish zone hierarchy
}
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
In addition, add a [global zone](06-distributed-monitoring.md#distributed-monitoring-global-zone-config-sync)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
for syncing check commands later:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
```
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/zones.conf
Deprecate the client 'bottom up' mode w/ node update-config This includes deprecation warnings and migration documentation. fixes #13255
2016-11-23 15:33:28 +01:00
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
object Zone "global-templates" {
global = true
}
```
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
> **Note:**
>
> Packages >= 2.8 provide this configuration by default.
zones.conf: Add global-templates & director-global by default This makes it easier for cluster and client setups with or without the Icinga Director. Note: Clients will still not receive synced configuration if accept_config is not enabled (which is the default, and can be changed during setup). fixes #5106
2017-06-02 10:52:47 +02:00
Docs: Add a note about removing "conf.d" on the client for "top down command endpoint" setups fixes #13395
2016-12-03 13:42:22 +01:00
You don't need any local configuration on the client except for
CheckCommand definitions which can be synced using the global zone
above. Therefore disable the inclusion of the `conf.d` directory
in `/etc/icinga2/icinga2.conf`.
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
```
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/icinga2.conf
// Commented out, not required on a client as command endpoint
//include_recursive "conf.d"
```
Docs: Add a note about removing "conf.d" on the client for "top down command endpoint" setups fixes #13395
2016-12-03 13:42:22 +01:00
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
> **Note**
>
> Packages >= 2.9 provide an option in the setup wizard to disable this.
> Defaults to disabled.
Docs: Add a note about removing "conf.d" on the client for "top down command endpoint" setups fixes #13395
2016-12-03 13:42:22 +01:00
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
Edit the `api` feature on the client `icinga2-client1.localdomain` in
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
the `/etc/icinga2/features-enabled/api.conf` file and make sure to set
`accept_commands` and `accept_config` to `true`:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/features-enabled/api.conf
object ApiListener "api" {
//...
accept_commands = true
accept_config = true
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Now it is time to validate the configuration and to restart the Icinga 2 daemon
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
on both nodes.
Example on CentOS 7:
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-client1.localdomain /]# icinga2 daemon -C
[root@icinga2-client1.localdomain /]# systemctl restart icinga2
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Once the clients have successfully connected, you are ready for the next step: **execute
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
a remote check on the client using the command endpoint**.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Include the host and service object configuration in the `master` zone
-- this will help adding a secondary master for high-availability later.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/master
Add the host and service objects you want to monitor. There is
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
no limitation for files and directories -- best practice is to
sort things by type.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
By convention a master/satellite/client host object should use the same name as the endpoint object.
You can also add multiple hosts which execute checks against remote services/clients.
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/master
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim hosts.conf
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
object Host "icinga2-client1.localdomain" {
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
check_command = "hostalive" //check is executed on the master
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
address = "192.168.56.111"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
vars.client_endpoint = name //follows the convention that host name == endpoint name
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Given that you are monitoring a Linux client, we'll add a remote [disk](10-icinga-template-library.md#plugin-check-command-disk)
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
check.
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf
apply Service "disk" {
check_command = "disk"
//specify where the check is executed
command_endpoint = host.vars.client_endpoint
assign where host.vars.client_endpoint
}
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
If you have your own custom `CheckCommand` definition, add it to the global zone:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/global-templates
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.d/global-templates/commands.conf
object CheckCommand "my-cmd" {
//...
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Save the changes and validate the configuration on the master node:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
Restart the Icinga 2 daemon (example for CentOS 7):
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
The following steps will happen:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
* Icinga 2 validates the configuration on `icinga2-master1.localdomain` and restarts.
* The `icinga2-master1.localdomain` node schedules and executes the checks.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
* The `icinga2-client1.localdomain` node receives the execute command event with additional command parameters.
* The `icinga2-client1.localdomain` node maps the command parameters to the local check command, executes the check locally, and sends back the check result message.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
As you can see, no interaction from your side is required on the client itself, and it's not necessary to reload the Icinga 2 service on the client.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
You have learned the basics about command endpoint checks. Proceed with
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
the [scenarios](06-distributed-monitoring.md#distributed-monitoring-scenarios)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
section where you can find detailed information on extending the setup.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Top Down Config Sync <a id="distributed-monitoring-top-down-config-sync"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
This mode syncs the object configuration files within specified zones.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
It comes in handy if you want to configure everything on the master node
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
and sync the satellite checks (disk, memory, etc.). The satellites run their
own local scheduler and will send the check result messages back to the master.
![Icinga 2 Distributed Top Down Config Sync](images/distributed-monitoring/icinga2_distributed_top_down_config_sync.png)
Advantages:
* Sync the configuration files from the parent zone to the child zones.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* No manual restart is required on the child nodes, as syncing, validation, and restarts happen automatically.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
* Execute checks directly on the child node's scheduler.
* Replay log if the connection drops (important for keeping the check history in sync, e.g. for SLA reports).
* Use a global zone for syncing templates, groups, etc.
Disadvantages:
* Requires a config directory on the master node with the zone name underneath `/etc/icinga2/zones.d`.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* Additional zone and endpoint configuration needed.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* Replay log is replicated on reconnect after connection loss. This might increase the data transfer and create an overload on the connection.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
To make sure that all involved nodes accept configuration and/or
commands, you need to configure the `Zone` and `Endpoint` hierarchy
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
on all nodes.
* `icinga2-master1.localdomain` is the configuration master in this scenario.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
* `icinga2-client2.localdomain` acts as client which receives configuration from the master. Checks are scheduled locally.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Include the endpoint and zone configuration on **both** nodes in the file `/etc/icinga2/zones.conf`.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
The endpoint configuration could look like this:
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-client2.localdomain /]# vim /etc/icinga2/zones.conf
Deprecate the client 'bottom up' mode w/ node update-config This includes deprecation warnings and migration documentation. fixes #13255
2016-11-23 15:33:28 +01:00
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Endpoint "icinga2-master1.localdomain" {
host = "192.168.56.101"
}
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
object Endpoint "icinga2-client2.localdomain" {
host = "192.168.56.112"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Next, you need to define two zones. There is no naming convention, best practice is to either use `master`, `satellite`/`client-fqdn` or to choose region names for example `Europe`, `USA` and `Asia`, though.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Note**: Each client requires its own zone and endpoint configuration. Best practice
is to use the client's FQDN for all object names.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
The `master` zone is a parent of the `icinga2-client2.localdomain` zone:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-client2.localdomain /]# vim /etc/icinga2/zones.conf
Deprecate the client 'bottom up' mode w/ node update-config This includes deprecation warnings and migration documentation. fixes #13255
2016-11-23 15:33:28 +01:00
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Zone "master" {
endpoints = [ "icinga2-master1.localdomain" ] //array with endpoint names
}
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
object Zone "icinga2-client2.localdomain" {
endpoints = [ "icinga2-client2.localdomain" ]
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
parent = "master" //establish zone hierarchy
}
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
Edit the `api` feature on the client `icinga2-client2.localdomain` in
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
the `/etc/icinga2/features-enabled/api.conf` file and set
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
`accept_config` to `true`.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-client2.localdomain /]# vim /etc/icinga2/features-enabled/api.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object ApiListener "api" {
//...
accept_config = true
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Now it is time to validate the configuration and to restart the Icinga 2 daemon
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
on both nodes.
Example on CentOS 7:
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-client2.localdomain /]# icinga2 daemon -C
[root@icinga2-client2.localdomain /]# systemctl restart icinga2
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
**Tip**: Best practice is to use a [global zone](06-distributed-monitoring.md#distributed-monitoring-global-zone-config-sync)
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
for common configuration items (check commands, templates, groups, etc.).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Once the clients have connected successfully, it's time for the next step: **execute
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
a local check on the client using the configuration sync**.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Navigate to `/etc/icinga2/zones.d` on your master node
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
`icinga2-master1.localdomain` and create a new directory with the same
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
name as your satellite/client zone name:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/icinga2-client2.localdomain
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Add the host and service objects you want to monitor. There is
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
no limitation for files and directories -- best practice is to
sort things by type.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
By convention a master/satellite/client host object should use the same name as the endpoint object.
You can also add multiple hosts which execute checks against remote services/clients.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/icinga2-client2.localdomain
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/icinga2-client2.localdomain]# vim hosts.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
object Host "icinga2-client2.localdomain" {
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
check_command = "hostalive"
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
address = "192.168.56.112"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
zone = "master" //optional trick: sync the required host object to the client, but enforce the "master" zone to execute the check
}
Given that you are monitoring a Linux client we'll just add a local [disk](10-icinga-template-library.md#plugin-check-command-disk)
check.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/icinga2-client2.localdomain]# vim services.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Service "disk" {
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
host_name = "icinga2-client2.localdomain"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
check_command = "disk"
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Save the changes and validate the configuration on the master node:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
Restart the Icinga 2 daemon (example for CentOS 7):
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
The following steps will happen:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* Icinga 2 validates the configuration on `icinga2-master1.localdomain`.
* Icinga 2 copies the configuration into its zone config store in `/var/lib/icinga2/api/zones`.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
* The `icinga2-master1.localdomain` node sends a config update event to all endpoints in the same or direct child zones.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
* The `icinga2-client2.localdomain` node accepts config and populates the local zone config store with the received config files.
* The `icinga2-client2.localdomain` node validates the configuration and automatically restarts.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Again, there is no interaction required on the client
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
itself.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
You can also use the config sync inside a high-availability zone to
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
ensure that all config objects are synced among zone members.
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Note**: You can only have one so-called "config master" in a zone which stores
the configuration in the `zones.d` directory.
Multiple nodes with configuration files in the `zones.d` directory are
**not supported**.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Now that you've learned the basics about the configuration sync, proceed with
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
the [scenarios](06-distributed-monitoring.md#distributed-monitoring-scenarios)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
section where you can find detailed information on extending the setup.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Deprecate the client 'bottom up' mode w/ node update-config This includes deprecation warnings and migration documentation. fixes #13255
2016-11-23 15:33:28 +01:00
If you are eager to start fresh instead you might take a look into the
[Icinga Director](https://github.com/icinga/icingaweb2-module-director).
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Scenarios <a id="distributed-monitoring-scenarios"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The following examples should give you an idea on how to build your own
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
distributed monitoring environment. We've seen them all in production
Update README.md and correct project URLs fixes #13491
2016-12-08 17:38:41 +01:00
environments and received feedback from our [community](https://www.icinga.com/community/get-involved/)
and [partner support](https://www.icinga.com/services/support/) channels:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* Single master with clients.
* HA master with clients as command endpoint.
* Three level cluster with config HA masters, satellites receiving config sync, and clients checked using command endpoint.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Master with Clients <a id="distributed-monitoring-master-clients"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Distributed Master with Clients](images/distributed-monitoring/icinga2_distributed_scenarios_master_clients.png)
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* `icinga2-master1.localdomain` is the primary master node.
* `icinga2-client1.localdomain` and `icinga2-client2.localdomain` are two child nodes as clients.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Setup requirements:
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
* Set up `icinga2-master1.localdomain` as [master](06-distributed-monitoring.md#distributed-monitoring-setup-master).
* Set up `icinga2-client1.localdomain` and `icinga2-client2.localdomain` as [client](06-distributed-monitoring.md#distributed-monitoring-setup-satellite-client).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Edit the `zones.conf` configuration file on the master:
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.conf
object Endpoint "icinga2-master1.localdomain" {
}
object Endpoint "icinga2-client1.localdomain" {
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
host = "192.168.56.111" //the master actively tries to connect to the client
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Endpoint "icinga2-client2.localdomain" {
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
host = "192.168.56.112" //the master actively tries to connect to the client
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "master" {
endpoints = [ "icinga2-master1.localdomain" ]
}
object Zone "icinga2-client1.localdomain" {
endpoints = [ "icinga2-client1.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "master"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "icinga2-client2.localdomain" {
endpoints = [ "icinga2-client2.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "master"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
/* sync global commands */
object Zone "global-templates" {
global = true
}
The two client nodes do not necessarily need to know about each other. The only important thing
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
is that they know about the parent zone and their endpoint members (and optionally the global zone).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
If you specify the `host` attribute in the `icinga2-master1.localdomain` endpoint object,
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
the client will actively try to connect to the master node. Since we've specified the client
endpoint's attribute on the master node already, we don't want the clients to connect to the
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
master. **Choose one [connection direction](06-distributed-monitoring.md#distributed-monitoring-advanced-hints-connection-direction).**
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/zones.conf
object Endpoint "icinga2-master1.localdomain" {
//do not actively connect to the master by leaving out the 'host' attribute
}
object Endpoint "icinga2-client1.localdomain" {
}
object Zone "master" {
endpoints = [ "icinga2-master1.localdomain" ]
}
object Zone "icinga2-client1.localdomain" {
endpoints = [ "icinga2-client1.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "master"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
/* sync global commands */
object Zone "global-templates" {
global = true
}
[root@icinga2-client2.localdomain /]# vim /etc/icinga2/zones.conf
object Endpoint "icinga2-master1.localdomain" {
//do not actively connect to the master by leaving out the 'host' attribute
}
object Endpoint "icinga2-client2.localdomain" {
}
object Zone "master" {
endpoints = [ "icinga2-master1.localdomain" ]
}
object Zone "icinga2-client2.localdomain" {
endpoints = [ "icinga2-client2.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "master"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
/* sync global commands */
object Zone "global-templates" {
global = true
}
Now it is time to define the two client hosts and apply service checks using
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
the command endpoint execution method on them. Note: You can also use the
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
config sync mode here.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Create a new configuration directory on the master node:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/master
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Add the two client nodes as host objects:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/master
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim hosts.conf
object Host "icinga2-client1.localdomain" {
check_command = "hostalive"
address = "192.168.56.111"
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
vars.client_endpoint = name //follows the convention that host name == endpoint name
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Host "icinga2-client2.localdomain" {
check_command = "hostalive"
address = "192.168.56.112"
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
vars.client_endpoint = name //follows the convention that host name == endpoint name
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Add services using command endpoint checks:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf
apply Service "ping4" {
check_command = "ping4"
//check is executed on the master node
assign where host.address
}
apply Service "disk" {
check_command = "disk"
//specify where the check is executed
command_endpoint = host.vars.client_endpoint
assign where host.vars.client_endpoint
}
Validate the configuration and restart Icinga 2 on the master node `icinga2-master1.localdomain`.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Open Icinga Web 2 and check the two newly created client hosts with two new services
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
-- one executed locally (`ping4`) and one using command endpoint (`disk`).
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### High-Availability Master with Clients <a id="distributed-monitoring-scenarios-ha-master-clients"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Distributed High Availability Master with Clients](images/distributed-monitoring/icinga2_distributed_scenarios_ha_master_clients.png)
Fixed grammer and spelling mistakes
2017-10-30 17:02:42 +01:00
This scenario is similar to the one in the [previous section](06-distributed-monitoring.md#distributed-monitoring-master-clients). The only difference is that we will now set up two master nodes in a high-availability setup.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
These nodes must be configured as zone and endpoints objects.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The setup uses the capabilities of the Icinga 2 cluster. All zone members
replicate cluster events amongst each other. In addition to that, several Icinga 2
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
features can enable HA functionality.
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Note**: All nodes in the same zone require that you enable the same features for high-availability (HA).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Overview:
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* `icinga2-master1.localdomain` is the config master master node.
* `icinga2-master2.localdomain` is the secondary master master node without config in `zones.d`.
* `icinga2-client1.localdomain` and `icinga2-client2.localdomain` are two child nodes as clients.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Setup requirements:
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
* Set up `icinga2-master1.localdomain` as [master](06-distributed-monitoring.md#distributed-monitoring-setup-master).
* Set up `icinga2-master2.localdomain` as [client](06-distributed-monitoring.md#distributed-monitoring-setup-satellite-client) (we will modify the generated configuration).
* Set up `icinga2-client1.localdomain` and `icinga2-client2.localdomain` as [clients](06-distributed-monitoring.md#distributed-monitoring-setup-satellite-client) (when asked for adding multiple masters, set to `y` and add the secondary master `icinga2-master2.localdomain`).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
In case you don't want to use the CLI commands, you can also manually create and sync the
required SSL certificates. We will modify and discuss all the details of the automatically generated configuration here.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Since there are now two nodes in the same zone, we must consider the
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
[high-availability features](06-distributed-monitoring.md#distributed-monitoring-high-availability-features).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fixed grammer and spelling mistakes
2017-10-30 17:02:42 +01:00
* Checks and notifications are balanced between the two master nodes. That's fine, but it requires check plugins and notification scripts to exist on both nodes.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* The IDO feature will only be active on one node by default. Since all events are replicated between both nodes, it is easier to just have one central database.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
One possibility is to use a dedicated MySQL cluster VIP (external application cluster)
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
and leave the IDO feature with enabled HA capabilities. Alternatively,
you can disable the HA feature and write to a local database on each node.
Both methods require that you configure Icinga Web 2 accordingly (monitoring
backend, IDO database, used transports, etc.).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
The zone hierarchy could look like this. It involves putting the two master nodes
`icinga2-master1.localdomain` and `icinga2-master2.localdomain` into the `master` zone.
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.conf
object Endpoint "icinga2-master1.localdomain" {
host = "192.168.56.101"
}
object Endpoint "icinga2-master2.localdomain" {
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
host = "192.168.56.102"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Endpoint "icinga2-client1.localdomain" {
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
host = "192.168.56.111" //the master actively tries to connect to the client
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Endpoint "icinga2-client2.localdomain" {
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
host = "192.168.56.112" //the master actively tries to connect to the client
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "master" {
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ]
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "icinga2-client1.localdomain" {
endpoints = [ "icinga2-client1.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "master"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "icinga2-client2.localdomain" {
endpoints = [ "icinga2-client2.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "master"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
/* sync global commands */
object Zone "global-templates" {
global = true
}
The two client nodes do not necessarily need to know about each other. The only important thing
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
is that they know about the parent zone and their endpoint members (and optionally about the global zone).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
If you specify the `host` attribute in the `icinga2-master1.localdomain` and `icinga2-master2.localdomain`
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
endpoint objects, the client will actively try to connect to the master node. Since we've specified the client
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
endpoint's attribute on the master node already, we don't want the clients to connect to the
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
master nodes. **Choose one [connection direction](06-distributed-monitoring.md#distributed-monitoring-advanced-hints-connection-direction).**
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/zones.conf
object Endpoint "icinga2-master1.localdomain" {
//do not actively connect to the master by leaving out the 'host' attribute
}
object Endpoint "icinga2-master2.localdomain" {
//do not actively connect to the master by leaving out the 'host' attribute
}
object Endpoint "icinga2-client1.localdomain" {
}
object Zone "master" {
endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ]
}
object Zone "icinga2-client1.localdomain" {
endpoints = [ "icinga2-client1.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "master"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
/* sync global commands */
object Zone "global-templates" {
global = true
}
[root@icinga2-client2.localdomain /]# vim /etc/icinga2/zones.conf
object Endpoint "icinga2-master1.localdomain" {
//do not actively connect to the master by leaving out the 'host' attribute
}
object Endpoint "icinga2-master2.localdomain" {
//do not actively connect to the master by leaving out the 'host' attribute
}
object Endpoint "icinga2-client2.localdomain" {
}
object Zone "master" {
endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ]
}
object Zone "icinga2-client2.localdomain" {
endpoints = [ "icinga2-client2.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "master"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
/* sync global commands */
object Zone "global-templates" {
global = true
}
Now it is time to define the two client hosts and apply service checks using
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
the command endpoint execution method. Note: You can also use the
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
config sync mode here.
Create a new configuration directory on the master node `icinga2-master1.localdomain`.
**Note**: The secondary master node `icinga2-master2.localdomain` receives the
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
configuration using the [config sync mode](06-distributed-monitoring.md#distributed-monitoring-top-down-config-sync).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/master
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Add the two client nodes as host objects:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/master
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim hosts.conf
object Host "icinga2-client1.localdomain" {
check_command = "hostalive"
address = "192.168.56.111"
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
vars.client_endpoint = name //follows the convention that host name == endpoint name
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Host "icinga2-client2.localdomain" {
check_command = "hostalive"
address = "192.168.56.112"
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
vars.client_endpoint = name //follows the convention that host name == endpoint name
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Add services using command endpoint checks:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf
apply Service "ping4" {
check_command = "ping4"
//check is executed on the master node
assign where host.address
}
apply Service "disk" {
check_command = "disk"
//specify where the check is executed
command_endpoint = host.vars.client_endpoint
assign where host.vars.client_endpoint
}
Validate the configuration and restart Icinga 2 on the master node `icinga2-master1.localdomain`.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Open Icinga Web 2 and check the two newly created client hosts with two new services
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
-- one executed locally (`ping4`) and one using command endpoint (`disk`).
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
**Tip**: It's a good idea to add [health checks](06-distributed-monitoring.md#distributed-monitoring-health-checks)
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
to make sure that your cluster notifies you in case of failure.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Three Levels with Master, Satellites, and Clients <a id="distributed-monitoring-scenarios-master-satellite-client"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
![Icinga 2 Distributed Master and Satellites with Clients](images/distributed-monitoring/icinga2_distributed_scenarios_master_satellite_client.png)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
This scenario combines everything you've learned so far: High-availability masters,
Enhance cluster scenario documentation fixes #5157
2017-04-10 17:24:39 +02:00
satellites receiving their configuration from the master zone, and clients checked via command
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
endpoint from the satellite zones.
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Tip**: It can get complicated, so grab a pen and paper and bring your thoughts to life.
Play around with a test setup before using it in a production environment!
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Overview:
Enhance cluster scenario documentation fixes #5157
2017-04-10 17:24:39 +02:00
* `icinga2-master1.localdomain` is the configuration master master node.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
* `icinga2-master2.localdomain` is the secondary master master node without configuration in `zones.d`.
* `icinga2-satellite1.localdomain` and `icinga2-satellite2.localdomain` are satellite nodes in a `master` child zone.
* `icinga2-client1.localdomain` and `icinga2-client2.localdomain` are two child nodes as clients.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Setup requirements:
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
* Set up `icinga2-master1.localdomain` as [master](06-distributed-monitoring.md#distributed-monitoring-setup-master).
* Set up `icinga2-master2.localdomain`, `icinga2-satellite1.localdomain` and `icinga2-satellite2.localdomain` as [clients](06-distributed-monitoring.md#distributed-monitoring-setup-satellite-client) (we will modify the generated configuration).
* Set up `icinga2-client1.localdomain` and `icinga2-client2.localdomain` as [clients](06-distributed-monitoring.md#distributed-monitoring-setup-satellite-client).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
When being asked for the master endpoint providing CSR auto-signing capabilities,
please add the master node which holds the CA and has the `ApiListener` feature configured and enabled.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
The parent endpoint must still remain the satellite endpoint name.
Example for `icinga2-client1.localdomain`:
Please specify the master endpoint(s) this node should connect to:
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Master is the first satellite `icinga2-satellite1.localdomain`:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Master Common Name (CN from your master setup): icinga2-satellite1.localdomain
Do you want to establish a connection to the master from this node? [Y/n]: y
Please fill out the master connection information:
Master endpoint host (Your master's IP address or FQDN): 192.168.56.105
Master endpoint port [5665]:
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Add the second satellite `icinga2-satellite2.localdomain` as master:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Add more master endpoints? [y/N]: y
Master Common Name (CN from your master setup): icinga2-satellite2.localdomain
Do you want to establish a connection to the master from this node? [Y/n]: y
Please fill out the master connection information:
Master endpoint host (Your master's IP address or FQDN): 192.168.56.106
Master endpoint port [5665]:
Add more master endpoints? [y/N]: n
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
Specify the master node `icinga2-master2.localdomain` with the CA private key and ticket salt:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Please specify the master connection for CSR auto-signing (defaults to master endpoint host):
Host [192.168.56.106]: icinga2-master1.localdomain
Port [5665]:
In case you cannot connect to the master node from your clients, you'll manually need
Fix wrong anchors in the documentation refs #5732
2017-11-15 11:10:52 +01:00
to [generate the SSL certificates](06-distributed-monitoring.md#distributed-monitoring-advanced-hints-certificates-manual)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
and modify the configuration accordingly.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
We'll discuss the details of the required configuration below.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
The zone hierarchy can look like this. We'll define only the directly connected zones here.
You can safely deploy this configuration onto all master and satellite zone
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
members. You should keep in mind to control the endpoint [connection direction](06-distributed-monitoring.md#distributed-monitoring-advanced-hints-connection-direction)
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
using the `host` attribute.
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.conf
object Endpoint "icinga2-master1.localdomain" {
host = "192.168.56.101"
}
object Endpoint "icinga2-master2.localdomain" {
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
host = "192.168.56.102"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Endpoint "icinga2-satellite1.localdomain" {
host = "192.168.56.105"
}
object Endpoint "icinga2-satellite2.localdomain" {
host = "192.168.56.106"
}
object Zone "master" {
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
endpoints = [ "icinga2-master1.localdomain", "icinga2-master2.localdomain" ]
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "satellite" {
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
endpoints = [ "icinga2-satellite1.localdomain", "icinga2-satellite2.localdomain" ]
parent = "master"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
/* sync global commands */
object Zone "global-templates" {
global = true
}
Enhance cluster scenario documentation fixes #5157
2017-04-10 17:24:39 +02:00
Repeat the configuration step for `icinga2-master2.localdomain`, `icinga2-satellite1.localdomain`
and `icinga2-satellite2.localdomain`.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Since we want to use [top down command endpoint](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint) checks,
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
we must configure the client endpoint and zone objects.
Enhance cluster scenario documentation fixes #5157
2017-04-10 17:24:39 +02:00
In order to minimize the effort, we'll sync the client zone and endpoint configuration to the
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
satellites where the connection information is needed as well.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/{master,satellite,global-templates}
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/satellite
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim icinga2-client1.localdomain.conf
object Endpoint "icinga2-client1.localdomain" {
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
host = "192.168.56.111" //the satellite actively tries to connect to the client
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "icinga2-client1.localdomain" {
endpoints = [ "icinga2-client1.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "satellite"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim icinga2-client2.localdomain.conf
object Endpoint "icinga2-client2.localdomain" {
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
host = "192.168.56.112" //the satellite actively tries to connect to the client
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "icinga2-client2.localdomain" {
endpoints = [ "icinga2-client2.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "satellite"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The two client nodes do not necessarily need to know about each other, either. The only important thing
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
is that they know about the parent zone (the satellite) and their endpoint members (and optionally the global zone).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
If you specify the `host` attribute in the `icinga2-satellite1.localdomain` and `icinga2-satellite2.localdomain`
endpoint objects, the client node will actively try to connect to the satellite node. Since we've specified the client
endpoint's attribute on the satellite node already, we don't want the client node to connect to the
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
satellite nodes. **Choose one [connection direction](06-distributed-monitoring.md#distributed-monitoring-advanced-hints-connection-direction).**
Enhance cluster scenario documentation fixes #5157
2017-04-10 17:24:39 +02:00
Example for `icinga2-client1.localdomain`:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/zones.conf
object Endpoint "icinga2-satellite1.localdomain" {
//do not actively connect to the satellite by leaving out the 'host' attribute
}
object Endpoint "icinga2-satellite2.localdomain" {
//do not actively connect to the satellite by leaving out the 'host' attribute
}
object Endpoint "icinga2-client1.localdomain" {
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
//that's us
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "satellite" {
endpoints = [ "icinga2-satellite1.localdomain", "icinga2-satellite2.localdomain" ]
}
object Zone "icinga2-client1.localdomain" {
endpoints = [ "icinga2-client1.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "satellite"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
/* sync global commands */
object Zone "global-templates" {
global = true
}
Enhance cluster scenario documentation fixes #5157
2017-04-10 17:24:39 +02:00
Example for `icinga2-client2.localdomain`:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-client2.localdomain /]# vim /etc/icinga2/zones.conf
object Endpoint "icinga2-satellite1.localdomain" {
//do not actively connect to the satellite by leaving out the 'host' attribute
}
object Endpoint "icinga2-satellite2.localdomain" {
//do not actively connect to the satellite by leaving out the 'host' attribute
}
object Endpoint "icinga2-client2.localdomain" {
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
//that's us
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
object Zone "satellite" {
endpoints = [ "icinga2-satellite1.localdomain", "icinga2-satellite2.localdomain" ]
}
object Zone "icinga2-client2.localdomain" {
endpoints = [ "icinga2-client2.localdomain" ]
Docs: Fix missing configuration in distributed monitoring chapter fixes #12681
2016-09-29 17:58:31 +02:00
parent = "satellite"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
/* sync global commands */
object Zone "global-templates" {
global = true
}
Now it is time to define the two client hosts on the master, sync them to the satellites
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
and apply service checks using the command endpoint execution method to them.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Add the two client nodes as host objects to the `satellite` zone.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
We've already created the directories in `/etc/icinga2/zones.d` including the files for the
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
zone and endpoint configuration for the clients.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/satellite
Enhance cluster scenario documentation fixes #5157
2017-04-10 17:24:39 +02:00
Add the host object configuration for the `icinga2-client1.localdomain` client. You should
have created the configuration file in the previous steps and it should contain the endpoint
and zone object configuration already.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim icinga2-client1.localdomain.conf
object Host "icinga2-client1.localdomain" {
check_command = "hostalive"
address = "192.168.56.111"
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
vars.client_endpoint = name //follows the convention that host name == endpoint name
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Enhance cluster scenario documentation fixes #5157
2017-04-10 17:24:39 +02:00
Add the host object configuration for the `icinga2-client2.localdomain` client configuration file:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim icinga2-client2.localdomain.conf
object Host "icinga2-client2.localdomain" {
check_command = "hostalive"
address = "192.168.56.112"
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
vars.client_endpoint = name //follows the convention that host name == endpoint name
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Enhance cluster scenario documentation fixes #5157
2017-04-10 17:24:39 +02:00
Add a service object which is executed on the satellite nodes (e.g. `ping4`). Pin the apply rule to the `satellite` zone only.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim services.conf
apply Service "ping4" {
check_command = "ping4"
//check is executed on the satellite node
assign where host.zone == "satellite" && host.address
}
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
Add services using command endpoint checks. Pin the apply rules to the `satellite` zone only.
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/satellite]# vim services.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
apply Service "disk" {
check_command = "disk"
//specify where the check is executed
command_endpoint = host.vars.client_endpoint
assign where host.zone == "satellite" && host.vars.client_endpoint
}
Validate the configuration and restart Icinga 2 on the master node `icinga2-master1.localdomain`.
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Open Icinga Web 2 and check the two newly created client hosts with two new services
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
-- one executed locally (`ping4`) and one using command endpoint (`disk`).
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
**Tip**: It's a good idea to add [health checks](06-distributed-monitoring.md#distributed-monitoring-health-checks)
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
to make sure that your cluster notifies you in case of failure.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Best Practice <a id="distributed-monitoring-best-practice"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
We've put together a collection of configuration examples from community feedback.
Update README.md and correct project URLs fixes #13491
2016-12-08 17:38:41 +01:00
If you like to share your tips and tricks with us, please join the [community channels](https://www.icinga.com/community/get-involved/)!
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Global Zone for Config Sync <a id="distributed-monitoring-global-zone-config-sync"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Global zones can be used to sync generic configuration objects
to all nodes depending on them. Common examples are:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* Templates which are imported into zone specific objects.
* Command objects referenced by Host, Service, Notification objects.
Enhance advanced topics with (scheduled) downtimes
2018-04-27 16:16:59 +02:00
* Apply rules for services, notifications and dependencies.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
* User objects referenced in notifications.
* Group objects.
* TimePeriod objects.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Plugin scripts and binaries cannot be synced, this is for Icinga 2
configuration files only. Use your preferred package repository
and/or configuration management tool (Puppet, Ansible, Chef, etc.)
for that.
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Note**: Checkable objects (hosts and services) cannot be put into a global
zone. The configuration validation will terminate with an error.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
The zone object configuration must be deployed on all nodes which should receive
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
the global configuration files:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Add a note about removing "conf.d" on the client for "top down command endpoint" setups fixes #13395
2016-12-03 13:42:22 +01:00
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Zone "global-templates" {
global = true
}
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Note: Packages >= 2.8 provide this configuration by default.
zones.conf: Add global-templates & director-global by default This makes it easier for cluster and client setups with or without the Icinga Director. Note: Clients will still not receive synced configuration if accept_config is not enabled (which is the default, and can be changed during setup). fixes #5106
2017-06-02 10:52:47 +02:00
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Similar to the zone configuration sync you'll need to create a new directory in
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
`/etc/icinga2/zones.d`:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/global-templates
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Next, add a new check command, for example:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.d/global-templates/commands.conf
object CheckCommand "my-cmd" {
//...
}
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Restart the client(s) which should receive the global zone before
before restarting the parent master/satellite nodes.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Then validate the configuration on the master node and restart Icinga 2.
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Tip**: You can copy the example configuration files located in `/etc/icinga2/conf.d`
into your global zone.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Example:
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/conf.d
Enhance advanced topics with (scheduled) downtimes
2018-04-27 16:16:59 +02:00
[root@icinga2-master1.localdomain /etc/icinga2/conf.d]# cp {commands,groups,notifications,services,templates,timeperiods,users}.conf /etc/icinga2/zones.d/global-templates
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Health Checks <a id="distributed-monitoring-health-checks"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
In case of network failures or other problems, your monitoring might
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
either have late check results or just send out mass alarms for unknown
checks.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
In order to minimize the problems caused by this, you should configure
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
additional health checks.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The `cluster` check, for example, will check if all endpoints in the current zone and the directly
connected zones are working properly:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/master
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.d/master/icinga2-master1.localdomain.conf
object Host "icinga2-master1.localdomain" {
check_command = "hostalive"
address = "192.168.56.101"
}
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.d/master/cluster.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Service "cluster" {
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
check_command = "cluster"
check_interval = 5s
retry_interval = 1s
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
host_name = "icinga2-master1.localdomain"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
The `cluster-zone` check will test whether the configured target zone is currently
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
connected or not. This example adds a health check for the [ha master with clients scenario](06-distributed-monitoring.md#distributed-monitoring-scenarios-ha-master-clients).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.d/master/services.conf
apply Service "cluster-health" {
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
check_command = "cluster-zone"
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
display_name = "cluster-health-" + host.name
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
/* This follows the convention that the client zone name is the FQDN which is the same as the host object name. */
vars.cluster_zone = host.name
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
assign where host.vars.client_endpoint
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
In case you cannot assign the `cluster_zone` attribute, add specific
checks to your cluster:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.d/master/cluster.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
object Service "cluster-zone-satellite" {
check_command = "cluster-zone"
check_interval = 5s
retry_interval = 1s
vars.cluster_zone = "satellite"
host_name = "icinga2-master1.localdomain"
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
If you are using top down checks with command endpoint configuration, you can
add a dependency which prevents notifications for all other failing services:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.d/master/dependencies.conf
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
apply Dependency "health-check" to Service {
parent_service_name = "child-health"
states = [ OK ]
disable_notifications = true
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
assign where host.vars.client_endpoint
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
ignore where service.name == "child-health"
Fixed doc formatting This fixes a minor doc formatting bug, where one closing bracket is outside the code tag.
2017-10-19 09:56:41 +02:00
}
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Pin Checks in a Zone <a id="distributed-monitoring-pin-checks-zone"></a>
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
In case you want to pin specific checks to their endpoints in a given zone you'll need to use
the `command_endpoint` attribute. This is reasonable if you want to
Fix missing word in doc chapter pin checks in a zone
2017-11-11 15:01:17 +01:00
execute a local disk check in the `master` Zone on a specific endpoint then.
Docs: Add a note about pinning checks in a zone fixes #13319
2016-11-24 16:35:29 +01:00
[root@icinga2-master1.localdomain /]# mkdir -p /etc/icinga2/zones.d/master
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.d/master/icinga2-master1.localdomain.conf
object Host "icinga2-master1.localdomain" {
check_command = "hostalive"
address = "192.168.56.101"
}
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.d/master/services.conf
apply Service "disk" {
check_command = "disk"
command_endpoint = host.name //requires a host object matching the endpoint object name e.g. icinga2-master1.localdomain
assign where host.zone == "master" && match("icinga2-master*", host.name)
}
Docs: Update API and Library Reference chapters New sub chapters for global functions linked everywhere. New API examples and clarifications. fixes #13327 fixes #12449
2016-11-25 13:40:42 +01:00
The `host.zone` attribute check inside the expression ensures that
the service object is only created for host objects inside the `master`
zone. In addition to that the [match](18-library-reference.md#global-functions-match)
function ensures to only create services for the master nodes.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Windows Firewall <a id="distributed-monitoring-windows-firewall"></a>
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
Docs: Add firewall details for check_nscp_api
2017-09-18 16:25:29 +02:00
#### ICMP Requests <a id="distributed-monitoring-windows-firewall-icmp"></a>
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
By default ICMP requests are disabled in the Windows firewall. You can
change that by [adding a new rule](https://support.microsoft.com/en-us/kb/947709).
C:\WINDOWS\system32>netsh advfirewall firewall add rule name="ICMP Allow incoming V4 echo request" protocol=icmpv4:8,any dir=in action=allow
Docs: Add firewall details for check_nscp_api
2017-09-18 16:25:29 +02:00
#### Icinga 2 <a id="distributed-monitoring-windows-firewall-icinga2"></a>
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
If your master/satellite nodes should actively connect to the Windows client
you'll also need to ensure that port `5665` is enabled.
C:\WINDOWS\system32>netsh advfirewall firewall add rule name="Open port 5665 (Icinga 2)" dir=in action=allow protocol=TCP localport=5665
Docs: Add firewall details for check_nscp_api
2017-09-18 16:25:29 +02:00
#### NSClient++ API <a id="distributed-monitoring-windows-firewall-nsclient-api"></a>
If the [check_nscp_api](06-distributed-monitoring.md#distributed-monitoring-windows-nscp-check-api)
Docs: Add a note to only query the NSClient++ API from the local Icinga 2 client
2018-03-20 11:50:52 +01:00
plugin is used to query NSClient++, you need to ensure that its port is enabled.
Docs: Add firewall details for check_nscp_api
2017-09-18 16:25:29 +02:00
C:\WINDOWS\system32>netsh advfirewall firewall add rule name="Open port 8443 (NSClient++ API)" dir=in action=allow protocol=TCP localport=8443
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
Docs: Add a note to only query the NSClient++ API from the local Icinga 2 client
2018-03-20 11:50:52 +01:00
For security reasons, it is advised to enable the NSClient++ HTTP API for local
connection from the Icinga 2 client only. Remote connections to the HTTP API
are not recommended with using the legacy HTTP API.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Windows Client and Plugins <a id="distributed-monitoring-windows-plugins"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
The Icinga 2 package on Windows already provides several plugins.
Detailed [documentation](10-icinga-template-library.md#windows-plugins) is available for all check command definitions.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Add the following `include` statement on all your nodes (master, satellite, client):
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
vim /etc/icinga2/icinga2.conf
include <windows-plugins>
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Based on the [master with clients](06-distributed-monitoring.md#distributed-monitoring-master-clients)
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
scenario we'll now add a local disk check.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
First, add the client node as host object:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/master
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim hosts.conf
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
object Host "icinga2-client2.localdomain" {
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
check_command = "hostalive"
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
address = "192.168.56.112"
vars.client_endpoint = name //follows the convention that host name == endpoint name
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
vars.os_type = "windows"
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Next, add the disk check using command endpoint checks (details in the
[disk-windows](10-icinga-template-library.md#windows-plugins-disk-windows) documentation):
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf
apply Service "disk C:" {
check_command = "disk-windows"
vars.disk_win_path = "C:"
//specify where the check is executed
command_endpoint = host.vars.client_endpoint
assign where host.vars.os_type == "windows" && host.vars.client_endpoint
}
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Validate the configuration and restart Icinga 2.
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Open Icinga Web 2 and check your newly added Windows disk check :)
![Icinga 2 Client Windows](images/distributed-monitoring/icinga2_distributed_windows_client_disk_icingaweb2.png)
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
If you want to add your own plugins please check [this chapter](05-service-monitoring.md#service-monitoring-requirements)
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
for the requirements.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Windows Client and NSClient++ <a id="distributed-monitoring-windows-nscp"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
There are two methods available for querying NSClient++:
Docs: Add a note to only query the NSClient++ API from the local Icinga 2 client
2018-03-20 11:50:52 +01:00
* Query the [HTTP API](06-distributed-monitoring.md#distributed-monitoring-windows-nscp-check-api) locally from an Icinga 2 client (requires a running NSClient++ service)
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
* Run a [local CLI check](06-distributed-monitoring.md#distributed-monitoring-windows-nscp-check-local) (does not require NSClient++ as a service)
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
Both methods have their advantages and disadvantages. One thing to
note: If you rely on performance counter delta calculations such as
CPU utilization, please use the HTTP API instead of the CLI sample call.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### NSCLient++ with check_nscp_api <a id="distributed-monitoring-windows-nscp-check-api"></a>
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
The [Windows setup](06-distributed-monitoring.md#distributed-monitoring-setup-client-windows) already allows
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
you to install the NSClient++ package. In addition to the Windows plugins you can
use the [nscp_api command](10-icinga-template-library.md#nscp-check-api) provided by the Icinga Template Library (ITL).
The initial setup for the NSClient++ API and the required arguments
is the described in the ITL chapter for the [nscp_api](10-icinga-template-library.md#nscp-check-api) CheckCommand.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Based on the [master with clients](06-distributed-monitoring.md#distributed-monitoring-master-clients)
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
scenario we'll now add a local nscp check which queries the NSClient++ API to check the free disk space.
Define a host object called `icinga2-client2.localdomain` on the master. Add the `nscp_api_password`
custom attribute and specify the drives to check.
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/master
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim hosts.conf
object Host "icinga2-client1.localdomain" {
check_command = "hostalive"
address = "192.168.56.111"
vars.client_endpoint = name //follows the convention that host name == endpoint name
vars.os_type = "Windows"
vars.nscp_api_password = "icinga"
vars.drives = [ "C:", "D:" ]
}
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
The service checks are generated using an [apply for](03-monitoring-basics.md#using-apply-for)
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
rule based on `host.vars.drives`:
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf
Fixed nscp-disk service example
2017-08-29 13:34:00 +02:00
apply Service "nscp-api-" for (drive in host.vars.drives) {
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
import "generic-service"
check_command = "nscp_api"
command_endpoint = host.vars.client_endpoint
//display_name = "nscp-drive-" + drive
vars.nscp_api_host = "localhost"
vars.nscp_api_query = "check_drivesize"
vars.nscp_api_password = host.vars.nscp_api_password
vars.nscp_api_arguments = [ "drive=" + drive ]
ignore where host.vars.os_type != "Windows"
}
Validate the configuration and restart Icinga 2.
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Two new services ("nscp-drive-D:" and "nscp-drive-C:") will be visible in Icinga Web 2.
![Icinga 2 Distributed Monitoring Windows Client with NSClient++ nscp-api](images/distributed-monitoring/icinga2_distributed_windows_nscp_api_drivesize_icingaweb2.png)
Note: You can also omit the `command_endpoint` configuration to execute
the command on the master. This also requires a different value for `nscp_api_host`
which defaults to `host.address`.
//command_endpoint = host.vars.client_endpoint
//vars.nscp_api_host = "localhost"
You can verify the check execution by looking at the `Check Source` attribute
in Icinga Web 2 or the REST API.
Docs: Add example for Windows service monitoring with check_nscp_api
2017-09-18 16:56:03 +02:00
If you want to monitor specific Windows services, you could use the following example:
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/master
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim hosts.conf
object Host "icinga2-client1.localdomain" {
check_command = "hostalive"
address = "192.168.56.111"
vars.client_endpoint = name //follows the convention that host name == endpoint name
vars.os_type = "Windows"
vars.nscp_api_password = "icinga"
vars.services = [ "Windows Update", "wscsvc" ]
}
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf
apply Service "nscp-api-" for (svc in host.vars.services) {
import "generic-service"
check_command = "nscp_api"
command_endpoint = host.vars.client_endpoint
//display_name = "nscp-service-" + svc
vars.nscp_api_host = "localhost"
vars.nscp_api_query = "check_service"
vars.nscp_api_password = host.vars.nscp_api_password
vars.nscp_api_arguments = [ "service=" + svc ]
ignore where host.vars.os_type != "Windows"
}
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### NSCLient++ with nscp-local <a id="distributed-monitoring-windows-nscp-check-local"></a>
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
The [Windows setup](06-distributed-monitoring.md#distributed-monitoring-setup-client-windows) already allows
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
you to install the NSClient++ package. In addition to the Windows plugins you can
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
use the [nscp-local commands](10-icinga-template-library.md#nscp-plugin-check-commands)
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
provided by the Icinga Template Library (ITL).
![Icinga 2 Distributed Monitoring Windows Client with NSClient++](images/distributed-monitoring/icinga2_distributed_windows_nscp.png)
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Add the following `include` statement on all your nodes (master, satellite, client):
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
vim /etc/icinga2/icinga2.conf
Fix wrong nscp-local include in the docs
2018-01-18 13:25:23 +01:00
include <nscp>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
The CheckCommand definitions will automatically determine the installed path
to the `nscp.exe` binary.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Based on the [master with clients](06-distributed-monitoring.md#distributed-monitoring-master-clients)
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
scenario we'll now add a local nscp check querying a given performance counter.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
First, add the client node as host object:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/master
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim hosts.conf
object Host "icinga2-client1.localdomain" {
check_command = "hostalive"
address = "192.168.56.111"
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
vars.client_endpoint = name //follows the convention that host name == endpoint name
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
vars.os_type = "windows"
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Next, add a performance counter check using command endpoint checks (details in the
[nscp-local-counter](10-icinga-template-library.md#nscp-check-local-counter) documentation):
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
[root@icinga2-master1.localdomain /etc/icinga2/zones.d/master]# vim services.conf
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
apply Service "nscp-local-counter-cpu" {
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
check_command = "nscp-local-counter"
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
command_endpoint = host.vars.client_endpoint
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
vars.nscp_counter_name = "\\Processor(_total)\\% Processor Time"
vars.nscp_counter_perfsyntax = "Total Processor Time"
vars.nscp_counter_warning = 1
vars.nscp_counter_critical = 5
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
vars.nscp_counter_showall = true
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
assign where host.vars.os_type == "windows" && host.vars.client_endpoint
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
}
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Validate the configuration and restart Icinga 2.
[root@icinga2-master1.localdomain /]# icinga2 daemon -C
[root@icinga2-master1.localdomain /]# systemctl restart icinga2
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
Open Icinga Web 2 and check your newly added Windows NSClient++ check :)
Add check_nscp_api plugin for NSClient++ API checks refs #4721
2016-10-10 11:42:18 +02:00
![Icinga 2 Distributed Monitoring Windows Client with NSClient++ nscp-local](images/distributed-monitoring/icinga2_distributed_windows_nscp_counter_icingaweb2.png)
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
Add a note on Windows NSClient++ CPU checks to the docs refs #6315
2018-05-18 10:43:20 +02:00
> **Tip**
>
> In order to measure CPU load, you'll need a running NSClient++ service.
> Therefore it is advised to use a local [nscp-api](06-distributed-monitoring.md#distributed-monitoring-windows-nscp-check-api)
> check against its REST API.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Advanced Hints <a id="distributed-monitoring-advanced-hints"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
You can find additional hints in this section if you prefer to go your own route
with automating setups (setup, certificates, configuration).
Docs: Update user documentation for signing methods and Linux client setups Better explanation for "CSR Auto-Signing" and a new term "On-Demand CSR Signing". The Linux setup now accompanies the user step by step on each question asked. The full table with all the details is moved to the bottom. TODO: The Windows setup wizard does not support connection-less or ticket-less requests yet. refs #5450
2017-09-07 19:00:11 +02:00
### Certificate Auto-Renewal <a id="distributed-monitoring-certificate-auto-renewal"></a>
Icinga 2 v2.8+ adds the possibility that nodes request certificate updates
on their own. If their expiration date is soon enough, they automatically
renew their already signed certificate by sending a signing request to the
parent node.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### High-Availability for Icinga 2 Features <a id="distributed-monitoring-high-availability-features"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
All nodes in the same zone require that you enable the same features for high-availability (HA).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
By default, the following features provide advanced HA functionality:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
* [Checks](06-distributed-monitoring.md#distributed-monitoring-high-availability-checks) (load balanced, automated failover).
* [Notifications](06-distributed-monitoring.md#distributed-monitoring-high-availability-notifications) (load balanced, automated failover).
* [DB IDO](06-distributed-monitoring.md#distributed-monitoring-high-availability-db-ido) (Run-Once, automated failover).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### High-Availability with Checks <a id="distributed-monitoring-high-availability-checks"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
All instances within the same zone (e.g. the `master` zone as HA cluster) must
have the `checker` feature enabled.
Example:
# icinga2 feature enable checker
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
All nodes in the same zone load-balance the check execution. If one instance shuts down,
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
the other nodes will automatically take over the remaining checks.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### High-Availability with Notifications <a id="distributed-monitoring-high-availability-notifications"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
All instances within the same zone (e.g. the `master` zone as HA cluster) must
have the `notification` feature enabled.
Example:
# icinga2 feature enable notification
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Notifications are load-balanced amongst all nodes in a zone. By default this functionality
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
is enabled.
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
If your nodes should send out notifications independently from any other nodes (this will cause
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
duplicated notifications if not properly handled!), you can set `enable_ha = false`
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
in the [NotificationComponent](09-object-types.md#objecttype-notificationcomponent) feature.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### High-Availability with DB IDO <a id="distributed-monitoring-high-availability-db-ido"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
All instances within the same zone (e.g. the `master` zone as HA cluster) must
have the DB IDO feature enabled.
Example DB IDO MySQL:
# icinga2 feature enable ido-mysql
By default the DB IDO feature only runs on one node. All other nodes in the same zone disable
the active IDO database connection at runtime. The node with the active DB IDO connection is
not necessarily the zone master.
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Note**: The DB IDO HA feature can be disabled by setting the `enable_ha` attribute to `false`
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
for the [IdoMysqlConnection](09-object-types.md#objecttype-idomysqlconnection) or
[IdoPgsqlConnection](09-object-types.md#objecttype-idopgsqlconnection) object on **all** nodes in the
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**same** zone.
All endpoints will enable the DB IDO feature and connect to the configured
database and dump configuration, status and historical data on their own.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
If the instance with the active DB IDO connection dies, the HA functionality will
automatically elect a new DB IDO master.
The DB IDO feature will try to determine which cluster endpoint is currently writing
to the database and bail out if another endpoint is active. You can manually verify that
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
by running the following query command:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
icinga=> SELECT status_update_time, endpoint_name FROM icinga_programstatus;
status_update_time | endpoint_name
------------------------+---------------
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
2016-08-15 15:52:26+02 | icinga2-master1.localdomain
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
(1 Zeile)
This is useful when the cluster connection between endpoints breaks, and prevents
data duplication in split-brain-scenarios. The failover timeout can be set for the
`failover_timeout` attribute, but not lower than 60 seconds.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Endpoint Connection Direction <a id="distributed-monitoring-advanced-hints-connection-direction"></a>
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Nodes will attempt to connect to another node when its local [Endpoint](09-object-types.md#objecttype-endpoint) object
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
configuration specifies a valid `host` attribute (FQDN or IP address).
Example for the master node `icinga2-master1.localdomain` actively connecting
to the client node `icinga2-client1.localdomain`:
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.conf
//...
object Endpoint "icinga2-client1.localdomain" {
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
host = "192.168.56.111" //the master actively tries to connect to the client
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
log_duration = 0
}
Example for the client node `icinga2-client1.localdomain` not actively
connecting to the master node `icinga2-master1.localdomain`:
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/zones.conf
//...
object Endpoint "icinga2-master1.localdomain" {
//do not actively connect to the master by leaving out the 'host' attribute
log_duration = 0
}
It is not necessary that both the master and the client node establish
two connections to each other. Icinga 2 will only use one connection
and close the second connection if established.
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Tip**: Choose either to let master/satellite nodes connect to client nodes
or vice versa.
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Disable Log Duration for Command Endpoints <a id="distributed-monitoring-advanced-hints-command-endpoint-log-duration"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
The replay log is a built-in mechanism to ensure that nodes in a distributed setup
keep the same history (check results, notifications, etc.) when nodes are temporarily
disconnected and then reconnect.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
This functionality is not needed when a master/satellite node is sending check
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
execution events to a client which is purely configured for [command endpoint](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint)
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
checks only.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
The [Endpoint](09-object-types.md#objecttype-endpoint) object attribute `log_duration` can
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
be lower or set to 0 to fully disable any log replay updates when the
client is not connected.
Configuration on the master node `icinga2-master1.localdomain`:
[root@icinga2-master1.localdomain /]# vim /etc/icinga2/zones.conf
//...
object Endpoint "icinga2-client1.localdomain" {
Upgrade NSClient++ to 0.5.0 stable This involves required changes in the nscp-local ITL CheckCommand definitions. Upgrading NSClient++ therefore requires updating the Icinga 2 Windows client as well. fixes #12733
2016-09-21 14:04:20 +02:00
host = "192.168.56.111" //the master actively tries to connect to the client
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
log_duration = 0
}
object Endpoint "icinga2-client2.localdomain" {
Fix client names in distributed monitoring docs fixes #4996
2017-02-14 12:53:04 +01:00
host = "192.168.56.112" //the master actively tries to connect to the client
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
log_duration = 0
}
Configuration on the client `icinga2-client1.localdomain`:
[root@icinga2-client1.localdomain /]# vim /etc/icinga2/zones.conf
//...
object Endpoint "icinga2-master1.localdomain" {
//do not actively connect to the master by leaving out the 'host' attribute
log_duration = 0
}
object Endpoint "icinga2-master2.localdomain" {
//do not actively connect to the master by leaving out the 'host' attribute
log_duration = 0
}
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### CSR auto-signing with HA and multiple Level Cluster <a id="distributed-monitoring-advanced-hints-csr-autosigning-ha-satellites"></a>
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
If you are using two masters in a High-Availability setup it can be necessary
to allow both to sign requested certificates. Ensure to safely sync the following
details in private:
* `TicketSalt` constant in `constants.conf`.
* `var/lib/icinga2/ca` directory.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
This also helps if you are using a [three level cluster](06-distributed-monitoring.md#distributed-monitoring-scenarios-master-satellite-client)
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
and your client nodes are not able to reach the CSR auto-signing master node(s).
Make sure that the directory permissions for `/var/lib/icinga2/ca` are secure
(not world readable).
**Do not expose these private keys to anywhere else. This is a matter of security.**
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
### Manual Certificate Creation <a id="distributed-monitoring-advanced-hints-certificates-manual"></a>
#### Create CA on the Master <a id="distributed-monitoring-advanced-hints-certificates-manual-ca"></a>
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Choose the host which should store the certificate authority (one of the master nodes).
The first step is the creation of the certificate authority (CA) by running the following command
as root user:
[root@icinga2-master1.localdomain /root]# icinga2 pki new-ca
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
#### Create CSR and Certificate <a id="distributed-monitoring-advanced-hints-certificates-manual-create"></a>
Create a certificate signing request (CSR) for the local instance:
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
```
[root@icinga2-master1.localdomain /root]# icinga2 pki new-cert --cn icinga2-master1.localdomain \
--key icinga2-master1.localdomain.key \
--csr icinga2-master1.localdomain.csr
```
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Sign the CSR with the previously created CA:
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
```
[root@icinga2-master1.localdomain /root]# icinga2 pki sign-csr --csr icinga2-master1.localdomain.csr --cert icinga2-master1.localdomain
```
Repeat the steps for all instances in your setup.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Implement support for migrating certificates to /var/lib/icinga2/certs This commit includes documentation too. Signed-off-by: Michael Friedrich <michael.friedrich@icinga.com>
2017-10-16 15:32:57 +02:00
> **Note**
>
> The certificate location changed in v2.8 to `/var/lib/icinga2/certs`. Please read the [upgrading chapter](16-upgrading-icinga-2.md#upgrading-to-2-8-certificate-paths)
> for more details.
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
#### Copy Certificates <a id="distributed-monitoring-advanced-hints-certificates-manual-copy"></a>
Docs: Update certs path refs #5450
2017-09-07 16:55:42 +02:00
Copy the host's certificate files and the public CA certificate to `/var/lib/icinga2/certs`:
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
```
[root@icinga2-master1.localdomain /root]# mkdir -p /var/lib/icinga2/certs
[root@icinga2-master1.localdomain /root]# cp icinga2-master1.localdomain.{crt,key} /var/lib/icinga2/certs
[root@icinga2-master1.localdomain /root]# cp /var/lib/icinga2/ca/ca.crt /var/lib/icinga2/certs
```
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Ensure that proper permissions are set (replace `icinga` with the Icinga 2 daemon user):
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
```
[root@icinga2-master1.localdomain /root]# chown -R icinga:icinga /var/lib/icinga2/certs
[root@icinga2-master1.localdomain /root]# chmod 600 /var/lib/icinga2/certs/*.key
[root@icinga2-master1.localdomain /root]# chmod 644 /var/lib/icinga2/certs/*.crt
```
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
The CA public and private key are stored in the `/var/lib/icinga2/ca` directory. Keep this path secure and include
it in your backups.
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
#### Create Multiple Certificates <a id="distributed-monitoring-advanced-hints-certificates-manual-multiple"></a>
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
Use your preferred method to automate the certificate generation process.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
```
[root@icinga2-master1.localdomain /var/lib/icinga2/certs]# for node in icinga2-master1.localdomain icinga2-master2.localdomain icinga2-satellite1.localdomain; do icinga2 pki new-cert --cn $node --csr $node.csr --key $node.key; done
information/base: Writing private key to 'icinga2-master1.localdomain.key'.
information/base: Writing certificate signing request to 'icinga2-master1.localdomain.csr'.
information/base: Writing private key to 'icinga2-master2.localdomain.key'.
information/base: Writing certificate signing request to 'icinga2-master2.localdomain.csr'.
information/base: Writing private key to 'icinga2-satellite1.localdomain.key'.
information/base: Writing certificate signing request to 'icinga2-satellite1.localdomain.csr'.
[root@icinga2-master1.localdomain /var/lib/icinga2/certs]# for node in icinga2-master1.localdomain icinga2-master2.localdomain icinga2-satellite1.localdomain; do sudo icinga2 pki sign-csr --csr $node.csr --cert $node.crt; done
information/pki: Writing certificate to file 'icinga2-master1.localdomain.crt'.
information/pki: Writing certificate to file 'icinga2-master2.localdomain.crt'.
information/pki: Writing certificate to file 'icinga2-satellite1.localdomain.crt'.
```
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Fix manual certificate creation chapter in the docs
2017-11-09 15:14:10 +01:00
Copy and move these certificates to the respective instances e.g. with SSH/SCP.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
## Automation <a id="distributed-monitoring-automation"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
These hints should get you started with your own automation tools (Puppet, Ansible, Chef, Salt, etc.)
or custom scripts for automated setup.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
These are collected best practices from various community channels.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
* [Silent Windows setup](06-distributed-monitoring.md#distributed-monitoring-automation-windows-silent)
* [Node Setup CLI command](06-distributed-monitoring.md#distributed-monitoring-automation-cli-node-setup) with parameters
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
If you prefer an alternate method, we still recommend leaving all the Icinga 2 features intact (e.g. `icinga2 feature enable api`).
You should also use well known and documented default configuration file locations (e.g. `zones.conf`).
Update README.md and correct project URLs fixes #13491
2016-12-08 17:38:41 +01:00
This will tremendously help when someone is trying to help in the [community channels](https://www.icinga.com/community/get-involved/).
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Silent Windows Setup <a id="distributed-monitoring-automation-windows-silent"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
If you want to install the client silently/unattended, use the `/qn` modifier. The
Fixed grammer and spelling mistakes
2017-10-30 17:02:42 +01:00
installation should not trigger a restart, but if you want to be completely sure, you can use the `/norestart` modifier.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
C:> msiexec /i C:\Icinga2-v2.5.0-x86.msi /qn /norestart
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Once the setup is completed you can use the `node setup` cli command too.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
### Node Setup using CLI Parameters <a id="distributed-monitoring-automation-cli-node-setup"></a>
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
Instead of using the `node wizard` CLI command, there is an alternative `node setup`
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
command available which has some prerequisites.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Change tip/note formatting again refs #12523
2016-08-23 20:20:15 +02:00
**Note**: The CLI command can be used on Linux/Unix and Windows operating systems.
The graphical Windows setup wizard actively uses these CLI commands.
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### Node Setup on the Master Node <a id="distributed-monitoring-automation-cli-node-setup-master"></a>
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
In case you want to setup a master node you must add the `--master` parameter
to the `node setup` CLI command. In addition to that the `--cn` can optionally
be passed (defaults to the FQDN).
Parameter | Description
--------------------|--------------------
Common name (CN) | **Optional.** Specified with the `--cn` parameter. By convention this should be the host's FQDN. Defaults to the FQDN.
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Zone name | **Optional.** Specified with the `--zone` parameter. Defaults to `master`.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Listen on | **Optional.** Specified with the `--listen` parameter. Syntax is `host,port`.
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
Disable conf.d | **Optional.** Specified with the `disable-confd` parameter. If provided, this disables the `include_recursive "conf.d"` directive and adds the `api-users.conf` file inclusion to `icinga2.conf`. Available since v2.9+. Not set by default for compatibility reasons with Puppet, Ansible, Chef, etc.
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Example:
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
```
[root@icinga2-master1.localdomain /]# icinga2 node setup --master
```
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
In case you want to bind the `ApiListener` object to a specific
host/port you can specify it like this:
--listen 192.68.56.101,5665
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
In case you don't need anything in `conf.d`, use the following command line:
```
[root@icinga2-master1.localdomain /]# icinga2 node setup --master --disable-confd
```
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
#### Node Setup with Satellites/Clients <a id="distributed-monitoring-automation-cli-node-setup-satellite-client"></a>
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Implement support for migrating certificates to /var/lib/icinga2/certs This commit includes documentation too. Signed-off-by: Michael Friedrich <michael.friedrich@icinga.com>
2017-10-16 15:32:57 +02:00
> **Note**
>
> The certificate location changed in v2.8 to `/var/lib/icinga2/certs`. Please read the [upgrading chapter](16-upgrading-icinga-2.md#upgrading-to-2-8-certificate-paths)
> for more details.
Make sure that the `/var/lib/icinga2/certs` directory exists and is owned by the `icinga`
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
user (or the user Icinga 2 is running as).
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Update certs path refs #5450
2017-09-07 16:55:42 +02:00
[root@icinga2-client1.localdomain /]# mkdir -p /var/lib/icinga2/certs
[root@icinga2-client1.localdomain /]# chown -R icinga:icinga /var/lib/icinga2/certs
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
First you'll need to generate a new local self-signed certificate.
Pass the following details to the `pki new-cert` CLI command:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Parameter | Description
--------------------|--------------------
Doc: fixed wrong information about defaulting Signed-off-by: Maurice Meyer <morre@mor.re>
2018-03-23 13:18:15 +01:00
Common name (CN) | **Required.** By convention this should be the host's FQDN.
Docs: Update certs path refs #5450
2017-09-07 16:55:42 +02:00
Client certificate files | **Required.** These generated files will be put into the specified location (--key and --file). By convention this should be using `/var/lib/icinga2/certs` as directory.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Example:
[root@icinga2-client1.localdomain /]# icinga2 pki new-cert --cn icinga2-client1.localdomain \
Docs: Update certs path refs #5450
2017-09-07 16:55:42 +02:00
--key /var/lib/icinga2/certs/icinga2-client1.localdomain.key \
--cert /var/lib/icinga2/certs/icinga2-client1.localdomain.crt
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Request the master certificate from the master host (`icinga2-master1.localdomain`)
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
and store it as `trusted-master.crt`. Review it and continue.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Pass the following details to the `pki save-cert` CLI command:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Parameter | Description
--------------------|--------------------
Client certificate files | **Required.** Pass the previously generated files using the `--key` and `--cert` parameters.
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Trusted parent certificate | **Required.** Store the parent's certificate file. Manually verify that you're trusting it.
Parent host | **Required.** FQDN or IP address of the parent host.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Example:
Docs: Update certs path refs #5450
2017-09-07 16:55:42 +02:00
[root@icinga2-client1.localdomain /]# icinga2 pki save-cert --key /var/lib/icinga2/certs/icinga2-client1.localdomain.key \
--cert /var/lib/icinga2/certs/icinga2-client1.localdomain.crt \
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
--trustedcert /var/lib/icinga2/certs/trusted-parent.crt \
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
--host icinga2-master1.localdomain
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Continue with the additional node setup step. Specify a local endpoint and zone name (`icinga2-client1.localdomain`)
and set the master host (`icinga2-master1.localdomain`) as parent zone configuration. Specify the path to
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
the previously stored trusted master certificate.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Fix typos, formatting, phrasing refs #12386
2016-08-21 12:43:28 +02:00
Pass the following details to the `node setup` CLI command:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Parameter | Description
--------------------|--------------------
Update 6-distributed-monitoring.md If you omit the Common name (CN) icinga2 uses the hostname instead, which can differ from FQDN.
2017-06-01 16:13:40 +02:00
Common name (CN) | **Optional.** Specified with the `--cn` parameter. By convention this should be the host's FQDN.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Request ticket | **Required.** Add the previously generated [ticket number](06-distributed-monitoring.md#distributed-monitoring-setup-csr-auto-signing).
Fixed grammer and spelling mistakes
2017-10-30 17:02:42 +01:00
Trusted master certificate | **Required.** Add the previously fetched trusted master certificate (this step means that you've verified its origin).
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Parent host | **Optional.** FQDN or IP address of the parent host. This is where the command connects for CSR signing. If not specified, you need to manually copy the parent's public CA certificate file into `/var/lib/icinga2/certs/ca.crt` in order to start Icinga 2.
Parent endpoint | **Required.** Specify the parent's endpoint name.
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Client zone name | **Required.** Specify the client's zone name.
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Parent zone name | **Optional.** Specify the parent's zone name.
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Accept config | **Optional.** Whether this node accepts configuration sync from the master node (required for [config sync mode](06-distributed-monitoring.md#distributed-monitoring-top-down-config-sync)).
Accept commands | **Optional.** Whether this node accepts command execution messages from the master node (required for [command endpoint mode](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint)).
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Global zones | **Optional.** Allows to specify more global zones in addition to `global-templates` and `director-global`.
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
Disable conf.d | **Optional.** Specified with the `disable-confd` parameter. If provided, this disables the `include_recursive "conf.d"` directive in `icinga2.conf`. Available since v2.9+. Not set by default for compatibility reasons with Puppet, Ansible, Chef, etc.
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
> **Note**
>
> The `master_host` parameter is deprecated and will be removed in 2.10.0. Please use `--parent_host` instead.
Example for Icinga 2 v2.9:
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Add documentation for CLI command parameters refs #4508
2018-05-08 16:31:06 +02:00
```
[root@icinga2-client1.localdomain /]# icinga2 node setup --ticket ead2d570e18c78abf285d6b85524970a0f69c22d \
--cn icinga2-client1.localdomain \
--endpoint icinga2-master1.localdomain \
--zone icinga2-client1.localdomain \
--parent_zone master \
--parent_host icinga2-master1.localdomain \
--trustedcert /var/lib/icinga2/certs/trusted-parent.crt \
--accept-commands --accept-config \
--disable-confd
```
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
In case the client should connect to the master node, you'll
Docs: Review service monitoring and distributed monitoring chapters, part I refs #12386
2016-08-20 14:17:18 +02:00
need to modify the `--endpoint` parameter using the format `cn,host,port`:
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
--endpoint icinga2-master1.localdomain,192.168.56.101,5665
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
Specify the parent zone using the `--parent_zone` parameter. This is useful
if the client connects to a satellite, not the master instance.
--parent_zone satellite
Adding documentation for configurable global zones during setup This adds the documentation for the configurable global zones during the node wizard/setup. refs #5767
2018-02-27 21:22:29 +01:00
In case the client should know the additional global zone `linux-templates`, you'll
need to set the `--global-zones` parameter.
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
--global_zones linux-templates
The `--parent-host` parameter is optional since v2.9 and allows you to perform a connection-less setup.
You cannot restart Icinga 2 yet, the CLI command asked to to manually copy the parent's public CA
certificate file in `/var/lib/icinga2/certs/ca.crt`. Once Icinga 2 is started, it sends
a ticket signing request to the parent node. If you have provided a ticket, the master node
signs the request and sends it back to the client which performs a certificate update in-memory.
Adding documentation for configurable global zones during setup This adds the documentation for the configurable global zones during the node wizard/setup. refs #5767
2018-02-27 21:22:29 +01:00
Update the documentation for zone name setting in setups and connection-less node setup
2018-04-06 20:19:43 +02:00
In case you did not provide a ticket, you need to manually sign the CSR on the master node
which holds the CA's key pair.
Docs: Rewrite cluster and client chapter from scratch; add service monitoring chapter Also apply a new structure. Deleted the old cluster and client documentation and started "fresh". This commit also includes various images used in the newly written "Distributed Monitoring" chapter for better understanding. fixes #12386
2016-08-13 15:59:06 +02:00
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
**You can find additional best practices below.**
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Add an additional global zone. Please note the `>>` append mode.
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
[root@icinga2-client1.localdomain /]# cat <<EOF >>/etc/icinga2/zones.conf
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
object Zone "global-templates" {
global = true
}
EOF
Update documentation for Windows Wizard and On-Demand signing support refs #5681
2017-11-03 17:07:16 +01:00
Note: Packages >= 2.8 provide this configuration by default.
zones.conf: Add global-templates & director-global by default This makes it easier for cluster and client setups with or without the Icinga Director. Note: Clients will still not receive synced configuration if accept_config is not enabled (which is the default, and can be changed during setup). fixes #5106
2017-06-02 10:52:47 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
If this client node is configured as [remote command endpoint execution](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint)
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
you can safely disable the `checker` feature. The `node setup` CLI command already disabled the `notification` feature.
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
[root@icinga2-client1.localdomain /]# icinga2 feature disable checker
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Update docs for better compatibility with mkdocs * Rename files to allow easy ordering * Update links inside markdown according to new file names * Move HTML links (<a>...</a>) to the end of the header lines * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Disable "conf.d" inclusion if this is a [top down](06-distributed-monitoring.md#distributed-monitoring-top-down)
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
configured client.
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
[root@icinga2-client1.localdomain /]# sed -i 's/include_recursive "conf.d"/\/\/include_recursive "conf.d"/g' /etc/icinga2/icinga2.conf
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
**Optional**: Add an ApiUser object configuration for remote troubleshooting.
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
[root@icinga2-client1.localdomain /]# cat <<EOF >/etc/icinga2/conf.d/api-users.conf
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
object ApiUser "root" {
password = "clientsupersecretpassword"
permissions = ["*"]
}
EOF
In case you've previously disabled the "conf.d" directory only
add the file file `conf.d/api-users.conf`:
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
[root@icinga2-client1.localdomain /]# echo 'include "conf.d/api-users.conf"' >> /etc/icinga2/icinga2.conf
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
Finally restart Icinga 2.
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
[root@icinga2-client1.localdomain /]# systemctl restart icinga2
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
Your automation tool must then configure master node in the meantime.
Add the global zone `global-templates` in case it did not exist.
# cat <<EOF >>/etc/icinga2/zones.conf
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
object Endpoint "icinga2-client1.localdomain" {
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
//client connects itself
}
Update distributed monitoring docs fixes #12587 fixes #12594
2016-08-31 13:25:57 +02:00
object Zone "icinga2-client1.localdomain" {
endpoints = [ "icinga2-client1.localdomain" ]
Docs: Review service monitoring and distributed monitoring chapters, part II Kudos to sru and the kind feedback from monitoring-portal.org users. fixes #12386
2016-08-20 14:51:05 +02:00
parent = "master"
}
object Zone "global-templates" {
global = true
}
EOF